blob: bf2bb61e05784bd2f75bbaa9759201947a545395 [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 Gebben14b0d1a2021-05-15 20:15:41 -0600337 const auto *layout_range_map = GetLayoutRangeMap(imageLayoutMap, image_state.image());
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,
356 VkImage image, VkImageView image_view,
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;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700360 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100361 const char *vuid;
362 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700363 const char *function_name = use_rp2 ? "vkCmdBeginRenderPass2()" : "vkCmdBeginRenderPass()";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100364
365 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600366 LogObjectList objlist(image);
367 objlist.add(renderpass);
368 objlist.add(framebuffer);
369 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700370 skip |=
371 LogError(image, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
372 "%s: RenderPass %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
373 function_name, report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
374 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100375 return skip;
376 }
377
378 auto image_usage = image_state->createInfo.usage;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700379 const auto stencil_usage_info = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Ricardo Garcia3f5984c2020-04-09 10:56:34 +0200380 if (stencil_usage_info) {
381 image_usage |= stencil_usage_info->stencilUsage;
382 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100383
384 // Check for layouts that mismatch image usages in the framebuffer
385 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800386 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600387 LogObjectList objlist(image);
388 objlist.add(renderpass);
389 objlist.add(framebuffer);
390 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700391 skip |= LogError(objlist, vuid,
392 "%s: Layout/usage mismatch for attachment %u in %s"
393 " - the %s is %s but the image attached to %s via %s"
394 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
395 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
396 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
397 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100398 }
399
400 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
401 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800402 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600403 LogObjectList objlist(image);
404 objlist.add(renderpass);
405 objlist.add(framebuffer);
406 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700407 skip |= LogError(objlist, vuid,
408 "%s: Layout/usage mismatch for attachment %u in %s"
409 " - the %s is %s but the image attached to %s via %s"
410 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
411 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
412 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
413 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100414 }
415
416 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800417 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600418 LogObjectList objlist(image);
419 objlist.add(renderpass);
420 objlist.add(framebuffer);
421 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700422 skip |= LogError(objlist, vuid,
423 "%s: Layout/usage mismatch for attachment %u in %s"
424 " - the %s is %s but the image attached to %s via %s"
425 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
426 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
427 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
428 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100429 }
430
431 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800432 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600433 LogObjectList objlist(image);
434 objlist.add(renderpass);
435 objlist.add(framebuffer);
436 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700437 skip |= LogError(objlist, vuid,
438 "%s: Layout/usage mismatch for attachment %u in %s"
439 " - the %s is %s but the image attached to %s via %s"
440 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
441 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
442 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
443 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100444 }
445
sfricke-samsung45996a42021-09-16 13:45:27 -0700446 if (IsExtEnabled(device_extensions.vk_khr_maintenance2)) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100447 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
448 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
449 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
450 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
451 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800452 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600453 LogObjectList objlist(image);
454 objlist.add(renderpass);
455 objlist.add(framebuffer);
456 objlist.add(image_view);
457 skip |= LogError(objlist, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700458 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700459 " - the %s is %s but the image attached to %s via %s"
460 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700461 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700462 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
463 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100464 }
465 } else {
466 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
467 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
468 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
469 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600470 LogObjectList objlist(image);
471 objlist.add(renderpass);
472 objlist.add(framebuffer);
473 objlist.add(image_view);
474 skip |= LogError(objlist, "VUID-vkCmdBeginRenderPass-initialLayout-00896",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700475 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700476 " - the %s is %s but the image attached to %s via %s"
477 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700478 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700479 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
480 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100481 }
482 }
483 return skip;
484}
485
John Zulauf17a01bb2019-08-09 16:41:19 -0600486bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700487 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600488 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600489 bool skip = false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700490 auto const render_pass_info = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
491 auto const &framebuffer_info = framebuffer_state->createInfo;
492 const VkImageView *attachments = framebuffer_info.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100493
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600494 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass();
495 auto framebuffer = framebuffer_state->framebuffer();
Tobias Hectorbbb12282018-10-22 15:17:59 +0100496
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700497 if (render_pass_info->attachmentCount != framebuffer_info.attachmentCount) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600498 skip |= LogError(pCB->commandBuffer(), kVUID_Core_DrawState_InvalidRenderpass,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700499 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700500 }
John Zulauf8e308292018-09-21 11:34:37 -0600501
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700502 const auto *attachment_info = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext);
Mike Schuchardt2df08912020-12-15 16:28:09 -0800503 if (((framebuffer_info.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) != 0) && attachment_info != nullptr) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700504 attachments = attachment_info->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100505 }
506
Tobias Hectorc9057422019-07-23 12:15:52 +0100507 if (attachments != nullptr) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700508 const auto *const_p_cb = static_cast<const CMD_BUFFER_STATE *>(pCB);
509 for (uint32_t i = 0; i < render_pass_info->attachmentCount; ++i) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100510 auto image_view = attachments[i];
511 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100512
Tobias Hectorc9057422019-07-23 12:15:52 +0100513 if (!view_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600514 LogObjectList objlist(pRenderPassBegin->renderPass);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600515 objlist.add(framebuffer_state->framebuffer());
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600516 objlist.add(image_view);
517 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700518 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600519 report_data->FormatHandle(framebuffer_state->framebuffer()).c_str(), i,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700520 report_data->FormatHandle(image_view).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100521 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100522 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100523
524 const VkImage image = view_state->create_info.image;
525 const IMAGE_STATE *image_state = GetImageState(image);
526
527 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600528 LogObjectList objlist(pRenderPassBegin->renderPass);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600529 objlist.add(framebuffer_state->framebuffer());
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600530 objlist.add(image_view);
531 objlist.add(image);
532 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700533 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600534 report_data->FormatHandle(framebuffer_state->framebuffer()).c_str(), i,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700535 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100536 continue;
537 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700538 auto attachment_initial_layout = render_pass_info->pAttachments[i].initialLayout;
539 auto final_layout = render_pass_info->pAttachments[i].finalLayout;
Tobias Hectorc9057422019-07-23 12:15:52 +0100540
Piers Daniell7f894f62020-01-09 16:33:48 -0700541 // Default to expecting stencil in the same layout.
542 auto attachment_stencil_initial_layout = attachment_initial_layout;
543
544 // If a separate layout is specified, look for that.
545 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700546 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(render_pass_info->pAttachments[i].pNext);
Piers Daniell7f894f62020-01-09 16:33:48 -0700547 if (attachment_description_stencil_layout) {
548 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
549 }
550
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200551 const ImageSubresourceLayoutMap *subresource_map = nullptr;
552 bool has_queried_map = false;
553 bool subres_skip = false;
Tobias Hectorc9057422019-07-23 12:15:52 +0100554
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200555 for (uint32_t aspect_index = 0; aspect_index < 32; aspect_index++) {
556 VkImageAspectFlags test_aspect = 1u << aspect_index;
557 if ((view_state->normalized_subresource_range.aspectMask & test_aspect) == 0) {
558 continue;
559 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700560
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200561 // Allow for differing depth and stencil layouts
562 VkImageLayout check_layout = attachment_initial_layout;
563 if (test_aspect == VK_IMAGE_ASPECT_STENCIL_BIT) {
564 check_layout = attachment_stencil_initial_layout;
565 }
566
567 if (check_layout != VK_IMAGE_LAYOUT_UNDEFINED) { // If no layout information for image yet, will be checked at QueueSubmit time
568 if (!has_queried_map) {
569 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
570 // in common with the non-const version.)
571 // The lookup is expensive, so cache it.
572 subresource_map = const_p_cb->GetImageSubresourceLayoutMap(image);
573 has_queried_map = true;
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200574 }
John Zulauf5e617452019-11-19 14:44:16 -0700575
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200576 if (subresource_map) {
577 auto normalized_range = view_state->normalized_subresource_range;
578 normalized_range.aspectMask = test_aspect;
579 auto pos = subresource_map->Find(normalized_range);
580 LayoutUseCheckAndMessage layout_check(subresource_map, test_aspect);
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200581
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200582 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to the next "constant value" range
583 for (; !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
584 const VkImageSubresource &subres = pos->subresource;
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200585
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200586 if (!layout_check.Check(subres, check_layout, pos->current_layout, pos->initial_layout)) {
587 subres_skip |= LogError(
588 device, kVUID_Core_DrawState_InvalidRenderpass,
589 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
590 "and the %s layout of the attachment is %s. The layouts must match, or the render "
591 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
592 i, string_VkImageLayout(check_layout), layout_check.message,
593 string_VkImageLayout(layout_check.layout));
594 }
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200595 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100596 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700597 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100598 }
599
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200600 skip |= subres_skip;
601
Tobias Hectorc9057422019-07-23 12:15:52 +0100602 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view,
603 framebuffer, render_pass, i, "initial layout");
604
605 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer,
606 render_pass, i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100607 }
608
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700609 for (uint32_t j = 0; j < render_pass_info->subpassCount; ++j) {
610 auto &subpass = render_pass_info->pSubpasses[j];
611 for (uint32_t k = 0; k < render_pass_info->pSubpasses[j].inputAttachmentCount; ++k) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100612 auto &attachment_ref = subpass.pInputAttachments[k];
613 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
614 auto image_view = attachments[attachment_ref.attachment];
615 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100616
Tobias Hectorc9057422019-07-23 12:15:52 +0100617 if (view_state) {
618 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700619 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
620 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100621 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100622 }
623 }
624 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100625
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700626 for (uint32_t k = 0; k < render_pass_info->pSubpasses[j].colorAttachmentCount; ++k) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100627 auto &attachment_ref = subpass.pColorAttachments[k];
628 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
629 auto image_view = attachments[attachment_ref.attachment];
630 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100631
Tobias Hectorc9057422019-07-23 12:15:52 +0100632 if (view_state) {
633 auto image = view_state->create_info.image;
634 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
635 framebuffer, render_pass, attachment_ref.attachment,
636 "color attachment layout");
637 if (subpass.pResolveAttachments) {
638 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
639 rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
640 attachment_ref.attachment, "resolve attachment layout");
641 }
642 }
643 }
644 }
645
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700646 if (render_pass_info->pSubpasses[j].pDepthStencilAttachment) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100647 auto &attachment_ref = *subpass.pDepthStencilAttachment;
648 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
649 auto image_view = attachments[attachment_ref.attachment];
650 auto view_state = GetImageViewState(image_view);
651
652 if (view_state) {
653 auto image = view_state->create_info.image;
654 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
655 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 // Scoreboard for checking for duplicate and inconsistent barriers to images
812 struct ImageBarrierScoreboardEntry {
813 uint32_t index;
814 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
815 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700816 const ImageBarrier *barrier;
Petr Krausad0096a2019-08-09 18:35:04 +0200817 };
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700818 // Necessary to resolve warning C4503 when building with Visual Studio 2015.
819 // Adding a struct wrapper is their recommend solution for the expanded type name growing too long
820 // when creating maps full of maps.
821 struct ImageBarrierScoreboardSubresMap {
Jeremy Gebbencbf22862021-03-03 12:01:22 -0700822 layer_data::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry> map;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700823 };
Jeremy Gebbencbf22862021-03-03 12:01:22 -0700824 using ImageBarrierScoreboardImageMap = layer_data::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
Petr Krausad0096a2019-08-09 18:35:04 +0200825
John Zulauf463c51e2018-05-31 13:29:20 -0600826 // Scoreboard for duplicate layout transition barriers within the list
827 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
828 ImageBarrierScoreboardImageMap layout_transitions;
829
Mike Weiblen62d08a32017-03-07 22:18:27 -0700830 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700831 auto loc = outer_loc.dot(Field::pImageMemoryBarriers, i);
Petr Krausad0096a2019-08-09 18:35:04 +0200832 const auto &img_barrier = pImageMemoryBarriers[i];
Mike Weiblen62d08a32017-03-07 22:18:27 -0700833
John Zulauf463c51e2018-05-31 13:29:20 -0600834 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
835 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
836 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +0200837 if (img_barrier.oldLayout != img_barrier.newLayout) {
838 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
839 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -0600840 if (image_it != layout_transitions.end()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700841 auto &subres_map = image_it->second.map;
Petr Krausad0096a2019-08-09 18:35:04 +0200842 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -0600843 if (subres_it != subres_map.end()) {
844 auto &entry = subres_it->second;
Jeremy Gebben579aaca2021-02-15 13:36:18 -0700845 auto entry_layout =
846 NormalizeSynchronization2Layout(entry.barrier->subresourceRange.aspectMask, entry.barrier->newLayout);
847 auto old_layout =
848 NormalizeSynchronization2Layout(img_barrier.subresourceRange.aspectMask, img_barrier.oldLayout);
849 if ((entry_layout != old_layout) && (old_layout != VK_IMAGE_LAYOUT_UNDEFINED)) {
Petr Krausad0096a2019-08-09 18:35:04 +0200850 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700851 const auto &vuid = GetImageBarrierVUID(loc, ImageError::kConflictingLayout);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700852 skip = LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600853 cb_state->commandBuffer(), vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700854 "%s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600855 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
856 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700857 loc.Message().c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
Petr Krausad0096a2019-08-09 18:35:04 +0200858 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
859 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600860 }
861 entry = new_entry;
862 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200863 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600864 }
865 } else {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700866 layout_transitions[img_barrier.image].map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600867 }
868 }
869
Petr Krausad0096a2019-08-09 18:35:04 +0200870 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600871 if (image_state) {
872 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700873 skip |=
874 ValidateBarrierLayoutToImageUsage(loc.dot(Field::oldLayout), img_barrier.image, img_barrier.oldLayout, usage_flags);
875 skip |=
876 ValidateBarrierLayoutToImageUsage(loc.dot(Field::newLayout), img_barrier.image, img_barrier.newLayout, usage_flags);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600877
878 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
879 if (image_state->layout_locked) {
880 // TODO: Add unique id for error when available
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700881 skip |= LogError(
882 img_barrier.image, 0,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700883 "%s Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600884 " 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 -0700885 loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
886 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600887 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600888
John Zulaufa4472282019-08-22 14:44:34 -0600889 const VkImageCreateInfo &image_create_info = image_state->createInfo;
sfricke-samsung79b00482020-04-01 21:15:50 -0700890 const VkFormat image_format = image_create_info.format;
891 const VkImageAspectFlags aspect_mask = img_barrier.subresourceRange.aspectMask;
John Zulauff660ad62019-03-23 07:16:05 -0600892 // For a Depth/Stencil image both aspects MUST be set
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700893 auto image_loc = loc.dot(Field::image);
sfricke-samsung79b00482020-04-01 21:15:50 -0700894 if (FormatIsDepthAndStencil(image_format)) {
Piers Daniell41b8c5d2020-01-10 15:42:00 -0700895 if (enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -0600896 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700897 auto vuid = GetImageBarrierVUID(loc, ImageError::kNotDepthOrStencilAspect);
898 skip |= LogError(img_barrier.image, vuid,
899 "%s references %s of format %s that must have either the depth or stencil "
900 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
901 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
902 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600903 }
904 } else {
905 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
906 if ((aspect_mask & ds_mask) != (ds_mask)) {
sfricke-samsung45996a42021-09-16 13:45:27 -0700907 auto error = IsExtEnabled(device_extensions.vk_khr_separate_depth_stencil_layouts)
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700908 ? ImageError::kNotSeparateDepthAndStencilAspect
909 : ImageError::kNotDepthAndStencilAspect;
910 auto vuid = GetImageBarrierVUID(image_loc, error);
sfricke-samsung38d280b2020-05-16 08:02:56 -0700911 skip |= LogError(img_barrier.image, vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700912 "%s references %s of format %s that must have the depth and stencil "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700913 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700914 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700915 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600916 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700917 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700918 }
John Zulauff660ad62019-03-23 07:16:05 -0600919
Jeremy Gebben159b3cc2021-06-03 09:09:03 -0600920 const auto *subresource_map = cb_state->GetImageSubresourceLayoutMap(img_barrier.image);
Petr Krausad0096a2019-08-09 18:35:04 +0200921 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -0600922 // TODO: Set memory invalid which is in mem_tracker currently
923 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
924 // subresource.
John Zulaufcea64cb2020-06-10 17:17:27 -0600925 } else if (subresource_map && !QueueFamilyIsExternal(img_barrier.srcQueueFamilyIndex)) {
John Zulauff660ad62019-03-23 07:16:05 -0600926 bool subres_skip = false;
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200927
928 // Validate aspects in isolation.
929 // This is required when handling separate depth-stencil layouts.
930 for (uint32_t aspect_index = 0; aspect_index < 32; aspect_index++) {
931 VkImageAspectFlags test_aspect = 1u << aspect_index;
932 if ((img_barrier.subresourceRange.aspectMask & test_aspect) == 0) {
933 continue;
934 }
935
936 LayoutUseCheckAndMessage layout_check(subresource_map, test_aspect);
937 auto normalized_isr = image_state->NormalizeSubresourceRange(img_barrier.subresourceRange);
938 normalized_isr.aspectMask = test_aspect;
939
940 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to the next "constant value" range
941 for (auto pos = subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
942 const auto &value = *pos;
943 auto old_layout =
944 NormalizeSynchronization2Layout(test_aspect, img_barrier.oldLayout);
945 if (!layout_check.Check(value.subresource, old_layout, value.current_layout, value.initial_layout)) {
946 const auto &vuid = GetImageBarrierVUID(loc, ImageError::kConflictingLayout);
947 subres_skip =
948 LogError(cb_state->commandBuffer(), vuid,
949 "%s %s cannot transition the layout of aspect=%d level=%d layer=%d from %s when the "
950 "%s layout is %s.",
951 loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
952 value.subresource.aspectMask, value.subresource.mipLevel, value.subresource.arrayLayer,
953 string_VkImageLayout(img_barrier.oldLayout), layout_check.message,
954 string_VkImageLayout(layout_check.layout));
955 }
John Zulauff660ad62019-03-23 07:16:05 -0600956 }
John Zulauf5e617452019-11-19 14:44:16 -0700957 }
John Zulauff660ad62019-03-23 07:16:05 -0600958 skip |= subres_skip;
959 }
sfricke-samsung79b00482020-04-01 21:15:50 -0700960
961 // checks color format and (single-plane or non-disjoint)
962 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
963 if ((FormatIsColor(image_format) == true) &&
sfricke-samsung71bc6572020-04-29 15:49:43 -0700964 ((FormatIsMultiplane(image_format) == false) || (image_state->disjoint == false))) {
sfricke-samsung79b00482020-04-01 21:15:50 -0700965 if (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsung45996a42021-09-16 13:45:27 -0700966 auto error = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion) ? ImageError::kNotColorAspect
967 : ImageError::kNotColorAspectYcbcr;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700968 const auto &vuid = GetImageBarrierVUID(loc, error);
sfricke-samsung79b00482020-04-01 21:15:50 -0700969 skip |= LogError(img_barrier.image, vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700970 "%s references %s of format %s that must be only VK_IMAGE_ASPECT_COLOR_BIT, "
sfricke-samsung79b00482020-04-01 21:15:50 -0700971 "but its aspectMask is 0x%" PRIx32 ".",
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700972 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700973 string_VkFormat(image_format), aspect_mask);
974 }
975 }
976
977 VkImageAspectFlags valid_disjoint_mask =
978 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 -0700979 if ((FormatIsMultiplane(image_format) == true) && (image_state->disjoint == true) &&
sfricke-samsung79b00482020-04-01 21:15:50 -0700980 ((aspect_mask & valid_disjoint_mask) == 0)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700981 const auto &vuid = GetImageBarrierVUID(image_loc, ImageError::kBadMultiplanarAspect);
982 skip |= LogError(img_barrier.image, vuid,
983 "%s references %s of format %s has aspectMask (0x%" PRIx32
sfricke-samsung79b00482020-04-01 21:15:50 -0700984 ") but needs to include either an VK_IMAGE_ASPECT_PLANE_*_BIT or VK_IMAGE_ASPECT_COLOR_BIT.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700985 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700986 string_VkFormat(image_format), aspect_mask);
987 }
988
989 if ((FormatPlaneCount(image_format) == 2) && ((aspect_mask & VK_IMAGE_ASPECT_PLANE_2_BIT) != 0)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700990 const auto &vuid = GetImageBarrierVUID(image_loc, ImageError::kBadPlaneCount);
991 skip |= LogError(img_barrier.image, vuid,
992 "%s references %s of format %s has only two planes but included "
sfricke-samsung79b00482020-04-01 21:15:50 -0700993 "VK_IMAGE_ASPECT_PLANE_2_BIT in its aspectMask (0x%" PRIx32 ").",
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700994 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700995 string_VkFormat(image_format), aspect_mask);
996 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700997 }
998 }
999 return skip;
1000}
1001
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001002template <typename Barrier, typename TransferBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001003bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const Location &loc, const CMD_BUFFER_STATE *cb_state, const Barrier &barrier,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001004 const QFOTransferBarrierSets<TransferBarrier> &barrier_sets) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001005 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001006 const char *handle_name = TransferBarrier::HandleName();
John Zulauf6b4aae82018-05-09 13:03:36 -06001007 const char *transfer_type = nullptr;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001008 if (!IsTransferOp(barrier)) {
1009 return skip;
1010 }
1011 const TransferBarrier *barrier_record = nullptr;
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001012 if (cb_state->IsReleaseOp(barrier) && !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001013 const auto found = barrier_sets.release.find(barrier);
1014 if (found != barrier_sets.release.cend()) {
1015 barrier_record = &(*found);
1016 transfer_type = "releasing";
John Zulauf6b4aae82018-05-09 13:03:36 -06001017 }
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001018 } else if (cb_state->IsAcquireOp(barrier) && !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001019 const auto found = barrier_sets.acquire.find(barrier);
1020 if (found != barrier_sets.acquire.cend()) {
1021 barrier_record = &(*found);
1022 transfer_type = "acquiring";
John Zulauf6b4aae82018-05-09 13:03:36 -06001023 }
1024 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001025 if (barrier_record != nullptr) {
1026 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001027 LogWarning(cb_state->commandBuffer(), TransferBarrier::ErrMsgDuplicateQFOInCB(),
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001028 "%s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
1029 " duplicates existing barrier recorded in this command buffer.",
1030 loc.Message().c_str(), transfer_type, handle_name, report_data->FormatHandle(barrier_record->handle).c_str(),
1031 barrier_record->srcQueueFamilyIndex, barrier_record->dstQueueFamilyIndex);
1032 }
John Zulauf6b4aae82018-05-09 13:03:36 -06001033 return skip;
1034}
1035
John Zulaufa4472282019-08-22 14:44:34 -06001036VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
1037 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1038}
1039
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001040VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier2KHR &barrier) {
1041 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1042}
1043
John Zulaufa4472282019-08-22 14:44:34 -06001044const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
1045 return device_state.GetImageState(barrier.image);
1046}
1047
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001048const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier2KHR &barrier) {
1049 return device_state.GetImageState(barrier.image);
1050}
1051
John Zulaufa4472282019-08-22 14:44:34 -06001052VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
1053 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1054}
1055
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001056VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier2KHR &barrier) {
1057 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1058}
1059
John Zulaufa4472282019-08-22 14:44:34 -06001060const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
1061 return device_state.GetBufferState(barrier.buffer);
1062}
1063
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001064const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier2KHR &barrier) {
1065 return device_state.GetBufferState(barrier.buffer);
1066}
John Zulaufa4472282019-08-22 14:44:34 -06001067
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001068template <typename Barrier, typename TransferBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001069void CoreChecks::RecordBarrierValidationInfo(const Location &loc, CMD_BUFFER_STATE *cb_state, const Barrier &barrier,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001070 QFOTransferBarrierSets<TransferBarrier> &barrier_sets) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001071 if (IsTransferOp(barrier)) {
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001072 if (cb_state->IsReleaseOp(barrier) && !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001073 barrier_sets.release.emplace(barrier);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001074 } else if (cb_state->IsAcquireOp(barrier) && !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001075 barrier_sets.acquire.emplace(barrier);
John Zulaufa4472282019-08-22 14:44:34 -06001076 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001077 }
John Zulaufa4472282019-08-22 14:44:34 -06001078
David Zhao Akeleyd76df472021-05-15 17:25:59 -07001079 // 7.7.4: If the values of srcQueueFamilyIndex and dstQueueFamilyIndex are equal, no ownership transfer is performed, and the
1080 // barrier operates as if they were both set to VK_QUEUE_FAMILY_IGNORED.
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001081 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
1082 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
David Zhao Akeleyd76df472021-05-15 17:25:59 -07001083 const bool is_ownership_transfer = src_queue_family != dst_queue_family;
1084
1085 if (is_ownership_transfer) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001086 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
1087 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
1088 auto handle_state = BarrierHandleState(*this, barrier);
1089 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
1090 if (!mode_concurrent) {
1091 const auto typed_handle = BarrierTypedHandle(barrier);
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001092 core_error::LocationCapture loc_capture(loc);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001093 cb_state->queue_submit_functions.emplace_back(
John Zulaufb4438f02021-02-20 20:22:16 -07001094 [loc_capture, cb_state, typed_handle, src_queue_family, dst_queue_family](const ValidationStateTracker *device_data,
1095 const QUEUE_STATE *queue_state) {
1096 return ValidateConcurrentBarrierAtSubmit(loc_capture.Get(), device_data, queue_state, cb_state, typed_handle,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001097 src_queue_family, dst_queue_family);
1098 });
John Zulauf6b4aae82018-05-09 13:03:36 -06001099 }
1100 }
1101}
1102
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001103// Verify image barrier image state and that the image is consistent with FB image
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001104template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001105bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001106 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1107 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001108 const ImgBarrier &img_barrier, const CMD_BUFFER_STATE *primary_cb_state) const {
1109 using sync_vuid_maps::GetImageBarrierVUID;
1110 using sync_vuid_maps::ImageError;
1111
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001112 bool skip = false;
1113 const auto *fb_state = framebuffer;
1114 assert(fb_state);
1115 const auto img_bar_image = img_barrier.image;
1116 bool image_match = false;
1117 bool sub_image_found = false; // Do we find a corresponding subpass description
1118 VkImageLayout sub_image_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1119 uint32_t attach_index = 0;
1120 // Verify that a framebuffer image matches barrier image
1121 const auto attachment_count = fb_state->createInfo.attachmentCount;
1122 for (uint32_t attachment = 0; attachment < attachment_count; ++attachment) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06001123 auto view_state = primary_cb_state ? primary_cb_state->GetActiveAttachmentImageViewState(attachment) : cb_state->GetActiveAttachmentImageViewState(attachment);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001124 if (view_state && (img_bar_image == view_state->create_info.image)) {
1125 image_match = true;
1126 attach_index = attachment;
1127 break;
1128 }
1129 }
1130 if (image_match) { // Make sure subpass is referring to matching attachment
1131 if (sub_desc.pDepthStencilAttachment && sub_desc.pDepthStencilAttachment->attachment == attach_index) {
1132 sub_image_layout = sub_desc.pDepthStencilAttachment->layout;
1133 sub_image_found = true;
1134 }
sfricke-samsung45996a42021-09-16 13:45:27 -07001135 if (!sub_image_found && IsExtEnabled(device_extensions.vk_khr_depth_stencil_resolve)) {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001136 const auto *resolve = LvlFindInChain<VkSubpassDescriptionDepthStencilResolve>(sub_desc.pNext);
1137 if (resolve && resolve->pDepthStencilResolveAttachment &&
1138 resolve->pDepthStencilResolveAttachment->attachment == attach_index) {
1139 sub_image_layout = resolve->pDepthStencilResolveAttachment->layout;
1140 sub_image_found = true;
1141 }
1142 }
1143 if (!sub_image_found) {
1144 for (uint32_t j = 0; j < sub_desc.colorAttachmentCount; ++j) {
1145 if (sub_desc.pColorAttachments && sub_desc.pColorAttachments[j].attachment == attach_index) {
1146 sub_image_layout = sub_desc.pColorAttachments[j].layout;
1147 sub_image_found = true;
1148 break;
1149 }
1150 if (!sub_image_found && sub_desc.pResolveAttachments &&
1151 sub_desc.pResolveAttachments[j].attachment == attach_index) {
1152 sub_image_layout = sub_desc.pResolveAttachments[j].layout;
1153 sub_image_found = true;
1154 break;
1155 }
1156 }
1157 }
1158 if (!sub_image_found) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001159 auto img_loc = loc.dot(Field::image);
1160 const auto &vuid = GetImageBarrierVUID(img_loc, ImageError::kRenderPassMismatch);
1161 skip |=
1162 LogError(rp_handle, vuid,
1163 "%s Barrier for %s is not referenced by the VkSubpassDescription for active subpass (%d) of current %s.",
1164 img_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(), active_subpass,
1165 report_data->FormatHandle(rp_handle).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001166 }
1167 } else { // !image_match
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001168 auto img_loc = loc.dot(Field::image);
1169 const auto &vuid = GetImageBarrierVUID(img_loc, ImageError::kRenderPassMismatch);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001170 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 -07001171 img_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001172 report_data->FormatHandle(fb_state->framebuffer()).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001173 }
1174 if (img_barrier.oldLayout != img_barrier.newLayout) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001175 auto layout_loc = loc.dot(Field::oldLayout);
1176 const auto &vuid = GetImageBarrierVUID(layout_loc, ImageError::kRenderPassLayoutChange);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001177 skip |= LogError(cb_state->commandBuffer(), vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001178 "%s As the Image Barrier for %s is being executed within a render pass instance, oldLayout must "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001179 "equal newLayout yet they are %s and %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001180 layout_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001181 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(img_barrier.newLayout));
1182 } else {
1183 if (sub_image_found && sub_image_layout != img_barrier.oldLayout) {
1184 LogObjectList objlist(rp_handle);
1185 objlist.add(img_bar_image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001186 auto layout_loc = loc.dot(Field::oldLayout);
1187 const auto &vuid = GetImageBarrierVUID(layout_loc, ImageError::kRenderPassLayoutChange);
1188 skip |= LogError(objlist, vuid,
1189 "%s Barrier for %s is referenced by the VkSubpassDescription for active "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001190 "subpass (%d) of current %s as having layout %s, but image barrier has layout %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001191 layout_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(), active_subpass,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001192 report_data->FormatHandle(rp_handle).c_str(), string_VkImageLayout(sub_image_layout),
1193 string_VkImageLayout(img_barrier.oldLayout));
1194 }
1195 }
1196 return skip;
1197}
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001198// explictly instantiate so these can be used in core_validation.cpp
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001199template bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001200 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1201 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
1202 const VkImageMemoryBarrier &img_barrier,
1203 const CMD_BUFFER_STATE *primary_cb_state) const;
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001204template bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001205 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1206 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
1207 const VkImageMemoryBarrier2KHR &img_barrier,
1208 const CMD_BUFFER_STATE *primary_cb_state) const;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001209
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001210template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001211void CoreChecks::EnqueueSubmitTimeValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001212 const ImgBarrier &barrier) {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001213 // Secondary CBs can have null framebuffer so queue up validation in that case 'til FB is known
1214 if ((cb_state->activeRenderPass) && (VK_NULL_HANDLE == cb_state->activeFramebuffer) &&
1215 (VK_COMMAND_BUFFER_LEVEL_SECONDARY == cb_state->createInfo.level)) {
1216 const auto active_subpass = cb_state->activeSubpass;
1217 const auto rp_state = cb_state->activeRenderPass;
1218 const auto &sub_desc = rp_state->createInfo.pSubpasses[active_subpass];
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001219 // Secondary CB case w/o FB specified delay validation
1220 auto *this_ptr = this; // Required for older compilers with c++20 compatibility
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001221 core_error::LocationCapture loc_capture(loc);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001222 const auto render_pass = rp_state->renderPass();
John Zulaufb4438f02021-02-20 20:22:16 -07001223 cb_state->cmd_execute_commands_functions.emplace_back(
1224 [this_ptr, loc_capture, cb_state, active_subpass, sub_desc, render_pass, barrier](const CMD_BUFFER_STATE *primary_cb,
1225 const FRAMEBUFFER_STATE *fb) {
1226 return this_ptr->ValidateImageBarrierAttachment(loc_capture.Get(), cb_state, fb, active_subpass, sub_desc,
1227 render_pass, barrier, primary_cb);
1228 });
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001229 }
1230}
1231
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001232void CoreChecks::RecordBarriers(Func func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001233 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1234 const VkImageMemoryBarrier *pImageMemBarriers) {
1235 for (uint32_t i = 0; i < bufferBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001236 Location loc(func_name, Struct::VkBufferMemoryBarrier, Field::pBufferMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001237 RecordBarrierValidationInfo(loc, cb_state, pBufferMemBarriers[i], cb_state->qfo_transfer_buffer_barriers);
1238 }
1239 for (uint32_t i = 0; i < imageMemBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001240 Location loc(func_name, Struct::VkImageMemoryBarrier, Field::pImageMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001241 const auto &img_barrier = pImageMemBarriers[i];
1242 RecordBarrierValidationInfo(loc, cb_state, img_barrier, cb_state->qfo_transfer_image_barriers);
1243 EnqueueSubmitTimeValidateImageBarrierAttachment(loc, cb_state, img_barrier);
1244 }
1245}
1246
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001247void CoreChecks::RecordBarriers(Func func_name, CMD_BUFFER_STATE *cb_state, const VkDependencyInfoKHR &dep_info) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001248 for (uint32_t i = 0; i < dep_info.bufferMemoryBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001249 Location loc(func_name, Struct::VkBufferMemoryBarrier2KHR, Field::pBufferMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001250 RecordBarrierValidationInfo(loc, cb_state, dep_info.pBufferMemoryBarriers[i], cb_state->qfo_transfer_buffer_barriers);
1251 }
1252 for (uint32_t i = 0; i < dep_info.imageMemoryBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001253 Location loc(func_name, Struct::VkImageMemoryBarrier2KHR, Field::pImageMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001254 const auto &img_barrier = dep_info.pImageMemoryBarriers[i];
1255 RecordBarrierValidationInfo(loc, cb_state, img_barrier, cb_state->qfo_transfer_image_barriers);
1256 EnqueueSubmitTimeValidateImageBarrierAttachment(loc, cb_state, img_barrier);
1257 }
1258}
1259
1260template <typename TransferBarrier, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001261bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001262 const char *operation, const TransferBarrier &barrier,
1263 Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001264 // Record to the scoreboard or report that we have a duplication
1265 bool skip = false;
Jeremy Gebbencbf22862021-03-03 12:01:22 -07001266 auto inserted = scoreboard->emplace(barrier, cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001267 if (!inserted.second && inserted.first->second != cb_state) {
1268 // 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 -06001269 LogObjectList objlist(cb_state->commandBuffer());
Mark Lobodzinskiea561582020-03-16 18:13:56 -06001270 objlist.add(barrier.handle);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001271 objlist.add(inserted.first->second->commandBuffer());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001272 skip = LogWarning(objlist, TransferBarrier::ErrMsgDuplicateQFOInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001273 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1274 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001275 "vkQueueSubmit()", TransferBarrier::BarrierName(), operation, TransferBarrier::HandleName(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001276 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001277 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer()).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001278 }
1279 return skip;
1280}
1281
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001282template <typename TransferBarrier>
1283bool CoreChecks::ValidateQueuedQFOTransferBarriers(
1284 const CMD_BUFFER_STATE *cb_state, QFOTransferCBScoreboards<TransferBarrier> *scoreboards,
1285 const GlobalQFOTransferBarrierMap<TransferBarrier> &global_release_barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001286 bool skip = false;
Jeremy Gebben159b3cc2021-06-03 09:09:03 -06001287 const auto &cb_barriers = cb_state->GetQFOBarrierSets(TransferBarrier());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001288 const char *barrier_name = TransferBarrier::BarrierName();
1289 const char *handle_name = TransferBarrier::HandleName();
John Zulauf6b4aae82018-05-09 13:03:36 -06001290 // No release should have an extant duplicate (WARNING)
1291 for (const auto &release : cb_barriers.release) {
1292 // Check the global pending release barriers
1293 const auto set_it = global_release_barriers.find(release.handle);
1294 if (set_it != global_release_barriers.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001295 const QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001296 const auto found = set_for_handle.find(release);
1297 if (found != set_for_handle.cend()) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001298 skip |= LogWarning(cb_state->commandBuffer(), TransferBarrier::ErrMsgDuplicateQFOSubmitted(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001299 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1300 " to dstQueueFamilyIndex %" PRIu32
1301 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1302 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1303 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001304 }
1305 }
1306 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1307 }
1308 // Each acquire must have a matching release (ERROR)
1309 for (const auto &acquire : cb_barriers.acquire) {
1310 const auto set_it = global_release_barriers.find(acquire.handle);
1311 bool matching_release_found = false;
1312 if (set_it != global_release_barriers.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001313 const QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001314 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1315 }
1316 if (!matching_release_found) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001317 skip |= LogError(cb_state->commandBuffer(), TransferBarrier::ErrMsgMissingQFOReleaseInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001318 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1319 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1320 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1321 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001322 }
1323 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1324 }
1325 return skip;
1326}
1327
John Zulauf3b04ebd2019-07-18 14:08:11 -06001328bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001329 QFOTransferCBScoreboards<QFOImageTransferBarrier> *qfo_image_scoreboards,
1330 QFOTransferCBScoreboards<QFOBufferTransferBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001331 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001332 skip |=
1333 ValidateQueuedQFOTransferBarriers<QFOImageTransferBarrier>(cb_state, qfo_image_scoreboards, qfo_release_image_barrier_map);
1334 skip |= ValidateQueuedQFOTransferBarriers<QFOBufferTransferBarrier>(cb_state, qfo_buffer_scoreboards,
1335 qfo_release_buffer_barrier_map);
John Zulauf6b4aae82018-05-09 13:03:36 -06001336 return skip;
1337}
1338
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001339template <typename TransferBarrier>
1340void RecordQueuedQFOTransferBarriers(QFOTransferBarrierSets<TransferBarrier> &cb_barriers,
1341 GlobalQFOTransferBarrierMap<TransferBarrier> &global_release_barriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001342 // Add release barriers from this submit to the global map
1343 for (const auto &release : cb_barriers.release) {
1344 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1345 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1346 global_release_barriers[release.handle].insert(release);
1347 }
1348
1349 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1350 for (const auto &acquire : cb_barriers.acquire) {
1351 // NOTE: We're not using [] because we don't want to create entries for missing releases
1352 auto set_it = global_release_barriers.find(acquire.handle);
1353 if (set_it != global_release_barriers.end()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001354 QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001355 set_for_handle.erase(acquire);
1356 if (set_for_handle.size() == 0) { // Clean up empty sets
1357 global_release_barriers.erase(set_it);
1358 }
1359 }
1360 }
1361}
1362
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001363void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001364 RecordQueuedQFOTransferBarriers<QFOImageTransferBarrier>(cb_state->qfo_transfer_image_barriers, qfo_release_image_barrier_map);
1365 RecordQueuedQFOTransferBarriers<QFOBufferTransferBarrier>(cb_state->qfo_transfer_buffer_barriers,
1366 qfo_release_buffer_barrier_map);
John Zulauf6b4aae82018-05-09 13:03:36 -06001367}
1368
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001369template <typename ImgBarrier>
1370void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count, const ImgBarrier *barriers) {
1371 // For ownership transfers, the barrier is specified twice; as a release
1372 // operation on the yielding queue family, and as an acquire operation
1373 // on the acquiring queue family. This barrier may also include a layout
1374 // transition, which occurs 'between' the two operations. For validation
1375 // purposes it doesn't seem important which side performs the layout
1376 // transition, but it must not be performed twice. We'll arbitrarily
1377 // choose to perform it as part of the acquire operation.
1378 //
1379 // However, we still need to record initial layout for the "initial layout" validation
1380 for (uint32_t i = 0; i < barrier_count; i++) {
1381 const auto &mem_barrier = barriers[i];
Jeremy Gebbenefead332021-06-18 08:22:44 -06001382 const bool is_release_op = cb_state->IsReleaseOp(mem_barrier);
Petr Krausad0096a2019-08-09 18:35:04 +02001383 auto *image_state = GetImageState(mem_barrier.image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001384 if (image_state) {
1385 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
1386 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001387 }
1388}
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001389// explictly instantiate this template so it can be used in core_validation.cpp
1390template void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1391 const VkImageMemoryBarrier *barrier);
1392template void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1393 const VkImageMemoryBarrier2KHR *barrier);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001394
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001395VkImageLayout NormalizeSynchronization2Layout(const VkImageAspectFlags aspect_mask, VkImageLayout layout);
1396
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001397template <typename ImgBarrier>
unknown86bcb3a2019-07-11 13:05:36 -06001398void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001399 const ImgBarrier &mem_barrier, bool is_release_op) {
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001400 if (enabled_features.synchronization2_features.synchronization2) {
1401 if (mem_barrier.oldLayout == mem_barrier.newLayout) {
1402 return;
1403 }
1404 }
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06001405 auto normalized_isr = image_state->NormalizeSubresourceRange(mem_barrier.subresourceRange);
unknown86bcb3a2019-07-11 13:05:36 -06001406
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001407 VkImageLayout initial_layout = NormalizeSynchronization2Layout(mem_barrier.subresourceRange.aspectMask, mem_barrier.oldLayout);
1408 VkImageLayout new_layout = NormalizeSynchronization2Layout(mem_barrier.subresourceRange.aspectMask, mem_barrier.newLayout);
Michael Spang8af7c102020-05-03 20:50:09 -04001409
1410 // Layout transitions in external instance are not tracked, so don't validate initial layout.
John Zulaufcea64cb2020-06-10 17:17:27 -06001411 if (QueueFamilyIsExternal(mem_barrier.srcQueueFamilyIndex)) {
Michael Spang8af7c102020-05-03 20:50:09 -04001412 initial_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1413 }
1414
John Zulauf2be3fe02019-12-30 09:48:02 -07001415 if (is_release_op) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06001416 cb_state->SetImageInitialLayout(*image_state, normalized_isr, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001417 } else {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06001418 cb_state->SetImageLayout(*image_state, normalized_isr, new_layout, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001419 }
unknown86bcb3a2019-07-11 13:05:36 -06001420}
1421
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001422bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1423 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1424 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1425 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06001426 if (disabled[image_layout_validation]) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001427 assert(cb_node);
1428 assert(image_state);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001429 const auto image = image_state->image();
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001430 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001431
Jeremy Gebben159b3cc2021-06-03 09:09:03 -06001432 const auto *subresource_map = cb_node->GetImageSubresourceLayoutMap(image);
John Zulauff660ad62019-03-23 07:16:05 -06001433 if (subresource_map) {
1434 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001435 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
Tony Barbour55688172020-09-23 15:19:50 -07001436 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
1437 // the next "constant value" range
1438 for (auto pos = subresource_map->Find(range); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07001439 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001440 *error = true;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001441 subres_skip |= LogError(cb_node->commandBuffer(), layout_mismatch_msg_code,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001442 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1443 "%s layout %s.",
1444 caller, report_data->FormatHandle(image).c_str(), pos->subresource.arrayLayer,
1445 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1446 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001447 }
John Zulauf5e617452019-11-19 14:44:16 -07001448 }
John Zulauff660ad62019-03-23 07:16:05 -06001449 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001450 }
John Zulauff660ad62019-03-23 07:16:05 -06001451
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001452 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1453 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1454 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001455 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1456 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001457 skip |= LogPerformanceWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001458 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
1459 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001460 }
sfricke-samsung45996a42021-09-16 13:45:27 -07001461 } else if (IsExtEnabled(device_extensions.vk_khr_shared_presentable_image)) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001462 if (image_state->shared_presentable) {
1463 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001464 skip |=
1465 LogError(device, layout_invalid_msg_code,
1466 "%s: Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1467 caller, string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001468 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001469 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001470 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001471 *error = true;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001472 skip |= LogError(cb_node->commandBuffer(), layout_invalid_msg_code,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001473 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1474 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1475 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001476 }
1477 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001478 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001479}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001480bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001481 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1482 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001483 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001484 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1485 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1486}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001487
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001488void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001489 FRAMEBUFFER_STATE *framebuffer_state) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001490 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass);
1491 if (!render_pass) return;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001492
Mike Schuchardt2df08912020-12-15 16:28:09 -08001493 const VkRenderPassCreateInfo2 *render_pass_info = render_pass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001494 if (framebuffer_state) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001495 for (uint32_t i = 0; i < render_pass_info->attachmentCount; ++i) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06001496 auto *view_state = pCB->GetActiveAttachmentImageViewState(i);
John Zulauf8e308292018-09-21 11:34:37 -06001497 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001498 VkImageLayout stencil_layout = kInvalidLayout;
1499 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001500 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(render_pass_info->pAttachments[i].pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -07001501 if (attachment_description_stencil_layout) {
1502 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1503 }
Jeremy Gebben1ec89332021-08-05 13:51:49 -06001504 pCB->SetImageViewLayout(*view_state, render_pass_info->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001505 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001506 }
1507 }
1508}
Dave Houltone19e20d2018-02-02 16:32:41 -07001509
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001510#ifdef VK_USE_PLATFORM_ANDROID_KHR
1511// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1512// This could also move into a seperate core_validation_android.cpp file... ?
1513
1514//
1515// AHB-specific validation within non-AHB APIs
1516//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001517bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001518 bool skip = false;
1519
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001520 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(create_info->pNext);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001521 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001522 if (0 != ext_fmt_android->externalFormat) {
1523 if (VK_FORMAT_UNDEFINED != create_info->format) {
1524 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001525 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1526 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1527 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001528 }
1529
1530 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001531 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1532 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1533 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001534 }
1535
1536 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001537 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1538 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06001539 "non-zero externalFormat, but usage includes bits (0x%" PRIx32 ") other than VK_IMAGE_USAGE_SAMPLED_BIT.",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001540 create_info->usage);
Dave Houltond9611312018-11-19 17:03:36 -07001541 }
1542
1543 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001544 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1545 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1546 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001547 }
1548 }
1549
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001550 if ((0 != ext_fmt_android->externalFormat) &&
1551 (ahb_ext_formats_map.find(ext_fmt_android->externalFormat) == ahb_ext_formats_map.end())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001552 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001553 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat (%" PRIu64
1554 ") which has "
1555 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().",
1556 ext_fmt_android->externalFormat);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001557 }
1558 }
1559
Dave Houltond9611312018-11-19 17:03:36 -07001560 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001561 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001562 skip |=
1563 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1564 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1565 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001566 }
1567 }
1568
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001569 const VkExternalMemoryImageCreateInfo *emici = LvlFindInChain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001570 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1571 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001572 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001573 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1574 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1575 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1576 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001577 }
1578
1579 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001580 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1581 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1582 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1583 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1584 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001585 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001586 }
1587
1588 return skip;
1589}
1590
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001591bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001592 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001593 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001594
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06001595 if (image_state->HasAHBFormat()) {
Dave Houltond9611312018-11-19 17:03:36 -07001596 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001597 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1598 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001599 "format member is %s and must be VK_FORMAT_UNDEFINED.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001600 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001601 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001602
Dave Houltond9611312018-11-19 17:03:36 -07001603 // Chain must include a compatible ycbcr conversion
1604 bool conv_found = false;
1605 uint64_t external_format = 0;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001606 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = LvlFindInChain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001607 if (ycbcr_conv_info != nullptr) {
Jeremy Gebbenf4fb2a02021-07-08 09:57:46 -06001608 auto ycbcr_state = GetSamplerYcbcrConversionState(ycbcr_conv_info->conversion);
1609 if (ycbcr_state) {
Dave Houltond9611312018-11-19 17:03:36 -07001610 conv_found = true;
Jeremy Gebbenf4fb2a02021-07-08 09:57:46 -06001611 external_format = ycbcr_state->external_format;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001612 }
Dave Houltond9611312018-11-19 17:03:36 -07001613 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001614 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001615 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001616 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1617 "an externalFormat (%" PRIu64
1618 ") but needs a chained VkSamplerYcbcrConversionInfo struct with a VkSamplerYcbcrConversion created "
1619 "with the same external format.",
1620 image_state->ahb_format);
Dave Houltond9611312018-11-19 17:03:36 -07001621 }
1622
1623 // Errors in create_info swizzles
sfricke-samsungbd0e8052020-06-06 01:36:39 -07001624 if (IsIdentitySwizzle(create_info->components) == false) {
1625 skip |= LogError(
1626 create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1627 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1628 "includes one or more non-identity component swizzles, r swizzle = %s, g swizzle = %s, b swizzle = %s, a swizzle "
1629 "= %s.",
1630 string_VkComponentSwizzle(create_info->components.r), string_VkComponentSwizzle(create_info->components.g),
1631 string_VkComponentSwizzle(create_info->components.b), string_VkComponentSwizzle(create_info->components.a));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001632 }
1633 }
Dave Houltond9611312018-11-19 17:03:36 -07001634
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001635 return skip;
1636}
1637
John Zulaufa26d3c82019-08-14 16:09:08 -06001638bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001639 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001640
John Zulaufa26d3c82019-08-14 16:09:08 -06001641 const IMAGE_STATE *image_state = GetImageState(image);
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001642 if (image_state != nullptr) {
Jeremy Gebben6fbf8242021-06-21 09:14:46 -06001643 if (image_state->IsExternalAHB() && (0 == image_state->GetBoundMemory().size())) {
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001644 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1645 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1646 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1647 "bound to memory.");
1648 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001649 }
1650 return skip;
1651}
1652
1653#else
1654
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001655bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001656 return false;
1657}
1658
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001659bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001660
John Zulaufa26d3c82019-08-14 16:09:08 -06001661bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001662
1663#endif // VK_USE_PLATFORM_ANDROID_KHR
1664
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001665bool CoreChecks::ValidateImageFormatFeatures(const VkImageCreateInfo *pCreateInfo) const {
1666 bool skip = false;
1667
1668 // validates based on imageCreateFormatFeatures from vkspec.html#resources-image-creation-limits
1669 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
1670 const VkImageTiling image_tiling = pCreateInfo->tiling;
1671 const VkFormat image_format = pCreateInfo->format;
1672
1673 if (image_format == VK_FORMAT_UNDEFINED) {
1674 // VU 01975 states format can't be undefined unless an android externalFormat
1675#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001676 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001677 if ((image_tiling == VK_IMAGE_TILING_OPTIMAL) && (ext_fmt_android != nullptr) && (0 != ext_fmt_android->externalFormat)) {
1678 auto it = ahb_ext_formats_map.find(ext_fmt_android->externalFormat);
1679 if (it != ahb_ext_formats_map.end()) {
1680 tiling_features = it->second;
1681 }
1682 }
1683#endif
1684 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1685 uint64_t drm_format_modifier = 0;
1686 const VkImageDrmFormatModifierExplicitCreateInfoEXT *drm_explicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001687 LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001688 const VkImageDrmFormatModifierListCreateInfoEXT *drm_implicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001689 LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001690
1691 if (drm_explicit != nullptr) {
1692 drm_format_modifier = drm_explicit->drmFormatModifier;
1693 } else {
1694 // VUID 02261 makes sure its only explict or implict in parameter checking
1695 assert(drm_implicit != nullptr);
1696 for (uint32_t i = 0; i < drm_implicit->drmFormatModifierCount; i++) {
1697 drm_format_modifier |= drm_implicit->pDrmFormatModifiers[i];
1698 }
1699 }
1700
1701 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
1702 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
1703 nullptr};
1704 format_properties_2.pNext = (void *)&drm_properties_list;
1705 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Lionel Landwerlin09351a72020-06-22 18:15:59 +03001706 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
1707 drm_properties.resize(drm_properties_list.drmFormatModifierCount);
1708 drm_properties_list.pDrmFormatModifierProperties = &drm_properties[0];
1709 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001710
1711 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
1712 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_modifier) != 0) {
1713 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
1714 }
1715 }
1716 } else {
1717 VkFormatProperties format_properties = GetPDFormatProperties(image_format);
1718 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
1719 : format_properties.optimalTilingFeatures;
1720 }
1721
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001722 // Lack of disjoint format feature support while using the flag
1723 if (FormatIsMultiplane(image_format) && ((pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT) != 0) &&
1724 ((tiling_features & VK_FORMAT_FEATURE_DISJOINT_BIT) == 0)) {
1725 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateFormatFeatures-02260",
1726 "vkCreateImage(): can't use VK_IMAGE_CREATE_DISJOINT_BIT because %s doesn't support "
1727 "VK_FORMAT_FEATURE_DISJOINT_BIT based on imageCreateFormatFeatures.",
1728 string_VkFormat(pCreateInfo->format));
1729 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001730
1731 return skip;
1732}
1733
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001734bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001735 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001736 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001737
sfricke-samsung45996a42021-09-16 13:45:27 -07001738 if (IsExtEnabled(device_extensions.vk_android_external_memory_android_hardware_buffer)) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001739 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001740 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1741 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001742 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1743 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001744 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001745 }
1746
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001747 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1748 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001749 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1750 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1751 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001752 }
Dave Houlton130c0212018-01-29 13:39:56 -07001753 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001754
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001755 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001756 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1757 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1758 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001759 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001760 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width (%u) exceeds "
1761 "device maxFramebufferWidth (%u).",
1762 pCreateInfo->extent.width, device_limits->maxFramebufferWidth);
Dave Houlton130c0212018-01-29 13:39:56 -07001763 }
1764
1765 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001766 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001767 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height (%u) exceeds "
1768 "device maxFramebufferHeight (%u).",
1769 pCreateInfo->extent.height, device_limits->maxFramebufferHeight);
Dave Houlton130c0212018-01-29 13:39:56 -07001770 }
1771
ziga-lunarg44cba6e2021-07-13 17:58:06 +02001772 VkImageCreateFlags sparseFlags =
1773 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
1774 if ((pCreateInfo->flags & sparseFlags) && (pCreateInfo->usage & VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT)) {
1775 skip |= LogError(
1776 device, "VUID-VkImageCreateInfo-None-01925",
1777 "vkCreateImage(): images using sparse memory cannot have VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT set");
1778 }
1779
sfricke-samsung45996a42021-09-16 13:45:27 -07001780 if (IsExtEnabled(device_extensions.vk_ext_fragment_density_map) ||
1781 IsExtEnabled(device_extensions.vk_ext_fragment_density_map2)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001782 uint32_t ceiling_width = static_cast<uint32_t>(ceil(
1783 static_cast<float>(device_limits->maxFramebufferWidth) /
1784 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001785 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1786 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001787 LogError(device, "VUID-VkImageCreateInfo-usage-02559",
1788 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1789 "ceiling of device "
1790 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1791 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1792 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001793 }
1794
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001795 uint32_t ceiling_height = static_cast<uint32_t>(ceil(
1796 static_cast<float>(device_limits->maxFramebufferHeight) /
1797 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001798 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1799 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001800 LogError(device, "VUID-VkImageCreateInfo-usage-02560",
1801 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1802 "ceiling of device "
1803 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1804 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1805 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001806 }
1807 }
1808
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001809 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001810 VkResult result = VK_SUCCESS;
1811 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1812 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1813 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1814 &format_limits);
1815 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001816 auto modifier_list = LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1817 auto explicit_modifier = LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001818 if (modifier_list) {
1819 for (uint32_t i = 0; i < modifier_list->drmFormatModifierCount; i++) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001820 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001821 drm_format_modifier.drmFormatModifier = modifier_list->pDrmFormatModifiers[i];
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001822 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001823 image_format_info.type = pCreateInfo->imageType;
1824 image_format_info.format = pCreateInfo->format;
1825 image_format_info.tiling = pCreateInfo->tiling;
1826 image_format_info.usage = pCreateInfo->usage;
1827 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001828 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001829
1830 result =
1831 DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1832 format_limits = image_format_properties.imageFormatProperties;
1833
1834 /* The application gives a list of modifier and the driver
1835 * selects one. If one is wrong, stop there.
1836 */
1837 if (result != VK_SUCCESS) break;
1838 }
1839 } else if (explicit_modifier) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001840 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001841 drm_format_modifier.drmFormatModifier = explicit_modifier->drmFormatModifier;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001842 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001843 image_format_info.type = pCreateInfo->imageType;
1844 image_format_info.format = pCreateInfo->format;
1845 image_format_info.tiling = pCreateInfo->tiling;
1846 image_format_info.usage = pCreateInfo->usage;
1847 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001848 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001849
1850 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1851 format_limits = image_format_properties.imageFormatProperties;
1852 }
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001853 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001854
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001855 // 1. vkGetPhysicalDeviceImageFormatProperties[2] only success code is VK_SUCCESS
1856 // 2. If call returns an error, then "imageCreateImageFormatPropertiesList" is defined to be the empty list
1857 // 3. All values in 02251 are undefined if "imageCreateImageFormatPropertiesList" is empty.
1858 if (result != VK_SUCCESS) {
1859 // External memory will always have a "imageCreateImageFormatPropertiesList" so skip
Lockee87f87c2019-04-23 17:53:10 -06001860#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001861 if (!LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext)) {
Lockee87f87c2019-04-23 17:53:10 -06001862#endif // VK_USE_PLATFORM_ANDROID_KHR
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001863 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateMaxMipLevels-02251",
Spencer Frickec46fc6d2020-04-16 06:23:05 -07001864 "vkCreateImage(): Format %s is not supported for this combination of parameters and "
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001865 "VkGetPhysicalDeviceImageFormatProperties returned back %s.",
1866 string_VkFormat(pCreateInfo->format), string_VkResult(result));
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001867#ifdef VK_USE_PLATFORM_ANDROID_KHR
1868 }
1869#endif // VK_USE_PLATFORM_ANDROID_KHR
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001870 } else {
1871 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1872 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001873 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1874 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1875 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001876 }
Dave Houlton130c0212018-01-29 13:39:56 -07001877
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001878 uint64_t texel_count = static_cast<uint64_t>(pCreateInfo->extent.width) *
1879 static_cast<uint64_t>(pCreateInfo->extent.height) *
1880 static_cast<uint64_t>(pCreateInfo->extent.depth) * static_cast<uint64_t>(pCreateInfo->arrayLayers) *
1881 static_cast<uint64_t>(pCreateInfo->samples);
Dave Houlton130c0212018-01-29 13:39:56 -07001882
sfricke-samsung2e827212021-09-28 07:52:08 -07001883 // Depth/Stencil formats size can't be accurately calculated
1884 if (!FormatIsDepthAndStencil(pCreateInfo->format)) {
1885 uint64_t total_size =
1886 static_cast<uint64_t>(std::ceil(FormatTexelSize(pCreateInfo->format) * static_cast<double>(texel_count)));
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001887
sfricke-samsung2e827212021-09-28 07:52:08 -07001888 // Round up to imageGranularity boundary
1889 VkDeviceSize image_granularity = phys_dev_props.limits.bufferImageGranularity;
1890 uint64_t ig_mask = image_granularity - 1;
1891 total_size = (total_size + ig_mask) & ~ig_mask;
1892
1893 if (total_size > format_limits.maxResourceSize) {
1894 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
1895 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1896 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1897 total_size, format_limits.maxResourceSize);
1898 }
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001899 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001900
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001901 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001902 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
1903 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1904 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001905 }
1906
1907 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001908 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
1909 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
1910 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001911 }
sfricke-samsung612f3622020-06-20 20:42:46 -07001912
1913 if (pCreateInfo->extent.width > format_limits.maxExtent.width) {
1914 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02252",
1915 "vkCreateImage(): extent.width %u exceeds allowable maximum image extent width %u.",
1916 pCreateInfo->extent.width, format_limits.maxExtent.width);
1917 }
1918
1919 if (pCreateInfo->extent.height > format_limits.maxExtent.height) {
1920 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02253",
1921 "vkCreateImage(): extent.height %u exceeds allowable maximum image extent height %u.",
1922 pCreateInfo->extent.height, format_limits.maxExtent.height);
1923 }
1924
1925 if (pCreateInfo->extent.depth > format_limits.maxExtent.depth) {
1926 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02254",
1927 "vkCreateImage(): extent.depth %u exceeds allowable maximum image extent depth %u.",
1928 pCreateInfo->extent.depth, format_limits.maxExtent.depth);
1929 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001930 }
1931
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001932 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsung10b35ce2021-09-29 08:50:20 -07001933 if (FormatRequiresYcbcrConversionExplicitly(pCreateInfo->format)) {
sfricke-samsungcead0802020-01-30 22:20:10 -08001934 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
sfricke-samsung45996a42021-09-16 13:45:27 -07001935 const char *error_vuid = IsExtEnabled(device_extensions.vk_ext_ycbcr_image_arrays)
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07001936 ? "VUID-VkImageCreateInfo-format-06414"
1937 : "VUID-VkImageCreateInfo-format-06413";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001938 skip |= LogError(device, error_vuid,
1939 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
1940 "YCbCr Conversion format, arrayLayers must be 1",
1941 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001942 }
1943
1944 if (pCreateInfo->mipLevels != 1) {
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07001945 skip |= LogError(device, "VUID-VkImageCreateInfo-format-06410",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001946 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
1947 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001948 }
1949
1950 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001951 skip |= LogError(
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07001952 device, "VUID-VkImageCreateInfo-format-06411",
sfricke-samsungcead0802020-01-30 22:20:10 -08001953 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
1954 string_VkSampleCountFlagBits(pCreateInfo->samples));
1955 }
1956
1957 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001958 skip |= LogError(
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07001959 device, "VUID-VkImageCreateInfo-format-06412",
sfricke-samsungcead0802020-01-30 22:20:10 -08001960 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
1961 string_VkImageType(pCreateInfo->imageType));
1962 }
1963 }
1964
sfricke-samsung45996a42021-09-16 13:45:27 -07001965 if (IsExtEnabled(device_extensions.vk_khr_maintenance2)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001966 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
sfricke-samsung08796682021-09-13 07:47:20 -07001967 if (!FormatIsCompressed(pCreateInfo->format)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001968 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01572",
1969 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
sfricke-samsung08796682021-09-13 07:47:20 -07001970 "format must be a compressed image format, but is %s",
Spencer Fricke48db59b2020-03-23 10:31:46 -07001971 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001972 }
1973 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001974 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01573",
1975 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1976 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001977 }
1978 }
1979 }
1980
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001981 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
sfricke-samsung45996a42021-09-16 13:45:27 -07001982 const char *vuid = IsExtEnabled(device_extensions.vk_khr_get_physical_device_properties2)
1983 ? "VUID-VkImageCreateInfo-sharingMode-01420"
1984 : "VUID-VkImageCreateInfo-sharingMode-01392";
Mark Lobodzinski314b9162020-07-16 15:33:08 -06001985 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
ziga-lunarge2e283d2021-08-01 09:55:04 +02001986 "vkCreateImage", "pCreateInfo->pQueueFamilyIndices", vuid);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001987 }
1988
unknown2c877272019-07-11 12:56:50 -06001989 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
1990 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
1991 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001992 LogError(device, "VUID-VkImageCreateInfo-format-01577",
1993 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
1994 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06001995 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001996
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001997 const auto swapchain_create_info = LvlFindInChain<VkImageSwapchainCreateInfoKHR>(pCreateInfo->pNext);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07001998 if (swapchain_create_info != nullptr) {
1999 if (swapchain_create_info->swapchain != VK_NULL_HANDLE) {
2000 const SWAPCHAIN_NODE *swapchain_state = GetSwapchainState(swapchain_create_info->swapchain);
2001 const VkSwapchainCreateFlagsKHR swapchain_flags = swapchain_state->createInfo.flags;
2002
2003 // Validate rest of Swapchain Image create check that require swapchain state
2004 const char *vuid = "VUID-VkImageSwapchainCreateInfoKHR-swapchain-00995";
2005 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR) != 0) &&
2006 ((pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) == 0)) {
2007 skip |= LogError(
2008 device, vuid,
2009 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR flag so "
2010 "all swapchain images must have the VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT flag set.");
2011 }
2012 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR) != 0) &&
2013 ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) == 0)) {
2014 skip |= LogError(device, vuid,
2015 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR flag so all "
2016 "swapchain images must have the VK_IMAGE_CREATE_PROTECTED_BIT flag set.");
2017 }
Mike Schuchardt2df08912020-12-15 16:28:09 -08002018 const VkImageCreateFlags mutable_flags = (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT | VK_IMAGE_CREATE_EXTENDED_USAGE_BIT);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002019 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR) != 0) &&
2020 ((pCreateInfo->flags & mutable_flags) != mutable_flags)) {
2021 skip |= LogError(device, vuid,
2022 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR flag so "
2023 "all swapchain images must have the VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT and "
Mike Schuchardt2df08912020-12-15 16:28:09 -08002024 "VK_IMAGE_CREATE_EXTENDED_USAGE_BIT flags both set.");
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002025 }
2026 }
2027 }
2028
sfricke-samsungedce77a2020-07-03 22:35:13 -07002029 if ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) != 0) {
2030 if (enabled_features.core11.protectedMemory == VK_FALSE) {
2031 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01890",
2032 "vkCreateImage(): the protectedMemory device feature is disabled: Images cannot be created with the "
2033 "VK_IMAGE_CREATE_PROTECTED_BIT set.");
2034 }
2035 const VkImageCreateFlags invalid_flags =
2036 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
2037 if ((pCreateInfo->flags & invalid_flags) != 0) {
2038 skip |= LogError(device, "VUID-VkImageCreateInfo-None-01891",
2039 "vkCreateImage(): VK_IMAGE_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at same "
2040 "time (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | "
2041 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT).");
2042 }
2043 }
2044
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002045 skip |= ValidateImageFormatFeatures(pCreateInfo);
2046
Nathaniel Cesarioc02c2512020-11-13 12:04:24 -07002047 // Check compatibility with VK_KHR_portability_subset
sfricke-samsung45996a42021-09-16 13:45:27 -07002048 if (IsExtEnabled(device_extensions.vk_khr_portability_subset)) {
Nathaniel Cesarioc02c2512020-11-13 12:04:24 -07002049 if (VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT & pCreateInfo->flags &&
2050 VK_FALSE == enabled_features.portability_subset_features.imageView2DOn3DImage) {
2051 skip |= LogError(device, "VUID-VkImageCreateInfo-imageView2DOn3DImage-04459",
2052 "vkCreateImage (portability error): VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT is not supported.");
2053 }
2054 if ((VK_SAMPLE_COUNT_1_BIT != pCreateInfo->samples) && (1 != pCreateInfo->arrayLayers) &&
2055 (VK_FALSE == enabled_features.portability_subset_features.multisampleArrayImage)) {
2056 skip |=
2057 LogError(device, "VUID-VkImageCreateInfo-multisampleArrayImage-04460",
2058 "vkCreateImage (portability error): Cannot create an image with samples/texel > 1 && arrayLayers != 1");
2059 }
2060 }
2061
ziga-lunarg63f8d7a2021-07-20 22:10:31 +02002062 const auto external_memory_create_info_nv = LvlFindInChain<VkExternalMemoryImageCreateInfoNV>(pCreateInfo->pNext);
ziga-lunarg62aa24f2021-10-09 11:58:30 +02002063 const auto external_memory_create_info = LvlFindInChain<VkExternalMemoryImageCreateInfo>(pCreateInfo->pNext);
2064 if (external_memory_create_info_nv != nullptr && external_memory_create_info != nullptr) {
2065 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-00988",
2066 "vkCreateImage(): VkImageCreateInfo struct has both VkExternalMemoryImageCreateInfoNV and "
2067 "VkExternalMemoryImageCreateInfo chained structs.");
2068 }
2069 if (external_memory_create_info) {
2070 if (external_memory_create_info->handleTypes != 0 && pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_UNDEFINED) {
2071 skip |= LogError(
2072 device, "VUID-VkImageCreateInfo-pNext-01443",
2073 "vkCreateImage: VkImageCreateInfo pNext chain includes VkExternalMemoryImageCreateInfo with handleTypes %" PRIu32
2074 " but pCreateInfo->initialLayout is %s.",
2075 external_memory_create_info->handleTypes, string_VkImageLayout(pCreateInfo->initialLayout));
2076 }
2077 } else if (external_memory_create_info_nv) {
2078 if (external_memory_create_info_nv->handleTypes != 0 && pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_UNDEFINED) {
2079 skip |= LogError(
2080 device, "VUID-VkImageCreateInfo-pNext-01443",
2081 "vkCreateImage: VkImageCreateInfo pNext chain includes VkExternalMemoryImageCreateInfoNV with handleTypes %" PRIu32
2082 " but pCreateInfo->initialLayout is %s.",
2083 external_memory_create_info_nv->handleTypes, string_VkImageLayout(pCreateInfo->initialLayout));
ziga-lunarg63f8d7a2021-07-20 22:10:31 +02002084 }
2085 }
2086
ziga-lunarg374fd9a2021-07-18 10:32:52 +02002087 if (device_group_create_info.physicalDeviceCount == 1) {
2088 if (pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) {
2089 skip |= LogError(device, "VUID-VkImageCreateInfo-physicalDeviceCount-01421",
2090 "vkCreateImage: Device was created with VkDeviceGroupDeviceCreateInfo::physicalDeviceCount 1, but "
2091 "flags contain VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT bit.");
2092 }
2093 }
2094
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002095 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002096}
2097
John Zulauf7eeb6f72019-06-17 11:56:36 -06002098void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
2099 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
2100 if (VK_SUCCESS != result) return;
2101
2102 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
locke-lunarg20699892020-01-02 19:17:29 -07002103 auto image_state = Get<IMAGE_STATE>(*pImage);
2104 AddInitialLayoutintoImageLayoutMap(*image_state, imageLayoutMap);
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07002105}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002106
Jeff Bolz5c801d12019-10-09 10:38:45 -05002107bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05002108 const IMAGE_STATE *image_state = GetImageState(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002109 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07002110 if (image_state) {
Jeremy Gebben82e11d52021-07-26 09:19:37 -06002111 if (image_state->IsSwapchainImage()) {
sfricke-samsung73452522021-06-17 08:44:46 -07002112 skip |= LogError(device, "VUID-vkDestroyImage-image-04882",
sfricke-samsung9056cc12021-04-18 22:51:00 -07002113 "vkDestroyImage(): %s is a presentable image and it is controlled by the implementation and is "
2114 "destroyed with vkDestroySwapchainKHR.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002115 report_data->FormatHandle(image_state->image()).c_str());
sfricke-samsung9056cc12021-04-18 22:51:00 -07002116 }
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06002117 skip |= ValidateObjectNotInUse(image_state, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002118 }
2119 return skip;
2120}
2121
John Zulauf7eeb6f72019-06-17 11:56:36 -06002122void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
2123 // Clean up validation specific data
Jeremy Gebbene60d4172021-02-02 15:42:15 -07002124 qfo_release_image_barrier_map.erase(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002125
locke-lunargcba7d5f2019-12-30 16:59:11 -07002126 imageLayoutMap.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06002127
2128 // Clean up generic image state
2129 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002130}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002131
sfricke-samsungcd924d92020-05-20 23:51:17 -07002132bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range,
2133 const char *param_name) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002134 bool skip = false;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002135 const VkImage image = image_state->image();
sfricke-samsungcd924d92020-05-20 23:51:17 -07002136 const VkFormat format = image_state->createInfo.format;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002137
2138 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002139 skip |= LogError(image, "VUID-vkCmdClearColorImage-aspectMask-02498",
2140 "vkCmdClearColorImage(): %s.aspectMasks must only be set to VK_IMAGE_ASPECT_COLOR_BIT.", param_name);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002141 }
2142
sfricke-samsungcd924d92020-05-20 23:51:17 -07002143 if (FormatIsDepthOrStencil(format)) {
2144 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2145 "vkCmdClearColorImage(): %s called with image %s which has a depth/stencil format (%s).", param_name,
2146 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
2147 } else if (FormatIsCompressed(format)) {
2148 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2149 "vkCmdClearColorImage(): %s called with image %s which has a compressed format (%s).", param_name,
2150 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002151 }
2152
2153 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002154 skip |=
2155 LogError(image, "VUID-vkCmdClearColorImage-image-00002",
2156 "vkCmdClearColorImage() %s called with image %s which was created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.",
2157 param_name, report_data->FormatHandle(image).c_str());
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002158 }
2159 return skip;
2160}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002161
John Zulauf07288512019-07-05 11:09:50 -06002162bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
2163 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
2164 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002165 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002166 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2167 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002168 skip |= LogError(image_state->image(), "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002169 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2170 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002171 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002172
2173 } else {
2174 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
sfricke-samsung45996a42021-09-16 13:45:27 -07002175 if (!IsExtEnabled(device_extensions.vk_khr_shared_presentable_image)) {
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002176 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002177 skip |= LogError(image_state->image(), "VUID-vkCmdClearColorImage-imageLayout-00005",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002178 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2179 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002180 }
2181 } else {
2182 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
2183 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002184 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002185 image_state->image(), "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002186 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
2187 func_name, string_VkImageLayout(dest_image_layout));
2188 }
2189 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002190 }
2191
John Zulauff660ad62019-03-23 07:16:05 -06002192 // Cast to const to prevent creation at validate time.
Jeremy Gebben159b3cc2021-06-03 09:09:03 -06002193 const auto *subresource_map = cb_node->GetImageSubresourceLayoutMap(image_state->image());
John Zulauff660ad62019-03-23 07:16:05 -06002194 if (subresource_map) {
2195 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06002196 LayoutUseCheckAndMessage layout_check(subresource_map);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002197 auto normalized_isr = image_state->NormalizeSubresourceRange(range);
Tony Barbour55688172020-09-23 15:19:50 -07002198 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
2199 // the next "constant value" range
2200 for (auto pos = subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07002201 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06002202 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
2203 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2204 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
2205 } else {
2206 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002207 }
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002208 subres_skip |= LogError(cb_node->commandBuffer(), error_code,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002209 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
2210 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
2211 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002212 }
John Zulauf5e617452019-11-19 14:44:16 -07002213 }
John Zulauff660ad62019-03-23 07:16:05 -06002214 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002215 }
2216
2217 return skip;
2218}
2219
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002220bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2221 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002222 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002223 bool skip = false;
2224 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06002225 const auto *cb_node = GetCBState(commandBuffer);
2226 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002227 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002228 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
sfricke-samsung85584a72021-09-30 21:43:38 -07002229 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE);
sfricke-samsung45996a42021-09-16 13:45:27 -07002230 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002231 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
2232 "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04002233 }
sfricke-samsung022fa252020-07-24 03:26:16 -07002234 skip |=
2235 ValidateProtectedImage(cb_node, image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-commandBuffer-01805");
2236 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearColorImage()",
2237 "VUID-vkCmdClearColorImage-commandBuffer-01806");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002238 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002239 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002240 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
sfricke-samsungcd924d92020-05-20 23:51:17 -07002241 skip |= ValidateImageAttributes(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002242 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002243 }
sfricke-samsunge775d492020-02-28 09:02:25 -08002244 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsung10b35ce2021-09-29 08:50:20 -07002245 if (FormatRequiresYcbcrConversionExplicitly(image_state->createInfo.format)) {
sfricke-samsunge775d492020-02-28 09:02:25 -08002246 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
2247 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
2248 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
2249 string_VkFormat(image_state->createInfo.format));
2250 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002251 }
2252 return skip;
2253}
2254
John Zulaufeabb4462019-07-05 14:13:03 -06002255void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2256 const VkClearColorValue *pColor, uint32_t rangeCount,
2257 const VkImageSubresourceRange *pRanges) {
2258 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
2259
2260 auto cb_node = GetCBState(commandBuffer);
2261 auto image_state = GetImageState(image);
2262 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002263 for (uint32_t i = 0; i < rangeCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06002264 cb_node->SetImageInitialLayout(image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002265 }
2266 }
2267}
2268
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002269bool CoreChecks::ValidateClearDepthStencilValue(VkCommandBuffer commandBuffer, VkClearDepthStencilValue clearValue,
2270 const char *apiName) const {
2271 bool skip = false;
2272
2273 // 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 -07002274 if (!IsExtEnabled(device_extensions.vk_ext_depth_range_unrestricted)) {
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002275 if (!(clearValue.depth >= 0.0) || !(clearValue.depth <= 1.0)) {
2276 // Also VUID-VkClearDepthStencilValue-depth-00022
2277 skip |= LogError(commandBuffer, "VUID-VkClearDepthStencilValue-depth-02506",
2278 "%s: VK_EXT_depth_range_unrestricted extension is not enabled and VkClearDepthStencilValue::depth "
2279 "(=%f) is not within the [0.0, 1.0] range.",
2280 apiName, clearValue.depth);
2281 }
2282 }
2283
2284 return skip;
2285}
2286
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002287bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2288 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002289 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002290 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002291
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002292 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06002293 const auto *cb_node = GetCBState(commandBuffer);
2294 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002295 if (cb_node && image_state) {
sfricke-samsung30e325a2020-07-25 12:56:13 -07002296 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002297 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002298 "VUID-vkCmdClearDepthStencilImage-image-00010");
sfricke-samsung85584a72021-09-30 21:43:38 -07002299 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE);
sfricke-samsung45996a42021-09-16 13:45:27 -07002300 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002301 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002302 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04002303 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002304 skip |= ValidateClearDepthStencilValue(commandBuffer, *pDepthStencil, "vkCmdClearDepthStencilImage()");
sfricke-samsung022fa252020-07-24 03:26:16 -07002305 skip |= ValidateProtectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2306 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01807");
2307 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2308 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01808");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002309
2310 bool any_include_aspect_depth_bit = false;
2311 bool any_include_aspect_stencil_bit = false;
2312
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002313 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002314 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002315 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002316 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002317 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06002318 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
2319 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002320 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-aspectMask-02824",
2321 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask can only be VK_IMAGE_ASPECT_DEPTH_BIT "
2322 "and/or VK_IMAGE_ASPECT_STENCIL_BIT.",
2323 i);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002324 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002325 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
2326 any_include_aspect_depth_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002327 if (FormatHasDepth(image_format) == false) {
2328 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02826",
2329 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_DEPTH_BIT but %s "
2330 "doesn't have a depth component.",
2331 i, string_VkFormat(image_format));
2332 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002333 }
2334 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
2335 any_include_aspect_stencil_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002336 if (FormatHasStencil(image_format) == false) {
2337 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02825",
2338 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_STENCIL_BIT but "
2339 "%s doesn't have a stencil component.",
2340 i, string_VkFormat(image_format));
2341 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002342 }
2343 }
2344 if (any_include_aspect_stencil_bit) {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07002345 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05002346 if (image_stencil_struct != nullptr) {
2347 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
2348 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002349 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
2350 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
2351 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
2352 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002353 }
2354 } else {
2355 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002356 skip |= LogError(
2357 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05002358 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
2359 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
2360 "in VkImageCreateInfo::usage used to create image");
2361 }
2362 }
2363 }
2364 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002365 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
2366 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
2367 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002368 }
sfricke-samsung30e325a2020-07-25 12:56:13 -07002369 if (image_state && !FormatIsDepthOrStencil(image_format)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002370 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014",
2371 "vkCmdClearDepthStencilImage(): called with image %s which doesn't have a depth/stencil format (%s).",
sfricke-samsung30e325a2020-07-25 12:56:13 -07002372 report_data->FormatHandle(image).c_str(), string_VkFormat(image_format));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002373 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002374 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002375 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009",
2376 "vkCmdClearDepthStencilImage(): called with image %s which was not created with the "
2377 "VK_IMAGE_USAGE_TRANSFER_DST_BIT set.",
2378 report_data->FormatHandle(image).c_str());
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002379 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002380 }
2381 return skip;
2382}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002383
John Zulaufeabb4462019-07-05 14:13:03 -06002384void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2385 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
2386 const VkImageSubresourceRange *pRanges) {
2387 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
2388 auto cb_node = GetCBState(commandBuffer);
2389 auto image_state = GetImageState(image);
2390 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002391 for (uint32_t i = 0; i < rangeCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06002392 cb_node->SetImageInitialLayout(image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002393 }
2394 }
2395}
2396
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002397// Returns true if [x, xoffset] and [y, yoffset] overlap
2398static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
2399 bool result = false;
2400 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
2401 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
2402
2403 if (intersection_max > intersection_min) {
2404 result = true;
2405 }
2406 return result;
2407}
2408
Jeff Leger178b1e52020-10-05 12:22:23 -04002409// Returns true if source area of first vkImageCopy/vkImageCopy2KHR region intersects dest area of second region
Dave Houltonc991cc92018-03-06 11:08:51 -07002410// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
Jeff Leger178b1e52020-10-05 12:22:23 -04002411template <typename RegionType>
2412static bool RegionIntersects(const RegionType *rgn0, const RegionType *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002413 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07002414
Dave Houltonc991cc92018-03-06 11:08:51 -07002415 // Separate planes within a multiplane image cannot intersect
2416 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07002417 return result;
2418 }
2419
Dave Houltonc991cc92018-03-06 11:08:51 -07002420 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
2421 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
2422 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002423 result = true;
2424 switch (type) {
2425 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002426 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002427 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002428 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002429 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002430 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002431 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002432 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002433 break;
2434 default:
2435 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2436 assert(false);
2437 }
2438 }
2439 return result;
2440}
2441
Dave Houltonfc1a4052017-04-27 14:32:45 -06002442// Returns non-zero if offset and extent exceed image extents
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002443static const uint32_t kXBit = 1;
2444static const uint32_t kYBit = 2;
2445static const uint32_t kZBit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002446static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002447 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002448 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002449 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2450 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002451 result |= kZBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002452 }
2453 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2454 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002455 result |= kYBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002456 }
2457 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2458 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002459 result |= kXBit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002460 }
2461 return result;
2462}
2463
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002464// Test if two VkExtent3D structs are equivalent
2465static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2466 bool result = true;
2467 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2468 (extent->depth != other_extent->depth)) {
2469 result = false;
2470 }
2471 return result;
2472}
2473
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002474// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002475static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002476 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2477}
2478
2479// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002480VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002481 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2482 VkExtent3D granularity = {0, 0, 0};
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002483 auto pool = cb_node->command_pool.get();
2484 if (pool) {
2485 granularity = GetPhysicalDeviceState()->queue_family_properties[pool->queueFamilyIndex].minImageTransferGranularity;
sfricke-samsung01da6312021-10-20 07:51:32 -07002486 if (FormatIsBlockedImage(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002487 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002488 granularity.width *= block_size.width;
2489 granularity.height *= block_size.height;
2490 }
2491 }
2492 return granularity;
2493}
2494
2495// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2496static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2497 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002498 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2499 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002500 valid = false;
2501 }
2502 return valid;
2503}
2504
2505// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002506bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002507 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002508 bool skip = false;
2509 VkExtent3D offset_extent = {};
2510 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2511 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2512 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002513 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002514 // 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 -07002515 if (IsExtentAllZeroes(&offset_extent) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002516 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002517 "%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 "
2518 "image transfer granularity is (w=0, h=0, d=0).",
2519 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002520 }
2521 } else {
2522 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2523 // integer multiples of the image transfer granularity.
2524 if (IsExtentAligned(&offset_extent, granularity) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002525 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002526 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2527 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2528 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2529 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002530 }
2531 }
2532 return skip;
2533}
2534
2535// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002536bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002537 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002538 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002539 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002540 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002541 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2542 // subresource extent.
2543 if (IsExtentEqual(extent, subresource_extent) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002544 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002545 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2546 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2547 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2548 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002549 }
2550 } else {
2551 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2552 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2553 // subresource extent dimensions.
2554 VkExtent3D offset_extent_sum = {};
2555 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2556 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2557 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002558 bool x_ok = true;
2559 bool y_ok = true;
2560 bool z_ok = true;
2561 switch (image_type) {
2562 case VK_IMAGE_TYPE_3D:
2563 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2564 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002565 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002566 case VK_IMAGE_TYPE_2D:
2567 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2568 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002569 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002570 case VK_IMAGE_TYPE_1D:
2571 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2572 (subresource_extent->width == offset_extent_sum.width));
2573 break;
2574 default:
2575 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2576 assert(false);
2577 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002578 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002579 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002580 LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002581 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2582 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2583 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2584 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2585 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2586 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002587 }
2588 }
2589 return skip;
2590}
2591
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002592bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002593 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002594 bool skip = false;
2595 if (mip_level >= img->createInfo.mipLevels) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002596 skip |= LogError(cb_node->commandBuffer(), vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2597 function, i, member, mip_level, report_data->FormatHandle(img->image()).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002598 }
2599 return skip;
2600}
2601
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002602bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002603 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002604 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002605 bool skip = false;
2606 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2607 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002608 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002609 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2610 "%u, but provided %s has %u array layers.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002611 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image()).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002612 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002613 }
2614 return skip;
2615}
2616
Jeff Leger178b1e52020-10-05 12:22:23 -04002617// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy/VkBufferImageCopy2KHR structure
2618template <typename BufferImageCopyRegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002619bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002620 const BufferImageCopyRegionType *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002621 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002622 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002623 VkExtent3D granularity = GetScaledItg(cb_node, img);
2624 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002625 VkExtent3D subresource_extent = img->GetSubresourceExtent(region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002626 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002627 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002628 return skip;
2629}
2630
Jeff Leger178b1e52020-10-05 12:22:23 -04002631// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy/VkImageCopy2KHR structure
2632template <typename RegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002633bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002634 const IMAGE_STATE *dst_img, const RegionType *region,
2635 const uint32_t i, const char *function,
2636 CopyCommandVersion version) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002637 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002638 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2639 const char *vuid;
2640
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002641 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002642 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002643 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
2644 skip |= CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", vuid);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002645 VkExtent3D subresource_extent = src_img->GetSubresourceExtent(region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002646 const VkExtent3D extent = region->extent;
Jeff Leger178b1e52020-10-05 12:22:23 -04002647 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002648 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04002649 i, function, "extent", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002650
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002651 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002652 granularity = GetScaledItg(cb_node, dst_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002653 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
2654 skip |= CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", vuid);
Dave Houltonee281a52017-12-08 13:51:02 -07002655 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002656 const VkExtent3D dest_effective_extent =
2657 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002658 subresource_extent = dst_img->GetSubresourceExtent(region->dstSubresource);
Jeff Leger178b1e52020-10-05 12:22:23 -04002659 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002660 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Jeff Leger178b1e52020-10-05 12:22:23 -04002661 dst_img->createInfo.imageType, i, function, "extent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002662 return skip;
2663}
2664
Jeff Leger178b1e52020-10-05 12:22:23 -04002665// Validate contents of a VkImageCopy or VkImageCopy2KHR struct
2666template <typename ImageCopyRegionType>
2667bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const ImageCopyRegionType *ic_regions,
2668 const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state,
2669 CopyCommandVersion version) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002670 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002671 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2672 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2673 const char *vuid;
Dave Houlton6f9059e2017-05-02 17:15:13 -06002674
2675 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002676 const ImageCopyRegionType region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002677
2678 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002679 const VkExtent3D src_copy_extent = region.extent;
2680 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002681 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2682
Dave Houlton6f9059e2017-05-02 17:15:13 -06002683 bool slice_override = false;
2684 uint32_t depth_slices = 0;
2685
2686 // Special case for copying between a 1D/2D array and a 3D image
2687 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2688 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002689 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002690 slice_override = (depth_slices != 1);
2691 } 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 -07002692 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002693 slice_override = (depth_slices != 1);
2694 }
2695
2696 // Do all checks on source image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002697 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002698 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002699 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00146" : "VUID-vkCmdCopyImage-srcImage-00146";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002700 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002701 "%s: pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2702 "be 0 and 1, respectively.",
2703 func_name, i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002704 }
2705 }
2706
Dave Houlton533be9f2018-03-26 17:08:30 -06002707 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 -04002708 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01785" : "VUID-vkCmdCopyImage-srcImage-01785";
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] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002711 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002712 func_name, i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002713 }
2714
Dave Houlton533be9f2018-03-26 17:08:30 -06002715 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002716 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01787" : "VUID-vkCmdCopyImage-srcImage-01787";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002717 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 -04002718 func_name, i, region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002719 }
2720
sfricke-samsung01da6312021-10-20 07:51:32 -07002721 // Source checks that apply only to "blocked images"
2722 if (FormatIsBlockedImage(src_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002723 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002724 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002725 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2726 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2727 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002728 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01727" : "VUID-vkCmdCopyImage-srcImage-01727";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002729 skip |= LogError(src_state->image(), vuid,
sfricke-samsung01da6312021-10-20 07:51:32 -07002730 "%s: pRegion[%d] srcOffset (%d, %d) must be multiples of the blocked image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002731 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002732 func_name, i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002733 }
2734
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002735 const VkExtent3D mip_extent = src_state->GetSubresourceExtent(region.srcSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07002736 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2737 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002738 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01728" : "VUID-vkCmdCopyImage-srcImage-01728";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002739 skip |= LogError(src_state->image(), vuid,
sfricke-samsung01da6312021-10-20 07:51:32 -07002740 "%s: pRegion[%d] extent width (%d) must be a multiple of the blocked texture block "
Jeff Leger178b1e52020-10-05 12:22:23 -04002741 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2742 func_name, i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002743 }
2744
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002745 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002746 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2747 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002748 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01729" : "VUID-vkCmdCopyImage-srcImage-01729";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002749 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002750 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2751 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2752 func_name, i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002753 }
2754
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002755 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002756 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2757 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002758 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01730" : "VUID-vkCmdCopyImage-srcImage-01730";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002759 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002760 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2761 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2762 func_name, i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002763 }
2764 } // Compressed
2765
2766 // Do all checks on dest image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002767 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002768 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002769 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00152" : "VUID-vkCmdCopyImage-dstImage-00152";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002770 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002771 "%s: pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002772 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002773 func_name, i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002774 }
2775 }
2776
Dave Houlton533be9f2018-03-26 17:08:30 -06002777 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 -04002778 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01786" : "VUID-vkCmdCopyImage-dstImage-01786";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002779 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002780 "%s: pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2781 "and 1, respectively.",
2782 func_name, i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002783 }
2784
Dave Houlton533be9f2018-03-26 17:08:30 -06002785 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002786 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01788" : "VUID-vkCmdCopyImage-dstImage-01788";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002787 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 -04002788 func_name, i, region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002789 }
2790
sfricke-samsung30b094c2020-05-30 11:42:11 -07002791 // Handle difference between Maintenance 1
sfricke-samsung45996a42021-09-16 13:45:27 -07002792 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002793 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2794 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002795 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-04443" : "VUID-vkCmdCopyImage-srcImage-04443";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002796 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002797 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2798 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2799 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002800 }
2801 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002802 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002803 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002804 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-04444" : "VUID-vkCmdCopyImage-dstImage-04444";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002805 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002806 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2807 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2808 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002809 }
2810 }
2811 } else { // Pre maint 1
2812 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002813 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002814 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002815 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002816 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and "
sfricke-samsung30b094c2020-05-30 11:42:11 -07002817 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2818 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002819 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002820 }
Dave Houltonee281a52017-12-08 13:51:02 -07002821 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002822 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002823 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002824 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002825 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2826 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002827 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002828 }
2829 }
2830 }
2831
sfricke-samsung01da6312021-10-20 07:51:32 -07002832 // Dest checks that apply only to "blocked images"
2833 if (FormatIsBlockedImage(dst_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002834 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002835
2836 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002837 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2838 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2839 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002840 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01731" : "VUID-vkCmdCopyImage-dstImage-01731";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002841 skip |= LogError(dst_state->image(), vuid,
sfricke-samsung01da6312021-10-20 07:51:32 -07002842 "%s: pRegion[%d] dstOffset (%d, %d) must be multiples of the blocked image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002843 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002844 func_name, i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002845 }
2846
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002847 const VkExtent3D mip_extent = dst_state->GetSubresourceExtent(region.dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07002848 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2849 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002850 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01732" : "VUID-vkCmdCopyImage-dstImage-01732";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002851 skip |= LogError(dst_state->image(), vuid,
sfricke-samsung01da6312021-10-20 07:51:32 -07002852 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the blocked texture "
Jeff Leger178b1e52020-10-05 12:22:23 -04002853 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2854 func_name, i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002855 }
2856
Dave Houltonee281a52017-12-08 13:51:02 -07002857 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2858 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2859 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002860 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01733" : "VUID-vkCmdCopyImage-dstImage-01733";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002861 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002862 "%s: pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002863 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2864 "height (%d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002865 func_name, i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002866 }
2867
Dave Houltonee281a52017-12-08 13:51:02 -07002868 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2869 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2870 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002871 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01734" : "VUID-vkCmdCopyImage-dstImage-01734";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002872 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002873 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2874 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2875 func_name, i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002876 }
2877 } // Compressed
2878 }
2879 return skip;
2880}
2881
Jeff Leger178b1e52020-10-05 12:22:23 -04002882template <typename RegionType>
2883bool CoreChecks::ValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2884 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2885 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002886 const auto *cb_node = GetCBState(commandBuffer);
2887 const auto *src_image_state = GetImageState(srcImage);
2888 const auto *dst_image_state = GetImageState(dstImage);
sfricke-samsungdce5f692020-03-07 13:59:31 -08002889 const VkFormat src_format = src_image_state->createInfo.format;
2890 const VkFormat dst_format = dst_image_state->createInfo.format;
Jeff Leger178b1e52020-10-05 12:22:23 -04002891 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002892 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002893
Jeff Leger178b1e52020-10-05 12:22:23 -04002894 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGE2KHR : CMD_COPYIMAGE;
sfricke-samsung85584a72021-09-30 21:43:38 -07002895 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04002896 const char *vuid;
2897
2898 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state, version);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002899
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002900 VkCommandBuffer command_buffer = cb_node->commandBuffer();
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002901
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002902 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002903 const RegionType region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002904
2905 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2906 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08002907 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07002908
Dave Houlton6f9059e2017-05-02 17:15:13 -06002909 bool slice_override = false;
2910 uint32_t depth_slices = 0;
2911
2912 // Special case for copying between a 1D/2D array and a 3D image
2913 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2914 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2915 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002916 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002917 slice_override = (depth_slices != 1);
2918 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2919 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002920 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002921 slice_override = (depth_slices != 1);
2922 }
2923
Jeff Leger178b1e52020-10-05 12:22:23 -04002924 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, func_name, "srcSubresource", i);
2925 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, func_name, "dstSubresource", i);
2926 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01696" : "VUID-vkCmdCopyImage-srcSubresource-01696";
2927 skip |=
2928 ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
2929 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01697" : "VUID-vkCmdCopyImage-dstSubresource-01697";
2930 skip |=
2931 ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
2932 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01698" : "VUID-vkCmdCopyImage-srcSubresource-01698";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002933 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002934 region.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
2935 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01699" : "VUID-vkCmdCopyImage-dstSubresource-01699";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002936 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002937 region.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002938
sfricke-samsung45996a42021-09-16 13:45:27 -07002939 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002940 // No chance of mismatch if we're overriding depth slice count
2941 if (!slice_override) {
2942 // The number of depth slices in srcSubresource and dstSubresource must match
2943 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2944 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002945 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2946 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002947 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002948 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2949 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002950 if (src_slices != dst_slices) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002951 vuid = is_2khr ? "VUID-VkImageCopy2KHR-extent-00140" : "VUID-VkImageCopy-extent-00140";
2952 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002953 "%s: number of depth slices in source (%u) and destination (%u) subresources for pRegions[%u] "
2954 "do not match.",
2955 func_name, src_slices, dst_slices, i);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002956 }
2957 }
2958 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002959 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002960 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002961 vuid = is_2khr ? "VUID-VkImageCopy2KHR-layerCount-00138" : "VUID-VkImageCopy-layerCount-00138";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002962 skip |=
2963 LogError(command_buffer, vuid,
2964 "%s: number of layers in source (%u) and destination (%u) subresources for pRegions[%u] do not match",
2965 func_name, region.srcSubresource.layerCount, region.dstSubresource.layerCount, i);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002966 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002967 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002968
Dave Houltonc991cc92018-03-06 11:08:51 -07002969 // Do multiplane-specific checks, if extension enabled
sfricke-samsung45996a42021-09-16 13:45:27 -07002970 if (IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)) {
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002971 if ((!FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format))) {
2972 // If neither image is multi-plane the aspectMask member of src and dst must match
2973 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2974 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01551" : "VUID-vkCmdCopyImage-srcImage-01551";
2975 skip |= LogError(command_buffer, vuid,
2976 "%s: Copy between non-multiplane images with differing aspectMasks in pRegions[%u] with "
2977 "source (0x%x) destination (0x%x).",
2978 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
2979 }
2980 } else {
2981 // Source image multiplane checks
2982 uint32_t planes = FormatPlaneCount(src_format);
2983 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2984 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
2985 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01552" : "VUID-vkCmdCopyImage-srcImage-01552";
2986 skip |= LogError(command_buffer, vuid,
2987 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
2988 i, aspect);
2989 }
2990 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
2991 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
2992 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01553" : "VUID-vkCmdCopyImage-srcImage-01553";
2993 skip |= LogError(command_buffer, vuid,
2994 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
2995 i, aspect);
2996 }
2997 // Single-plane to multi-plane
2998 if ((!FormatIsMultiplane(src_format)) && (FormatIsMultiplane(dst_format)) &&
2999 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
3000 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01557" : "VUID-vkCmdCopyImage-dstImage-01557";
3001 skip |= LogError(command_buffer, vuid,
3002 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
3003 func_name, i, aspect);
3004 }
Dave Houltonc991cc92018-03-06 11:08:51 -07003005
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003006 // Dest image multiplane checks
3007 planes = FormatPlaneCount(dst_format);
3008 aspect = region.dstSubresource.aspectMask;
3009 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
3010 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01554" : "VUID-vkCmdCopyImage-dstImage-01554";
3011 skip |= LogError(command_buffer, vuid,
3012 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
3013 i, aspect);
3014 }
3015 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
3016 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
3017 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01555" : "VUID-vkCmdCopyImage-dstImage-01555";
3018 skip |= LogError(command_buffer, vuid,
3019 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
3020 i, aspect);
3021 }
3022 // Multi-plane to single-plane
3023 if ((FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format)) &&
3024 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
3025 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01556" : "VUID-vkCmdCopyImage-srcImage-01556";
3026 skip |= LogError(command_buffer, vuid,
3027 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
3028 func_name, i, aspect);
3029 }
3030 }
3031 } else {
3032 // !vk_khr_sampler_ycbcr_conversion
Dave Houltonf5217612018-02-02 16:18:52 -07003033 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
3034 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003035 vuid = is_2khr ? "VUID-VkImageCopy2KHR-aspectMask-00137" : "VUID-VkImageCopy-aspectMask-00137";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003036 skip |= LogError(
3037 command_buffer, vuid,
3038 "%s: Copy between images with differing aspectMasks in pRegions[%u] with source (0x%x) destination (0x%x).",
3039 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
Dave Houltonf5217612018-02-02 16:18:52 -07003040 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003041 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003042
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003043 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08003044 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003045 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00142" : "VUID-vkCmdCopyImage-aspectMask-00142";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003046 skip |=
3047 LogError(command_buffer, vuid,
3048 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) cannot specify aspects not present in source image.",
3049 func_name, i, region.srcSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003050 }
3051
3052 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08003053 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003054 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00143" : "VUID-vkCmdCopyImage-aspectMask-00143";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003055 skip |= LogError(
3056 command_buffer, vuid,
3057 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) cannot specify aspects not present in destination image.",
3058 func_name, i, region.dstSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003059 }
3060
Dave Houltonfc1a4052017-04-27 14:32:45 -06003061 // Each dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003062 VkExtent3D subresource_extent = src_image_state->GetSubresourceExtent(region.srcSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07003063 if (slice_override) src_copy_extent.depth = depth_slices;
3064 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003065 if (extent_check & kXBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003066 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00144" : "VUID-vkCmdCopyImage-srcOffset-00144";
3067 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003068 "%s: Source image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003069 "width [%1d].",
3070 func_name, i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003071 }
3072
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003073 if (extent_check & kYBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003074 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00145" : "VUID-vkCmdCopyImage-srcOffset-00145";
3075 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003076 "%s: Source image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003077 "height [%1d].",
3078 func_name, i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003079 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003080 if (extent_check & kZBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003081 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00147" : "VUID-vkCmdCopyImage-srcOffset-00147";
3082 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003083 "%s: Source image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003084 "depth [%1d].",
3085 func_name, i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003086 }
3087
Dave Houltonee281a52017-12-08 13:51:02 -07003088 // Adjust dest extent if necessary
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003089 subresource_extent = dst_image_state->GetSubresourceExtent(region.dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07003090 if (slice_override) dst_copy_extent.depth = depth_slices;
3091
3092 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003093 if (extent_check & kXBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003094 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00150" : "VUID-vkCmdCopyImage-dstOffset-00150";
3095 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003096 "%s: Dest image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003097 "width [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003098 func_name, i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003099 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003100 if (extent_check & kYBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003101 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00151" : "VUID-vkCmdCopyImage-dstOffset-00151";
3102 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003103 "%s): Dest image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003104 "height [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003105 func_name, i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003106 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003107 if (extent_check & kZBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003108 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00153" : "VUID-vkCmdCopyImage-dstOffset-00153";
3109 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003110 "%s: Dest image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003111 "depth [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003112 func_name, i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003113 }
3114
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003115 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
3116 // must not overlap in memory
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003117 if (src_image_state->image() == dst_image_state->image()) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003118 for (uint32_t j = 0; j < regionCount; j++) {
3119 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
sfricke-samsungdce5f692020-03-07 13:59:31 -08003120 FormatIsMultiplane(src_format))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003121 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-pRegions-00124" : "VUID-vkCmdCopyImage-pRegions-00124";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003122 skip |= LogError(command_buffer, vuid, "%s: pRegion[%u] src overlaps with pRegions[%u].", func_name, i, j);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003123 }
3124 }
3125 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08003126
3127 // 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 -07003128 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
sfricke-samsung48172ca2020-02-13 23:38:11 -08003129 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3130 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3131 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003132 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01790" : "VUID-vkCmdCopyImage-srcImage-01790";
3133 skip |= LogError(command_buffer, vuid,
3134 "%s: pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1",
3135 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003136 }
3137 } else {
3138 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
3139 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3140 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003141 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01789" : "VUID-vkCmdCopyImage-srcImage-01789";
3142 skip |= LogError(command_buffer, vuid,
3143 "%s: pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1",
3144 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003145 }
3146 }
3147
3148 // Check if 2D with 3D and depth not equal to 2D layerCount
3149 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3150 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
3151 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003152 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01791" : "VUID-vkCmdCopyImage-srcImage-01791";
3153 skip |= LogError(command_buffer, vuid,
3154 "%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 -08003155 "srcSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003156 func_name, i, src_copy_extent.depth, region.srcSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003157 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
3158 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
3159 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003160 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01792" : "VUID-vkCmdCopyImage-dstImage-01792";
3161 skip |= LogError(command_buffer, vuid,
3162 "%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 -08003163 "dstSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003164 func_name, i, src_copy_extent.depth, region.dstSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003165 }
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003166
3167 // Check for multi-plane format compatiblity
3168 if (FormatIsMultiplane(src_format) || FormatIsMultiplane(dst_format)) {
sfricke-samsung73e755c2021-09-30 08:34:57 -07003169 const VkFormat src_plane_format = FormatIsMultiplane(src_format)
3170 ? FindMultiplaneCompatibleFormat(src_format, region.srcSubresource.aspectMask)
3171 : src_format;
3172 const VkFormat dst_plane_format = FormatIsMultiplane(dst_format)
3173 ? FindMultiplaneCompatibleFormat(dst_format, region.dstSubresource.aspectMask)
3174 : dst_format;
3175 const size_t src_format_size = FormatElementSize(src_plane_format);
3176 const size_t dst_format_size = FormatElementSize(dst_plane_format);
3177
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003178 // If size is still zero, then format is invalid and will be caught in another VU
3179 if ((src_format_size != dst_format_size) && (src_format_size != 0) && (dst_format_size != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003180 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-None-01549" : "VUID-vkCmdCopyImage-None-01549";
3181 skip |= LogError(command_buffer, vuid,
3182 "%s: pRegions[%u] called with non-compatible image formats. "
3183 "The src format %s with aspectMask %s is not compatible with dst format %s aspectMask %s.",
3184 func_name, i, string_VkFormat(src_format),
3185 string_VkImageAspectFlags(region.srcSubresource.aspectMask).c_str(), string_VkFormat(dst_format),
3186 string_VkImageAspectFlags(region.dstSubresource.aspectMask).c_str());
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003187 }
3188 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003189 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003190
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003191 // The formats of non-multiplane src_image and dst_image must be compatible. Formats are considered compatible if their texel
3192 // size in bytes is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT
3193 // because because both texels are 4 bytes in size.
3194 if (!FormatIsMultiplane(src_format) && !FormatIsMultiplane(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003195 const char *compatible_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003196 IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
Jeff Leger178b1e52020-10-05 12:22:23 -04003197 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01548" : "VUID-vkCmdCopyImage-srcImage-01548")
3198 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00135" : "VUID-vkCmdCopyImage-srcImage-00135");
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003199 // Depth/stencil formats must match exactly.
3200 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3201 if (src_format != dst_format) {
3202 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003203 "%s: Depth/stencil formats must match exactly for src (%s) and dst (%s).", func_name,
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003204 string_VkFormat(src_format), string_VkFormat(dst_format));
3205 }
3206 } else {
Jeff Leger178b1e52020-10-05 12:22:23 -04003207 if (FormatElementSize(src_format) != FormatElementSize(dst_format)) {
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003208 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003209 "%s: Unmatched image format sizes. "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06003210 "The src format %s has size of %" PRIu32 " and dst format %s has size of %" PRIu32 ".",
Jeff Leger178b1e52020-10-05 12:22:23 -04003211 func_name, string_VkFormat(src_format), FormatElementSize(src_format), string_VkFormat(dst_format),
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003212 FormatElementSize(dst_format));
3213 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003214 }
3215 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003216
Dave Houlton33c22b72017-02-28 13:16:02 -07003217 // Source and dest image sample counts must match
3218 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003219 std::stringstream ss;
3220 ss << func_name << " called on image pair with non-identical sample counts.";
3221 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00136" : "VUID-vkCmdCopyImage-srcImage-00136";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003222 skip |=
3223 LogError(command_buffer, vuid, "%s: The src image sample count (%s) dose not match the dst image sample count (%s).",
3224 func_name, string_VkSampleCountFlagBits(src_image_state->createInfo.samples),
3225 string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Dave Houlton33c22b72017-02-28 13:16:02 -07003226 }
3227
sfricke-samsung45996a42021-09-16 13:45:27 -07003228 vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
Tony-LunarG5a066372021-01-21 10:31:34 -07003229 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01546" : "VUID-vkCmdCopyImage-srcImage-01546")
3230 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00127" : "VUID-vkCmdCopyImage-srcImage-00127");
Jeff Leger178b1e52020-10-05 12:22:23 -04003231 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
sfricke-samsung45996a42021-09-16 13:45:27 -07003232 vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
Tony-LunarG5a066372021-01-21 10:31:34 -07003233 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01547" : "VUID-vkCmdCopyImage-dstImage-01547")
3234 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00132" : "VUID-vkCmdCopyImage-dstImage-00132");
3235 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003236 // Validate that SRC & DST images have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04003237 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00126" : "VUID-vkCmdCopyImage-srcImage-00126";
3238 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3239 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3240 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00131" : "VUID-vkCmdCopyImage-dstImage-00131";
3241 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3242 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3243 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01825" : "VUID-vkCmdCopyImage-commandBuffer-01825";
3244 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3245 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01826" : "VUID-vkCmdCopyImage-commandBuffer-01826";
3246 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3247 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01827" : "VUID-vkCmdCopyImage-commandBuffer-01827";
3248 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003249
3250 // Validation for VK_EXT_fragment_density_map
3251 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003252 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3253 skip |=
3254 LogError(command_buffer, vuid,
3255 "%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 +02003256 }
3257 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003258 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3259 skip |=
3260 LogError(command_buffer, vuid,
3261 "%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 +02003262 }
3263
sfricke-samsung45996a42021-09-16 13:45:27 -07003264 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003265 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01995" : "VUID-vkCmdCopyImage-srcImage-01995";
3266 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
3267 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01996" : "VUID-vkCmdCopyImage-dstImage-01996";
3268 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003269 }
sfricke-samsung85584a72021-09-30 21:43:38 -07003270 skip |= ValidateCmd(cb_node, cmd_type);
Tobin Ehlisc8266452017-04-07 12:20:30 -06003271 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04003272
3273 const char *invalid_src_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003274 (src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003275 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-01917" : "VUID-vkCmdCopyImage-srcImageLayout-01917")
3276 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00129" : "VUID-vkCmdCopyImage-srcImageLayout-00129");
3277 const char *invalid_dst_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003278 (dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003279 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-01395" : "VUID-vkCmdCopyImage-dstImageLayout-01395")
3280 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00134" : "VUID-vkCmdCopyImage-dstImageLayout-00134");
3281
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003282 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003283 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00128" : "VUID-vkCmdCopyImage-srcImageLayout-00128";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003284 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003285 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3286 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00133" : "VUID-vkCmdCopyImage-dstImageLayout-00133";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003287 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003288 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003289 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003290 func_name, version);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003291 }
3292
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003293 return skip;
3294}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003295
Jeff Leger178b1e52020-10-05 12:22:23 -04003296bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3297 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3298 const VkImageCopy *pRegions) const {
3299 return ValidateCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3300 COPY_COMMAND_VERSION_1);
3301}
3302
3303bool CoreChecks::PreCallValidateCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) const {
3304 return ValidateCmdCopyImage(commandBuffer, pCopyImageInfo->srcImage, pCopyImageInfo->srcImageLayout, pCopyImageInfo->dstImage,
3305 pCopyImageInfo->dstImageLayout, pCopyImageInfo->regionCount, pCopyImageInfo->pRegions,
3306 COPY_COMMAND_VERSION_2);
3307}
3308
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003309void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3310 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3311 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003312 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3313 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003314 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003315 auto src_image_state = GetImageState(srcImage);
3316 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003317
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003318 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003319 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06003320 cb_node->SetImageInitialLayout(*src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3321 cb_node->SetImageInitialLayout(*dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003322 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003323}
3324
Jeff Leger178b1e52020-10-05 12:22:23 -04003325void CoreChecks::PreCallRecordCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) {
3326 StateTracker::PreCallRecordCmdCopyImage2KHR(commandBuffer, pCopyImageInfo);
3327 auto cb_node = GetCBState(commandBuffer);
3328 auto src_image_state = GetImageState(pCopyImageInfo->srcImage);
3329 auto dst_image_state = GetImageState(pCopyImageInfo->dstImage);
3330
3331 // Make sure that all image slices are updated to correct layout
3332 for (uint32_t i = 0; i < pCopyImageInfo->regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06003333 cb_node->SetImageInitialLayout(*src_image_state, pCopyImageInfo->pRegions[i].srcSubresource,
3334 pCopyImageInfo->srcImageLayout);
3335 cb_node->SetImageInitialLayout(*dst_image_state, pCopyImageInfo->pRegions[i].dstSubresource,
3336 pCopyImageInfo->dstImageLayout);
Jeff Leger178b1e52020-10-05 12:22:23 -04003337 }
3338}
3339
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003340// Returns true if sub_rect is entirely contained within rect
3341static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
3342 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 -07003343 (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 -07003344 return false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003345 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003346 return true;
3347}
3348
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003349bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003350 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
locke-lunargfc78e932020-11-19 17:06:24 -07003351 const VkRect2D &render_area, uint32_t rect_count, const VkClearRect *clear_rects,
3352 const CMD_BUFFER_STATE *primary_cb_state) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07003353 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07003354 const IMAGE_VIEW_STATE *image_view_state = nullptr;
3355 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06003356 if (primary_cb_state) {
3357 image_view_state = primary_cb_state->GetActiveAttachmentImageViewState(fb_attachment);
3358 } else {
3359 image_view_state = GetCBState(command_buffer)->GetActiveAttachmentImageViewState(fb_attachment);
3360 }
John Zulauff2582972019-02-09 14:53:30 -07003361 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003362
3363 for (uint32_t j = 0; j < rect_count; j++) {
3364 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003365 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00016",
3366 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
3367 "the current render pass instance.",
3368 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07003369 }
3370
3371 if (image_view_state) {
3372 // The layers specified by a given element of pRects must be contained within every attachment that
3373 // pAttachments refers to
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06003374 const auto attachment_layer_count = image_view_state->normalized_subresource_range.layerCount;
John Zulauf3a548ef2019-02-01 16:14:07 -07003375 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
3376 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003377 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00017",
3378 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
3379 "of pAttachment[%d].",
3380 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07003381 }
3382 }
3383 }
3384 return skip;
3385}
3386
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003387bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3388 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003389 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003390 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06003391 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02003392 if (!cb_node) return skip;
3393
sfricke-samsung85584a72021-09-30 21:43:38 -07003394 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003395
3396 // Validate that attachment is in reference list of active subpass
3397 if (cb_node->activeRenderPass) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08003398 const VkRenderPassCreateInfo2 *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07003399 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Mike Schuchardt2df08912020-12-15 16:28:09 -08003400 const VkSubpassDescription2 *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
locke-lunargaecf2152020-05-12 17:15:41 -06003401 const auto *framebuffer = cb_node->activeFramebuffer.get();
John Zulauf3a548ef2019-02-01 16:14:07 -07003402 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003403
John Zulauf3a548ef2019-02-01 16:14:07 -07003404 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3405 auto clear_desc = &pAttachments[attachment_index];
3406 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003407 const VkImageAspectFlags aspect_mask = clear_desc->aspectMask;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003408
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003409 if (aspect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
3410 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020",
3411 "vkCmdClearAttachments() pAttachments[%u] mask contains VK_IMAGE_ASPECT_METADATA_BIT",
3412 attachment_index);
3413 } else if (aspect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
3414 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
3415 skip |=
3416 LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-02246",
3417 "vkCmdClearAttachments() pAttachments[%u] mask contains a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit",
3418 attachment_index);
3419 } else if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07003420 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
3421 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
3422 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3423 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003424 skip |= LogError(
3425 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3426 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
3427 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
3428 attachment_index, clear_desc->colorAttachment,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003429 report_data->FormatHandle(cb_node->activeRenderPass->renderPass()).c_str(), cb_node->activeSubpass,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003430 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07003431
John Zulauff2582972019-02-09 14:53:30 -07003432 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
3433 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003434 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003435 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3436 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
3437 " subpass %u. colorAttachmentCount=%u",
3438 attachment_index, clear_desc->colorAttachment,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003439 report_data->FormatHandle(cb_node->activeRenderPass->renderPass()).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003440 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003441 }
John Zulauff2582972019-02-09 14:53:30 -07003442 fb_attachment = color_attachment;
3443
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003444 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
3445 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
3446 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019",
3447 "vkCmdClearAttachments() pAttachments[%u] aspectMask must set only VK_IMAGE_ASPECT_COLOR_BIT "
3448 "of a color attachment.",
3449 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003450 }
3451 } else { // Must be depth and/or stencil
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003452 bool subpass_depth = false;
3453 bool subpass_stencil = false;
3454 if (subpass_desc->pDepthStencilAttachment &&
3455 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3456 auto index = subpass_desc->pDepthStencilAttachment->attachment;
3457 subpass_depth = FormatHasDepth(renderpass_create_info->pAttachments[index].format);
3458 subpass_stencil = FormatHasStencil(renderpass_create_info->pAttachments[index].format);
3459 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003460 if (!subpass_desc->pDepthStencilAttachment ||
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003461 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3462 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) && !subpass_depth) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003463 skip |= LogError(
3464 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02502",
3465 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_DEPTH_BIT but there is no "
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003466 "depth attachment in subpass",
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003467 attachment_index);
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003468 }
3469 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) && !subpass_stencil) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003470 skip |= LogError(
3471 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02503",
3472 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_STENCIL_BIT but there is no "
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003473 "stencil attachment in subpass",
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003474 attachment_index);
3475 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003476 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07003477 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003478 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08003479 if (subpass_depth) {
3480 skip |= ValidateClearDepthStencilValue(commandBuffer, clear_desc->clearValue.depthStencil,
3481 "vkCmdClearAttachments()");
3482 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003483 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003484 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003485 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3486 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06003487 }
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003488
3489 // Once the framebuffer attachment is found, can get the image view state
3490 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) &&
3491 (fb_attachment < framebuffer->createInfo.attachmentCount)) {
3492 const IMAGE_VIEW_STATE *image_view_state =
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06003493 GetCBState(commandBuffer)->GetActiveAttachmentImageViewState(fb_attachment);
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003494 if (image_view_state != nullptr) {
3495 skip |= ValidateProtectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3496 "VUID-vkCmdClearAttachments-commandBuffer-02504");
3497 skip |= ValidateUnprotectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3498 "VUID-vkCmdClearAttachments-commandBuffer-02505");
3499 }
3500 }
John Zulauf441558b2019-08-12 11:47:39 -06003501 }
ziga-lunargfa335aa2021-08-05 16:59:39 +02003502
3503 // When a subpass uses a non-zero view mask, multiview functionality is considered to be enabled
3504 if (subpass_desc->viewMask > 0) {
3505 for (uint32_t i = 0; i < rectCount; ++i) {
3506 if (pRects[i].baseArrayLayer != 0 || pRects[i].layerCount != 1) {
3507 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-baseArrayLayer-00018",
3508 "vkCmdClearAttachments(): pRects[%" PRIu32 "] baseArrayLayer is %" PRIu32
3509 " and layerCount is %" PRIu32 ", but the render pass instance uses multiview.",
3510 i, pRects[i].baseArrayLayer, pRects[i].layerCount);
3511 }
3512 }
3513 }
John Zulauf441558b2019-08-12 11:47:39 -06003514 }
3515 return skip;
3516}
3517
3518void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3519 const VkClearAttachment *pAttachments, uint32_t rectCount,
3520 const VkClearRect *pRects) {
3521 auto *cb_node = GetCBState(commandBuffer);
3522 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08003523 const VkRenderPassCreateInfo2 *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3524 const VkSubpassDescription2 *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
John Zulauf441558b2019-08-12 11:47:39 -06003525 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
3526 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3527 const auto clear_desc = &pAttachments[attachment_index];
3528 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3529 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3530 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3531 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3532 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3533 subpass_desc->pDepthStencilAttachment) {
3534 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3535 }
3536 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003537 if (!clear_rect_copy) {
3538 // We need a copy of the clear rectangles that will persist until the last lambda executes
3539 // but we want to create it as lazily as possible
3540 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003541 }
John Zulauf441558b2019-08-12 11:47:39 -06003542 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3543 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003544 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
locke-lunargaecf2152020-05-12 17:15:41 -06003545 const CMD_BUFFER_STATE *prim_cb, const FRAMEBUFFER_STATE *fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003546 assert(rectCount == clear_rect_copy->size());
John Zulauf3a548ef2019-02-01 16:14:07 -07003547 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3548 bool skip = false;
locke-lunargaecf2152020-05-12 17:15:41 -06003549 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, fb, fb_attachment, render_area, rectCount,
locke-lunargfc78e932020-11-19 17:06:24 -07003550 clear_rect_copy->data(), prim_cb);
John Zulauf3a548ef2019-02-01 16:14:07 -07003551 return skip;
3552 };
3553 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003554 }
3555 }
3556 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003557}
3558
Jeff Leger178b1e52020-10-05 12:22:23 -04003559template <typename RegionType>
3560bool CoreChecks::ValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3561 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3562 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003563 const auto *cb_node = GetCBState(commandBuffer);
3564 const auto *src_image_state = GetImageState(srcImage);
3565 const auto *dst_image_state = GetImageState(dstImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04003566 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
sfricke-samsung85584a72021-09-30 21:43:38 -07003567 const CMD_TYPE cmd_type = is_2khr ? CMD_RESOLVEIMAGE2KHR : CMD_RESOLVEIMAGE;
3568 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04003569 const char *vuid;
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003570
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003571 bool skip = false;
3572 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003573 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00256" : "VUID-vkCmdResolveImage-srcImage-00256";
3574 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3575 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00258" : "VUID-vkCmdResolveImage-dstImage-00258";
3576 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
sfricke-samsung85584a72021-09-30 21:43:38 -07003577 skip |= ValidateCmd(cb_node, cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04003578 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02003" : "VUID-vkCmdResolveImage-dstImage-02003";
3579 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, func_name, vuid);
3580 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01837" : "VUID-vkCmdResolveImage-commandBuffer-01837";
3581 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3582 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01838" : "VUID-vkCmdResolveImage-commandBuffer-01838";
3583 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3584 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01839" : "VUID-vkCmdResolveImage-commandBuffer-01839";
3585 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003586
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003587 // Validation for VK_EXT_fragment_density_map
3588 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003589 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003590 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003591 "%s: srcImage must not have been created with flags containing "
3592 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3593 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003594 }
3595 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003596 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003597 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003598 "%s: dstImage must not have been created with flags containing "
3599 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3600 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003601 }
3602
Cort Stratton7df30962018-05-17 19:45:57 -07003603 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003604 const char *invalid_src_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003605 is_2khr ? ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003606 ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-01400"
Shannon McPhersonc505df62020-10-20 16:27:11 -06003607 : "VUID-VkResolveImageInfo2KHR-srcImageLayout-00261")
sfricke-samsung45996a42021-09-16 13:45:27 -07003608 : ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003609 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3610 : "VUID-vkCmdResolveImage-srcImageLayout-00261");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003611 const char *invalid_dst_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003612 is_2khr ? ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003613 ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-01401"
3614 : "VUID-VkResolveImageInfo2KHR-dstImageLayout-00263")
sfricke-samsung45996a42021-09-16 13:45:27 -07003615 : ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003616 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3617 : "VUID-vkCmdResolveImage-dstImageLayout-00263");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003618 // For each region, the number of layers in the image subresource should not be zero
3619 // For each region, src and dest image aspect must be color only
3620 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003621 const RegionType region = pRegions[i];
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003622 const VkImageSubresourceLayers src_subresource = region.srcSubresource;
3623 const VkImageSubresourceLayers dst_subresource = region.dstSubresource;
Jeff Leger178b1e52020-10-05 12:22:23 -04003624 skip |= ValidateImageSubresourceLayers(cb_node, &src_subresource, func_name, "srcSubresource", i);
3625 skip |= ValidateImageSubresourceLayers(cb_node, &dst_subresource, func_name, "dstSubresource", i);
3626 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-00260" : "VUID-vkCmdResolveImage-srcImageLayout-00260";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003627 skip |= VerifyImageLayout(cb_node, src_image_state, src_subresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003628 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3629 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-00262" : "VUID-vkCmdResolveImage-dstImageLayout-00262";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003630 skip |= VerifyImageLayout(cb_node, dst_image_state, dst_subresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003631 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
3632 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01709" : "VUID-vkCmdResolveImage-srcSubresource-01709";
3633 skip |= ValidateImageMipLevel(cb_node, src_image_state, src_subresource.mipLevel, i, func_name, "srcSubresource", vuid);
3634 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01710" : "VUID-vkCmdResolveImage-dstSubresource-01710";
3635 skip |= ValidateImageMipLevel(cb_node, dst_image_state, dst_subresource.mipLevel, i, func_name, "dstSubresource", vuid);
3636 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01711" : "VUID-vkCmdResolveImage-srcSubresource-01711";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003637 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, src_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003638 src_subresource.layerCount, i, func_name, "srcSubresource", vuid);
3639 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01712" : "VUID-vkCmdResolveImage-dstSubresource-01712";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003640 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, dst_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003641 dst_subresource.layerCount, i, func_name, "srcSubresource", vuid);
Cort Stratton7df30962018-05-17 19:45:57 -07003642
3643 // layer counts must match
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003644 if (src_subresource.layerCount != dst_subresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003645 vuid = is_2khr ? "VUID-VkImageResolve2KHR-layerCount-00267" : "VUID-VkImageResolve-layerCount-00267";
3646 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003647 LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003648 "%s: layerCount in source and destination subresource of pRegions[%u] does not match.", func_name, i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003649 }
Cort Stratton7df30962018-05-17 19:45:57 -07003650 // For each region, src and dest image aspect must be color only
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003651 if ((src_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3652 (dst_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003653 vuid = is_2khr ? "VUID-VkImageResolve2KHR-aspectMask-00266" : "VUID-VkImageResolve-aspectMask-00266";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003654 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003655 "%s: src and dest aspectMasks for pRegions[%u] must specify only VK_IMAGE_ASPECT_COLOR_BIT.",
3656 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003657 }
3658
3659 const VkImageType src_image_type = src_image_state->createInfo.imageType;
3660 const VkImageType dst_image_type = dst_image_state->createInfo.imageType;
3661
3662 if ((VK_IMAGE_TYPE_3D == src_image_type) || (VK_IMAGE_TYPE_3D == dst_image_type)) {
Shannon McPherson74b341c2020-09-08 15:43:05 -06003663 if ((0 != src_subresource.baseArrayLayer) || (1 != src_subresource.layerCount)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003664 LogObjectList objlist(cb_node->commandBuffer());
3665 objlist.add(src_image_state->image());
3666 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003667 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04446" : "VUID-vkCmdResolveImage-srcImage-04446";
3668 skip |= LogError(objlist, vuid,
3669 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
Shannon McPherson74b341c2020-09-08 15:43:05 -06003670 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003671 func_name, i);
Shannon McPherson74b341c2020-09-08 15:43:05 -06003672 }
3673 if ((0 != dst_subresource.baseArrayLayer) || (1 != dst_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-04447" : "VUID-vkCmdResolveImage-srcImage-04447";
3678 skip |= LogError(objlist, vuid,
3679 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003680 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003681 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003682 }
3683 }
3684
3685 if (VK_IMAGE_TYPE_1D == src_image_type) {
3686 if ((pRegions[i].srcOffset.y != 0) || (pRegions[i].extent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003687 LogObjectList objlist(cb_node->commandBuffer());
3688 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003689 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00271" : "VUID-vkCmdResolveImage-srcImage-00271";
3690 skip |= LogError(objlist, vuid,
3691 "%s: srcImage (%s) is 1D but pRegions[%u] srcOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003692 "extent.height (%u) is not 1.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003693 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003694 pRegions[i].srcOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003695 }
3696 }
3697 if ((VK_IMAGE_TYPE_1D == src_image_type) || (VK_IMAGE_TYPE_2D == src_image_type)) {
3698 if ((pRegions[i].srcOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003699 LogObjectList objlist(cb_node->commandBuffer());
3700 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003701 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00273" : "VUID-vkCmdResolveImage-srcImage-00273";
3702 skip |= LogError(objlist, vuid,
3703 "%s: srcImage (%s) is 2D but pRegions[%u] srcOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003704 "extent.depth (%u) is not 1.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003705 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003706 pRegions[i].srcOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003707 }
3708 }
3709
3710 if (VK_IMAGE_TYPE_1D == dst_image_type) {
3711 if ((pRegions[i].dstOffset.y != 0) || (pRegions[i].extent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003712 LogObjectList objlist(cb_node->commandBuffer());
3713 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003714 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00276" : "VUID-vkCmdResolveImage-dstImage-00276";
3715 skip |= LogError(objlist, vuid,
3716 "%s: dstImage (%s) is 1D but pRegions[%u] dstOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003717 "extent.height (%u) is not 1.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003718 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003719 pRegions[i].dstOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003720 }
3721 }
3722 if ((VK_IMAGE_TYPE_1D == dst_image_type) || (VK_IMAGE_TYPE_2D == dst_image_type)) {
3723 if ((pRegions[i].dstOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003724 LogObjectList objlist(cb_node->commandBuffer());
3725 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003726 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00278" : "VUID-vkCmdResolveImage-dstImage-00278";
3727 skip |= LogError(objlist, vuid,
3728 "%s: dstImage (%s) is 2D but pRegions[%u] dstOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003729 "extent.depth (%u) is not 1.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003730 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003731 pRegions[i].dstOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003732 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003733 }
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003734
3735 // Each srcImage dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003736 VkExtent3D subresource_extent = src_image_state->GetSubresourceExtent(src_subresource);
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003737 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3738 // developer
3739 if (src_subresource.mipLevel < src_image_state->createInfo.mipLevels) {
3740 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003741 if ((extent_check & kXBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003742 LogObjectList objlist(cb_node->commandBuffer());
3743 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003744 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00269" : "VUID-vkCmdResolveImage-srcOffset-00269";
3745 skip |= LogError(objlist, vuid,
3746 "%s: srcImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003747 "exceeds subResource width [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003748 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003749 region.extent.width, subresource_extent.width);
3750 }
3751
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003752 if ((extent_check & kYBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003753 LogObjectList objlist(cb_node->commandBuffer());
3754 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003755 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00270" : "VUID-vkCmdResolveImage-srcOffset-00270";
3756 skip |= LogError(objlist, vuid,
3757 "%s: srcImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003758 "exceeds subResource height [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003759 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003760 region.extent.height, subresource_extent.height);
3761 }
3762
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003763 if ((extent_check & kZBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003764 LogObjectList objlist(cb_node->commandBuffer());
3765 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003766 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00272" : "VUID-vkCmdResolveImage-srcOffset-00272";
3767 skip |= LogError(objlist, vuid,
3768 "%s: srcImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003769 "exceeds subResource depth [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003770 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003771 region.extent.depth, subresource_extent.depth);
3772 }
3773 }
3774
3775 // Each dstImage dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003776 subresource_extent = dst_image_state->GetSubresourceExtent(dst_subresource);
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003777 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3778 // developer
3779 if (dst_subresource.mipLevel < dst_image_state->createInfo.mipLevels) {
3780 uint32_t extent_check = ExceedsBounds(&(region.dstOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003781 if ((extent_check & kXBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003782 LogObjectList objlist(cb_node->commandBuffer());
3783 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003784 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00274" : "VUID-vkCmdResolveImage-dstOffset-00274";
3785 skip |= LogError(objlist, vuid,
3786 "%s: dstImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003787 "exceeds subResource width [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003788 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003789 region.extent.width, subresource_extent.width);
3790 }
3791
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003792 if ((extent_check & kYBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003793 LogObjectList objlist(cb_node->commandBuffer());
3794 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003795 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00275" : "VUID-vkCmdResolveImage-dstOffset-00275";
3796 skip |= LogError(objlist, vuid,
3797 "%s: dstImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003798 "exceeds subResource height [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003799 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003800 region.extent.height, subresource_extent.height);
3801 }
3802
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003803 if ((extent_check & kZBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003804 LogObjectList objlist(cb_node->commandBuffer());
3805 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003806 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00277" : "VUID-vkCmdResolveImage-dstOffset-00277";
3807 skip |= LogError(objlist, vuid,
3808 "%s: dstImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003809 "exceeds subResource depth [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003810 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003811 region.extent.depth, subresource_extent.depth);
3812 }
3813 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003814 }
3815
3816 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003817 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-01386" : "VUID-vkCmdResolveImage-srcImage-01386";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003818 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 -04003819 func_name, string_VkFormat(src_image_state->createInfo.format),
3820 string_VkFormat(dst_image_state->createInfo.format));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003821 }
3822 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003823 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_MismatchedImageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04003824 "%s: srcImage type (%s) and dstImage type (%s) are not the same.", func_name,
sfricke-samsungc26350e2020-05-30 12:31:31 -07003825 string_VkImageType(src_image_state->createInfo.imageType),
3826 string_VkImageType(dst_image_state->createInfo.imageType));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003827 }
3828 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003829 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00257" : "VUID-vkCmdResolveImage-srcImage-00257";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003830 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 -07003831 }
3832 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003833 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00259" : "VUID-vkCmdResolveImage-dstImage-00259";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003834 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 -04003835 func_name, string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003836 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003837 } else {
3838 assert(0);
3839 }
3840 return skip;
3841}
3842
Jeff Leger178b1e52020-10-05 12:22:23 -04003843bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3844 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3845 const VkImageResolve *pRegions) const {
3846 return ValidateCmdResolveImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3847 COPY_COMMAND_VERSION_1);
3848}
3849
3850bool CoreChecks::PreCallValidateCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
3851 const VkResolveImageInfo2KHR *pResolveImageInfo) const {
3852 return ValidateCmdResolveImage(commandBuffer, pResolveImageInfo->srcImage, pResolveImageInfo->srcImageLayout,
3853 pResolveImageInfo->dstImage, pResolveImageInfo->dstImageLayout, pResolveImageInfo->regionCount,
3854 pResolveImageInfo->pRegions, COPY_COMMAND_VERSION_2);
3855}
3856
3857template <typename RegionType>
3858bool CoreChecks::ValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3859 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3860 const RegionType *pRegions, VkFilter filter, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003861 const auto *cb_node = GetCBState(commandBuffer);
3862 const auto *src_image_state = GetImageState(srcImage);
3863 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003864
Jeff Leger178b1e52020-10-05 12:22:23 -04003865 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
sfricke-samsung85584a72021-09-30 21:43:38 -07003866 const CMD_TYPE cmd_type = is_2khr ? CMD_BLITIMAGE2KHR : CMD_BLITIMAGE;
3867 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04003868
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003869 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003870 if (cb_node) {
sfricke-samsung85584a72021-09-30 21:43:38 -07003871 skip |= ValidateCmd(cb_node, cmd_type);
John Zulauf5c2750c2018-01-30 15:04:56 -07003872 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003873 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003874 const char *vuid;
3875 const char *location;
3876 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00233" : "VUID-vkCmdBlitImage-srcImage-00233";
3877 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->srcImage" : "vkCmdBlitImage(): srcImage";
3878 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
3879 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00234" : "VUID-vkCmdBlitImage-dstImage-00234";
3880 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->dstImage" : "vkCmdBlitImage(): dstImage";
3881 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
3882 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00220" : "VUID-vkCmdBlitImage-srcImage-00220";
3883 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3884 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00225" : "VUID-vkCmdBlitImage-dstImage-00225";
3885 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
3886 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00219" : "VUID-vkCmdBlitImage-srcImage-00219";
3887 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3888 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3889 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00224" : "VUID-vkCmdBlitImage-dstImage-00224";
3890 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3891 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
sfricke-samsung85584a72021-09-30 21:43:38 -07003892 skip |= ValidateCmd(cb_node, cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04003893 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-01999" : "VUID-vkCmdBlitImage-srcImage-01999";
3894 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, func_name, vuid);
3895 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02000" : "VUID-vkCmdBlitImage-dstImage-02000";
3896 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, func_name, vuid);
3897 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01834" : "VUID-vkCmdBlitImage-commandBuffer-01834";
3898 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3899 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01835" : "VUID-vkCmdBlitImage-commandBuffer-01835";
3900 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3901 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01836" : "VUID-vkCmdBlitImage-commandBuffer-01836";
3902 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
sfricke-samsung022fa252020-07-24 03:26:16 -07003903
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003904 // Validation for VK_EXT_fragment_density_map
3905 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003906 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003907 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003908 "%s: srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3909 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003910 }
3911 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003912 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003913 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003914 "%s: dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3915 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003916 }
3917
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003918 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003919
Dave Houlton33c2d252017-06-09 17:08:32 -06003920 VkFormat src_format = src_image_state->createInfo.format;
3921 VkFormat dst_format = dst_image_state->createInfo.format;
3922 VkImageType src_type = src_image_state->createInfo.imageType;
3923 VkImageType dst_type = dst_image_state->createInfo.imageType;
3924
Cort Stratton186b1a22018-05-01 20:18:06 -04003925 if (VK_FILTER_LINEAR == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003926 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02001" : "VUID-vkCmdBlitImage-filter-02001";
3927 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT, func_name,
3928 vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003929 } else if (VK_FILTER_CUBIC_IMG == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003930 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02002" : "VUID-vkCmdBlitImage-filter-02002";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003931 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
Jeff Leger178b1e52020-10-05 12:22:23 -04003932 func_name, vuid);
Dave Houlton33c2d252017-06-09 17:08:32 -06003933 }
3934
sfricke-samsung10b35ce2021-09-29 08:50:20 -07003935 if (FormatRequiresYcbcrConversionExplicitly(src_format)) {
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07003936 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-06421" : "VUID-vkCmdBlitImage-srcImage-06421";
Jeff Leger178b1e52020-10-05 12:22:23 -04003937 skip |= LogError(device, vuid,
3938 "%s: srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003939 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04003940 func_name, string_VkFormat(src_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003941 }
3942
sfricke-samsung10b35ce2021-09-29 08:50:20 -07003943 if (FormatRequiresYcbcrConversionExplicitly(dst_format)) {
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07003944 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-06422" : "VUID-vkCmdBlitImage-dstImage-06422";
Jeff Leger178b1e52020-10-05 12:22:23 -04003945 skip |= LogError(device, vuid,
3946 "%s: dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003947 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04003948 func_name, string_VkFormat(dst_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003949 }
3950
ziga-lunarg52604a12021-09-09 16:02:05 +02003951 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_2D != src_type)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003952 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-00237" : "VUID-vkCmdBlitImage-filter-00237";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003953 skip |= LogError(cb_node->commandBuffer(), vuid,
ziga-lunarg52604a12021-09-09 16:02:05 +02003954 "%s: source image type must be VK_IMAGE_TYPE_2D when cubic filtering is specified.", func_name);
Dave Houlton33c2d252017-06-09 17:08:32 -06003955 }
3956
Dave Houlton33c2d252017-06-09 17:08:32 -06003957 // Validate consistency for unsigned formats
3958 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3959 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003960 ss << func_name << ": If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003961 << "the other one must also have unsigned integer format. "
3962 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003963 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00230" : "VUID-vkCmdBlitImage-srcImage-00230";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003964 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003965 }
3966
3967 // Validate consistency for signed formats
3968 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3969 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003970 ss << func_name << ": If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003971 << "the other one must also have signed 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-00229" : "VUID-vkCmdBlitImage-srcImage-00229";
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 filter for Depth/Stencil formats
3978 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3979 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003980 ss << func_name << ": If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003981 << "then filter must be VK_FILTER_NEAREST.";
Jeff Leger178b1e52020-10-05 12:22:23 -04003982 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00232" : "VUID-vkCmdBlitImage-srcImage-00232";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003983 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003984 }
3985
3986 // Validate aspect bits and formats for depth/stencil images
3987 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3988 if (src_format != dst_format) {
3989 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003990 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 -06003991 << "stencil, the other one must have exactly the same format. "
3992 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3993 << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003994 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00231" : "VUID-vkCmdBlitImage-srcImage-00231";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003995 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003996 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003997 } // Depth or Stencil
3998
3999 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004000 const char *invalid_src_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07004001 is_2khr ? ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04004002 ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-01398"
4003 : "VUID-VkBlitImageInfo2KHR-srcImageLayout-00222")
sfricke-samsung45996a42021-09-16 13:45:27 -07004004 : ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04004005 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
4006 : "VUID-vkCmdBlitImage-srcImageLayout-00222");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004007 const char *invalid_dst_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07004008 is_2khr ? ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04004009 ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-01399"
4010 : "VUID-VkBlitImageInfo2KHR-dstImageLayout-00227")
sfricke-samsung45996a42021-09-16 13:45:27 -07004011 : ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04004012 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
4013 : "VUID-vkCmdBlitImage-dstImageLayout-00227");
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004014 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004015 const RegionType rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004016 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04004017 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-00221" : "VUID-vkCmdBlitImage-srcImageLayout-00221";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004018 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04004019 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
4020 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-00226" : "VUID-vkCmdBlitImage-dstImageLayout-00226";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004021 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04004022 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
4023 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, func_name, "srcSubresource", i);
4024 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, func_name, "dstSubresource", i);
4025 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01705" : "VUID-vkCmdBlitImage-srcSubresource-01705";
4026 skip |=
4027 ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
4028 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01706" : "VUID-vkCmdBlitImage-dstSubresource-01706";
4029 skip |=
4030 ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
4031 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01707" : "VUID-vkCmdBlitImage-srcSubresource-01707";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004032 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04004033 rgn.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
4034 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01708" : "VUID-vkCmdBlitImage-dstSubresource-01708";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004035 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04004036 rgn.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004037 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06004038 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
4039 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004040 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004041 ss << func_name << ": pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004042 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004043 }
Dave Houlton48989f32017-05-26 15:01:46 -06004044 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
4045 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004046 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004047 ss << func_name << ": pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004048 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004049 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004050
4051 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06004052 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004053 vuid = is_2khr ? "VUID-VkImageBlit2KHR-layerCount-00239" : "VUID-VkImageBlit-layerCount-00239";
4054 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004055 LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004056 "%s: layerCount in source and destination subresource of pRegions[%d] does not match.", func_name, i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004057 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07004058
Dave Houlton48989f32017-05-26 15:01:46 -06004059 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004060 vuid = is_2khr ? "VUID-VkImageBlit2KHR-aspectMask-00238" : "VUID-VkImageBlit-aspectMask-00238";
4061 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004062 LogError(cb_node->commandBuffer(), vuid, "%s: aspectMask members for pRegion[%d] do not match.", func_name, i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07004063 }
Dave Houlton48989f32017-05-26 15:01:46 -06004064
Dave Houlton33c2d252017-06-09 17:08:32 -06004065 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004066 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00241" : "VUID-vkCmdBlitImage-aspectMask-00241";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004067 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004068 "%s: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004069 "image format %s.",
Jeff Leger178b1e52020-10-05 12:22:23 -04004070 func_name, i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004071 }
4072
4073 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004074 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00242" : "VUID-vkCmdBlitImage-aspectMask-00242";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004075 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004076 "%s: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
4077 func_name, i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004078 }
4079
Dave Houlton48989f32017-05-26 15:01:46 -06004080 // Validate source image offsets
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06004081 VkExtent3D src_extent = src_image_state->GetSubresourceExtent(rgn.srcSubresource);
Dave Houlton33c2d252017-06-09 17:08:32 -06004082 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06004083 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004084 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00245" : "VUID-vkCmdBlitImage-srcImage-00245";
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], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
4087 "of (%1d, %1d). These must be (0, 1).",
4088 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004089 }
4090 }
4091
Dave Houlton33c2d252017-06-09 17:08:32 -06004092 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06004093 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004094 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00247" : "VUID-vkCmdBlitImage-srcImage-00247";
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 or VK_IMAGE_TYPE_2D with "
4097 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
4098 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004099 }
4100 }
4101
Dave Houlton33c2d252017-06-09 17:08:32 -06004102 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06004103 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
4104 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004105 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004106 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00243" : "VUID-vkCmdBlitImage-srcOffset-00243";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004107 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004108 "%s: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).",
4109 func_name, i, rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004110 }
4111 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
4112 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004113 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004114 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00244" : "VUID-vkCmdBlitImage-srcOffset-00244";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004115 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004116 "%s: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).",
4117 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004118 }
4119 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
4120 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004121 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004122 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00246" : "VUID-vkCmdBlitImage-srcOffset-00246";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004123 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004124 "%s: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).",
4125 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004126 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004127 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004128 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00215" : "VUID-vkCmdBlitImage-pRegions-00215";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004129 skip |= LogError(cb_node->commandBuffer(), vuid, "%s: region [%d] source image blit region exceeds image dimensions.",
Jeff Leger178b1e52020-10-05 12:22:23 -04004130 func_name, i);
Dave Houlton33c2d252017-06-09 17:08:32 -06004131 }
Dave Houlton48989f32017-05-26 15:01:46 -06004132
4133 // Validate dest image offsets
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06004134 VkExtent3D dst_extent = dst_image_state->GetSubresourceExtent(rgn.dstSubresource);
Dave Houlton33c2d252017-06-09 17:08:32 -06004135 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06004136 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004137 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00250" : "VUID-vkCmdBlitImage-dstImage-00250";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004138 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004139 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
4140 "(%1d, %1d). These must be (0, 1).",
4141 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004142 }
4143 }
4144
Dave Houlton33c2d252017-06-09 17:08:32 -06004145 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06004146 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004147 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00252" : "VUID-vkCmdBlitImage-dstImage-00252";
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 or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004150 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
Jeff Leger178b1e52020-10-05 12:22:23 -04004151 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004152 }
4153 }
4154
Dave Houlton33c2d252017-06-09 17:08:32 -06004155 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06004156 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
4157 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004158 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004159 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00248" : "VUID-vkCmdBlitImage-dstOffset-00248";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004160 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004161 "%s: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).",
4162 func_name, i, rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004163 }
4164 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
4165 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004166 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004167 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00249" : "VUID-vkCmdBlitImage-dstOffset-00249";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004168 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004169 "%s: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).",
4170 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004171 }
4172 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
4173 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004174 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004175 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00251" : "VUID-vkCmdBlitImage-dstOffset-00251";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004176 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004177 "%s: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).",
4178 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004179 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004180 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004181 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00216" : "VUID-vkCmdBlitImage-pRegions-00216";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004182 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004183 "%s: region [%d] destination image blit region exceeds image dimensions.", func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004184 }
4185
Dave Houlton33c2d252017-06-09 17:08:32 -06004186 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
4187 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
4188 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004189 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00240" : "VUID-vkCmdBlitImage-srcImage-00240";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004190 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004191 "%s: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
4192 "layerCount other than 1.",
4193 func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004194 }
4195 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004196 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004197 } else {
4198 assert(0);
4199 }
4200 return skip;
4201}
4202
Jeff Leger178b1e52020-10-05 12:22:23 -04004203bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4204 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4205 const VkImageBlit *pRegions, VkFilter filter) const {
4206 return ValidateCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter,
4207 COPY_COMMAND_VERSION_1);
4208}
4209
4210bool CoreChecks::PreCallValidateCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) const {
4211 return ValidateCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4212 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4213 pBlitImageInfo->filter, COPY_COMMAND_VERSION_2);
4214}
4215
4216template <typename RegionType>
4217void CoreChecks::RecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
4218 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
4219 VkFilter filter) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004220 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004221 auto src_image_state = GetImageState(srcImage);
4222 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004223
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004224 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004225 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06004226 cb_node->SetImageInitialLayout(*src_image_state, pRegions[i].srcSubresource, srcImageLayout);
4227 cb_node->SetImageInitialLayout(*dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004228 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004229}
4230
Jeff Leger178b1e52020-10-05 12:22:23 -04004231void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4232 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4233 const VkImageBlit *pRegions, VkFilter filter) {
4234 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
4235 pRegions, filter);
4236 RecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter);
4237}
4238
4239void CoreChecks::PreCallRecordCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) {
4240 StateTracker::PreCallRecordCmdBlitImage2KHR(commandBuffer, pBlitImageInfo);
4241 RecordCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4242 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4243 pBlitImageInfo->filter);
4244}
4245
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004246GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap &map, const IMAGE_STATE &image_state) {
John Zulauf2076e812020-01-08 14:55:54 -07004247 // This approach allows for a single hash lookup or/create new
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004248 auto &layout_map = map[image_state.image()];
John Zulauf17708d02021-02-22 11:20:58 -07004249 if (!layout_map) {
4250 layout_map.emplace(image_state.subresource_encoder.SubresourceCount());
John Zulauf2076e812020-01-08 14:55:54 -07004251 }
John Zulauf17708d02021-02-22 11:20:58 -07004252 return &layout_map;
John Zulauf2076e812020-01-08 14:55:54 -07004253}
4254
4255const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, VkImage image) {
4256 auto it = map.find(image);
4257 if (it != map.end()) {
John Zulauf17708d02021-02-22 11:20:58 -07004258 return &it->second;
John Zulauf2076e812020-01-08 14:55:54 -07004259 }
4260 return nullptr;
4261}
4262
Jeremy Gebben53631302021-04-13 16:46:37 -06004263// Helper to update the Global or Overlay layout map
4264struct GlobalLayoutUpdater {
4265 bool update(VkImageLayout &dst, const image_layout_map::ImageSubresourceLayoutMap::LayoutEntry &src) const {
4266 if (src.current_layout != image_layout_map::kInvalidLayout && dst != src.current_layout) {
4267 dst = src.current_layout;
4268 return true;
4269 }
4270 return false;
4271 }
4272
4273 layer_data::optional<VkImageLayout> insert(const image_layout_map::ImageSubresourceLayoutMap::LayoutEntry &src) const {
4274 layer_data::optional<VkImageLayout> result;
4275 if (src.current_layout != image_layout_map::kInvalidLayout) {
4276 result.emplace(src.current_layout);
4277 }
4278 return result;
4279 }
4280};
4281
Shannon McPherson449fa9c2018-10-25 11:51:07 -06004282// 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 -07004283bool CoreChecks::ValidateCmdBufImageLayouts(const Location &loc, const CMD_BUFFER_STATE *pCB,
4284 const GlobalImageLayoutMap &globalImageLayoutMap,
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004285 GlobalImageLayoutMap &overlayLayoutMap) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06004286 if (disabled[image_layout_validation]) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004287 bool skip = false;
John Zulauff660ad62019-03-23 07:16:05 -06004288 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07004289 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06004290 for (const auto &layout_map_entry : pCB->image_layout_map) {
4291 const auto image = layout_map_entry.first;
4292 const auto *image_state = GetImageState(image);
4293 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06004294 const auto &subres_map = layout_map_entry.second;
Jeremy Gebben53631302021-04-13 16:46:37 -06004295 const auto &layout_map = subres_map->GetLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06004296 // Validate the initial_uses for each subresource referenced
Jeremy Gebben53631302021-04-13 16:46:37 -06004297 if (layout_map.empty()) continue;
John Zulauf2076e812020-01-08 14:55:54 -07004298
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004299 auto *overlay_map = GetLayoutRangeMap(overlayLayoutMap, *image_state);
John Zulauf2076e812020-01-08 14:55:54 -07004300 const auto *global_map = GetLayoutRangeMap(globalImageLayoutMap, image);
4301 if (global_map == nullptr) {
4302 global_map = &empty_map;
4303 }
4304
4305 // Note: don't know if it would matter
4306 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
4307
Jeremy Gebben53631302021-04-13 16:46:37 -06004308 auto pos = layout_map.begin();
4309 const auto end = layout_map.end();
4310 sparse_container::parallel_iterator<const GlobalImageLayoutRangeMap> current_layout(*overlay_map, *global_map,
4311 pos->first.begin);
John Zulauf2076e812020-01-08 14:55:54 -07004312 while (pos != end) {
Jeremy Gebben53631302021-04-13 16:46:37 -06004313 VkImageLayout initial_layout = pos->second.initial_layout;
4314 assert(initial_layout != image_layout_map::kInvalidLayout);
4315 if (initial_layout == image_layout_map::kInvalidLayout) {
4316 continue;
4317 }
4318
John Zulauf2076e812020-01-08 14:55:54 -07004319 VkImageLayout image_layout = kInvalidLayout;
Jeremy Gebben53631302021-04-13 16:46:37 -06004320
John Zulauf2076e812020-01-08 14:55:54 -07004321 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 -07004322 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004323 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07004324 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004325 image_layout = current_layout->pos_B->lower_bound->second;
4326 }
4327 const auto intersected_range = pos->first & current_layout->range;
4328 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
4329 // TODO: Set memory invalid which is in mem_tracker currently
4330 } else if (image_layout != initial_layout) {
Hans-Kristian Arntzen6cb03492021-07-05 16:57:31 +02004331 const auto aspect_mask = image_state->subresource_encoder.Decode(intersected_range.begin).aspectMask;
4332 bool matches = ImageLayoutMatches(aspect_mask, image_layout, initial_layout);
John Zulauf2076e812020-01-08 14:55:54 -07004333 if (!matches) {
John Zulauf2076e812020-01-08 14:55:54 -07004334 // We can report all the errors for the intersected range directly
4335 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
locke-lunarg296a3c92020-03-25 01:04:29 -06004336 const auto subresource = image_state->subresource_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004337 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004338 pCB->commandBuffer(), kVUID_Core_DrawState_InvalidImageLayout,
sfricke-samsung6b447aa2021-07-26 09:42:26 -07004339 "%s command buffer %s expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004340 "to be in layout %s--instead, current layout is %s.",
sfricke-samsung6b447aa2021-07-26 09:42:26 -07004341 loc.Message().c_str(), report_data->FormatHandle(pCB->commandBuffer()).c_str(),
John Zulauf2076e812020-01-08 14:55:54 -07004342 report_data->FormatHandle(image).c_str(), subresource.aspectMask, subresource.arrayLayer,
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004343 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
John Zulaufb61ed972019-04-09 16:12:35 -06004344 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004345 }
4346 }
John Zulauf2076e812020-01-08 14:55:54 -07004347 if (pos->first.includes(intersected_range.end)) {
4348 current_layout.seek(intersected_range.end);
4349 } else {
4350 ++pos;
4351 if (pos != end) {
4352 current_layout.seek(pos->first.begin);
4353 }
4354 }
John Zulauff660ad62019-03-23 07:16:05 -06004355 }
locke-lunargf155ccf2020-02-18 11:34:15 -07004356 // Update all layout set operations (which will be a subset of the initial_layouts)
Jeremy Gebben53631302021-04-13 16:46:37 -06004357 sparse_container::splice(*overlay_map, subres_map->GetLayoutMap(), GlobalLayoutUpdater());
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004358 }
John Zulauff660ad62019-03-23 07:16:05 -06004359
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004360 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004361}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07004362
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004363void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06004364 for (const auto &layout_map_entry : pCB->image_layout_map) {
4365 const auto image = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07004366 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06004367 const auto *image_state = GetImageState(image);
4368 if (!image_state) continue; // Can't set layouts of a dead image
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004369 auto *global_map = GetLayoutRangeMap(imageLayoutMap, *image_state);
Jeremy Gebben53631302021-04-13 16:46:37 -06004370 sparse_container::splice(*global_map, subres_map->GetLayoutMap(), GlobalLayoutUpdater());
Tony Barbourdf013b92017-01-25 12:53:48 -07004371 }
4372}
4373
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004374// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004375// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
4376// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004377bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
4378 const VkImageLayout first_layout, const uint32_t attachment,
Mike Schuchardt2df08912020-12-15 16:28:09 -08004379 const VkAttachmentDescription2 &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004380 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004381 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
4382
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004383 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
sfricke-samsung55f01952020-03-24 08:16:41 -07004384 // for both loadOp and stencilLoaOp rp2 has it in 1 VU while rp1 has it in 2 VU with half behind Maintenance2 extension
4385 // Each is VUID is below in following order: rp2 -> rp1 with Maintenance2 -> rp1 with no extenstion
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004386 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07004387 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4388 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4389 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004390 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004391 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004392 string_VkImageLayout(first_layout));
sfricke-samsung45996a42021-09-16 13:45:27 -07004393 } else if ((use_rp2 == false) && IsExtEnabled(device_extensions.vk_khr_maintenance2) &&
sfricke-samsung55f01952020-03-24 08:16:41 -07004394 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL)) {
4395 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01566",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004396 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004397 string_VkImageLayout(first_layout));
4398 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4399 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004400 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004401 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004402 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004403 }
4404 }
sfricke-samsung55f01952020-03-24 08:16:41 -07004405
4406 // Same as above for loadOp, but for stencilLoadOp
4407 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
4408 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4409 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4410 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL))) {
4411 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02523",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004412 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004413 string_VkImageLayout(first_layout));
sfricke-samsung45996a42021-09-16 13:45:27 -07004414 } else if ((use_rp2 == false) && IsExtEnabled(device_extensions.vk_khr_maintenance2) &&
sfricke-samsung55f01952020-03-24 08:16:41 -07004415 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL)) {
4416 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01567",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004417 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004418 string_VkImageLayout(first_layout));
4419 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4420 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
4421 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-02511",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004422 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004423 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02004424 }
4425 }
4426
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004427 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004428}
4429
Mark Lobodzinski96210742017-02-09 10:33:46 -07004430// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4431// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004432template <typename T1>
4433bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
4434 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
4435 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004436 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004437 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004438 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004439 if (strict) {
4440 correct_usage = ((actual & desired) == desired);
4441 } else {
4442 correct_usage = ((actual & desired) != 0);
4443 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004444
Mark Lobodzinski96210742017-02-09 10:33:46 -07004445 if (!correct_usage) {
sfricke-samsungbb971942020-09-10 22:11:56 -07004446 // All callers should have a valid VUID
4447 assert(msgCode != kVUIDUndefined);
4448 skip =
4449 LogError(object, msgCode, "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4450 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004451 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004452 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004453}
4454
4455// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4456// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004457bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004458 char const *func_name, char const *usage_string) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004459 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image(),
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06004460 image_state->Handle(), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004461}
4462
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004463bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004464 char const *func_name, const char *vuid) const {
Cort Stratton186b1a22018-05-01 20:18:06 -04004465 bool skip = false;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004466 const VkFormatFeatureFlags image_format_features = image_state->format_features;
4467 if ((image_format_features & desired) != desired) {
4468 // Same error, but more details if it was an AHB external format
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06004469 if (image_state->HasAHBFormat()) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004470 skip |= LogError(image_state->image(), vuid,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004471 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for the external format "
4472 "found in VkAndroidHardwareBufferFormatPropertiesANDROID::formatFeatures used by %s.",
4473 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004474 report_data->FormatHandle(image_state->image()).c_str());
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004475 } else {
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 format %u used by %s "
4478 "with tiling %s.",
4479 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004480 image_state->createInfo.format, report_data->FormatHandle(image_state->image()).c_str(),
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004481 string_VkImageTiling(image_state->createInfo.tiling));
Cort Stratton186b1a22018-05-01 20:18:06 -04004482 }
4483 }
4484 return skip;
4485}
4486
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004487bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004488 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004489 bool skip = false;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004490 const VkImageAspectFlags apsect_mask = subresource_layers->aspectMask;
Cort Strattond619a302018-05-17 19:46:32 -07004491 // layerCount must not be zero
4492 if (subresource_layers->layerCount == 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004493 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-layerCount-01700",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004494 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004495 }
4496 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004497 if (apsect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004498 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-00168",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004499 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004500 }
4501 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004502 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 -06004503 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-00167",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004504 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4505 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4506 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004507 }
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004508 // aspectMask must not contain VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT
4509 if (apsect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
4510 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004511 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-02247",
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004512 "In %s, pRegions[%u].%s.aspectMask has a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit set.", func_name, i,
4513 member);
4514 }
Cort Strattond619a302018-05-17 19:46:32 -07004515 return skip;
4516}
4517
Mark Lobodzinski96210742017-02-09 10:33:46 -07004518// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4519// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004520bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004521 char const *func_name, char const *usage_string) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004522 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer(),
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06004523 buffer_state->Handle(), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004524}
4525
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004526bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004527 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004528 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004529
4530 const VkDeviceSize &range = pCreateInfo->range;
4531 if (range != VK_WHOLE_SIZE) {
4532 // Range must be greater than 0
4533 if (range <= 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004534 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00928",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004535 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004536 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4537 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004538 }
4539 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004540 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4541 if (SafeModulo(range, format_size) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004542 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00929",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004543 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004544 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4545 "(%" PRIu32 ").",
4546 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004547 }
4548 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004549 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004550 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00930",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004551 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004552 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4553 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4554 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004555 }
4556 // The sum of range and offset must be less than or equal to the size of buffer
4557 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004558 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-offset-00931",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004559 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004560 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4561 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4562 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004563 }
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004564 } else {
4565 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4566
4567 // Size of buffer - offset, divided by the element size of format must be less than or equal to
4568 // VkPhysicalDeviceLimits::maxTexelBufferElements
4569 if (SafeDivision(buffer_state->createInfo.size - pCreateInfo->offset, format_size) >
4570 device_limits->maxTexelBufferElements) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004571 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-04059",
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004572 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
4573 ") equals VK_WHOLE_SIZE, the buffer's size (%" PRIuLEAST64 ") minus the offset (%" PRIuLEAST64
4574 "), divided by the element size of the format (%" PRIu32
4575 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4576 range, buffer_state->createInfo.size, pCreateInfo->offset, format_size,
4577 device_limits->maxTexelBufferElements);
4578 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004579 }
4580 return skip;
4581}
4582
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004583bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004584 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004585 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004586 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4587 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004588 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-00933",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004589 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004590 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format (%s) must "
4591 "be supported for uniform texel buffers",
4592 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004593 }
4594 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4595 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004596 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-00934",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004597 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004598 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format (%s) must "
4599 "be supported for storage texel buffers",
4600 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004601 }
4602 return skip;
4603}
4604
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004605bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004606 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004607 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004608
Dave Houltond8ed0212018-05-16 17:18:24 -06004609 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004610
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004611 auto chained_devaddr_struct = LvlFindInChain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
Jeff Bolz87697532019-01-11 22:54:00 -06004612 if (chained_devaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004613 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz87697532019-01-11 22:54:00 -06004614 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004615 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4616 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004617 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004618 }
4619 }
4620
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004621 auto chained_opaqueaddr_struct = LvlFindInChain<VkBufferOpaqueCaptureAddressCreateInfo>(pCreateInfo->pNext);
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004622 if (chained_opaqueaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004623 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004624 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004625 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
Mike Schuchardt2df08912020-12-15 16:28:09 -08004626 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfo::opaqueCaptureAddress"
4627 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004628 }
4629 }
4630
ziga-lunarg2e2be1e2021-07-18 23:09:15 +02004631 auto dedicated_allocation_buffer = LvlFindInChain<VkDedicatedAllocationBufferCreateInfoNV>(pCreateInfo->pNext);
4632 if (dedicated_allocation_buffer && dedicated_allocation_buffer->dedicatedAllocation == VK_TRUE) {
4633 if (pCreateInfo->flags &
4634 (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT)) {
4635 skip |= LogError(device, "VUID-VkBufferCreateInfo-pNext-01571",
4636 "vkCreateBuffer(): pCreateInfos->flags must not include VK_BUFFER_CREATE_SPARSE_BINDING_BIT, "
4637 "VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT, or VK_BUFFER_CREATE_SPARSE_ALIASED_BIT when "
4638 "VkDedicatedAllocationBufferCreateInfoNV is in pNext chain with dedicatedAllocation VK_TRUE.");
4639 }
4640 }
4641
Mike Schuchardt2df08912020-12-15 16:28:09 -08004642 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz33fc6722020-03-31 12:58:16 -05004643 !enabled_features.core12.bufferDeviceAddressCaptureReplay &&
sfricke-samsung828e59d2021-08-22 23:20:49 -07004644 !enabled_features.buffer_device_address_ext_features.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004645 skip |= LogError(
4646 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004647 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004648 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT set.");
Jeff Bolz87697532019-01-11 22:54:00 -06004649 }
4650
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004651 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
sfricke-samsung45996a42021-09-16 13:45:27 -07004652 const char *vuid = IsExtEnabled(device_extensions.vk_khr_get_physical_device_properties2)
4653 ? "VUID-VkBufferCreateInfo-sharingMode-01419"
4654 : "VUID-VkBufferCreateInfo-sharingMode-01391";
Mark Lobodzinski314b9162020-07-16 15:33:08 -06004655 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
ziga-lunarga0b4f8a2021-07-28 13:23:02 +02004656 "vkCreateBuffer", "pCreateInfo->pQueueFamilyIndices", vuid);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004657 }
4658
sfricke-samsungedce77a2020-07-03 22:35:13 -07004659 if ((pCreateInfo->flags & VK_BUFFER_CREATE_PROTECTED_BIT) != 0) {
4660 if (enabled_features.core11.protectedMemory == VK_FALSE) {
4661 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-01887",
4662 "vkCreateBuffer(): the protectedMemory device feature is disabled: Buffers cannot be created with the "
4663 "VK_BUFFER_CREATE_PROTECTED_BIT set.");
4664 }
4665 const VkBufferCreateFlags invalid_flags =
4666 VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT;
4667 if ((pCreateInfo->flags & invalid_flags) != 0) {
4668 skip |= LogError(device, "VUID-VkBufferCreateInfo-None-01888",
4669 "vkCreateBuffer(): VK_BUFFER_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at "
4670 "same time (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | "
4671 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT).");
4672 }
4673 }
4674
Mark Lobodzinski96210742017-02-09 10:33:46 -07004675 return skip;
4676}
4677
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004678bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004679 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004680 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004681 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
sfricke-samsung2e827212021-09-28 07:52:08 -07004682
4683 if (FormatIsDepthOrStencil(pCreateInfo->format)) {
4684 // Should never hopefully get here, but there are known driver advertising the wrong feature flags
4685 // see https://gitlab.khronos.org/vulkan/vulkan/-/merge_requests/4849
4686 skip |= LogError(device, kVUID_Core_invalidDepthStencilFormat,
4687 "vkCreateBufferView(): format is a depth/stencil format (%s) but depth/stencil formats do not have a "
4688 "defined sizes for alignment, replace with a color format.",
4689 string_VkFormat(pCreateInfo->format));
4690 }
4691
Mark Lobodzinski96210742017-02-09 10:33:46 -07004692 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4693 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004694 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004695 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4696 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004697 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004698 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4699 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4700 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004701
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004702 // Buffer view offset must be less than the size of buffer
4703 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004704 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-offset-00925",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004705 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004706 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4707 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004708 }
4709
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004710 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004711 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4712 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4713 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
sfricke-samsung45996a42021-09-16 13:45:27 -07004714 const char *vuid = IsExtEnabled(device_extensions.vk_ext_texel_buffer_alignment)
4715 ? "VUID-VkBufferViewCreateInfo-offset-02749"
4716 : "VUID-VkBufferViewCreateInfo-offset-00926";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004717 skip |= LogError(buffer_state->buffer(), vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004718 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004719 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4720 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004721 }
4722
4723 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004724 VkDeviceSize element_size = FormatElementSize(pCreateInfo->format);
4725 if ((element_size % 3) == 0) {
4726 element_size /= 3;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004727 }
4728 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004729 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05004730 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4731 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004732 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004733 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004734 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004735 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004736 buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-02750",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004737 "vkCreateBufferView(): If buffer was created with usage containing "
4738 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004739 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4740 ") must be a multiple of the lesser of "
4741 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4742 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4743 "(%" PRId32
4744 ") is VK_TRUE, the size of a texel of the requested format. "
4745 "If the size of a texel is a multiple of three bytes, then the size of a "
4746 "single component of format is used instead",
4747 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4748 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4749 }
4750 }
4751 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004752 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05004753 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4754 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004755 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004756 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004757 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004758 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004759 buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-02751",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004760 "vkCreateBufferView(): If buffer was created with usage containing "
4761 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004762 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4763 ") must be a multiple of the lesser of "
4764 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4765 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4766 "(%" PRId32
4767 ") is VK_TRUE, the size of a texel of the requested format. "
4768 "If the size of a texel is a multiple of three bytes, then the size of a "
4769 "single component of format is used instead",
4770 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4771 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4772 }
4773 }
4774 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004775
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004776 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004777
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004778 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004779 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004780 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004781}
4782
Mark Lobodzinski602de982017-02-09 11:01:33 -07004783// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004784bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004785 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004786 bool skip = false;
sfricke-samsung79b00482020-04-01 21:15:50 -07004787 const IMAGE_STATE *image_state = GetImageState(image);
4788 // checks color format and (single-plane or non-disjoint)
4789 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
sfricke-samsung71bc6572020-04-29 15:49:43 -07004790 if ((FormatIsColor(format)) && ((FormatIsMultiplane(format) == false) || (image_state->disjoint == false))) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004791 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004792 skip |= LogError(
4793 image, vuid,
4794 "%s: Using format (%s) with aspect flags (%s) but color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.",
4795 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004796 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004797 skip |= LogError(image, vuid,
4798 "%s: Using format (%s) with aspect flags (%s) but color image formats must have ONLY the "
4799 "VK_IMAGE_ASPECT_COLOR_BIT set.",
4800 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004801 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004802 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004803 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004804 skip |= LogError(image, vuid,
sfricke-samsung7687a482021-01-29 23:19:22 -08004805 "%s: Using format (%s) with aspect flags (%s) but depth/stencil image formats must have at least one "
4806 "of VK_IMAGE_ASPECT_DEPTH_BIT and VK_IMAGE_ASPECT_STENCIL_BIT set.",
4807 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004808 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004809 skip |= LogError(image, vuid,
sfricke-samsung7687a482021-01-29 23:19:22 -08004810 "%s: Using format (%s) with aspect flags (%s) but combination depth/stencil image formats can have "
4811 "only the VK_IMAGE_ASPECT_DEPTH_BIT and VK_IMAGE_ASPECT_STENCIL_BIT set.",
4812 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004813 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004814 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004815 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004816 skip |= LogError(image, vuid,
4817 "%s: Using format (%s) with aspect flags (%s) but depth-only image formats must have the "
4818 "VK_IMAGE_ASPECT_DEPTH_BIT set.",
4819 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004820 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004821 skip |= LogError(image, vuid,
4822 "%s: Using format (%s) with aspect flags (%s) but depth-only image formats can have only the "
4823 "VK_IMAGE_ASPECT_DEPTH_BIT set.",
4824 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004825 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004826 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004827 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004828 skip |= LogError(image, vuid,
4829 "%s: Using format (%s) with aspect flags (%s) but stencil-only image formats must have the "
4830 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4831 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004832 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004833 skip |= LogError(image, vuid,
4834 "%s: Using format (%s) with aspect flags (%s) but stencil-only image formats can have only the "
4835 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4836 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004837 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004838 } else if (FormatIsMultiplane(format)) {
4839 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4840 if (3 == FormatPlaneCount(format)) {
4841 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4842 }
4843 if ((aspect_mask & valid_flags) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004844 skip |= LogError(image, vuid,
4845 "%s: Using format (%s) with aspect flags (%s) but multi-plane image formats may have only "
4846 "VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs set, where n = [0, 1, 2].",
4847 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Dave Houlton501b15b2018-03-30 15:07:41 -06004848 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004849 }
4850 return skip;
4851}
4852
ziga-lunarg04e94b32021-10-03 01:42:37 +02004853bool CoreChecks::ValidateImageAcquired(IMAGE_STATE const &image_state, const char *func_name) const {
4854 bool skip = false;
4855
4856 if (image_state.create_from_swapchain) {
4857 if (!image_state.bind_swapchain->images[image_state.swapchain_image_index].acquired) {
4858 skip |= LogError(image_state.Handle(), kVUID_Core_NonAcquiredSwapchainImageUsed,
4859 "%s: Image %s is a presentable image, but it is currently not acquired from swapchain.", func_name,
4860 report_data->FormatHandle(image_state.Handle()).c_str());
4861 }
4862 }
4863 return skip;
4864}
4865
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004866bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4867 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004868 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
Jeremy Gebben5573a8c2021-06-04 08:55:10 -06004869 const SubresourceRangeErrorCodes &errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004870 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004871
4872 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004873 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004874 skip |= LogError(image, errorCodes.base_mip_err,
4875 "%s: %s.baseMipLevel (= %" PRIu32
4876 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4877 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004878 }
Petr Kraus4d718682017-05-18 03:38:41 +02004879
Petr Krausffa94af2017-08-08 21:46:02 +02004880 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4881 if (subresourceRange.levelCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004882 skip |=
4883 LogError(image, "VUID-VkImageSubresourceRange-levelCount-01720", "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004884 } else {
4885 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004886
Petr Krausffa94af2017-08-08 21:46:02 +02004887 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004888 skip |= LogError(image, errorCodes.mip_count_err,
4889 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4890 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
4891 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
4892 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004893 }
Petr Kraus4d718682017-05-18 03:38:41 +02004894 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004895 }
Petr Kraus4d718682017-05-18 03:38:41 +02004896
4897 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004898 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004899 skip |= LogError(image, errorCodes.base_layer_err,
4900 "%s: %s.baseArrayLayer (= %" PRIu32
4901 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4902 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004903 }
Petr Kraus4d718682017-05-18 03:38:41 +02004904
Petr Krausffa94af2017-08-08 21:46:02 +02004905 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4906 if (subresourceRange.layerCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004907 skip |=
4908 LogError(image, "VUID-VkImageSubresourceRange-layerCount-01721", "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004909 } else {
4910 const uint64_t necessary_layer_count =
4911 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004912
Petr Krausffa94af2017-08-08 21:46:02 +02004913 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004914 skip |= LogError(image, errorCodes.layer_count_err,
4915 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4916 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
4917 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
4918 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004919 }
Petr Kraus4d718682017-05-18 03:38:41 +02004920 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004921 }
Petr Kraus4d718682017-05-18 03:38:41 +02004922
ziga-lunargb4e90752021-08-02 13:58:29 +02004923 if (subresourceRange.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
4924 if (subresourceRange.aspectMask &
4925 (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT)) {
4926 skip |= LogError(image, "VUID-VkImageSubresourceRange-aspectMask-01670",
4927 "%s: aspectMask includes both VK_IMAGE_ASPECT_COLOR_BIT and one of VK_IMAGE_ASPECT_PLANE_0_BIT, "
4928 "VK_IMAGE_ASPECT_PLANE_1_BIT, or VK_IMAGE_ASPECT_PLANE_2_BIT.",
4929 cmd_name);
4930 }
4931 }
4932
Mark Lobodzinski602de982017-02-09 11:01:33 -07004933 return skip;
4934}
4935
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004936bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004937 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004938 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004939 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
Mike Schuchardt2df08912020-12-15 16:28:09 -08004940 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004941 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 +02004942
David McFarland2853f2f2020-11-30 15:50:39 -04004943 uint32_t image_layer_count;
4944
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004945 if (is_3_d_to_2_d_map) {
David McFarland2853f2f2020-11-30 15:50:39 -04004946 const auto layers = LayersFromRange(subresourceRange);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06004947 const auto extent = image_state->GetSubresourceExtent(layers);
David McFarland2853f2f2020-11-30 15:50:39 -04004948 image_layer_count = extent.depth;
4949 } else {
4950 image_layer_count = image_state->createInfo.arrayLayers;
4951 }
4952
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004953 const auto image_layer_count_var_name = is_3_d_to_2_d_map ? "extent.depth" : "arrayLayers";
Petr Krausffa94af2017-08-08 21:46:02 +02004954
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004955 SubresourceRangeErrorCodes subresource_range_error_codes = {};
4956 subresource_range_error_codes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4957 subresource_range_error_codes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
4958 subresource_range_error_codes.base_layer_err =
4959 is_khr_maintenance1
4960 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-image-02724" : "VUID-VkImageViewCreateInfo-image-01482")
4961 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4962 subresource_range_error_codes.layer_count_err = is_khr_maintenance1
4963 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
4964 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4965 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004966
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004967 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004968 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004969 image_state->image(), subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02004970}
4971
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004972bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004973 const VkImageSubresourceRange &subresourceRange,
4974 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004975 SubresourceRangeErrorCodes subresource_range_error_codes = {};
4976 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4977 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4978 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4979 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004980
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004981 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004982 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image(),
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004983 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02004984}
4985
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004986bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004987 const VkImageSubresourceRange &subresourceRange,
4988 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004989 SubresourceRangeErrorCodes subresource_range_error_codes = {};
4990 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4991 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4992 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4993 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004994
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004995 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004996 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image(),
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004997 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02004998}
4999
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005000bool CoreChecks::ValidateImageBarrierSubresourceRange(const Location &loc, const IMAGE_STATE *image_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005001 const VkImageSubresourceRange &subresourceRange) const {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005002 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005003 loc.StringFunc().c_str(), loc.StringField().c_str(), "arrayLayers", image_state->image(),
Jeremy Gebbenbb845612021-02-18 18:16:05 -07005004 sync_vuid_maps::GetSubResourceVUIDs(loc));
Petr Krausffa94af2017-08-08 21:46:02 +02005005}
5006
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005007namespace barrier_queue_families {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005008using sync_vuid_maps::GetBarrierQueueVUID;
5009using sync_vuid_maps::kQueueErrorSummary;
5010using sync_vuid_maps::QueueError;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005011
5012class ValidatorState {
5013 public:
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005014 ValidatorState(const ValidationStateTracker *device_data, LogObjectList &&obj, const core_error::Location &location,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005015 const VulkanTypedHandle &barrier_handle, const VkSharingMode sharing_mode)
5016 : device_data_(device_data),
John Zulaufbea70432021-02-23 07:03:12 -07005017 objects_(std::move(obj)),
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005018 loc_(location),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005019 barrier_handle_(barrier_handle),
5020 sharing_mode_(sharing_mode),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005021 limit_(static_cast<uint32_t>(device_data->physical_device_state->queue_family_properties.size())),
5022 mem_ext_(IsExtEnabled(device_data->device_extensions.vk_khr_external_memory)) {}
5023
5024 // Log the messages using boilerplate from object state, and Vu specific information from the template arg
5025 // 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 -07005026 bool LogMsg(QueueError vu_index, uint32_t family, const char *param_name) const {
5027 const std::string val_code = GetBarrierQueueVUID(loc_, vu_index);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005028 const char *annotation = GetFamilyAnnotation(family);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005029 return device_data_->LogError(objects_, val_code, "%s Barrier using %s %s created with sharingMode %s, has %s %u%s. %s",
5030 loc_.Message().c_str(), GetTypeString(),
5031 device_data_->report_data->FormatHandle(barrier_handle_).c_str(), GetModeString(), param_name,
5032 family, annotation, kQueueErrorSummary.at(vu_index).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005033 }
5034
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005035 bool LogMsg(QueueError vu_index, uint32_t src_family, uint32_t dst_family) const {
5036 const std::string val_code = GetBarrierQueueVUID(loc_, vu_index);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005037 const char *src_annotation = GetFamilyAnnotation(src_family);
5038 const char *dst_annotation = GetFamilyAnnotation(dst_family);
5039 return device_data_->LogError(
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005040 objects_, val_code,
5041 "%s Barrier using %s %s created with sharingMode %s, has srcQueueFamilyIndex %u%s and dstQueueFamilyIndex %u%s. %s",
5042 loc_.Message().c_str(), GetTypeString(), device_data_->report_data->FormatHandle(barrier_handle_).c_str(),
5043 GetModeString(), src_family, src_annotation, dst_family, dst_annotation, kQueueErrorSummary.at(vu_index).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005044 }
5045
5046 // This abstract Vu can only be tested at submit time, thus we need a callback from the closure containing the needed
5047 // data. Note that the mem_barrier is copied to the closure as the lambda lifespan exceed the guarantees of validity for
5048 // application input.
5049 static bool ValidateAtQueueSubmit(const QUEUE_STATE *queue_state, const ValidationStateTracker *device_data,
5050 uint32_t src_family, uint32_t dst_family, const ValidatorState &val) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005051 auto error_code = QueueError::kSubmitQueueMustMatchSrcOrDst;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005052 uint32_t queue_family = queue_state->queueFamilyIndex;
5053 if ((src_family != queue_family) && (dst_family != queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005054 const std::string val_code = GetBarrierQueueVUID(val.loc_, error_code);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005055 const char *src_annotation = val.GetFamilyAnnotation(src_family);
5056 const char *dst_annotation = val.GetFamilyAnnotation(dst_family);
5057 return device_data->LogError(
Jeremy Gebben63f3cb02021-09-07 15:16:32 -06005058 queue_state->Handle(), val_code,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005059 "%s Barrier submitted to queue with family index %u, using %s %s created with sharingMode %s, has "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005060 "srcQueueFamilyIndex %u%s and dstQueueFamilyIndex %u%s. %s",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005061 val.loc_.Message().c_str(), queue_family, val.GetTypeString(),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005062 device_data->report_data->FormatHandle(val.barrier_handle_).c_str(), val.GetModeString(), src_family,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005063 src_annotation, dst_family, dst_annotation, kQueueErrorSummary.at(error_code).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005064 }
5065 return false;
5066 }
5067 // Logical helpers for semantic clarity
5068 inline bool KhrExternalMem() const { return mem_ext_; }
5069 inline bool IsValid(uint32_t queue_family) const { return (queue_family < limit_); }
5070 inline bool IsValidOrSpecial(uint32_t queue_family) const {
5071 return IsValid(queue_family) || (mem_ext_ && QueueFamilyIsExternal(queue_family));
5072 }
5073
5074 // Helpers for LogMsg
5075 const char *GetModeString() const { return string_VkSharingMode(sharing_mode_); }
5076
5077 // Descriptive text for the various types of queue family index
5078 const char *GetFamilyAnnotation(uint32_t family) const {
5079 const char *external = " (VK_QUEUE_FAMILY_EXTERNAL)";
5080 const char *foreign = " (VK_QUEUE_FAMILY_FOREIGN_EXT)";
5081 const char *ignored = " (VK_QUEUE_FAMILY_IGNORED)";
5082 const char *valid = " (VALID)";
5083 const char *invalid = " (INVALID)";
5084 switch (family) {
5085 case VK_QUEUE_FAMILY_EXTERNAL:
5086 return external;
5087 case VK_QUEUE_FAMILY_FOREIGN_EXT:
5088 return foreign;
5089 case VK_QUEUE_FAMILY_IGNORED:
5090 return ignored;
5091 default:
5092 if (IsValid(family)) {
5093 return valid;
5094 }
5095 return invalid;
5096 };
5097 }
5098 const char *GetTypeString() const { return object_string[barrier_handle_.type]; }
5099 VkSharingMode GetSharingMode() const { return sharing_mode_; }
5100
5101 protected:
5102 const ValidationStateTracker *device_data_;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005103 const LogObjectList objects_;
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005104 const core_error::Location loc_;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005105 const VulkanTypedHandle barrier_handle_;
5106 const VkSharingMode sharing_mode_;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005107 const uint32_t limit_;
5108 const bool mem_ext_;
5109};
5110
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005111bool Validate(const CoreChecks *device_data, const CMD_BUFFER_STATE *cb_state, const ValidatorState &val,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005112 const uint32_t src_queue_family, const uint32_t dst_queue_family) {
5113 bool skip = false;
5114
5115 const bool mode_concurrent = val.GetSharingMode() == VK_SHARING_MODE_CONCURRENT;
5116 const bool src_ignored = QueueFamilyIsIgnored(src_queue_family);
5117 const bool dst_ignored = QueueFamilyIsIgnored(dst_queue_family);
5118 if (val.KhrExternalMem()) {
5119 if (mode_concurrent) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005120 bool sync2 = device_data->enabled_features.synchronization2_features.synchronization2 != 0;
5121 // this requirement is removed by VK_KHR_synchronization2
5122 if (!(src_ignored || dst_ignored) && !sync2) {
5123 skip |= val.LogMsg(QueueError::kSrcOrDstMustBeIgnore, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005124 }
5125 if ((src_ignored && !(dst_ignored || QueueFamilyIsExternal(dst_queue_family))) ||
5126 (dst_ignored && !(src_ignored || QueueFamilyIsExternal(src_queue_family)))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005127 skip |= val.LogMsg(QueueError::kSpecialOrIgnoreOnly, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005128 }
5129 } else {
5130 // VK_SHARING_MODE_EXCLUSIVE
5131 if (src_queue_family != dst_queue_family) {
5132 if (!val.IsValidOrSpecial(dst_queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005133 skip |= val.LogMsg(QueueError::kSrcAndDstValidOrSpecial, dst_queue_family, "dstQueueFamilyIndex");
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005134 }
5135 if (!val.IsValidOrSpecial(src_queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005136 skip |= val.LogMsg(QueueError::kSrcAndDstValidOrSpecial, src_queue_family, "srcQueueFamilyIndex");
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005137 }
5138 }
5139 }
5140 } else {
5141 // No memory extension
5142 if (mode_concurrent) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005143 bool sync2 = device_data->enabled_features.synchronization2_features.synchronization2 != 0;
5144 // this requirement is removed by VK_KHR_synchronization2
5145 if ((!src_ignored || !dst_ignored) && !sync2) {
5146 skip |= val.LogMsg(QueueError::kSrcAndDestMustBeIgnore, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005147 }
5148 } else {
5149 // VK_SHARING_MODE_EXCLUSIVE
5150 if ((src_queue_family != dst_queue_family) && !(val.IsValid(src_queue_family) && val.IsValid(dst_queue_family))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005151 skip |= val.LogMsg(QueueError::kSrcAndDstBothValid, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005152 }
5153 }
5154 }
5155 return skip;
5156}
5157} // namespace barrier_queue_families
5158
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005159bool CoreChecks::ValidateConcurrentBarrierAtSubmit(const Location &loc, const ValidationStateTracker *state_data,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005160 const QUEUE_STATE *queue_state, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005161 const VulkanTypedHandle &typed_handle, uint32_t src_queue_family,
5162 uint32_t dst_queue_family) {
5163 using barrier_queue_families::ValidatorState;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005164 ValidatorState val(state_data, LogObjectList(cb_state->commandBuffer()), loc, typed_handle, VK_SHARING_MODE_CONCURRENT);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005165 return ValidatorState::ValidateAtQueueSubmit(queue_state, state_data, src_queue_family, dst_queue_family, val);
5166}
5167
5168// Type specific wrapper for image barriers
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005169template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005170bool CoreChecks::ValidateBarrierQueueFamilies(const Location &loc, const CMD_BUFFER_STATE *cb_state, const ImgBarrier &barrier,
5171 const IMAGE_STATE *state_data) const {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005172 // State data is required
5173 if (!state_data) {
5174 return false;
5175 }
5176
5177 // Create the validator state from the image state
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005178 barrier_queue_families::ValidatorState val(this, LogObjectList(cb_state->commandBuffer()), loc,
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06005179 state_data->Handle(), state_data->createInfo.sharingMode);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005180 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
5181 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005182 return barrier_queue_families::Validate(this, cb_state, val, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005183}
5184
5185// Type specific wrapper for buffer barriers
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005186template <typename BufBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005187bool CoreChecks::ValidateBarrierQueueFamilies(const Location &loc, const CMD_BUFFER_STATE *cb_state, const BufBarrier &barrier,
5188 const BUFFER_STATE *state_data) const {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005189 // State data is required
5190 if (!state_data) {
5191 return false;
5192 }
5193
5194 // Create the validator state from the buffer state
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005195 barrier_queue_families::ValidatorState val(this, LogObjectList(cb_state->commandBuffer()), loc,
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06005196 state_data->Handle(), state_data->createInfo.sharingMode);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005197 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
5198 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005199 return barrier_queue_families::Validate(this, cb_state, val, src_queue_family, dst_queue_family);
5200}
5201
5202template <typename Barrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005203bool CoreChecks::ValidateBufferBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005204 const Barrier &mem_barrier) const {
5205 using sync_vuid_maps::BufferError;
5206 using sync_vuid_maps::GetBufferBarrierVUID;
5207
5208 bool skip = false;
5209
5210 skip |= ValidateQFOTransferBarrierUniqueness(loc, cb_state, mem_barrier, cb_state->qfo_transfer_buffer_barriers);
5211
5212 // Validate buffer barrier queue family indices
5213 auto buffer_state = GetBufferState(mem_barrier.buffer);
5214 if (buffer_state) {
5215 auto buf_loc = loc.dot(Field::buffer);
5216 const auto &mem_vuid = GetBufferBarrierVUID(buf_loc, BufferError::kNoMemory);
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005217 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, loc.StringFunc().c_str(), mem_vuid.c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005218
5219 skip |= ValidateBarrierQueueFamilies(buf_loc, cb_state, mem_barrier, buffer_state);
5220
5221 auto buffer_size = buffer_state->createInfo.size;
5222 if (mem_barrier.offset >= buffer_size) {
5223 auto offset_loc = loc.dot(Field::offset);
5224 const auto &vuid = GetBufferBarrierVUID(offset_loc, BufferError::kOffsetTooBig);
5225
5226 skip |= LogError(objects, vuid, "%s %s has offset 0x%" PRIx64 " which is not less than total size 0x%" PRIx64 ".",
5227 offset_loc.Message().c_str(), report_data->FormatHandle(mem_barrier.buffer).c_str(),
5228 HandleToUint64(mem_barrier.offset), HandleToUint64(buffer_size));
5229 } else if (mem_barrier.size != VK_WHOLE_SIZE && (mem_barrier.offset + mem_barrier.size > buffer_size)) {
5230 auto size_loc = loc.dot(Field::size);
5231 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kSizeOutOfRange);
5232 skip |= LogError(objects, vuid,
5233 "%s %s has offset 0x%" PRIx64 " and size 0x%" PRIx64 " whose sum is greater than total size 0x%" PRIx64
5234 ".",
5235 size_loc.Message().c_str(), report_data->FormatHandle(mem_barrier.buffer).c_str(),
5236 HandleToUint64(mem_barrier.offset), HandleToUint64(mem_barrier.size), HandleToUint64(buffer_size));
5237 }
5238 if (mem_barrier.size == 0) {
5239 auto size_loc = loc.dot(Field::size);
5240 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kSizeZero);
5241 skip |= LogError(objects, vuid, "%s %s has a size of 0.", loc.Message().c_str(),
5242 report_data->FormatHandle(mem_barrier.buffer).c_str());
5243 }
5244 }
5245 return skip;
5246}
5247
5248template <typename Barrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005249bool CoreChecks::ValidateImageBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005250 const Barrier &mem_barrier) const {
5251 bool skip = false;
5252
5253 skip |= ValidateQFOTransferBarrierUniqueness(loc, cb_state, mem_barrier, cb_state->qfo_transfer_image_barriers);
5254
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005255 bool is_ilt = true;
5256 if (enabled_features.synchronization2_features.synchronization2) {
5257 is_ilt = mem_barrier.oldLayout != mem_barrier.newLayout;
5258 }
5259
5260 if (is_ilt) {
5261 if (mem_barrier.newLayout == VK_IMAGE_LAYOUT_UNDEFINED || mem_barrier.newLayout == VK_IMAGE_LAYOUT_PREINITIALIZED) {
5262 auto layout_loc = loc.dot(Field::newLayout);
5263 const auto &vuid = sync_vuid_maps::GetImageBarrierVUID(loc, sync_vuid_maps::ImageError::kBadLayout);
5264 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005265 LogError(cb_state->commandBuffer(), vuid, "%s Image Layout cannot be transitioned to UNDEFINED or PREINITIALIZED.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005266 layout_loc.Message().c_str());
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005267 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005268 }
5269
5270 auto image_data = GetImageState(mem_barrier.image);
5271 if (image_data) {
5272 auto image_loc = loc.dot(Field::image);
5273
John Zulaufbea70432021-02-23 07:03:12 -07005274 skip |= ValidateMemoryIsBoundToImage(image_data, loc);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005275
5276 skip |= ValidateBarrierQueueFamilies(image_loc, cb_state, mem_barrier, image_data);
5277
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005278 skip |= ValidateImageAspectMask(image_data->image(), image_data->createInfo.format, mem_barrier.subresourceRange.aspectMask,
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005279 loc.StringFunc().c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005280
5281 skip |= ValidateImageBarrierSubresourceRange(loc.dot(Field::subresourceRange), image_data, mem_barrier.subresourceRange);
ziga-lunarg04e94b32021-10-03 01:42:37 +02005282 skip |= ValidateImageAcquired(*image_data, loc.StringFunc().c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005283 }
5284 return skip;
5285}
5286
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005287bool CoreChecks::ValidateBarriers(const Location &outer_loc, const CMD_BUFFER_STATE *cb_state, VkPipelineStageFlags src_stage_mask,
5288 VkPipelineStageFlags dst_stage_mask, uint32_t memBarrierCount,
5289 const VkMemoryBarrier *pMemBarriers, uint32_t bufferBarrierCount,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005290 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
5291 const VkImageMemoryBarrier *pImageMemBarriers) const {
5292 bool skip = false;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005293 LogObjectList objects(cb_state->commandBuffer());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005294
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005295 for (uint32_t i = 0; i < memBarrierCount; ++i) {
5296 const auto &mem_barrier = pMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005297 auto loc = outer_loc.dot(Struct::VkMemoryBarrier, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005298 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005299 }
5300 for (uint32_t i = 0; i < imageMemBarrierCount; ++i) {
5301 const auto &mem_barrier = pImageMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005302 auto loc = outer_loc.dot(Struct::VkImageMemoryBarrier, Field::pImageMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005303 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005304 skip |= ValidateImageBarrier(objects, loc, cb_state, mem_barrier);
5305 }
5306 {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005307 Location loc(outer_loc.function, Struct::VkImageMemoryBarrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005308 skip |= ValidateBarriersToImages(loc, cb_state, imageMemBarrierCount, pImageMemBarriers);
5309 }
5310 for (uint32_t i = 0; i < bufferBarrierCount; ++i) {
5311 const auto &mem_barrier = pBufferMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005312 auto loc = outer_loc.dot(Struct::VkBufferMemoryBarrier, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005313 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005314 skip |= ValidateBufferBarrier(objects, loc, cb_state, mem_barrier);
5315 }
5316 return skip;
5317}
5318
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005319bool CoreChecks::ValidateDependencyInfo(const LogObjectList &objects, const Location &outer_loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbenefead332021-06-18 08:22:44 -06005320 const VkDependencyInfoKHR *dep_info) const {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005321 bool skip = false;
5322
5323 if (cb_state->activeRenderPass) {
5324 skip |= ValidateRenderPassPipelineBarriers(outer_loc, cb_state, dep_info);
5325 if (skip) return true; // Early return to avoid redundant errors from below calls
5326 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005327 for (uint32_t i = 0; i < dep_info->memoryBarrierCount; ++i) {
5328 const auto &mem_barrier = dep_info->pMemoryBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005329 auto loc = outer_loc.dot(Struct::VkMemoryBarrier2KHR, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005330 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005331 }
5332 for (uint32_t i = 0; i < dep_info->imageMemoryBarrierCount; ++i) {
5333 const auto &mem_barrier = dep_info->pImageMemoryBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005334 auto loc = outer_loc.dot(Struct::VkImageMemoryBarrier2KHR, Field::pImageMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005335 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005336 skip |= ValidateImageBarrier(objects, loc, cb_state, mem_barrier);
5337 }
5338 {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005339 Location loc(outer_loc.function, Struct::VkImageMemoryBarrier2KHR);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005340 skip |= ValidateBarriersToImages(loc, cb_state, dep_info->imageMemoryBarrierCount, dep_info->pImageMemoryBarriers);
5341 }
5342
5343 for (uint32_t i = 0; i < dep_info->bufferMemoryBarrierCount; ++i) {
5344 const auto &mem_barrier = dep_info->pBufferMemoryBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005345 auto loc = outer_loc.dot(Struct::VkBufferMemoryBarrier2KHR, Field::pBufferMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005346 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005347 skip |= ValidateBufferBarrier(objects, loc, cb_state, mem_barrier);
5348 }
5349
5350 return skip;
5351}
5352
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005353// template to check all original barrier structures
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005354template <typename Barrier>
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005355bool CoreChecks::ValidateMemoryBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
5356 const Barrier &barrier, VkPipelineStageFlags src_stage_mask,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005357 VkPipelineStageFlags dst_stage_mask) const {
5358 bool skip = false;
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005359 assert(cb_state);
5360 auto queue_flags = cb_state->GetQueueFlags();
5361
5362 if (!cb_state->IsAcquireOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005363 skip |= ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), queue_flags, barrier.srcAccessMask, src_stage_mask);
5364 }
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005365 if (!cb_state->IsReleaseOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005366 skip |= ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), queue_flags, barrier.dstAccessMask, dst_stage_mask);
5367 }
5368 return skip;
5369}
5370
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005371// template to check all synchronization2 barrier structures
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005372template <typename Barrier>
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005373bool CoreChecks::ValidateMemoryBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
5374 const Barrier &barrier) const {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005375 bool skip = false;
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005376 assert(cb_state);
5377 auto queue_flags = cb_state->GetQueueFlags();
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005378
Jeremy Gebbenefead332021-06-18 08:22:44 -06005379 skip |= ValidatePipelineStage(objects, loc.dot(Field::srcStageMask), queue_flags, barrier.srcStageMask);
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005380 if (!cb_state->IsAcquireOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005381 skip |=
5382 ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), queue_flags, barrier.srcAccessMask, barrier.srcStageMask);
5383 }
Jeremy Gebbenefead332021-06-18 08:22:44 -06005384
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005385 skip |= ValidatePipelineStage(objects, loc.dot(Field::dstStageMask), queue_flags, barrier.dstStageMask);
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005386 if (!cb_state->IsReleaseOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005387 skip |=
5388 ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), queue_flags, barrier.dstAccessMask, barrier.dstStageMask);
5389 }
5390 return skip;
5391}
5392
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005393// VkSubpassDependency validation happens when vkCreateRenderPass() is called.
5394// Dependencies between subpasses can only use pipeline stages compatible with VK_QUEUE_GRAPHICS_BIT,
5395// for external subpasses we don't have a yet command buffer so we have to assume all of them are valid.
5396static inline VkQueueFlags SubpassToQueueFlags(uint32_t subpass) {
5397 return subpass == VK_SUBPASS_EXTERNAL ? sync_utils::kAllQueueTypes : static_cast<VkQueueFlags>(VK_QUEUE_GRAPHICS_BIT);
5398}
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005399
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005400bool CoreChecks::ValidateSubpassDependency(const LogObjectList &objects, const Location &in_loc,
5401 const VkSubpassDependency2 &dependency) const {
5402 bool skip = false;
5403 Location loc = in_loc;
5404 VkMemoryBarrier2KHR converted_barrier;
5405 const auto *mem_barrier = LvlFindInChain<VkMemoryBarrier2KHR>(dependency.pNext);
5406
5407 if (mem_barrier && enabled_features.synchronization2_features.synchronization2) {
5408 if (dependency.srcAccessMask != 0) {
5409 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-srcAccessMask",
5410 "%s is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5411 loc.dot(Field::srcAccessMask).Message().c_str());
5412 }
5413 if (dependency.dstAccessMask != 0) {
5414 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-dstAccessMask",
5415 "%s dstAccessMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5416 loc.dot(Field::dstAccessMask).Message().c_str());
5417 }
5418 if (dependency.srcStageMask != 0) {
5419 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-srcStageMask",
5420 "%s srcStageMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5421 loc.dot(Field::srcStageMask).Message().c_str());
5422 }
5423 if (dependency.dstStageMask != 0) {
5424 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-dstStageMask",
5425 "%s dstStageMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5426 loc.dot(Field::dstStageMask).Message().c_str());
5427 }
5428 loc = in_loc.dot(Field::pNext);
5429 converted_barrier = *mem_barrier;
5430 } else {
5431 if (mem_barrier) {
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005432 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-pNext",
5433 "%s a VkMemoryBarrier2KHR is present in pNext but synchronization2 is not enabled.",
5434 loc.Message().c_str());
5435 }
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005436 // use the subpass dependency flags, upconverted into wider synchronization2 fields.
5437 converted_barrier.srcStageMask = dependency.srcStageMask;
5438 converted_barrier.dstStageMask = dependency.dstStageMask;
5439 converted_barrier.srcAccessMask = dependency.srcAccessMask;
5440 converted_barrier.dstAccessMask = dependency.dstAccessMask;
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005441 }
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005442 auto src_queue_flags = SubpassToQueueFlags(dependency.srcSubpass);
5443 skip |= ValidatePipelineStage(objects, loc.dot(Field::srcStageMask), src_queue_flags, converted_barrier.srcStageMask);
5444 skip |= ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), src_queue_flags, converted_barrier.srcAccessMask,
5445 converted_barrier.srcStageMask);
5446
5447 auto dst_queue_flags = SubpassToQueueFlags(dependency.dstSubpass);
5448 skip |= ValidatePipelineStage(objects, loc.dot(Field::dstStageMask), dst_queue_flags, converted_barrier.dstStageMask);
5449 skip |= ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), dst_queue_flags, converted_barrier.dstAccessMask,
5450 converted_barrier.dstStageMask);
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005451 return skip;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005452}
5453
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005454bool CoreChecks::ValidateImageViewFormatFeatures(const IMAGE_STATE *image_state, const VkFormat view_format,
5455 const VkImageUsageFlags image_usage) const {
5456 // Pass in image_usage here instead of extracting it from image_state in case there's a chained VkImageViewUsageCreateInfo
5457 bool skip = false;
5458
5459 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
5460 const VkImageTiling image_tiling = image_state->createInfo.tiling;
5461
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06005462 if (image_state->HasAHBFormat()) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005463 // AHB image view and image share same feature sets
5464 tiling_features = image_state->format_features;
5465 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5466 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
sfricke-samsung45996a42021-09-16 13:45:27 -07005467 assert(IsExtEnabled(device_extensions.vk_ext_image_drm_format_modifier));
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005468 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = {VK_STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_PROPERTIES_EXT,
5469 nullptr};
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005470 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image_state->image(), &drm_format_properties);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005471
5472 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
5473 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
5474 nullptr};
5475 format_properties_2.pNext = (void *)&drm_properties_list;
5476 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
5477
nyorain38a9d232021-03-06 13:06:12 +01005478 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
5479 drm_properties.resize(drm_properties_list.drmFormatModifierCount);
5480 drm_properties_list.pDrmFormatModifierProperties = drm_properties.data();
5481
5482 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
5483
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005484 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
5485 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_properties.drmFormatModifier) !=
5486 0) {
5487 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
5488 }
5489 }
5490 } else {
5491 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
5492 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
5493 : format_properties.optimalTilingFeatures;
5494 }
5495
5496 if (tiling_features == 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005497 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-None-02273",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005498 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
5499 "physical device.",
5500 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5501 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005502 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02274",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005503 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5504 "VK_IMAGE_USAGE_SAMPLED_BIT.",
5505 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5506 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005507 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02275",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005508 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5509 "VK_IMAGE_USAGE_STORAGE_BIT.",
5510 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5511 } 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 -06005512 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02276",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005513 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5514 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
5515 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5516 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
5517 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005518 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02277",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005519 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5520 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5521 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5522 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
5523 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005524 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02652",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005525 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5526 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5527 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Tobias Hector6663c9b2020-11-05 10:18:02 +00005528 } else if ((image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) &&
5529 !(tiling_features & VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR)) {
5530 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005531 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-04550",
Tobias Hector6663c9b2020-11-05 10:18:02 +00005532 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5533 "VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR.",
5534 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5535 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005536 }
5537
5538 return skip;
5539}
5540
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005541bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005542 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005543 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005544 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005545 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005546 skip |=
5547 ValidateImageUsageFlags(image_state,
5548 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
5549 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
sfricke-samsungbb971942020-09-10 22:11:56 -07005550 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV |
5551 VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
5552 false, "VUID-VkImageViewCreateInfo-image-04441", "vkCreateImageView()",
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005553 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
sfricke-samsungbb971942020-09-10 22:11:56 -07005554 "TRANSIENT_ATTACHMENT|SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005555 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005556 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005557 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02005558 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005559 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005560 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005561
5562 VkImageCreateFlags image_flags = image_state->createInfo.flags;
5563 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005564 VkImageUsageFlags image_usage = image_state->createInfo.usage;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005565 VkFormat view_format = pCreateInfo->format;
5566 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06005567 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005568 VkImageViewType view_type = pCreateInfo->viewType;
sfricke-samsung20a8a372021-07-14 06:12:17 -07005569 uint32_t layer_count = pCreateInfo->subresourceRange.layerCount;
Mark Lobodzinski602de982017-02-09 11:01:33 -07005570
Dave Houltonbd2e2622018-04-10 16:41:14 -06005571 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005572 auto chained_ivuci_struct = LvlFindInChain<VkImageViewUsageCreateInfo>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06005573 if (chained_ivuci_struct) {
sfricke-samsung45996a42021-09-16 13:45:27 -07005574 if (IsExtEnabled(device_extensions.vk_khr_maintenance2)) {
5575 if (!IsExtEnabled(device_extensions.vk_ext_separate_stencil_usage)) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05005576 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005577 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
5578 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
5579 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05005580 }
5581 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005582 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05005583 if (image_stencil_struct == nullptr) {
5584 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005585 skip |= LogError(
5586 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005587 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
5588 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
5589 "any bits that were not set in VkImageCreateInfo::usage used to create image");
5590 }
5591 } else {
5592 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
5593 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
5594 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005595 skip |= LogError(
5596 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005597 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5598 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5599 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
5600 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
5601 }
5602 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
5603 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005604 skip |= LogError(
5605 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005606 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5607 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5608 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
5609 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
5610 }
5611 }
5612 }
5613 }
5614
Dave Houltonbd2e2622018-04-10 16:41:14 -06005615 image_usage = chained_ivuci_struct->usage;
5616 }
5617
sfricke-samsungf60b6c82021-04-05 22:59:20 -07005618 // If image used VkImageFormatListCreateInfo need to make sure a format from list is used
5619 const auto format_list_info = LvlFindInChain<VkImageFormatListCreateInfo>(image_state->createInfo.pNext);
5620 if (format_list_info && (format_list_info->viewFormatCount > 0)) {
5621 bool foundFormat = false;
5622 for (uint32_t i = 0; i < format_list_info->viewFormatCount; i++) {
5623 if (format_list_info->pViewFormats[i] == view_format) {
5624 foundFormat = true;
5625 break;
5626 }
5627 }
5628 if (foundFormat == false) {
5629 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-01585",
5630 "vkCreateImageView(): image was created with a VkImageFormatListCreateInfo in pNext of "
5631 "vkImageCreateInfo, but none of the formats match the VkImageViewCreateInfo::format (%s).",
5632 string_VkFormat(view_format));
5633 }
5634 }
5635
Dave Houlton6f5f20a2018-05-04 12:37:44 -06005636 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
5637 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005638 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01005639 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06005640 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01005641 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06005642 std::stringstream ss;
5643 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01005644 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06005645 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005646 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005647 }
5648 } else {
Mike Schuchardt2df08912020-12-15 16:28:09 -08005649 if (!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005650 // 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 -07005651 const VkFormatCompatibilityClass imageClass = FormatCompatibilityClass(image_format);
5652 const VkFormatCompatibilityClass viewClass = FormatCompatibilityClass(view_format);
5653 // Need to only check if one is NONE_BIT to handle edge case both are NONE_BIT
5654 if ((imageClass != viewClass) || (imageClass == VK_FORMAT_COMPATIBILITY_CLASS_NONE_BIT)) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005655 const char *error_vuid;
sfricke-samsung45996a42021-09-16 13:45:27 -07005656 if ((!IsExtEnabled(device_extensions.vk_khr_maintenance2)) &&
5657 (!IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion))) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005658 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
sfricke-samsung45996a42021-09-16 13:45:27 -07005659 } else if ((IsExtEnabled(device_extensions.vk_khr_maintenance2)) &&
5660 (!IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion))) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005661 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
sfricke-samsung45996a42021-09-16 13:45:27 -07005662 } else if ((!IsExtEnabled(device_extensions.vk_khr_maintenance2)) &&
5663 (IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion))) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005664 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
5665 } else {
5666 // both enabled
5667 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
5668 }
Dave Houltonc7988072018-04-16 11:46:56 -06005669 std::stringstream ss;
5670 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06005671 << " is not in the same format compatibility class as "
5672 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06005673 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
5674 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005675 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005676 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06005677 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005678 }
5679 } else {
5680 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07005681 // Unless it is a multi-planar color bit aspect
5682 if ((image_format != view_format) &&
5683 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
sfricke-samsung45996a42021-09-16 13:45:27 -07005684 const char *vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
5685 ? "VUID-VkImageViewCreateInfo-image-01762"
5686 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07005687 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06005688 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07005689 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07005690 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07005691 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005692 }
5693 }
5694
ziga-lunargebb32de2021-08-29 21:24:30 +02005695 if (image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT && view_type != VK_IMAGE_VIEW_TYPE_2D &&
5696 view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5697 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04972",
5698 "vkCreateImageView(): image was created with sample count %s, but pCreateInfo->viewType is %s.",
5699 string_VkSampleCountFlagBits(image_state->createInfo.samples), string_VkImageViewType(view_type));
5700 }
5701
Mark Lobodzinski602de982017-02-09 11:01:33 -07005702 // Validate correct image aspect bits for desired formats and format consistency
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005703 skip |= ValidateImageAspectMask(image_state->image(), image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06005704
sfricke-samsung20a8a372021-07-14 06:12:17 -07005705 // Valdiate Image/ImageView type compatibility #resources-image-views-compatibility
Jeremy Kniager846ab732017-07-10 13:12:04 -06005706 switch (image_type) {
5707 case VK_IMAGE_TYPE_1D:
5708 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005709 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5710 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5711 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005712 }
5713 break;
5714 case VK_IMAGE_TYPE_2D:
5715 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5716 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
5717 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005718 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
5719 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5720 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005721 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005722 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5723 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5724 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005725 }
5726 }
5727 break;
5728 case VK_IMAGE_TYPE_3D:
sfricke-samsung45996a42021-09-16 13:45:27 -07005729 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06005730 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
5731 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08005732 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005733 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005734 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
sfricke-samsungd9b3e122021-07-15 22:50:00 -07005735 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type "
5736 "%s since the image doesn't have VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT flag set.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005737 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005738 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
5739 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005740 skip |= LogError(
sfricke-samsungd9b3e122021-07-15 22:50:00 -07005741 pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04971",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005742 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
5743 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
5744 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
5745 string_VkImageViewType(view_type), string_VkImageType(image_type));
sfricke-samsungd9b3e122021-07-15 22:50:00 -07005746 } else if (pCreateInfo->subresourceRange.levelCount != 1) {
5747 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04970",
5748 "vkCreateImageView(): pCreateInfo->viewType %s is with image type %s must have a "
5749 "levelCount of 1 but it is %u.",
5750 string_VkImageViewType(view_type), string_VkImageType(image_type),
5751 pCreateInfo->subresourceRange.levelCount);
Jeremy Kniager846ab732017-07-10 13:12:04 -06005752 }
5753 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005754 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5755 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5756 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005757 }
5758 }
5759 } else {
5760 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
sfricke-samsungd9b3e122021-07-15 22:50:00 -07005761 // Help point to VK_KHR_maintenance1
5762 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
5763 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5764 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
5765 "without VK_KHR_maintenance1 enabled which was promoted in Vulkan 1.0.",
5766 string_VkImageViewType(view_type), string_VkImageType(image_type));
5767 } else {
5768 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5769 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5770 string_VkImageViewType(view_type), string_VkImageType(image_type));
5771 }
Jeremy Kniager846ab732017-07-10 13:12:04 -06005772 }
5773 }
5774 break;
5775 default:
5776 break;
5777 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005778
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005779 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
sfricke-samsung45996a42021-09-16 13:45:27 -07005780 if (IsExtEnabled(device_extensions.vk_android_external_memory_android_hardware_buffer)) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005781 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005782 }
5783
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005784 skip |= ValidateImageViewFormatFeatures(image_state, view_format, image_usage);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005785
sfricke-samsung828e59d2021-08-22 23:20:49 -07005786 if (enabled_features.shading_rate_image_features.shadingRateImage) {
Tobias Hector6663c9b2020-11-05 10:18:02 +00005787 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
5788 if (view_format != VK_FORMAT_R8_UINT) {
5789 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
5790 "vkCreateImageView() If image was created with usage containing "
5791 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
5792 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05005793 }
Tobias Hector6663c9b2020-11-05 10:18:02 +00005794 }
5795
sfricke-samsung828e59d2021-08-22 23:20:49 -07005796 if (enabled_features.shading_rate_image_features.shadingRateImage ||
Tobias Hector6663c9b2020-11-05 10:18:02 +00005797 enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
5798 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) {
5799 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5800 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
5801 "vkCreateImageView() If image was created with usage containing "
5802 "VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR, viewType must be "
5803 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
5804 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05005805 }
5806 }
Jeff Bolz99e3f632020-03-24 22:59:22 -05005807
Tobias Hector6663c9b2020-11-05 10:18:02 +00005808 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate &&
5809 !phys_dev_ext_props.fragment_shading_rate_props.layeredShadingRateAttachments &&
sfricke-samsung20a8a372021-07-14 06:12:17 -07005810 image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR && layer_count != 1) {
Tobias Hector6663c9b2020-11-05 10:18:02 +00005811 skip |= LogError(device, "VUID-VkImageViewCreateInfo-usage-04551",
5812 "vkCreateImageView(): subresourceRange.layerCount is %u for a shading rate attachment image view.",
sfricke-samsung20a8a372021-07-14 06:12:17 -07005813 layer_count);
Tobias Hector6663c9b2020-11-05 10:18:02 +00005814 }
5815
sfricke-samsung20a8a372021-07-14 06:12:17 -07005816 if (layer_count == VK_REMAINING_ARRAY_LAYERS) {
5817 const uint32_t remaining_layers = image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer;
5818 if (view_type == VK_IMAGE_VIEW_TYPE_CUBE && remaining_layers != 6) {
Jeff Bolz99e3f632020-03-24 22:59:22 -05005819 skip |= LogError(device, "VUID-VkImageViewCreateInfo-viewType-02962",
5820 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be 6",
sfricke-samsung20a8a372021-07-14 06:12:17 -07005821 remaining_layers);
Jeff Bolz99e3f632020-03-24 22:59:22 -05005822 }
sfricke-samsung20a8a372021-07-14 06:12:17 -07005823 if (view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY && ((remaining_layers) % 6) != 0) {
Jeff Bolz99e3f632020-03-24 22:59:22 -05005824 skip |= LogError(
5825 device, "VUID-VkImageViewCreateInfo-viewType-02963",
5826 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be a multiple of 6",
sfricke-samsung20a8a372021-07-14 06:12:17 -07005827 remaining_layers);
5828 }
5829 if ((remaining_layers != 1) && ((view_type == VK_IMAGE_VIEW_TYPE_1D) || (view_type == VK_IMAGE_VIEW_TYPE_2D) ||
5830 (view_type == VK_IMAGE_VIEW_TYPE_3D))) {
5831 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-imageViewType-04974",
5832 "vkCreateImageView(): Using pCreateInfo->viewType %s and the subresourceRange.layerCount "
5833 "VK_REMAINING_ARRAY_LAYERS=(%d) and must 1 (try looking into VK_IMAGE_VIEW_TYPE_*_ARRAY).",
5834 string_VkImageViewType(view_type), remaining_layers);
5835 }
5836 } else {
5837 if ((layer_count != 1) && ((view_type == VK_IMAGE_VIEW_TYPE_1D) || (view_type == VK_IMAGE_VIEW_TYPE_2D) ||
5838 (view_type == VK_IMAGE_VIEW_TYPE_3D))) {
5839 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-imageViewType-04973",
5840 "vkCreateImageView(): Using pCreateInfo->viewType %s and the subresourceRange.layerCount is %d "
5841 "and must 1 (try looking into VK_IMAGE_VIEW_TYPE_*_ARRAY).",
5842 string_VkImageViewType(view_type), layer_count);
Jeff Bolz99e3f632020-03-24 22:59:22 -05005843 }
5844 }
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005845
5846 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5847 if (pCreateInfo->subresourceRange.levelCount != 1) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005848 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02571",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005849 "vkCreateImageView(): If image was created with usage containing "
5850 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, subresourceRange.levelCount (%d) must: be 1",
5851 pCreateInfo->subresourceRange.levelCount);
5852 }
5853 }
5854 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5855 if (!enabled_features.fragment_density_map_features.fragmentDensityMapDynamic) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005856 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-02572",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005857 "vkCreateImageView(): If the fragmentDensityMapDynamic feature is not enabled, "
5858 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5859 }
5860 } else {
5861 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5862 if (image_flags & (VK_IMAGE_CREATE_PROTECTED_BIT | VK_IMAGE_CREATE_SPARSE_BINDING_BIT |
5863 VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT)) {
Shannon McPherson8d0d1f92020-07-06 11:58:21 -06005864 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-04116",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005865 "vkCreateImageView(): If image was created with usage containing "
5866 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT flags must not contain any of "
5867 "VK_IMAGE_CREATE_PROTECTED_BIT, VK_IMAGE_CREATE_SPARSE_BINDING_BIT, "
5868 "VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or VK_IMAGE_CREATE_SPARSE_ALIASED_BIT");
5869 }
5870 }
5871 }
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005872
ziga-lunarg966ac0e2021-07-18 11:51:44 +02005873 if (image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
5874 if (pCreateInfo->subresourceRange.levelCount != 1) {
5875 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01584",
5876 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit, "
5877 "but subresourcesRange.levelCount (%" PRIu32 ") is not 1.",
5878 pCreateInfo->subresourceRange.levelCount);
5879 }
5880 if (pCreateInfo->subresourceRange.layerCount != 1) {
5881 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01584",
5882 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit, "
5883 "but subresourcesRange.layerCount (%" PRIu32 ") is not 1.",
5884 pCreateInfo->subresourceRange.layerCount);
5885 }
5886 }
5887
Nathaniel Cesario42d5b282021-08-17 12:47:24 -06005888 if (image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT && !FormatIsCompressed(view_format) &&
ziga-lunargc290c7f2021-07-31 22:01:46 +02005889 pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_3D) {
5890 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04739",
5891 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit and "
5892 "non-compressed format (%s), but pCreateInfo->viewType is VK_IMAGE_VIEW_TYPE_3D.",
5893 string_VkFormat(image_format));
5894 }
5895
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005896 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT) {
5897 if (!enabled_features.fragment_density_map2_features.fragmentDensityMapDeferred) {
5898 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03567",
5899 "vkCreateImageView(): If the fragmentDensityMapDeferred feature is not enabled, "
5900 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT");
5901 }
5902 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5903 skip |=
5904 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03568",
5905 "vkCreateImageView(): If flags contains VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT, "
5906 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5907 }
5908 }
sfricke-samsung45996a42021-09-16 13:45:27 -07005909 if (IsExtEnabled(device_extensions.vk_ext_fragment_density_map2)) {
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005910 if ((image_flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) && (image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) &&
sfricke-samsung20a8a372021-07-14 06:12:17 -07005911 (layer_count > phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers)) {
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005912 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-03569",
5913 "vkCreateImageView(): If image was created with flags containing "
5914 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT and usage containing VK_IMAGE_USAGE_SAMPLED_BIT "
5915 "subresourceRange.layerCount (%d) must: be less than or equal to maxSubsampledArrayLayers (%d)",
sfricke-samsung20a8a372021-07-14 06:12:17 -07005916 layer_count, phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers);
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005917 }
5918 }
5919
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005920 auto astc_decode_mode = LvlFindInChain<VkImageViewASTCDecodeModeEXT>(pCreateInfo->pNext);
sfricke-samsung45996a42021-09-16 13:45:27 -07005921 if (IsExtEnabled(device_extensions.vk_ext_astc_decode_mode) && (astc_decode_mode != nullptr)) {
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005922 if ((enabled_features.astc_decode_features.decodeModeSharedExponent == VK_FALSE) &&
5923 (astc_decode_mode->decodeMode == VK_FORMAT_E5B9G9R9_UFLOAT_PACK32)) {
5924 skip |= LogError(device, "VUID-VkImageViewASTCDecodeModeEXT-decodeMode-02231",
5925 "vkCreateImageView(): decodeModeSharedExponent is not enabled but "
5926 "VkImageViewASTCDecodeModeEXT::decodeMode is VK_FORMAT_E5B9G9R9_UFLOAT_PACK32.");
5927 }
5928 }
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005929
sfricke-samsung45996a42021-09-16 13:45:27 -07005930 if (IsExtEnabled(device_extensions.vk_khr_portability_subset)) {
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005931 // If swizzling is disabled, make sure it isn't used
Nathaniel Cesario17d057e2021-06-21 22:58:45 -06005932 // NOTE: as of spec version 1.2.183, VUID 04465 states: "all elements of components _must_ be
5933 // VK_COMPONENT_SWIZZLE_IDENTITY."
5934 // However, issue https://github.com/KhronosGroup/Vulkan-Portability/issues/27 points out that the identity can
5935 // also be defined via R, G, B, A enums in the correct order.
5936 // Spec change is at https://gitlab.khronos.org/vulkan/vulkan/-/merge_requests/4600
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005937 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatSwizzle) &&
Nathaniel Cesario17d057e2021-06-21 22:58:45 -06005938 !IsIdentitySwizzle(pCreateInfo->components)) {
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005939 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatSwizzle-04465",
5940 "vkCreateImageView (portability error): swizzle is disabled for this device.");
5941 }
5942
5943 // Ensure ImageView's format has the same number of bits and components as Image's format if format reinterpretation is
5944 // disabled
5945 // TODO (ncesario): This is not correct for some cases (e.g., VK_FORMAT_B10G11R11_UFLOAT_PACK32 and
5946 // VK_FORMAT_E5B9G9R9_UFLOAT_PACK32), but requires additional information that should probably be generated from the
5947 // spec. See Github issue #2361.
5948 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatReinterpretation) &&
5949 ((FormatElementSize(pCreateInfo->format, VK_IMAGE_ASPECT_COLOR_BIT) !=
5950 FormatElementSize(image_state->createInfo.format, VK_IMAGE_ASPECT_COLOR_BIT)) ||
sfricke-samsunged028b02021-09-06 23:14:51 -07005951 (FormatComponentCount(pCreateInfo->format) != FormatComponentCount(image_state->createInfo.format)))) {
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005952 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatReinterpretation-04466",
5953 "vkCreateImageView (portability error): ImageView format must have"
5954 " the same number of components and bits per component as the Image's format");
5955 }
5956 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005957 }
5958 return skip;
5959}
5960
Jeff Leger178b1e52020-10-05 12:22:23 -04005961template <typename RegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005962bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
Jeff Leger178b1e52020-10-05 12:22:23 -04005963 uint32_t regionCount, const RegionType *pRegions, CopyCommandVersion version) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005964 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04005965 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5966 const char *func_name = is_2khr ? "vkCmdCopyBuffer2KHR()" : "vkCmdCopyBuffer()";
5967 const char *vuid;
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005968
5969 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
5970 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
5971 VkDeviceSize src_min = UINT64_MAX;
5972 VkDeviceSize src_max = 0;
5973 VkDeviceSize dst_min = UINT64_MAX;
5974 VkDeviceSize dst_max = 0;
5975
5976 for (uint32_t i = 0; i < regionCount; i++) {
5977 src_min = std::min(src_min, pRegions[i].srcOffset);
5978 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
5979 dst_min = std::min(dst_min, pRegions[i].dstOffset);
5980 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
5981
5982 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
5983 if (pRegions[i].srcOffset >= src_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005984 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-srcOffset-00113" : "VUID-vkCmdCopyBuffer-srcOffset-00113";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005985 skip |= LogError(src_buffer_state->buffer(), vuid,
ziga-lunargd6b58ce2021-10-16 01:22:56 +02005986 "%s: pRegions[%" PRIu32 "].srcOffset (%" PRIuLEAST64
5987 ") is greater than size of srcBuffer (%" PRIuLEAST64 ").",
5988 func_name, i, pRegions[i].srcOffset, src_buffer_size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005989 }
5990
5991 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
5992 if (pRegions[i].dstOffset >= dst_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005993 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-dstOffset-00114" : "VUID-vkCmdCopyBuffer-dstOffset-00114";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005994 skip |= LogError(dst_buffer_state->buffer(), vuid,
ziga-lunargd6b58ce2021-10-16 01:22:56 +02005995 "%s: pRegions[%" PRIu32 "].dstOffset (%" PRIuLEAST64
5996 ") is greater than size of dstBuffer (%" PRIuLEAST64 ").",
5997 func_name, i, pRegions[i].dstOffset, dst_buffer_size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005998 }
5999
6000 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
6001 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006002 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00115" : "VUID-vkCmdCopyBuffer-size-00115";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006003 skip |= LogError(src_buffer_state->buffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006004 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the source buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006005 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04006006 func_name, i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006007 }
6008
6009 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
6010 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006011 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00116" : "VUID-vkCmdCopyBuffer-size-00116";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006012 skip |= LogError(dst_buffer_state->buffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006013 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the destination buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006014 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04006015 func_name, i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006016 }
6017 }
6018
6019 // 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 -06006020 if (src_buffer_state->buffer() == dst_buffer_state->buffer()) {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006021 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006022 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-pRegions-00117" : "VUID-vkCmdCopyBuffer-pRegions-00117";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006023 skip |= LogError(src_buffer_state->buffer(), vuid, "%s: Detected overlap between source and dest regions in memory.",
Jeff Leger178b1e52020-10-05 12:22:23 -04006024 func_name);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006025 }
6026 }
6027
6028 return skip;
6029}
6030
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006031bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006032 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06006033 const auto cb_node = GetCBState(commandBuffer);
6034 const auto src_buffer_state = GetBufferState(srcBuffer);
6035 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006036
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006037 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07006038 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
6039 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006040 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06006041 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006042 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
6043 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06006044 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006045 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
6046 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
sfricke-samsung85584a72021-09-30 21:43:38 -07006047 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER);
Jeff Leger178b1e52020-10-05 12:22:23 -04006048 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, regionCount, pRegions, COPY_COMMAND_VERSION_1);
sfricke-samsung022fa252020-07-24 03:26:16 -07006049 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01822");
6050 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01823");
6051 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01824");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006052 return skip;
6053}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07006054
Jeff Leger178b1e52020-10-05 12:22:23 -04006055bool CoreChecks::PreCallValidateCmdCopyBuffer2KHR(VkCommandBuffer commandBuffer,
6056 const VkCopyBufferInfo2KHR *pCopyBufferInfos) const {
6057 const auto cb_node = GetCBState(commandBuffer);
6058 const auto src_buffer_state = GetBufferState(pCopyBufferInfos->srcBuffer);
6059 const auto dst_buffer_state = GetBufferState(pCopyBufferInfos->dstBuffer);
6060
6061 bool skip = false;
6062 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-VkCopyBufferInfo2KHR-srcBuffer-00119");
6063 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-VkCopyBufferInfo2KHR-dstBuffer-00121");
6064 // Validate that SRC & DST buffers have correct usage flags set
6065 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
6066 "VUID-VkCopyBufferInfo2KHR-srcBuffer-00118", "vkCmdCopyBuffer2KHR()",
6067 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
6068 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
6069 "VUID-VkCopyBufferInfo2KHR-dstBuffer-00120", "vkCmdCopyBuffer2KHR()",
6070 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
sfricke-samsung85584a72021-09-30 21:43:38 -07006071 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER2KHR);
Jeff Leger178b1e52020-10-05 12:22:23 -04006072 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, pCopyBufferInfos->regionCount,
6073 pCopyBufferInfos->pRegions, COPY_COMMAND_VERSION_2);
6074 skip |=
6075 ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01822");
6076 skip |=
6077 ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01823");
6078 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer2KHR()",
6079 "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01824");
6080 return skip;
6081}
6082
Jeff Bolz46c0ea02019-10-09 13:06:29 -05006083bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006084 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07006085 auto buffer_state = GetBufferState(buffer);
sfricke-samsung9c7d8552020-08-16 22:12:21 -07006086 if (buffer_state) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06006087 if (buffer_state->InUse()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006088 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
6089 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006090 }
6091 }
6092 return skip;
6093}
6094
Jeff Bolz5c801d12019-10-09 10:38:45 -05006095bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
6096 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05006097 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07006098
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006099 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07006100 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07006101 skip |=
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06006102 ValidateObjectNotInUse(image_view_state, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006103 }
6104 return skip;
6105}
6106
Jeff Bolz5c801d12019-10-09 10:38:45 -05006107bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07006108 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07006109
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006110 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07006111 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07006112 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006113 }
6114 return skip;
6115}
6116
Nathaniel Cesario42ac6ca2021-06-15 17:23:05 -06006117void CoreChecks::PreCallRecordDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
6118 const auto buffer_state = Get<BUFFER_STATE>(buffer);
6119 if (buffer_state) {
6120 auto itr = buffer_address_map_.find(buffer_state->deviceAddress);
6121 if (itr != buffer_address_map_.end()) {
6122 buffer_address_map_.erase(itr);
6123 }
6124 }
6125 StateTracker::PreCallRecordDestroyBuffer(device, buffer, pAllocator);
6126}
6127
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006128bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006129 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07006130 auto buffer_view_state = GetBufferViewState(bufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006131 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07006132 if (buffer_view_state) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06006133 skip |= ValidateObjectNotInUse(buffer_view_state, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06006134 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006135 }
6136 return skip;
6137}
6138
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006139bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006140 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06006141 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07006142 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006143 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07006144 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
sfricke-samsung85584a72021-09-30 21:43:38 -07006145 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006146 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006147 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
6148 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006149
sfricke-samsung022fa252020-07-24 03:26:16 -07006150 skip |= ValidateProtectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01811");
6151 skip |= ValidateUnprotectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01812");
6152
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006153 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006154 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
6155 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
6156 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
6157 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006158 }
6159
6160 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006161 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
6162 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
6163 ") minus dstOffset (0x%" PRIxLEAST64 ").",
6164 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006165 }
6166
sfricke-samsung45996a42021-09-16 13:45:27 -07006167 if (!IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
ziga-lunarg3c5c84e2021-08-04 15:18:56 +02006168 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
6169 "VUID-vkCmdFillBuffer-commandBuffer-00030");
6170 }
6171
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006172 return skip;
6173}
6174
Jeff Leger178b1e52020-10-05 12:22:23 -04006175template <typename BufferImageCopyRegionType>
sfricke-samsungd0659242020-08-18 22:38:43 -07006176bool CoreChecks::ValidateBufferImageCopyData(const CMD_BUFFER_STATE *cb_node, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04006177 const BufferImageCopyRegionType *pRegions, const IMAGE_STATE *image_state,
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006178 const char *function, CopyCommandVersion version, bool image_to_buffer) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006179 bool skip = false;
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07006180 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
6181 const char *vuid;
Jeff Leger178b1e52020-10-05 12:22:23 -04006182
sfricke-samsung125d2b42020-05-28 06:32:43 -07006183 assert(image_state != nullptr);
6184 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006185
6186 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006187 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006188 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
6189 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006190 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00199", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006191 "%s: pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
6192 "and 1, respectively.",
6193 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006194 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006195 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006196
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006197 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
6198 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006199 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00201", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006200 "%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 -07006201 "must be 0 and 1, respectively.",
6202 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006203 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006204 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006205
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006206 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
6207 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006208 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00213", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006209 "%s: pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006210 "For 3D images these must be 0 and 1, respectively.",
6211 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006212 }
6213 }
6214
6215 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07006216 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
sfricke-samsung73e755c2021-09-30 08:34:57 -07006217 const uint32_t element_size =
6218 FormatIsDepthOrStencil(image_format) ? 0 : FormatElementSize(image_format, region_aspect_mask);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006219 const VkDeviceSize bufferOffset = pRegions[i].bufferOffset;
Locke497739c2019-03-08 11:50:47 -07006220
sfricke-samsung8feecc12021-01-23 03:28:38 -08006221 if (FormatIsDepthOrStencil(image_format)) {
6222 if (SafeModulo(bufferOffset, 4) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006223 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("04053", image_to_buffer, is_2khr),
sfricke-samsung8feecc12021-01-23 03:28:38 -08006224 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6225 " must be a multiple 4 if using a depth/stencil format (%s).",
6226 function, i, bufferOffset, string_VkFormat(image_format));
6227 }
6228 } else {
6229 // If not depth/stencil and not multi-plane
6230 if (!FormatIsMultiplane(image_format) && (SafeModulo(bufferOffset, element_size) != 0)) {
sfricke-samsung45996a42021-09-16 13:45:27 -07006231 vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
sfricke-samsung8feecc12021-01-23 03:28:38 -08006232 ? GetBufferImageCopyCommandVUID("01558", image_to_buffer, is_2khr)
6233 : GetBufferImageCopyCommandVUID("00193", image_to_buffer, is_2khr);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006234 skip |= LogError(image_state->image(), vuid,
sfricke-samsung8feecc12021-01-23 03:28:38 -08006235 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6236 " must be a multiple of this format's texel size (%" PRIu32 ").",
6237 function, i, bufferOffset, element_size);
6238 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006239 }
6240
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006241 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
6242 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006243 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferRowLength-00195" : "VUID-VkBufferImageCopy-bufferRowLength-00195";
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06006244 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006245 LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006246 "%s: pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006247 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006248 }
6249
6250 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
6251 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006252 vuid =
6253 (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferImageHeight-00196" : "VUID-VkBufferImageCopy-bufferImageHeight-00196";
Jeff Leger178b1e52020-10-05 12:22:23 -04006254 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006255 LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006256 "%s: pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
6257 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006258 }
6259
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006260 // Calculate adjusted image extent, accounting for multiplane image factors
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06006261 VkExtent3D adjusted_image_extent = image_state->GetSubresourceExtent(pRegions[i].imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006262 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006263 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 -06006264 ((pRegions[i].imageOffset.x + static_cast<int32_t>(pRegions[i].imageExtent.width)) >
6265 static_cast<int32_t>(adjusted_image_extent.width))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006266 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00197", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006267 "%s: Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006268 "zero or <= image subresource width (%d).",
6269 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006270 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006271 }
6272
6273 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006274 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 -06006275 ((pRegions[i].imageOffset.y + static_cast<int32_t>(pRegions[i].imageExtent.height)) >
6276 static_cast<int32_t>(adjusted_image_extent.height))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006277 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00198", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006278 "%s: Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006279 "zero or <= image subresource height (%d).",
6280 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006281 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006282 }
6283
6284 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006285 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 -06006286 ((pRegions[i].imageOffset.z + static_cast<int32_t>(pRegions[i].imageExtent.depth)) >
6287 static_cast<int32_t>(adjusted_image_extent.depth))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006288 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00200", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006289 "%s: Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006290 "zero or <= image subresource depth (%d).",
6291 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006292 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006293 }
6294
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006295 // subresource aspectMask must have exactly 1 bit set
6296 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
sfricke-samsung125d2b42020-05-28 06:32:43 -07006297 std::bitset<num_bits> aspect_mask_bits(region_aspect_mask);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006298 if (aspect_mask_bits.count() != 1) {
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07006299 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-aspectMask-00212" : "VUID-VkBufferImageCopy-aspectMask-00212";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006300 skip |= LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006301 "%s: aspectMasks for imageSubresource in pRegion[%d] must have only a single bit set.", function, i);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006302 }
6303
6304 // image subresource aspect bit must match format
sfricke-samsung125d2b42020-05-28 06:32:43 -07006305 if (!VerifyAspectsPresent(region_aspect_mask, image_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006306 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006307 LogError(image_state->image(), GetBufferImageCopyCommandVUID("00211", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006308 "%s: pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
6309 function, i, region_aspect_mask, image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006310 }
6311
6312 // Checks that apply only to compressed images
sfricke-samsung01da6312021-10-20 07:51:32 -07006313 if (FormatIsBlockedImage(image_format)) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006314 auto block_size = FormatTexelBlockExtent(image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006315
6316 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06006317 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
sfricke-samsung01da6312021-10-20 07:51:32 -07006318 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00203", image_to_buffer, is_2khr),
6319 "%s: pRegion[%d] bufferRowLength (%d) must be a multiple of the blocked image's texel width (%d).",
6320 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006321 }
6322
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006323 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06006324 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
sfricke-samsung01da6312021-10-20 07:51:32 -07006325 skip |=
6326 LogError(image_state->image(), GetBufferImageCopyCommandVUID("00204", image_to_buffer, is_2khr),
6327 "%s: pRegion[%d] bufferImageHeight (%d) must be a multiple of the blocked image's texel height (%d).",
6328 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006329 }
6330
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006331 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06006332 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
6333 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
6334 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006335 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00205", image_to_buffer, is_2khr),
sfricke-samsung01da6312021-10-20 07:51:32 -07006336 "%s: pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the blocked image's texel "
Petr Krausb0d5e592021-05-21 23:37:11 +02006337 "width & height (%d, %d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006338 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
6339 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006340 }
6341
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006342 // bufferOffset must be a multiple of block size (linear bytes)
sfricke-samsung73e755c2021-09-30 08:34:57 -07006343 if (SafeModulo(bufferOffset, element_size) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006344 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00206", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006345 "%s: pRegion[%d] bufferOffset (0x%" PRIxLEAST64
sfricke-samsung01da6312021-10-20 07:51:32 -07006346 ") must be a multiple of the blocked image's texel block size (%" PRIu32 ").",
sfricke-samsung73e755c2021-09-30 08:34:57 -07006347 function, i, bufferOffset, element_size);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006348 }
Dave Houlton67e9b532017-03-02 17:00:10 -07006349
6350 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06006351 VkExtent3D mip_extent = image_state->GetSubresourceExtent(pRegions[i].imageSubresource);
Dave Houlton1d2022c2017-03-29 11:43:58 -06006352 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006353 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006354 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00207", image_to_buffer, is_2khr),
sfricke-samsung01da6312021-10-20 07:51:32 -07006355 "%s: pRegion[%d] extent width (%d) must be a multiple of the blocked texture block width "
Petr Krausb0d5e592021-05-21 23:37:11 +02006356 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006357 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
6358 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07006359 }
6360
6361 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06006362 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006363 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006364 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00208", image_to_buffer, is_2khr),
sfricke-samsung01da6312021-10-20 07:51:32 -07006365 "%s: pRegion[%d] extent height (%d) must be a multiple of the blocked texture block height "
Petr Krausb0d5e592021-05-21 23:37:11 +02006366 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006367 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
6368 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07006369 }
6370
6371 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06006372 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006373 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006374 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00209", image_to_buffer, is_2khr),
sfricke-samsung01da6312021-10-20 07:51:32 -07006375 "%s: pRegion[%d] extent width (%d) must be a multiple of the blocked texture block depth "
Petr Krausb0d5e592021-05-21 23:37:11 +02006376 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006377 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
6378 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07006379 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006380 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08006381
6382 // Checks that apply only to multi-planar format images
sfricke-samsung125d2b42020-05-28 06:32:43 -07006383 if (FormatIsMultiplane(image_format)) {
sfricke-samsung552d5e12020-01-07 22:00:20 -08006384 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
sfricke-samsung125d2b42020-05-28 06:32:43 -07006385 if ((FormatPlaneCount(image_format) < 3) && (region_aspect_mask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006386 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006387 "%s: pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006388 "format has three planes.",
6389 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08006390 }
6391
6392 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
sfricke-samsung125d2b42020-05-28 06:32:43 -07006393 if (0 ==
6394 (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 -06006395 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006396 "%s: pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006397 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
6398 function, i);
sfricke-samsung125d2b42020-05-28 06:32:43 -07006399 } else {
6400 // Know aspect mask is valid
6401 const VkFormat compatible_format = FindMultiplaneCompatibleFormat(image_format, region_aspect_mask);
6402 const uint32_t compatible_size = FormatElementSize(compatible_format);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006403 if (SafeModulo(bufferOffset, compatible_size) != 0) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006404 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006405 image_state->image(), GetBufferImageCopyCommandVUID("01559", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006406 "%s: pRegion[%d]->bufferOffset is 0x%" PRIxLEAST64
sfricke-samsung125d2b42020-05-28 06:32:43 -07006407 " 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 -08006408 function, i, bufferOffset, element_size, GetPlaneIndex(region_aspect_mask),
sfricke-samsung125d2b42020-05-28 06:32:43 -07006409 string_VkFormat(compatible_format));
6410 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08006411 }
6412 }
sfricke-samsung8feecc12021-01-23 03:28:38 -08006413
6414 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
6415 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool.get();
6416 assert(command_pool != nullptr);
6417 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
6418 const VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[queue_family_index].queueFlags;
6419 if (((queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT)) == 0) && (SafeModulo(bufferOffset, 4) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006420 LogObjectList objlist(cb_node->commandBuffer());
6421 objlist.add(command_pool->commandPool());
6422 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("04052", image_to_buffer, is_2khr),
sfricke-samsung8feecc12021-01-23 03:28:38 -08006423 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6424 " must be a multiple 4 because the command buffer %s was allocated from the command pool %s "
6425 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT or "
6426 "VK_QUEUE_COMPUTE_BIT flag.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006427 function, i, bufferOffset, report_data->FormatHandle(cb_node->commandBuffer()).c_str(),
6428 report_data->FormatHandle(command_pool->commandPool()).c_str(), queue_family_index);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006429 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006430 }
6431
6432 return skip;
6433}
6434
Jeff Leger178b1e52020-10-05 12:22:23 -04006435template <typename BufferImageCopyRegionType>
6436bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount,
6437 const BufferImageCopyRegionType *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006438 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006439 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006440
6441 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006442 VkExtent3D extent = pRegions[i].imageExtent;
6443 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006444
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006445 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
6446 {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006447 skip |= LogWarning(image_state->image(), kVUID_Core_Image_ZeroAreaSubregion,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006448 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
6449 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006450 }
6451
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06006452 VkExtent3D image_extent = image_state->GetSubresourceExtent(pRegions[i].imageSubresource);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006453
sfricke-samsung01da6312021-10-20 07:51:32 -07006454 // If we're using a blocked image format, valid extent is rounded up to multiple of block size (per
6455 // vkspec.html#_common_operation)
6456 if (FormatIsBlockedImage(image_info->format)) {
Dave Houltona585d132019-01-18 13:05:42 -07006457 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006458 if (image_extent.width % block_extent.width) {
6459 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
6460 }
6461 if (image_extent.height % block_extent.height) {
6462 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
6463 }
6464 if (image_extent.depth % block_extent.depth) {
6465 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
6466 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006467 }
6468
Dave Houltonfc1a4052017-04-27 14:32:45 -06006469 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Petr Krausb0d5e592021-05-21 23:37:11 +02006470 skip |= LogError(image_state->image(), msg_code, "%s: pRegion[%d] exceeds image bounds.", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006471 }
6472 }
6473
6474 return skip;
6475}
6476
Jeff Leger178b1e52020-10-05 12:22:23 -04006477template <typename BufferImageCopyRegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006478bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04006479 const BufferImageCopyRegionType *pRegions, const char *func_name,
6480 const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006481 bool skip = false;
6482
sfricke-samsung11d15ba2021-09-30 09:19:56 -07006483 const VkDeviceSize buffer_size = buff_state->createInfo.size;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006484
6485 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung11d15ba2021-09-30 09:19:56 -07006486 const VkDeviceSize buffer_copy_size = GetBufferSizeFromCopyImage(pRegions[i], image_state->createInfo.format);
6487 // This blocks against invalid VkBufferCopyImage that already have been caught elsewhere
6488 if (buffer_copy_size != 0) {
6489 const VkDeviceSize max_buffer_copy = buffer_copy_size + pRegions[i].bufferOffset;
6490 if (buffer_size < max_buffer_copy) {
6491 skip |= LogError(device, msg_code,
6492 "%s: pRegion[%" PRIu32 "] is trying to copy %" PRIu64 " bytes plus %" PRIu64
6493 " offset to/from the VkBuffer (%s) which exceeds the VkBuffer total size of %" PRIu64 " bytes.",
6494 func_name, i, buffer_copy_size, pRegions[i].bufferOffset,
6495 report_data->FormatHandle(buff_state->buffer()).c_str(), buffer_size);
6496 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006497 }
6498 }
6499
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006500 return skip;
6501}
6502
Jeff Leger178b1e52020-10-05 12:22:23 -04006503template <typename BufferImageCopyRegionType>
6504bool CoreChecks::ValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6505 VkBuffer dstBuffer, uint32_t regionCount, const BufferImageCopyRegionType *pRegions,
6506 CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06006507 const auto cb_node = GetCBState(commandBuffer);
6508 const auto src_image_state = GetImageState(srcImage);
6509 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006510
Jeff Leger178b1e52020-10-05 12:22:23 -04006511 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
Jeff Leger178b1e52020-10-05 12:22:23 -04006512 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGETOBUFFER2KHR : CMD_COPYIMAGETOBUFFER;
sfricke-samsung85584a72021-09-30 21:43:38 -07006513 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04006514 const char *vuid;
6515
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006516 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, src_image_state, func_name, version, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006517
6518 // Validate command buffer state
sfricke-samsung85584a72021-09-30 21:43:38 -07006519 skip |= ValidateCmd(cb_node, cmd_type);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006520
6521 // Command pool must support graphics, compute, or transfer operations
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07006522 const auto pool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006523
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07006524 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07006525
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006526 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006527 vuid =
6528 is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool";
6529 skip |= LogError(cb_node->createInfo.commandPool, vuid,
6530 "Cannot call %s on a command buffer allocated from a pool without graphics, compute, "
6531 "or transfer capabilities.",
6532 func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006533 }
Mike Schuchardt7b152fa2021-08-03 16:30:27 -07006534 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00182" : "VUID-vkCmdCopyImageToBuffer-pRegions-06220";
Jeff Leger178b1e52020-10-05 12:22:23 -04006535 skip |= ValidateImageBounds(src_image_state, regionCount, pRegions, func_name, vuid);
6536 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00183" : "VUID-vkCmdCopyImageToBuffer-pRegions-00183";
6537 skip |= ValidateBufferBounds(src_image_state, dst_buffer_state, regionCount, pRegions, func_name, vuid);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006538
Jeff Leger178b1e52020-10-05 12:22:23 -04006539 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00188" : "VUID-vkCmdCopyImageToBuffer-srcImage-00188";
6540 const char *location = is_2khr ? "vkCmdCopyImageToBuffer2KHR(): srcImage" : "vkCmdCopyImageToBuffer(): srcImage";
6541 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
6542
6543 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00187" : "VUID-vkCmdCopyImageToBuffer-srcImage-00187";
6544 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
6545 vuid = is_2khr ? "vkCmdCopyImageToBuffer-dstBuffer2KHR-00192" : "vkCmdCopyImageToBuffer dstBuffer-00192";
6546 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, func_name, vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006547
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006548 // Validate that SRC image & DST buffer have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04006549 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00186" : "VUID-vkCmdCopyImageToBuffer-srcImage-00186";
6550 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006551 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006552 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-dstBuffer-00191" : "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191";
6553 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006554 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006555 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01831" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01831";
6556 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
6557 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01832" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01832";
6558 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
6559 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01833" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01833";
6560 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006561
6562 // Validation for VK_EXT_fragment_density_map
6563 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006564 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-02544" : "VUID-vkCmdCopyImageToBuffer-srcImage-02544";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006565 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006566 "%s: srcImage must not have been created with flags containing "
6567 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
6568 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006569 }
6570
sfricke-samsung45996a42021-09-16 13:45:27 -07006571 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006572 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-01998" : "VUID-vkCmdCopyImageToBuffer-srcImage-01998";
6573 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04006574 }
Tobin Ehlisc8266452017-04-07 12:20:30 -06006575 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04006576
sfricke-samsung45996a42021-09-16 13:45:27 -07006577 const char *src_invalid_layout_vuid =
6578 (src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
6579 ? (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-01397"
6580 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397")
6581 : (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00190"
6582 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190");
Jeff Leger178b1e52020-10-05 12:22:23 -04006583
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006584 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006585 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
6586 vuid =
6587 is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00189" : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07006588 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04006589 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, src_invalid_layout_vuid, vuid, &hit_error);
6590 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-01794" : "VUID-vkCmdCopyImageToBuffer-imageOffset-01794";
6591 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, src_image_state, &pRegions[i], i, func_name, vuid);
6592 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01703"
6593 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703";
6594 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
6595 "imageSubresource", vuid);
6596 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01704"
6597 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006598 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04006599 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006600 }
6601 return skip;
6602}
6603
Jeff Leger178b1e52020-10-05 12:22:23 -04006604bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6605 VkBuffer dstBuffer, uint32_t regionCount,
6606 const VkBufferImageCopy *pRegions) const {
6607 return ValidateCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions,
6608 COPY_COMMAND_VERSION_1);
6609}
6610
6611bool CoreChecks::PreCallValidateCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
6612 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) const {
6613 return ValidateCmdCopyImageToBuffer(commandBuffer, pCopyImageToBufferInfo->srcImage, pCopyImageToBufferInfo->srcImageLayout,
6614 pCopyImageToBufferInfo->dstBuffer, pCopyImageToBufferInfo->regionCount,
6615 pCopyImageToBufferInfo->pRegions, COPY_COMMAND_VERSION_2);
6616}
6617
John Zulauf1686f232019-07-09 16:27:11 -06006618void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6619 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
6620 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
6621
6622 auto cb_node = GetCBState(commandBuffer);
6623 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06006624 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006625 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06006626 cb_node->SetImageInitialLayout(*src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06006627 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006628}
6629
Jeff Leger178b1e52020-10-05 12:22:23 -04006630void CoreChecks::PreCallRecordCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
6631 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) {
6632 StateTracker::PreCallRecordCmdCopyImageToBuffer2KHR(commandBuffer, pCopyImageToBufferInfo);
6633
6634 auto cb_node = GetCBState(commandBuffer);
6635 auto src_image_state = GetImageState(pCopyImageToBufferInfo->srcImage);
6636 // Make sure that all image slices record referenced layout
6637 for (uint32_t i = 0; i < pCopyImageToBufferInfo->regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06006638 cb_node->SetImageInitialLayout(*src_image_state, pCopyImageToBufferInfo->pRegions[i].imageSubresource,
6639 pCopyImageToBufferInfo->srcImageLayout);
Jeff Leger178b1e52020-10-05 12:22:23 -04006640 }
6641}
6642
6643template <typename RegionType>
6644bool CoreChecks::ValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6645 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
6646 CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06006647 const auto cb_node = GetCBState(commandBuffer);
6648 const auto src_buffer_state = GetBufferState(srcBuffer);
6649 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006650
Jeff Leger178b1e52020-10-05 12:22:23 -04006651 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
Jeff Leger178b1e52020-10-05 12:22:23 -04006652 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYBUFFERTOIMAGE2KHR : CMD_COPYBUFFERTOIMAGE;
sfricke-samsung85584a72021-09-30 21:43:38 -07006653 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04006654 const char *vuid;
6655
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006656 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, dst_image_state, func_name, version, false);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006657
6658 // Validate command buffer state
sfricke-samsung85584a72021-09-30 21:43:38 -07006659 skip |= ValidateCmd(cb_node, cmd_type);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006660
Mike Schuchardt7b152fa2021-08-03 16:30:27 -07006661 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00172" : "VUID-vkCmdCopyBufferToImage-pRegions-06217";
Jeff Leger178b1e52020-10-05 12:22:23 -04006662 skip |= ValidateImageBounds(dst_image_state, regionCount, pRegions, func_name, vuid);
6663 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00171" : "VUID-vkCmdCopyBufferToImage-pRegions-00171";
6664 skip |= ValidateBufferBounds(dst_image_state, src_buffer_state, regionCount, pRegions, func_name, vuid);
6665
6666 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00179" : "VUID-vkCmdCopyBufferToImage-dstImage-00179";
6667 const char *location = is_2khr ? "vkCmdCopyBufferToImage2KHR(): dstImage" : "vkCmdCopyBufferToImage(): dstImage";
6668 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
6669 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00176" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00176";
6670 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, func_name, vuid);
6671 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00178" : "VUID-vkCmdCopyBufferToImage-dstImage-00178";
6672 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
6673 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00174" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00174";
6674 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006675 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006676 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00177" : "VUID-vkCmdCopyBufferToImage-dstImage-00177";
6677 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006678 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006679 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01828" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01828";
6680 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, func_name, vuid);
6681 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01829" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01829";
6682 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
6683 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage-commandBuffer-01830" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01830";
6684 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006685
6686 // Validation for VK_EXT_fragment_density_map
6687 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006688 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-02543" : "VUID-vkCmdCopyBufferToImage-dstImage-02543";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006689 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006690 "%s: dstImage must not have been created with flags containing "
6691 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
6692 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006693 }
6694
sfricke-samsung45996a42021-09-16 13:45:27 -07006695 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006696 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-01997" : "VUID-vkCmdCopyBufferToImage-dstImage-01997";
6697 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04006698 }
Tobin Ehlisc8266452017-04-07 12:20:30 -06006699 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04006700
sfricke-samsung45996a42021-09-16 13:45:27 -07006701 const char *dst_invalid_layout_vuid =
6702 (dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
6703 ? (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-01396"
6704 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396")
6705 : (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00181"
6706 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181");
Jeff Leger178b1e52020-10-05 12:22:23 -04006707
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006708 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006709 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
6710 vuid =
6711 is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00180" : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07006712 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04006713 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, dst_invalid_layout_vuid, vuid, &hit_error);
6714 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-01793" : "VUID-vkCmdCopyBufferToImage-imageOffset-01793";
6715 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, dst_image_state, &pRegions[i], i, func_name, vuid);
6716 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01701"
6717 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01701";
6718 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
6719 "imageSubresource", vuid);
6720 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01702"
6721 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01702";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006722 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04006723 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
sfricke-samsungea4fd142020-10-17 23:51:59 -07006724
6725 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
6726 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool.get();
6727 assert(command_pool != nullptr);
6728 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
6729 const VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[queue_family_index].queueFlags;
6730 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
6731 if (((queue_flags & VK_QUEUE_GRAPHICS_BIT) == 0) &&
6732 ((region_aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006733 LogObjectList objlist(cb_node->commandBuffer());
6734 objlist.add(command_pool->commandPool());
sfricke-samsungea4fd142020-10-17 23:51:59 -07006735 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-commandBuffer-04477"
6736 : "VUID-vkCmdCopyBufferToImage-commandBuffer-04477";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006737 skip |= LogError(dst_image_state->image(), vuid,
sfricke-samsungea4fd142020-10-17 23:51:59 -07006738 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies VK_IMAGE_ASPECT_DEPTH_BIT or "
6739 "VK_IMAGE_ASPECT_STENCIL_BIT but the command buffer %s was allocated from the command pool %s "
6740 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT flag.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006741 func_name, i, region_aspect_mask, report_data->FormatHandle(cb_node->commandBuffer()).c_str(),
6742 report_data->FormatHandle(command_pool->commandPool()).c_str(), queue_family_index);
sfricke-samsungea4fd142020-10-17 23:51:59 -07006743 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006744 }
6745 return skip;
6746}
6747
Jeff Leger178b1e52020-10-05 12:22:23 -04006748bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6749 VkImageLayout dstImageLayout, uint32_t regionCount,
6750 const VkBufferImageCopy *pRegions) const {
6751 return ValidateCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions,
6752 COPY_COMMAND_VERSION_1);
6753}
6754
6755bool CoreChecks::PreCallValidateCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
6756 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo) const {
6757 return ValidateCmdCopyBufferToImage(commandBuffer, pCopyBufferToImageInfo->srcBuffer, pCopyBufferToImageInfo->dstImage,
6758 pCopyBufferToImageInfo->dstImageLayout, pCopyBufferToImageInfo->regionCount,
6759 pCopyBufferToImageInfo->pRegions, COPY_COMMAND_VERSION_2);
6760}
6761
John Zulauf1686f232019-07-09 16:27:11 -06006762void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6763 VkImageLayout dstImageLayout, uint32_t regionCount,
6764 const VkBufferImageCopy *pRegions) {
6765 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
6766
6767 auto cb_node = GetCBState(commandBuffer);
6768 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06006769 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006770 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06006771 cb_node->SetImageInitialLayout(*dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06006772 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006773}
Mike Weiblen672b58b2017-02-21 14:32:53 -07006774
Jeff Leger178b1e52020-10-05 12:22:23 -04006775void CoreChecks::PreCallRecordCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
6776 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo2KHR) {
6777 StateTracker::PreCallRecordCmdCopyBufferToImage2KHR(commandBuffer, pCopyBufferToImageInfo2KHR);
6778
6779 auto cb_node = GetCBState(commandBuffer);
6780 auto dst_image_state = GetImageState(pCopyBufferToImageInfo2KHR->dstImage);
6781 // Make sure that all image slices are record referenced layout
6782 for (uint32_t i = 0; i < pCopyBufferToImageInfo2KHR->regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06006783 cb_node->SetImageInitialLayout(*dst_image_state, pCopyBufferToImageInfo2KHR->pRegions[i].imageSubresource,
6784 pCopyBufferToImageInfo2KHR->dstImageLayout);
Jeff Leger178b1e52020-10-05 12:22:23 -04006785 }
6786}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006787bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006788 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07006789 bool skip = false;
6790 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
6791
Dave Houlton1d960ff2018-01-19 12:17:05 -07006792 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07006793 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
6794 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
6795 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006796 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
6797 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006798 }
6799
John Zulaufa26d3c82019-08-14 16:09:08 -06006800 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006801 if (!image_entry) {
6802 return skip;
6803 }
6804
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006805 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
sfricke-samsung45996a42021-09-16 13:45:27 -07006806 if (IsExtEnabled(device_extensions.vk_ext_image_drm_format_modifier)) {
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006807 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
6808 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006809 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
6810 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
6811 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006812 }
6813 } else {
6814 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006815 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
6816 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006817 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07006818 }
6819
Dave Houlton1d960ff2018-01-19 12:17:05 -07006820 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07006821 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006822 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
6823 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
6824 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006825 }
6826
Dave Houlton1d960ff2018-01-19 12:17:05 -07006827 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07006828 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006829 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
6830 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
6831 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006832 }
6833
Dave Houlton1d960ff2018-01-19 12:17:05 -07006834 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07006835 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006836 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
6837 if (FormatIsMultiplane(img_format)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08006838 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006839 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
6840 if (FormatPlaneCount(img_format) > 2u) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08006841 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006842 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
6843 }
6844 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006845 skip |= LogError(image, vuid,
6846 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
6847 ") must be a single-plane specifier flag.",
6848 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006849 }
6850 } else if (FormatIsColor(img_format)) {
6851 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
ziga-lunargcc568bc2021-09-05 13:45:45 +02006852 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04461",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006853 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
6854 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006855 }
6856 } else if (FormatIsDepthOrStencil(img_format)) {
Nathaniel Cesario8c80f352021-07-15 15:06:48 -06006857 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006858 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07006859 }
ziga-lunarg4ecbd5b2021-07-15 20:48:30 +02006860 if (!FormatIsDepthAndStencil(img_format) && !FormatIsDepthOnly(img_format)) {
6861 if (sub_aspect & VK_IMAGE_ASPECT_DEPTH_BIT) {
6862 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04464",
6863 "vkGetImageSubresourceLayout(): Image format (%s) does not contain a depth component, "
6864 "but VkImageSubresource.aspectMask contains VK_IMAGE_ASPECT_DEPTH_BIT.",
6865 string_VkFormat(img_format));
6866 }
6867 } else {
6868 if ((sub_aspect & VK_IMAGE_ASPECT_DEPTH_BIT) == 0) {
6869 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04462",
6870 "vkGetImageSubresourceLayout(): Image format (%s) contains a depth component, "
6871 "but VkImageSubresource.aspectMask does not contain VK_IMAGE_ASPECT_DEPTH_BIT.",
6872 string_VkFormat(img_format));
6873 }
6874 }
6875 if (!FormatIsDepthAndStencil(img_format) && !FormatIsStencilOnly(img_format)) {
6876 if (sub_aspect & VK_IMAGE_ASPECT_STENCIL_BIT) {
6877 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04464",
6878 "vkGetImageSubresourceLayout(): Image format (%s) does not contain a stencil component, "
6879 "but VkImageSubresource.aspectMask contains VK_IMAGE_ASPECT_STENCIL_BIT.",
6880 string_VkFormat(img_format));
6881 }
6882 } else {
6883 if ((sub_aspect & VK_IMAGE_ASPECT_STENCIL_BIT) == 0) {
6884 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04463",
6885 "vkGetImageSubresourceLayout(): Image format (%s) contains a stencil component, "
6886 "but VkImageSubresource.aspectMask does not contain VK_IMAGE_ASPECT_STENCIL_BIT.",
6887 string_VkFormat(img_format));
6888 }
6889 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006890 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
6891 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
6892 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
6893 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006894 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
6895 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
6896 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006897 }
6898 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006899
sfricke-samsung45996a42021-09-16 13:45:27 -07006900 if (IsExtEnabled(device_extensions.vk_android_external_memory_android_hardware_buffer)) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07006901 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006902 }
6903
Mike Weiblen672b58b2017-02-21 14:32:53 -07006904 return skip;
6905}
sfricke-samsung022fa252020-07-24 03:26:16 -07006906
6907// Validates the image is allowed to be protected
6908bool CoreChecks::ValidateProtectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006909 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006910 bool skip = false;
6911 if ((cb_state->unprotected == true) && (image_state->unprotected == false)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006912 LogObjectList objlist(cb_state->commandBuffer());
6913 objlist.add(image_state->image());
locke-lunarg351c9d82020-10-23 14:43:21 -06006914 skip |= LogError(objlist, vuid, "%s: command buffer %s is unprotected while image %s is a protected image.%s", cmd_name,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006915 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
6916 report_data->FormatHandle(image_state->image()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006917 }
6918 return skip;
6919}
6920
6921// Validates the image is allowed to be unprotected
6922bool CoreChecks::ValidateUnprotectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006923 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006924 bool skip = false;
6925 if ((cb_state->unprotected == false) && (image_state->unprotected == true)) {
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 protected while image %s is an unprotected 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 buffer is allowed to be protected
6936bool CoreChecks::ValidateProtectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_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;
6939 if ((cb_state->unprotected == true) && (buffer_state->unprotected == false)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006940 LogObjectList objlist(cb_state->commandBuffer());
6941 objlist.add(buffer_state->buffer());
locke-lunarg351c9d82020-10-23 14:43:21 -06006942 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 -06006943 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
6944 report_data->FormatHandle(buffer_state->buffer()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006945 }
6946 return skip;
6947}
6948
6949// Validates the buffer is allowed to be unprotected
6950bool CoreChecks::ValidateUnprotectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006951 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006952 bool skip = false;
6953 if ((cb_state->unprotected == false) && (buffer_state->unprotected == true)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006954 LogObjectList objlist(cb_state->commandBuffer());
6955 objlist.add(buffer_state->buffer());
locke-lunarg351c9d82020-10-23 14:43:21 -06006956 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 -06006957 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
6958 report_data->FormatHandle(buffer_state->buffer()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006959 }
6960 return skip;
6961}