blob: a707874cb472bb868d2bac0ea6b60eda6bce4f63 [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
Mike Weiblen62d08a32017-03-07 22:18:27 -0700745// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -0700746bool CoreChecks::ValidateBarrierLayoutToImageUsage(const Location &loc, VkImage image, VkImageLayout layout,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700747 VkImageUsageFlags usage_flags) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700748 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700749 bool is_error = false;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700750 switch (layout) {
751 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700752 is_error = ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700753 break;
754 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700755 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700756 break;
757 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700758 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700759 break;
760 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700761 is_error = ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700762 break;
763 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700764 is_error = ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700765 break;
766 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700767 is_error = ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700768 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600769 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700770 is_error = ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0);
Jeff Bolz9af91c52018-09-01 21:53:57 -0500771 break;
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700772 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700773 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700774 break;
775 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700776 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700777 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700778 default:
779 // Other VkImageLayout values do not have VUs defined in this context.
780 break;
781 }
782
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700783 if (is_error) {
784 const auto &vuid = sync_vuid_maps::GetBadImageLayoutVUID(loc, layout);
785
786 skip |=
787 LogError(image, vuid, "%s Image barrier Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".",
788 loc.Message().c_str(), string_VkImageLayout(layout), report_data->FormatHandle(image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700789 }
790 return skip;
791}
792
793// Verify image barriers are compatible with the images they reference.
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700794template <typename ImageBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -0700795bool CoreChecks::ValidateBarriersToImages(const Location &outer_loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700796 uint32_t imageMemoryBarrierCount, const ImageBarrier *pImageMemoryBarriers) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700797 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700798 using sync_vuid_maps::GetImageBarrierVUID;
799 using sync_vuid_maps::ImageError;
Petr Krausad0096a2019-08-09 18:35:04 +0200800 // Scoreboard for checking for duplicate and inconsistent barriers to images
801 struct ImageBarrierScoreboardEntry {
802 uint32_t index;
803 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
804 // 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 -0700805 const ImageBarrier *barrier;
Petr Krausad0096a2019-08-09 18:35:04 +0200806 };
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700807 // Necessary to resolve warning C4503 when building with Visual Studio 2015.
808 // Adding a struct wrapper is their recommend solution for the expanded type name growing too long
809 // when creating maps full of maps.
810 struct ImageBarrierScoreboardSubresMap {
Jeremy Gebbencbf22862021-03-03 12:01:22 -0700811 layer_data::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry> map;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700812 };
Jeremy Gebbencbf22862021-03-03 12:01:22 -0700813 using ImageBarrierScoreboardImageMap = layer_data::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
Petr Krausad0096a2019-08-09 18:35:04 +0200814
John Zulauf463c51e2018-05-31 13:29:20 -0600815 // Scoreboard for duplicate layout transition barriers within the list
816 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
817 ImageBarrierScoreboardImageMap layout_transitions;
818
Mike Weiblen62d08a32017-03-07 22:18:27 -0700819 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700820 auto loc = outer_loc.dot(Field::pImageMemoryBarriers, i);
Petr Krausad0096a2019-08-09 18:35:04 +0200821 const auto &img_barrier = pImageMemoryBarriers[i];
Mike Weiblen62d08a32017-03-07 22:18:27 -0700822
John Zulauf463c51e2018-05-31 13:29:20 -0600823 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
824 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
825 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +0200826 if (img_barrier.oldLayout != img_barrier.newLayout) {
827 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
828 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -0600829 if (image_it != layout_transitions.end()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700830 auto &subres_map = image_it->second.map;
Petr Krausad0096a2019-08-09 18:35:04 +0200831 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -0600832 if (subres_it != subres_map.end()) {
833 auto &entry = subres_it->second;
Jeremy Gebben579aaca2021-02-15 13:36:18 -0700834 auto entry_layout =
835 NormalizeSynchronization2Layout(entry.barrier->subresourceRange.aspectMask, entry.barrier->newLayout);
836 auto old_layout =
837 NormalizeSynchronization2Layout(img_barrier.subresourceRange.aspectMask, img_barrier.oldLayout);
838 if ((entry_layout != old_layout) && (old_layout != VK_IMAGE_LAYOUT_UNDEFINED)) {
Petr Krausad0096a2019-08-09 18:35:04 +0200839 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700840 const auto &vuid = GetImageBarrierVUID(loc, ImageError::kConflictingLayout);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700841 skip = LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600842 cb_state->commandBuffer(), vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700843 "%s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600844 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
845 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700846 loc.Message().c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
Petr Krausad0096a2019-08-09 18:35:04 +0200847 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
848 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600849 }
850 entry = new_entry;
851 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200852 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600853 }
854 } else {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700855 layout_transitions[img_barrier.image].map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600856 }
857 }
858
Petr Krausad0096a2019-08-09 18:35:04 +0200859 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600860 if (image_state) {
861 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700862 skip |=
863 ValidateBarrierLayoutToImageUsage(loc.dot(Field::oldLayout), img_barrier.image, img_barrier.oldLayout, usage_flags);
864 skip |=
865 ValidateBarrierLayoutToImageUsage(loc.dot(Field::newLayout), img_barrier.image, img_barrier.newLayout, usage_flags);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600866
867 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
868 if (image_state->layout_locked) {
869 // TODO: Add unique id for error when available
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700870 skip |= LogError(
871 img_barrier.image, 0,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700872 "%s Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600873 " 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 -0700874 loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
875 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600876 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600877
John Zulaufa4472282019-08-22 14:44:34 -0600878 const VkImageCreateInfo &image_create_info = image_state->createInfo;
sfricke-samsung79b00482020-04-01 21:15:50 -0700879 const VkFormat image_format = image_create_info.format;
880 const VkImageAspectFlags aspect_mask = img_barrier.subresourceRange.aspectMask;
John Zulauff660ad62019-03-23 07:16:05 -0600881 // For a Depth/Stencil image both aspects MUST be set
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700882 auto image_loc = loc.dot(Field::image);
sfricke-samsung79b00482020-04-01 21:15:50 -0700883 if (FormatIsDepthAndStencil(image_format)) {
Piers Daniell41b8c5d2020-01-10 15:42:00 -0700884 if (enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -0600885 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700886 auto vuid = GetImageBarrierVUID(loc, ImageError::kNotDepthOrStencilAspect);
887 skip |= LogError(img_barrier.image, vuid,
888 "%s references %s of format %s that must have either the depth or stencil "
889 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
890 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
891 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600892 }
893 } else {
894 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
895 if ((aspect_mask & ds_mask) != (ds_mask)) {
sfricke-samsung45996a42021-09-16 13:45:27 -0700896 auto error = IsExtEnabled(device_extensions.vk_khr_separate_depth_stencil_layouts)
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700897 ? ImageError::kNotSeparateDepthAndStencilAspect
898 : ImageError::kNotDepthAndStencilAspect;
899 auto vuid = GetImageBarrierVUID(image_loc, error);
sfricke-samsung38d280b2020-05-16 08:02:56 -0700900 skip |= LogError(img_barrier.image, vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700901 "%s references %s of format %s that must have the depth and stencil "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700902 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700903 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700904 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600905 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700906 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700907 }
John Zulauff660ad62019-03-23 07:16:05 -0600908
Jeremy Gebben159b3cc2021-06-03 09:09:03 -0600909 const auto *subresource_map = cb_state->GetImageSubresourceLayoutMap(img_barrier.image);
Petr Krausad0096a2019-08-09 18:35:04 +0200910 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -0600911 // TODO: Set memory invalid which is in mem_tracker currently
912 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
913 // subresource.
John Zulaufcea64cb2020-06-10 17:17:27 -0600914 } else if (subresource_map && !QueueFamilyIsExternal(img_barrier.srcQueueFamilyIndex)) {
John Zulauff660ad62019-03-23 07:16:05 -0600915 bool subres_skip = false;
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200916
917 // Validate aspects in isolation.
918 // This is required when handling separate depth-stencil layouts.
919 for (uint32_t aspect_index = 0; aspect_index < 32; aspect_index++) {
920 VkImageAspectFlags test_aspect = 1u << aspect_index;
921 if ((img_barrier.subresourceRange.aspectMask & test_aspect) == 0) {
922 continue;
923 }
924
925 LayoutUseCheckAndMessage layout_check(subresource_map, test_aspect);
926 auto normalized_isr = image_state->NormalizeSubresourceRange(img_barrier.subresourceRange);
927 normalized_isr.aspectMask = test_aspect;
928
929 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to the next "constant value" range
930 for (auto pos = subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
931 const auto &value = *pos;
932 auto old_layout =
933 NormalizeSynchronization2Layout(test_aspect, img_barrier.oldLayout);
934 if (!layout_check.Check(value.subresource, old_layout, value.current_layout, value.initial_layout)) {
935 const auto &vuid = GetImageBarrierVUID(loc, ImageError::kConflictingLayout);
936 subres_skip =
937 LogError(cb_state->commandBuffer(), vuid,
938 "%s %s cannot transition the layout of aspect=%d level=%d layer=%d from %s when the "
939 "%s layout is %s.",
940 loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
941 value.subresource.aspectMask, value.subresource.mipLevel, value.subresource.arrayLayer,
942 string_VkImageLayout(img_barrier.oldLayout), layout_check.message,
943 string_VkImageLayout(layout_check.layout));
944 }
John Zulauff660ad62019-03-23 07:16:05 -0600945 }
John Zulauf5e617452019-11-19 14:44:16 -0700946 }
John Zulauff660ad62019-03-23 07:16:05 -0600947 skip |= subres_skip;
948 }
sfricke-samsung79b00482020-04-01 21:15:50 -0700949
950 // checks color format and (single-plane or non-disjoint)
951 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
952 if ((FormatIsColor(image_format) == true) &&
sfricke-samsung71bc6572020-04-29 15:49:43 -0700953 ((FormatIsMultiplane(image_format) == false) || (image_state->disjoint == false))) {
sfricke-samsung79b00482020-04-01 21:15:50 -0700954 if (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsung45996a42021-09-16 13:45:27 -0700955 auto error = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion) ? ImageError::kNotColorAspect
956 : ImageError::kNotColorAspectYcbcr;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700957 const auto &vuid = GetImageBarrierVUID(loc, error);
sfricke-samsung79b00482020-04-01 21:15:50 -0700958 skip |= LogError(img_barrier.image, vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700959 "%s references %s of format %s that must be only VK_IMAGE_ASPECT_COLOR_BIT, "
sfricke-samsung79b00482020-04-01 21:15:50 -0700960 "but its aspectMask is 0x%" PRIx32 ".",
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700961 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700962 string_VkFormat(image_format), aspect_mask);
963 }
964 }
965
966 VkImageAspectFlags valid_disjoint_mask =
967 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 -0700968 if ((FormatIsMultiplane(image_format) == true) && (image_state->disjoint == true) &&
sfricke-samsung79b00482020-04-01 21:15:50 -0700969 ((aspect_mask & valid_disjoint_mask) == 0)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700970 const auto &vuid = GetImageBarrierVUID(image_loc, ImageError::kBadMultiplanarAspect);
971 skip |= LogError(img_barrier.image, vuid,
972 "%s references %s of format %s has aspectMask (0x%" PRIx32
sfricke-samsung79b00482020-04-01 21:15:50 -0700973 ") but needs to include either an VK_IMAGE_ASPECT_PLANE_*_BIT or VK_IMAGE_ASPECT_COLOR_BIT.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700974 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700975 string_VkFormat(image_format), aspect_mask);
976 }
977
978 if ((FormatPlaneCount(image_format) == 2) && ((aspect_mask & VK_IMAGE_ASPECT_PLANE_2_BIT) != 0)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700979 const auto &vuid = GetImageBarrierVUID(image_loc, ImageError::kBadPlaneCount);
980 skip |= LogError(img_barrier.image, vuid,
981 "%s references %s of format %s has only two planes but included "
sfricke-samsung79b00482020-04-01 21:15:50 -0700982 "VK_IMAGE_ASPECT_PLANE_2_BIT in its aspectMask (0x%" PRIx32 ").",
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700983 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700984 string_VkFormat(image_format), aspect_mask);
985 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700986 }
987 }
988 return skip;
989}
990
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700991template <typename Barrier, typename TransferBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -0700992bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const Location &loc, const CMD_BUFFER_STATE *cb_state, const Barrier &barrier,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700993 const QFOTransferBarrierSets<TransferBarrier> &barrier_sets) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600994 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700995 const char *handle_name = TransferBarrier::HandleName();
John Zulauf6b4aae82018-05-09 13:03:36 -0600996 const char *transfer_type = nullptr;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700997 if (!IsTransferOp(barrier)) {
998 return skip;
999 }
1000 const TransferBarrier *barrier_record = nullptr;
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001001 if (cb_state->IsReleaseOp(barrier) && !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001002 const auto found = barrier_sets.release.find(barrier);
1003 if (found != barrier_sets.release.cend()) {
1004 barrier_record = &(*found);
1005 transfer_type = "releasing";
John Zulauf6b4aae82018-05-09 13:03:36 -06001006 }
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001007 } else if (cb_state->IsAcquireOp(barrier) && !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001008 const auto found = barrier_sets.acquire.find(barrier);
1009 if (found != barrier_sets.acquire.cend()) {
1010 barrier_record = &(*found);
1011 transfer_type = "acquiring";
John Zulauf6b4aae82018-05-09 13:03:36 -06001012 }
1013 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001014 if (barrier_record != nullptr) {
1015 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001016 LogWarning(cb_state->commandBuffer(), TransferBarrier::ErrMsgDuplicateQFOInCB(),
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001017 "%s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
1018 " duplicates existing barrier recorded in this command buffer.",
1019 loc.Message().c_str(), transfer_type, handle_name, report_data->FormatHandle(barrier_record->handle).c_str(),
1020 barrier_record->srcQueueFamilyIndex, barrier_record->dstQueueFamilyIndex);
1021 }
John Zulauf6b4aae82018-05-09 13:03:36 -06001022 return skip;
1023}
1024
John Zulaufa4472282019-08-22 14:44:34 -06001025VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
1026 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1027}
1028
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001029VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier2KHR &barrier) {
1030 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1031}
1032
John Zulaufa4472282019-08-22 14:44:34 -06001033const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
1034 return device_state.GetImageState(barrier.image);
1035}
1036
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001037const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier2KHR &barrier) {
1038 return device_state.GetImageState(barrier.image);
1039}
1040
John Zulaufa4472282019-08-22 14:44:34 -06001041VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
1042 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1043}
1044
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001045VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier2KHR &barrier) {
1046 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1047}
1048
John Zulaufa4472282019-08-22 14:44:34 -06001049const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
1050 return device_state.GetBufferState(barrier.buffer);
1051}
1052
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001053const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier2KHR &barrier) {
1054 return device_state.GetBufferState(barrier.buffer);
1055}
John Zulaufa4472282019-08-22 14:44:34 -06001056
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001057template <typename Barrier, typename TransferBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001058void CoreChecks::RecordBarrierValidationInfo(const Location &loc, CMD_BUFFER_STATE *cb_state, const Barrier &barrier,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001059 QFOTransferBarrierSets<TransferBarrier> &barrier_sets) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001060 if (IsTransferOp(barrier)) {
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001061 if (cb_state->IsReleaseOp(barrier) && !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001062 barrier_sets.release.emplace(barrier);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001063 } else if (cb_state->IsAcquireOp(barrier) && !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001064 barrier_sets.acquire.emplace(barrier);
John Zulaufa4472282019-08-22 14:44:34 -06001065 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001066 }
John Zulaufa4472282019-08-22 14:44:34 -06001067
David Zhao Akeleyd76df472021-05-15 17:25:59 -07001068 // 7.7.4: If the values of srcQueueFamilyIndex and dstQueueFamilyIndex are equal, no ownership transfer is performed, and the
1069 // barrier operates as if they were both set to VK_QUEUE_FAMILY_IGNORED.
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001070 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
1071 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
David Zhao Akeleyd76df472021-05-15 17:25:59 -07001072 const bool is_ownership_transfer = src_queue_family != dst_queue_family;
1073
1074 if (is_ownership_transfer) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001075 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
1076 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
1077 auto handle_state = BarrierHandleState(*this, barrier);
1078 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
1079 if (!mode_concurrent) {
1080 const auto typed_handle = BarrierTypedHandle(barrier);
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001081 core_error::LocationCapture loc_capture(loc);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001082 cb_state->queue_submit_functions.emplace_back(
John Zulaufb4438f02021-02-20 20:22:16 -07001083 [loc_capture, cb_state, typed_handle, src_queue_family, dst_queue_family](const ValidationStateTracker *device_data,
1084 const QUEUE_STATE *queue_state) {
1085 return ValidateConcurrentBarrierAtSubmit(loc_capture.Get(), device_data, queue_state, cb_state, typed_handle,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001086 src_queue_family, dst_queue_family);
1087 });
John Zulauf6b4aae82018-05-09 13:03:36 -06001088 }
1089 }
1090}
1091
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001092// Verify image barrier image state and that the image is consistent with FB image
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001093template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001094bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001095 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1096 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001097 const ImgBarrier &img_barrier, const CMD_BUFFER_STATE *primary_cb_state) const {
1098 using sync_vuid_maps::GetImageBarrierVUID;
1099 using sync_vuid_maps::ImageError;
1100
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001101 bool skip = false;
1102 const auto *fb_state = framebuffer;
1103 assert(fb_state);
1104 const auto img_bar_image = img_barrier.image;
1105 bool image_match = false;
1106 bool sub_image_found = false; // Do we find a corresponding subpass description
1107 VkImageLayout sub_image_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1108 uint32_t attach_index = 0;
1109 // Verify that a framebuffer image matches barrier image
1110 const auto attachment_count = fb_state->createInfo.attachmentCount;
1111 for (uint32_t attachment = 0; attachment < attachment_count; ++attachment) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06001112 auto view_state = primary_cb_state ? primary_cb_state->GetActiveAttachmentImageViewState(attachment) : cb_state->GetActiveAttachmentImageViewState(attachment);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001113 if (view_state && (img_bar_image == view_state->create_info.image)) {
1114 image_match = true;
1115 attach_index = attachment;
1116 break;
1117 }
1118 }
1119 if (image_match) { // Make sure subpass is referring to matching attachment
1120 if (sub_desc.pDepthStencilAttachment && sub_desc.pDepthStencilAttachment->attachment == attach_index) {
1121 sub_image_layout = sub_desc.pDepthStencilAttachment->layout;
1122 sub_image_found = true;
1123 }
sfricke-samsung45996a42021-09-16 13:45:27 -07001124 if (!sub_image_found && IsExtEnabled(device_extensions.vk_khr_depth_stencil_resolve)) {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001125 const auto *resolve = LvlFindInChain<VkSubpassDescriptionDepthStencilResolve>(sub_desc.pNext);
1126 if (resolve && resolve->pDepthStencilResolveAttachment &&
1127 resolve->pDepthStencilResolveAttachment->attachment == attach_index) {
1128 sub_image_layout = resolve->pDepthStencilResolveAttachment->layout;
1129 sub_image_found = true;
1130 }
1131 }
1132 if (!sub_image_found) {
1133 for (uint32_t j = 0; j < sub_desc.colorAttachmentCount; ++j) {
1134 if (sub_desc.pColorAttachments && sub_desc.pColorAttachments[j].attachment == attach_index) {
1135 sub_image_layout = sub_desc.pColorAttachments[j].layout;
1136 sub_image_found = true;
1137 break;
1138 }
1139 if (!sub_image_found && sub_desc.pResolveAttachments &&
1140 sub_desc.pResolveAttachments[j].attachment == attach_index) {
1141 sub_image_layout = sub_desc.pResolveAttachments[j].layout;
1142 sub_image_found = true;
1143 break;
1144 }
1145 }
1146 }
1147 if (!sub_image_found) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001148 auto img_loc = loc.dot(Field::image);
1149 const auto &vuid = GetImageBarrierVUID(img_loc, ImageError::kRenderPassMismatch);
1150 skip |=
1151 LogError(rp_handle, vuid,
1152 "%s Barrier for %s is not referenced by the VkSubpassDescription for active subpass (%d) of current %s.",
1153 img_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(), active_subpass,
1154 report_data->FormatHandle(rp_handle).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001155 }
1156 } else { // !image_match
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001157 auto img_loc = loc.dot(Field::image);
1158 const auto &vuid = GetImageBarrierVUID(img_loc, ImageError::kRenderPassMismatch);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001159 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 -07001160 img_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001161 report_data->FormatHandle(fb_state->framebuffer()).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001162 }
1163 if (img_barrier.oldLayout != img_barrier.newLayout) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001164 auto layout_loc = loc.dot(Field::oldLayout);
1165 const auto &vuid = GetImageBarrierVUID(layout_loc, ImageError::kRenderPassLayoutChange);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001166 skip |= LogError(cb_state->commandBuffer(), vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001167 "%s As the Image Barrier for %s is being executed within a render pass instance, oldLayout must "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001168 "equal newLayout yet they are %s and %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001169 layout_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001170 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(img_barrier.newLayout));
1171 } else {
1172 if (sub_image_found && sub_image_layout != img_barrier.oldLayout) {
1173 LogObjectList objlist(rp_handle);
1174 objlist.add(img_bar_image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001175 auto layout_loc = loc.dot(Field::oldLayout);
1176 const auto &vuid = GetImageBarrierVUID(layout_loc, ImageError::kRenderPassLayoutChange);
1177 skip |= LogError(objlist, vuid,
1178 "%s Barrier for %s is referenced by the VkSubpassDescription for active "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001179 "subpass (%d) of current %s as having layout %s, but image barrier has layout %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001180 layout_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(), active_subpass,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001181 report_data->FormatHandle(rp_handle).c_str(), string_VkImageLayout(sub_image_layout),
1182 string_VkImageLayout(img_barrier.oldLayout));
1183 }
1184 }
1185 return skip;
1186}
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001187// explictly instantiate so these can be used in core_validation.cpp
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001188template bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001189 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1190 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
1191 const VkImageMemoryBarrier &img_barrier,
1192 const CMD_BUFFER_STATE *primary_cb_state) const;
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001193template bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001194 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1195 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
1196 const VkImageMemoryBarrier2KHR &img_barrier,
1197 const CMD_BUFFER_STATE *primary_cb_state) const;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001198
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001199template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001200void CoreChecks::EnqueueSubmitTimeValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001201 const ImgBarrier &barrier) {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001202 // Secondary CBs can have null framebuffer so queue up validation in that case 'til FB is known
1203 if ((cb_state->activeRenderPass) && (VK_NULL_HANDLE == cb_state->activeFramebuffer) &&
1204 (VK_COMMAND_BUFFER_LEVEL_SECONDARY == cb_state->createInfo.level)) {
1205 const auto active_subpass = cb_state->activeSubpass;
1206 const auto rp_state = cb_state->activeRenderPass;
1207 const auto &sub_desc = rp_state->createInfo.pSubpasses[active_subpass];
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001208 // Secondary CB case w/o FB specified delay validation
1209 auto *this_ptr = this; // Required for older compilers with c++20 compatibility
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001210 core_error::LocationCapture loc_capture(loc);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001211 const auto render_pass = rp_state->renderPass();
John Zulaufb4438f02021-02-20 20:22:16 -07001212 cb_state->cmd_execute_commands_functions.emplace_back(
1213 [this_ptr, loc_capture, cb_state, active_subpass, sub_desc, render_pass, barrier](const CMD_BUFFER_STATE *primary_cb,
1214 const FRAMEBUFFER_STATE *fb) {
1215 return this_ptr->ValidateImageBarrierAttachment(loc_capture.Get(), cb_state, fb, active_subpass, sub_desc,
1216 render_pass, barrier, primary_cb);
1217 });
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001218 }
1219}
1220
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001221void CoreChecks::RecordBarriers(Func func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001222 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1223 const VkImageMemoryBarrier *pImageMemBarriers) {
1224 for (uint32_t i = 0; i < bufferBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001225 Location loc(func_name, Struct::VkBufferMemoryBarrier, Field::pBufferMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001226 RecordBarrierValidationInfo(loc, cb_state, pBufferMemBarriers[i], cb_state->qfo_transfer_buffer_barriers);
1227 }
1228 for (uint32_t i = 0; i < imageMemBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001229 Location loc(func_name, Struct::VkImageMemoryBarrier, Field::pImageMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001230 const auto &img_barrier = pImageMemBarriers[i];
1231 RecordBarrierValidationInfo(loc, cb_state, img_barrier, cb_state->qfo_transfer_image_barriers);
1232 EnqueueSubmitTimeValidateImageBarrierAttachment(loc, cb_state, img_barrier);
1233 }
1234}
1235
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001236void CoreChecks::RecordBarriers(Func func_name, CMD_BUFFER_STATE *cb_state, const VkDependencyInfoKHR &dep_info) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001237 for (uint32_t i = 0; i < dep_info.bufferMemoryBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001238 Location loc(func_name, Struct::VkBufferMemoryBarrier2KHR, Field::pBufferMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001239 RecordBarrierValidationInfo(loc, cb_state, dep_info.pBufferMemoryBarriers[i], cb_state->qfo_transfer_buffer_barriers);
1240 }
1241 for (uint32_t i = 0; i < dep_info.imageMemoryBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001242 Location loc(func_name, Struct::VkImageMemoryBarrier2KHR, Field::pImageMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001243 const auto &img_barrier = dep_info.pImageMemoryBarriers[i];
1244 RecordBarrierValidationInfo(loc, cb_state, img_barrier, cb_state->qfo_transfer_image_barriers);
1245 EnqueueSubmitTimeValidateImageBarrierAttachment(loc, cb_state, img_barrier);
1246 }
1247}
1248
1249template <typename TransferBarrier, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001250bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001251 const char *operation, const TransferBarrier &barrier,
1252 Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001253 // Record to the scoreboard or report that we have a duplication
1254 bool skip = false;
Jeremy Gebbencbf22862021-03-03 12:01:22 -07001255 auto inserted = scoreboard->emplace(barrier, cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001256 if (!inserted.second && inserted.first->second != cb_state) {
1257 // 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 -06001258 LogObjectList objlist(cb_state->commandBuffer());
Mark Lobodzinskiea561582020-03-16 18:13:56 -06001259 objlist.add(barrier.handle);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001260 objlist.add(inserted.first->second->commandBuffer());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001261 skip = LogWarning(objlist, TransferBarrier::ErrMsgDuplicateQFOInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001262 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1263 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001264 "vkQueueSubmit()", TransferBarrier::BarrierName(), operation, TransferBarrier::HandleName(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001265 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001266 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer()).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001267 }
1268 return skip;
1269}
1270
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001271template <typename TransferBarrier>
1272bool CoreChecks::ValidateQueuedQFOTransferBarriers(
1273 const CMD_BUFFER_STATE *cb_state, QFOTransferCBScoreboards<TransferBarrier> *scoreboards,
1274 const GlobalQFOTransferBarrierMap<TransferBarrier> &global_release_barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001275 bool skip = false;
Jeremy Gebben159b3cc2021-06-03 09:09:03 -06001276 const auto &cb_barriers = cb_state->GetQFOBarrierSets(TransferBarrier());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001277 const char *barrier_name = TransferBarrier::BarrierName();
1278 const char *handle_name = TransferBarrier::HandleName();
John Zulauf6b4aae82018-05-09 13:03:36 -06001279 // No release should have an extant duplicate (WARNING)
1280 for (const auto &release : cb_barriers.release) {
1281 // Check the global pending release barriers
1282 const auto set_it = global_release_barriers.find(release.handle);
1283 if (set_it != global_release_barriers.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001284 const QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001285 const auto found = set_for_handle.find(release);
1286 if (found != set_for_handle.cend()) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001287 skip |= LogWarning(cb_state->commandBuffer(), TransferBarrier::ErrMsgDuplicateQFOSubmitted(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001288 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1289 " to dstQueueFamilyIndex %" PRIu32
1290 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1291 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1292 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001293 }
1294 }
1295 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1296 }
1297 // Each acquire must have a matching release (ERROR)
1298 for (const auto &acquire : cb_barriers.acquire) {
1299 const auto set_it = global_release_barriers.find(acquire.handle);
1300 bool matching_release_found = false;
1301 if (set_it != global_release_barriers.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001302 const QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001303 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1304 }
1305 if (!matching_release_found) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001306 skip |= LogError(cb_state->commandBuffer(), TransferBarrier::ErrMsgMissingQFOReleaseInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001307 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1308 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1309 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1310 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001311 }
1312 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1313 }
1314 return skip;
1315}
1316
John Zulauf3b04ebd2019-07-18 14:08:11 -06001317bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001318 QFOTransferCBScoreboards<QFOImageTransferBarrier> *qfo_image_scoreboards,
1319 QFOTransferCBScoreboards<QFOBufferTransferBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001320 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001321 skip |=
1322 ValidateQueuedQFOTransferBarriers<QFOImageTransferBarrier>(cb_state, qfo_image_scoreboards, qfo_release_image_barrier_map);
1323 skip |= ValidateQueuedQFOTransferBarriers<QFOBufferTransferBarrier>(cb_state, qfo_buffer_scoreboards,
1324 qfo_release_buffer_barrier_map);
John Zulauf6b4aae82018-05-09 13:03:36 -06001325 return skip;
1326}
1327
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001328template <typename TransferBarrier>
1329void RecordQueuedQFOTransferBarriers(QFOTransferBarrierSets<TransferBarrier> &cb_barriers,
1330 GlobalQFOTransferBarrierMap<TransferBarrier> &global_release_barriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001331 // Add release barriers from this submit to the global map
1332 for (const auto &release : cb_barriers.release) {
1333 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1334 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1335 global_release_barriers[release.handle].insert(release);
1336 }
1337
1338 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1339 for (const auto &acquire : cb_barriers.acquire) {
1340 // NOTE: We're not using [] because we don't want to create entries for missing releases
1341 auto set_it = global_release_barriers.find(acquire.handle);
1342 if (set_it != global_release_barriers.end()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001343 QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001344 set_for_handle.erase(acquire);
1345 if (set_for_handle.size() == 0) { // Clean up empty sets
1346 global_release_barriers.erase(set_it);
1347 }
1348 }
1349 }
1350}
1351
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001352void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001353 RecordQueuedQFOTransferBarriers<QFOImageTransferBarrier>(cb_state->qfo_transfer_image_barriers, qfo_release_image_barrier_map);
1354 RecordQueuedQFOTransferBarriers<QFOBufferTransferBarrier>(cb_state->qfo_transfer_buffer_barriers,
1355 qfo_release_buffer_barrier_map);
John Zulauf6b4aae82018-05-09 13:03:36 -06001356}
1357
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001358template <typename ImgBarrier>
1359void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count, const ImgBarrier *barriers) {
1360 // For ownership transfers, the barrier is specified twice; as a release
1361 // operation on the yielding queue family, and as an acquire operation
1362 // on the acquiring queue family. This barrier may also include a layout
1363 // transition, which occurs 'between' the two operations. For validation
1364 // purposes it doesn't seem important which side performs the layout
1365 // transition, but it must not be performed twice. We'll arbitrarily
1366 // choose to perform it as part of the acquire operation.
1367 //
1368 // However, we still need to record initial layout for the "initial layout" validation
1369 for (uint32_t i = 0; i < barrier_count; i++) {
1370 const auto &mem_barrier = barriers[i];
Jeremy Gebbenefead332021-06-18 08:22:44 -06001371 const bool is_release_op = cb_state->IsReleaseOp(mem_barrier);
Petr Krausad0096a2019-08-09 18:35:04 +02001372 auto *image_state = GetImageState(mem_barrier.image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001373 if (image_state) {
1374 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
1375 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001376 }
1377}
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001378// explictly instantiate this template so it can be used in core_validation.cpp
1379template void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1380 const VkImageMemoryBarrier *barrier);
1381template void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1382 const VkImageMemoryBarrier2KHR *barrier);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001383
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001384VkImageLayout NormalizeSynchronization2Layout(const VkImageAspectFlags aspect_mask, VkImageLayout layout);
1385
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001386template <typename ImgBarrier>
unknown86bcb3a2019-07-11 13:05:36 -06001387void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001388 const ImgBarrier &mem_barrier, bool is_release_op) {
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001389 if (enabled_features.synchronization2_features.synchronization2) {
1390 if (mem_barrier.oldLayout == mem_barrier.newLayout) {
1391 return;
1392 }
1393 }
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06001394 auto normalized_isr = image_state->NormalizeSubresourceRange(mem_barrier.subresourceRange);
unknown86bcb3a2019-07-11 13:05:36 -06001395
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001396 VkImageLayout initial_layout = NormalizeSynchronization2Layout(mem_barrier.subresourceRange.aspectMask, mem_barrier.oldLayout);
1397 VkImageLayout new_layout = NormalizeSynchronization2Layout(mem_barrier.subresourceRange.aspectMask, mem_barrier.newLayout);
Michael Spang8af7c102020-05-03 20:50:09 -04001398
1399 // Layout transitions in external instance are not tracked, so don't validate initial layout.
John Zulaufcea64cb2020-06-10 17:17:27 -06001400 if (QueueFamilyIsExternal(mem_barrier.srcQueueFamilyIndex)) {
Michael Spang8af7c102020-05-03 20:50:09 -04001401 initial_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1402 }
1403
John Zulauf2be3fe02019-12-30 09:48:02 -07001404 if (is_release_op) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06001405 cb_state->SetImageInitialLayout(*image_state, normalized_isr, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001406 } else {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06001407 cb_state->SetImageLayout(*image_state, normalized_isr, new_layout, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001408 }
unknown86bcb3a2019-07-11 13:05:36 -06001409}
1410
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001411bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1412 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1413 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1414 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06001415 if (disabled[image_layout_validation]) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001416 assert(cb_node);
1417 assert(image_state);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001418 const auto image = image_state->image();
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001419 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001420
Jeremy Gebben159b3cc2021-06-03 09:09:03 -06001421 const auto *subresource_map = cb_node->GetImageSubresourceLayoutMap(image);
John Zulauff660ad62019-03-23 07:16:05 -06001422 if (subresource_map) {
1423 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001424 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
Tony Barbour55688172020-09-23 15:19:50 -07001425 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
1426 // the next "constant value" range
1427 for (auto pos = subresource_map->Find(range); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07001428 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001429 *error = true;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001430 subres_skip |= LogError(cb_node->commandBuffer(), layout_mismatch_msg_code,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001431 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1432 "%s layout %s.",
1433 caller, report_data->FormatHandle(image).c_str(), pos->subresource.arrayLayer,
1434 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1435 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001436 }
John Zulauf5e617452019-11-19 14:44:16 -07001437 }
John Zulauff660ad62019-03-23 07:16:05 -06001438 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001439 }
John Zulauff660ad62019-03-23 07:16:05 -06001440
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001441 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1442 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1443 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001444 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1445 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001446 skip |= LogPerformanceWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001447 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
1448 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001449 }
sfricke-samsung45996a42021-09-16 13:45:27 -07001450 } else if (IsExtEnabled(device_extensions.vk_khr_shared_presentable_image)) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001451 if (image_state->shared_presentable) {
1452 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001453 skip |=
1454 LogError(device, layout_invalid_msg_code,
1455 "%s: Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1456 caller, string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001457 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001458 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001459 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001460 *error = true;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001461 skip |= LogError(cb_node->commandBuffer(), layout_invalid_msg_code,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001462 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1463 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1464 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001465 }
1466 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001467 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001468}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001469bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001470 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1471 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001472 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001473 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1474 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1475}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001476
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001477void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001478 FRAMEBUFFER_STATE *framebuffer_state) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001479 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass);
1480 if (!render_pass) return;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001481
Mike Schuchardt2df08912020-12-15 16:28:09 -08001482 const VkRenderPassCreateInfo2 *render_pass_info = render_pass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001483 if (framebuffer_state) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001484 for (uint32_t i = 0; i < render_pass_info->attachmentCount; ++i) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06001485 auto *view_state = pCB->GetActiveAttachmentImageViewState(i);
John Zulauf8e308292018-09-21 11:34:37 -06001486 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001487 VkImageLayout stencil_layout = kInvalidLayout;
1488 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001489 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(render_pass_info->pAttachments[i].pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -07001490 if (attachment_description_stencil_layout) {
1491 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1492 }
Jeremy Gebben1ec89332021-08-05 13:51:49 -06001493 pCB->SetImageViewLayout(*view_state, render_pass_info->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001494 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001495 }
1496 }
1497}
Dave Houltone19e20d2018-02-02 16:32:41 -07001498
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001499#ifdef VK_USE_PLATFORM_ANDROID_KHR
1500// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1501// This could also move into a seperate core_validation_android.cpp file... ?
1502
1503//
1504// AHB-specific validation within non-AHB APIs
1505//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001506bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001507 bool skip = false;
1508
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001509 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(create_info->pNext);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001510 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001511 if (0 != ext_fmt_android->externalFormat) {
1512 if (VK_FORMAT_UNDEFINED != create_info->format) {
1513 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001514 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1515 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1516 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001517 }
1518
1519 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001520 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1521 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1522 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001523 }
1524
1525 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001526 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1527 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06001528 "non-zero externalFormat, but usage includes bits (0x%" PRIx32 ") other than VK_IMAGE_USAGE_SAMPLED_BIT.",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001529 create_info->usage);
Dave Houltond9611312018-11-19 17:03:36 -07001530 }
1531
1532 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001533 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1534 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1535 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001536 }
1537 }
1538
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001539 if ((0 != ext_fmt_android->externalFormat) &&
1540 (ahb_ext_formats_map.find(ext_fmt_android->externalFormat) == ahb_ext_formats_map.end())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001541 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001542 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat (%" PRIu64
1543 ") which has "
1544 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().",
1545 ext_fmt_android->externalFormat);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001546 }
1547 }
1548
Dave Houltond9611312018-11-19 17:03:36 -07001549 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001550 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001551 skip |=
1552 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1553 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1554 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001555 }
1556 }
1557
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001558 const VkExternalMemoryImageCreateInfo *emici = LvlFindInChain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001559 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1560 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001561 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001562 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1563 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1564 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1565 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001566 }
1567
1568 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001569 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1570 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1571 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1572 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1573 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001574 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001575 }
1576
1577 return skip;
1578}
1579
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001580bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001581 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001582 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001583
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06001584 if (image_state->HasAHBFormat()) {
Dave Houltond9611312018-11-19 17:03:36 -07001585 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001586 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1587 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001588 "format member is %s and must be VK_FORMAT_UNDEFINED.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001589 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001590 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001591
Dave Houltond9611312018-11-19 17:03:36 -07001592 // Chain must include a compatible ycbcr conversion
1593 bool conv_found = false;
1594 uint64_t external_format = 0;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001595 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = LvlFindInChain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001596 if (ycbcr_conv_info != nullptr) {
Jeremy Gebbenf4fb2a02021-07-08 09:57:46 -06001597 auto ycbcr_state = GetSamplerYcbcrConversionState(ycbcr_conv_info->conversion);
1598 if (ycbcr_state) {
Dave Houltond9611312018-11-19 17:03:36 -07001599 conv_found = true;
Jeremy Gebbenf4fb2a02021-07-08 09:57:46 -06001600 external_format = ycbcr_state->external_format;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001601 }
Dave Houltond9611312018-11-19 17:03:36 -07001602 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001603 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001604 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001605 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1606 "an externalFormat (%" PRIu64
1607 ") but needs a chained VkSamplerYcbcrConversionInfo struct with a VkSamplerYcbcrConversion created "
1608 "with the same external format.",
1609 image_state->ahb_format);
Dave Houltond9611312018-11-19 17:03:36 -07001610 }
1611
1612 // Errors in create_info swizzles
sfricke-samsungbd0e8052020-06-06 01:36:39 -07001613 if (IsIdentitySwizzle(create_info->components) == false) {
1614 skip |= LogError(
1615 create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1616 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1617 "includes one or more non-identity component swizzles, r swizzle = %s, g swizzle = %s, b swizzle = %s, a swizzle "
1618 "= %s.",
1619 string_VkComponentSwizzle(create_info->components.r), string_VkComponentSwizzle(create_info->components.g),
1620 string_VkComponentSwizzle(create_info->components.b), string_VkComponentSwizzle(create_info->components.a));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001621 }
1622 }
Dave Houltond9611312018-11-19 17:03:36 -07001623
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001624 return skip;
1625}
1626
John Zulaufa26d3c82019-08-14 16:09:08 -06001627bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001628 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001629
John Zulaufa26d3c82019-08-14 16:09:08 -06001630 const IMAGE_STATE *image_state = GetImageState(image);
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001631 if (image_state != nullptr) {
Jeremy Gebben6fbf8242021-06-21 09:14:46 -06001632 if (image_state->IsExternalAHB() && (0 == image_state->GetBoundMemory().size())) {
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001633 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1634 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1635 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1636 "bound to memory.");
1637 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001638 }
1639 return skip;
1640}
1641
1642#else
1643
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001644bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001645 return false;
1646}
1647
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001648bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001649
John Zulaufa26d3c82019-08-14 16:09:08 -06001650bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001651
1652#endif // VK_USE_PLATFORM_ANDROID_KHR
1653
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001654bool CoreChecks::ValidateImageFormatFeatures(const VkImageCreateInfo *pCreateInfo) const {
1655 bool skip = false;
1656
1657 // validates based on imageCreateFormatFeatures from vkspec.html#resources-image-creation-limits
1658 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
1659 const VkImageTiling image_tiling = pCreateInfo->tiling;
1660 const VkFormat image_format = pCreateInfo->format;
1661
1662 if (image_format == VK_FORMAT_UNDEFINED) {
1663 // VU 01975 states format can't be undefined unless an android externalFormat
1664#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001665 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001666 if ((image_tiling == VK_IMAGE_TILING_OPTIMAL) && (ext_fmt_android != nullptr) && (0 != ext_fmt_android->externalFormat)) {
1667 auto it = ahb_ext_formats_map.find(ext_fmt_android->externalFormat);
1668 if (it != ahb_ext_formats_map.end()) {
1669 tiling_features = it->second;
1670 }
1671 }
1672#endif
1673 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1674 uint64_t drm_format_modifier = 0;
1675 const VkImageDrmFormatModifierExplicitCreateInfoEXT *drm_explicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001676 LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001677 const VkImageDrmFormatModifierListCreateInfoEXT *drm_implicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001678 LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001679
1680 if (drm_explicit != nullptr) {
1681 drm_format_modifier = drm_explicit->drmFormatModifier;
1682 } else {
1683 // VUID 02261 makes sure its only explict or implict in parameter checking
1684 assert(drm_implicit != nullptr);
1685 for (uint32_t i = 0; i < drm_implicit->drmFormatModifierCount; i++) {
1686 drm_format_modifier |= drm_implicit->pDrmFormatModifiers[i];
1687 }
1688 }
1689
1690 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
1691 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
1692 nullptr};
1693 format_properties_2.pNext = (void *)&drm_properties_list;
1694 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Lionel Landwerlin09351a72020-06-22 18:15:59 +03001695 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
1696 drm_properties.resize(drm_properties_list.drmFormatModifierCount);
1697 drm_properties_list.pDrmFormatModifierProperties = &drm_properties[0];
1698 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001699
1700 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
1701 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_modifier) != 0) {
1702 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
1703 }
1704 }
1705 } else {
1706 VkFormatProperties format_properties = GetPDFormatProperties(image_format);
1707 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
1708 : format_properties.optimalTilingFeatures;
1709 }
1710
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001711 // Lack of disjoint format feature support while using the flag
1712 if (FormatIsMultiplane(image_format) && ((pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT) != 0) &&
1713 ((tiling_features & VK_FORMAT_FEATURE_DISJOINT_BIT) == 0)) {
1714 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateFormatFeatures-02260",
1715 "vkCreateImage(): can't use VK_IMAGE_CREATE_DISJOINT_BIT because %s doesn't support "
1716 "VK_FORMAT_FEATURE_DISJOINT_BIT based on imageCreateFormatFeatures.",
1717 string_VkFormat(pCreateInfo->format));
1718 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001719
1720 return skip;
1721}
1722
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001723bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001724 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001725 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001726
sfricke-samsung45996a42021-09-16 13:45:27 -07001727 if (IsExtEnabled(device_extensions.vk_android_external_memory_android_hardware_buffer)) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001728 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001729 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1730 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001731 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1732 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001733 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001734 }
1735
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001736 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1737 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001738 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1739 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1740 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001741 }
Dave Houlton130c0212018-01-29 13:39:56 -07001742 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001743
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001744 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001745 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1746 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1747 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001748 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001749 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width (%u) exceeds "
1750 "device maxFramebufferWidth (%u).",
1751 pCreateInfo->extent.width, device_limits->maxFramebufferWidth);
Dave Houlton130c0212018-01-29 13:39:56 -07001752 }
1753
1754 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001755 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001756 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height (%u) exceeds "
1757 "device maxFramebufferHeight (%u).",
1758 pCreateInfo->extent.height, device_limits->maxFramebufferHeight);
Dave Houlton130c0212018-01-29 13:39:56 -07001759 }
1760
ziga-lunarg44cba6e2021-07-13 17:58:06 +02001761 VkImageCreateFlags sparseFlags =
1762 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
1763 if ((pCreateInfo->flags & sparseFlags) && (pCreateInfo->usage & VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT)) {
1764 skip |= LogError(
1765 device, "VUID-VkImageCreateInfo-None-01925",
1766 "vkCreateImage(): images using sparse memory cannot have VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT set");
1767 }
1768
sfricke-samsung45996a42021-09-16 13:45:27 -07001769 if (IsExtEnabled(device_extensions.vk_ext_fragment_density_map) ||
1770 IsExtEnabled(device_extensions.vk_ext_fragment_density_map2)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001771 uint32_t ceiling_width = static_cast<uint32_t>(ceil(
1772 static_cast<float>(device_limits->maxFramebufferWidth) /
1773 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001774 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1775 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001776 LogError(device, "VUID-VkImageCreateInfo-usage-02559",
1777 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1778 "ceiling of device "
1779 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1780 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1781 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001782 }
1783
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001784 uint32_t ceiling_height = static_cast<uint32_t>(ceil(
1785 static_cast<float>(device_limits->maxFramebufferHeight) /
1786 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001787 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1788 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001789 LogError(device, "VUID-VkImageCreateInfo-usage-02560",
1790 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1791 "ceiling of device "
1792 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1793 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1794 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001795 }
1796 }
1797
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001798 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001799 VkResult result = VK_SUCCESS;
1800 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1801 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1802 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1803 &format_limits);
1804 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001805 auto modifier_list = LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1806 auto explicit_modifier = LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001807 if (modifier_list) {
1808 for (uint32_t i = 0; i < modifier_list->drmFormatModifierCount; i++) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001809 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001810 drm_format_modifier.drmFormatModifier = modifier_list->pDrmFormatModifiers[i];
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001811 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001812 image_format_info.type = pCreateInfo->imageType;
1813 image_format_info.format = pCreateInfo->format;
1814 image_format_info.tiling = pCreateInfo->tiling;
1815 image_format_info.usage = pCreateInfo->usage;
1816 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001817 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001818
1819 result =
1820 DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1821 format_limits = image_format_properties.imageFormatProperties;
1822
1823 /* The application gives a list of modifier and the driver
1824 * selects one. If one is wrong, stop there.
1825 */
1826 if (result != VK_SUCCESS) break;
1827 }
1828 } else if (explicit_modifier) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001829 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001830 drm_format_modifier.drmFormatModifier = explicit_modifier->drmFormatModifier;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001831 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001832 image_format_info.type = pCreateInfo->imageType;
1833 image_format_info.format = pCreateInfo->format;
1834 image_format_info.tiling = pCreateInfo->tiling;
1835 image_format_info.usage = pCreateInfo->usage;
1836 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001837 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001838
1839 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1840 format_limits = image_format_properties.imageFormatProperties;
1841 }
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001842 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001843
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001844 // 1. vkGetPhysicalDeviceImageFormatProperties[2] only success code is VK_SUCCESS
1845 // 2. If call returns an error, then "imageCreateImageFormatPropertiesList" is defined to be the empty list
1846 // 3. All values in 02251 are undefined if "imageCreateImageFormatPropertiesList" is empty.
1847 if (result != VK_SUCCESS) {
1848 // External memory will always have a "imageCreateImageFormatPropertiesList" so skip
Lockee87f87c2019-04-23 17:53:10 -06001849#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001850 if (!LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext)) {
Lockee87f87c2019-04-23 17:53:10 -06001851#endif // VK_USE_PLATFORM_ANDROID_KHR
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001852 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateMaxMipLevels-02251",
Spencer Frickec46fc6d2020-04-16 06:23:05 -07001853 "vkCreateImage(): Format %s is not supported for this combination of parameters and "
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001854 "VkGetPhysicalDeviceImageFormatProperties returned back %s.",
1855 string_VkFormat(pCreateInfo->format), string_VkResult(result));
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001856#ifdef VK_USE_PLATFORM_ANDROID_KHR
1857 }
1858#endif // VK_USE_PLATFORM_ANDROID_KHR
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001859 } else {
1860 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1861 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001862 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1863 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1864 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001865 }
Dave Houlton130c0212018-01-29 13:39:56 -07001866
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001867 uint64_t texel_count = static_cast<uint64_t>(pCreateInfo->extent.width) *
1868 static_cast<uint64_t>(pCreateInfo->extent.height) *
1869 static_cast<uint64_t>(pCreateInfo->extent.depth) * static_cast<uint64_t>(pCreateInfo->arrayLayers) *
1870 static_cast<uint64_t>(pCreateInfo->samples);
Dave Houlton130c0212018-01-29 13:39:56 -07001871
sfricke-samsung2e827212021-09-28 07:52:08 -07001872 // Depth/Stencil formats size can't be accurately calculated
1873 if (!FormatIsDepthAndStencil(pCreateInfo->format)) {
1874 uint64_t total_size =
1875 static_cast<uint64_t>(std::ceil(FormatTexelSize(pCreateInfo->format) * static_cast<double>(texel_count)));
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001876
sfricke-samsung2e827212021-09-28 07:52:08 -07001877 // Round up to imageGranularity boundary
1878 VkDeviceSize image_granularity = phys_dev_props.limits.bufferImageGranularity;
1879 uint64_t ig_mask = image_granularity - 1;
1880 total_size = (total_size + ig_mask) & ~ig_mask;
1881
1882 if (total_size > format_limits.maxResourceSize) {
1883 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
1884 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1885 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1886 total_size, format_limits.maxResourceSize);
1887 }
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001888 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001889
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001890 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001891 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
1892 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1893 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001894 }
1895
1896 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001897 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
1898 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
1899 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001900 }
sfricke-samsung612f3622020-06-20 20:42:46 -07001901
1902 if (pCreateInfo->extent.width > format_limits.maxExtent.width) {
1903 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02252",
1904 "vkCreateImage(): extent.width %u exceeds allowable maximum image extent width %u.",
1905 pCreateInfo->extent.width, format_limits.maxExtent.width);
1906 }
1907
1908 if (pCreateInfo->extent.height > format_limits.maxExtent.height) {
1909 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02253",
1910 "vkCreateImage(): extent.height %u exceeds allowable maximum image extent height %u.",
1911 pCreateInfo->extent.height, format_limits.maxExtent.height);
1912 }
1913
1914 if (pCreateInfo->extent.depth > format_limits.maxExtent.depth) {
1915 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02254",
1916 "vkCreateImage(): extent.depth %u exceeds allowable maximum image extent depth %u.",
1917 pCreateInfo->extent.depth, format_limits.maxExtent.depth);
1918 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001919 }
1920
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001921 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsungcead0802020-01-30 22:20:10 -08001922 if (FormatRequiresYcbcrConversion(pCreateInfo->format)) {
1923 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
sfricke-samsung45996a42021-09-16 13:45:27 -07001924 const char *error_vuid = IsExtEnabled(device_extensions.vk_ext_ycbcr_image_arrays)
1925 ? "VUID-VkImageCreateInfo-format-02653"
1926 : "VUID-VkImageCreateInfo-format-02564";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001927 skip |= LogError(device, error_vuid,
1928 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
1929 "YCbCr Conversion format, arrayLayers must be 1",
1930 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001931 }
1932
1933 if (pCreateInfo->mipLevels != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001934 skip |= LogError(device, "VUID-VkImageCreateInfo-format-02561",
1935 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
1936 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001937 }
1938
1939 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001940 skip |= LogError(
1941 device, "VUID-VkImageCreateInfo-format-02562",
sfricke-samsungcead0802020-01-30 22:20:10 -08001942 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
1943 string_VkSampleCountFlagBits(pCreateInfo->samples));
1944 }
1945
1946 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001947 skip |= LogError(
1948 device, "VUID-VkImageCreateInfo-format-02563",
sfricke-samsungcead0802020-01-30 22:20:10 -08001949 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
1950 string_VkImageType(pCreateInfo->imageType));
1951 }
1952 }
1953
sfricke-samsung45996a42021-09-16 13:45:27 -07001954 if (IsExtEnabled(device_extensions.vk_khr_maintenance2)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001955 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
sfricke-samsung08796682021-09-13 07:47:20 -07001956 if (!FormatIsCompressed(pCreateInfo->format)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001957 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01572",
1958 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
sfricke-samsung08796682021-09-13 07:47:20 -07001959 "format must be a compressed image format, but is %s",
Spencer Fricke48db59b2020-03-23 10:31:46 -07001960 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001961 }
1962 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001963 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01573",
1964 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1965 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001966 }
1967 }
1968 }
1969
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001970 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
sfricke-samsung45996a42021-09-16 13:45:27 -07001971 const char *vuid = IsExtEnabled(device_extensions.vk_khr_get_physical_device_properties2)
1972 ? "VUID-VkImageCreateInfo-sharingMode-01420"
1973 : "VUID-VkImageCreateInfo-sharingMode-01392";
Mark Lobodzinski314b9162020-07-16 15:33:08 -06001974 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
ziga-lunarge2e283d2021-08-01 09:55:04 +02001975 "vkCreateImage", "pCreateInfo->pQueueFamilyIndices", vuid);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001976 }
1977
unknown2c877272019-07-11 12:56:50 -06001978 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
1979 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
1980 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001981 LogError(device, "VUID-VkImageCreateInfo-format-01577",
1982 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
1983 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06001984 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001985
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001986 const auto swapchain_create_info = LvlFindInChain<VkImageSwapchainCreateInfoKHR>(pCreateInfo->pNext);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07001987 if (swapchain_create_info != nullptr) {
1988 if (swapchain_create_info->swapchain != VK_NULL_HANDLE) {
1989 const SWAPCHAIN_NODE *swapchain_state = GetSwapchainState(swapchain_create_info->swapchain);
1990 const VkSwapchainCreateFlagsKHR swapchain_flags = swapchain_state->createInfo.flags;
1991
1992 // Validate rest of Swapchain Image create check that require swapchain state
1993 const char *vuid = "VUID-VkImageSwapchainCreateInfoKHR-swapchain-00995";
1994 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR) != 0) &&
1995 ((pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) == 0)) {
1996 skip |= LogError(
1997 device, vuid,
1998 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR flag so "
1999 "all swapchain images must have the VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT flag set.");
2000 }
2001 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR) != 0) &&
2002 ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) == 0)) {
2003 skip |= LogError(device, vuid,
2004 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR flag so all "
2005 "swapchain images must have the VK_IMAGE_CREATE_PROTECTED_BIT flag set.");
2006 }
Mike Schuchardt2df08912020-12-15 16:28:09 -08002007 const VkImageCreateFlags mutable_flags = (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT | VK_IMAGE_CREATE_EXTENDED_USAGE_BIT);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002008 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR) != 0) &&
2009 ((pCreateInfo->flags & mutable_flags) != mutable_flags)) {
2010 skip |= LogError(device, vuid,
2011 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR flag so "
2012 "all swapchain images must have the VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT and "
Mike Schuchardt2df08912020-12-15 16:28:09 -08002013 "VK_IMAGE_CREATE_EXTENDED_USAGE_BIT flags both set.");
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002014 }
2015 }
2016 }
2017
sfricke-samsungedce77a2020-07-03 22:35:13 -07002018 if ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) != 0) {
2019 if (enabled_features.core11.protectedMemory == VK_FALSE) {
2020 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01890",
2021 "vkCreateImage(): the protectedMemory device feature is disabled: Images cannot be created with the "
2022 "VK_IMAGE_CREATE_PROTECTED_BIT set.");
2023 }
2024 const VkImageCreateFlags invalid_flags =
2025 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
2026 if ((pCreateInfo->flags & invalid_flags) != 0) {
2027 skip |= LogError(device, "VUID-VkImageCreateInfo-None-01891",
2028 "vkCreateImage(): VK_IMAGE_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at same "
2029 "time (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | "
2030 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT).");
2031 }
2032 }
2033
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002034 skip |= ValidateImageFormatFeatures(pCreateInfo);
2035
Nathaniel Cesarioc02c2512020-11-13 12:04:24 -07002036 // Check compatibility with VK_KHR_portability_subset
sfricke-samsung45996a42021-09-16 13:45:27 -07002037 if (IsExtEnabled(device_extensions.vk_khr_portability_subset)) {
Nathaniel Cesarioc02c2512020-11-13 12:04:24 -07002038 if (VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT & pCreateInfo->flags &&
2039 VK_FALSE == enabled_features.portability_subset_features.imageView2DOn3DImage) {
2040 skip |= LogError(device, "VUID-VkImageCreateInfo-imageView2DOn3DImage-04459",
2041 "vkCreateImage (portability error): VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT is not supported.");
2042 }
2043 if ((VK_SAMPLE_COUNT_1_BIT != pCreateInfo->samples) && (1 != pCreateInfo->arrayLayers) &&
2044 (VK_FALSE == enabled_features.portability_subset_features.multisampleArrayImage)) {
2045 skip |=
2046 LogError(device, "VUID-VkImageCreateInfo-multisampleArrayImage-04460",
2047 "vkCreateImage (portability error): Cannot create an image with samples/texel > 1 && arrayLayers != 1");
2048 }
2049 }
2050
ziga-lunarg63f8d7a2021-07-20 22:10:31 +02002051 const auto external_memory_create_info_nv = LvlFindInChain<VkExternalMemoryImageCreateInfoNV>(pCreateInfo->pNext);
2052 if (external_memory_create_info_nv != nullptr) {
2053 const auto external_memory_create_info = LvlFindInChain<VkExternalMemoryImageCreateInfo>(pCreateInfo->pNext);
2054 if (external_memory_create_info != nullptr) {
2055 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-00988",
2056 "vkCreateImage(): VkImageCreateInfo struct has both VkExternalMemoryImageCreateInfoNV and "
2057 "VkExternalMemoryImageCreateInfo chained structs.");
2058 }
2059 }
2060
ziga-lunarg374fd9a2021-07-18 10:32:52 +02002061 if (device_group_create_info.physicalDeviceCount == 1) {
2062 if (pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) {
2063 skip |= LogError(device, "VUID-VkImageCreateInfo-physicalDeviceCount-01421",
2064 "vkCreateImage: Device was created with VkDeviceGroupDeviceCreateInfo::physicalDeviceCount 1, but "
2065 "flags contain VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT bit.");
2066 }
2067 }
2068
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002069 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002070}
2071
John Zulauf7eeb6f72019-06-17 11:56:36 -06002072void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
2073 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
2074 if (VK_SUCCESS != result) return;
2075
2076 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
locke-lunarg20699892020-01-02 19:17:29 -07002077 auto image_state = Get<IMAGE_STATE>(*pImage);
2078 AddInitialLayoutintoImageLayoutMap(*image_state, imageLayoutMap);
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07002079}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002080
Jeff Bolz5c801d12019-10-09 10:38:45 -05002081bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05002082 const IMAGE_STATE *image_state = GetImageState(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002083 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07002084 if (image_state) {
Jeremy Gebben82e11d52021-07-26 09:19:37 -06002085 if (image_state->IsSwapchainImage()) {
sfricke-samsung73452522021-06-17 08:44:46 -07002086 skip |= LogError(device, "VUID-vkDestroyImage-image-04882",
sfricke-samsung9056cc12021-04-18 22:51:00 -07002087 "vkDestroyImage(): %s is a presentable image and it is controlled by the implementation and is "
2088 "destroyed with vkDestroySwapchainKHR.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002089 report_data->FormatHandle(image_state->image()).c_str());
sfricke-samsung9056cc12021-04-18 22:51:00 -07002090 }
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06002091 skip |= ValidateObjectNotInUse(image_state, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002092 }
2093 return skip;
2094}
2095
John Zulauf7eeb6f72019-06-17 11:56:36 -06002096void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
2097 // Clean up validation specific data
Jeremy Gebbene60d4172021-02-02 15:42:15 -07002098 qfo_release_image_barrier_map.erase(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002099
locke-lunargcba7d5f2019-12-30 16:59:11 -07002100 imageLayoutMap.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06002101
2102 // Clean up generic image state
2103 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002104}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002105
sfricke-samsungcd924d92020-05-20 23:51:17 -07002106bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range,
2107 const char *param_name) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002108 bool skip = false;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002109 const VkImage image = image_state->image();
sfricke-samsungcd924d92020-05-20 23:51:17 -07002110 const VkFormat format = image_state->createInfo.format;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002111
2112 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002113 skip |= LogError(image, "VUID-vkCmdClearColorImage-aspectMask-02498",
2114 "vkCmdClearColorImage(): %s.aspectMasks must only be set to VK_IMAGE_ASPECT_COLOR_BIT.", param_name);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002115 }
2116
sfricke-samsungcd924d92020-05-20 23:51:17 -07002117 if (FormatIsDepthOrStencil(format)) {
2118 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2119 "vkCmdClearColorImage(): %s called with image %s which has a depth/stencil format (%s).", param_name,
2120 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
2121 } else if (FormatIsCompressed(format)) {
2122 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2123 "vkCmdClearColorImage(): %s called with image %s which has a compressed format (%s).", param_name,
2124 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002125 }
2126
2127 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002128 skip |=
2129 LogError(image, "VUID-vkCmdClearColorImage-image-00002",
2130 "vkCmdClearColorImage() %s called with image %s which was created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.",
2131 param_name, report_data->FormatHandle(image).c_str());
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002132 }
2133 return skip;
2134}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002135
John Zulauf07288512019-07-05 11:09:50 -06002136bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
2137 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
2138 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002139 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002140 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2141 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002142 skip |= LogError(image_state->image(), "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002143 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2144 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002145 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002146
2147 } else {
2148 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
sfricke-samsung45996a42021-09-16 13:45:27 -07002149 if (!IsExtEnabled(device_extensions.vk_khr_shared_presentable_image)) {
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002150 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002151 skip |= LogError(image_state->image(), "VUID-vkCmdClearColorImage-imageLayout-00005",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002152 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2153 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002154 }
2155 } else {
2156 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
2157 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002158 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002159 image_state->image(), "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002160 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
2161 func_name, string_VkImageLayout(dest_image_layout));
2162 }
2163 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002164 }
2165
John Zulauff660ad62019-03-23 07:16:05 -06002166 // Cast to const to prevent creation at validate time.
Jeremy Gebben159b3cc2021-06-03 09:09:03 -06002167 const auto *subresource_map = cb_node->GetImageSubresourceLayoutMap(image_state->image());
John Zulauff660ad62019-03-23 07:16:05 -06002168 if (subresource_map) {
2169 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06002170 LayoutUseCheckAndMessage layout_check(subresource_map);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002171 auto normalized_isr = image_state->NormalizeSubresourceRange(range);
Tony Barbour55688172020-09-23 15:19:50 -07002172 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
2173 // the next "constant value" range
2174 for (auto pos = subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07002175 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06002176 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
2177 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2178 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
2179 } else {
2180 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002181 }
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002182 subres_skip |= LogError(cb_node->commandBuffer(), error_code,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002183 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
2184 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
2185 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002186 }
John Zulauf5e617452019-11-19 14:44:16 -07002187 }
John Zulauff660ad62019-03-23 07:16:05 -06002188 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002189 }
2190
2191 return skip;
2192}
2193
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002194bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2195 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002196 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002197 bool skip = false;
2198 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06002199 const auto *cb_node = GetCBState(commandBuffer);
2200 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002201 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002202 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002203 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
sfricke-samsung45996a42021-09-16 13:45:27 -07002204 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002205 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
2206 "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04002207 }
sfricke-samsung022fa252020-07-24 03:26:16 -07002208 skip |=
2209 ValidateProtectedImage(cb_node, image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-commandBuffer-01805");
2210 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearColorImage()",
2211 "VUID-vkCmdClearColorImage-commandBuffer-01806");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002212 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002213 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002214 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
sfricke-samsungcd924d92020-05-20 23:51:17 -07002215 skip |= ValidateImageAttributes(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002216 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002217 }
sfricke-samsunge775d492020-02-28 09:02:25 -08002218 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
2219 if (FormatRequiresYcbcrConversion(image_state->createInfo.format)) {
2220 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
2221 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
2222 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
2223 string_VkFormat(image_state->createInfo.format));
2224 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002225 }
2226 return skip;
2227}
2228
John Zulaufeabb4462019-07-05 14:13:03 -06002229void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2230 const VkClearColorValue *pColor, uint32_t rangeCount,
2231 const VkImageSubresourceRange *pRanges) {
2232 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
2233
2234 auto cb_node = GetCBState(commandBuffer);
2235 auto image_state = GetImageState(image);
2236 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002237 for (uint32_t i = 0; i < rangeCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06002238 cb_node->SetImageInitialLayout(image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002239 }
2240 }
2241}
2242
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002243bool CoreChecks::ValidateClearDepthStencilValue(VkCommandBuffer commandBuffer, VkClearDepthStencilValue clearValue,
2244 const char *apiName) const {
2245 bool skip = false;
2246
2247 // 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 -07002248 if (!IsExtEnabled(device_extensions.vk_ext_depth_range_unrestricted)) {
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002249 if (!(clearValue.depth >= 0.0) || !(clearValue.depth <= 1.0)) {
2250 // Also VUID-VkClearDepthStencilValue-depth-00022
2251 skip |= LogError(commandBuffer, "VUID-VkClearDepthStencilValue-depth-02506",
2252 "%s: VK_EXT_depth_range_unrestricted extension is not enabled and VkClearDepthStencilValue::depth "
2253 "(=%f) is not within the [0.0, 1.0] range.",
2254 apiName, clearValue.depth);
2255 }
2256 }
2257
2258 return skip;
2259}
2260
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002261bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2262 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002263 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002264 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002265
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002266 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06002267 const auto *cb_node = GetCBState(commandBuffer);
2268 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002269 if (cb_node && image_state) {
sfricke-samsung30e325a2020-07-25 12:56:13 -07002270 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002271 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002272 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002273 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
sfricke-samsung45996a42021-09-16 13:45:27 -07002274 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002275 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002276 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04002277 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002278 skip |= ValidateClearDepthStencilValue(commandBuffer, *pDepthStencil, "vkCmdClearDepthStencilImage()");
sfricke-samsung022fa252020-07-24 03:26:16 -07002279 skip |= ValidateProtectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2280 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01807");
2281 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2282 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01808");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002283
2284 bool any_include_aspect_depth_bit = false;
2285 bool any_include_aspect_stencil_bit = false;
2286
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002287 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002288 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002289 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002290 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002291 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06002292 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
2293 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002294 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-aspectMask-02824",
2295 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask can only be VK_IMAGE_ASPECT_DEPTH_BIT "
2296 "and/or VK_IMAGE_ASPECT_STENCIL_BIT.",
2297 i);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002298 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002299 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
2300 any_include_aspect_depth_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002301 if (FormatHasDepth(image_format) == false) {
2302 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02826",
2303 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_DEPTH_BIT but %s "
2304 "doesn't have a depth component.",
2305 i, string_VkFormat(image_format));
2306 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002307 }
2308 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
2309 any_include_aspect_stencil_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002310 if (FormatHasStencil(image_format) == false) {
2311 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02825",
2312 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_STENCIL_BIT but "
2313 "%s doesn't have a stencil component.",
2314 i, string_VkFormat(image_format));
2315 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002316 }
2317 }
2318 if (any_include_aspect_stencil_bit) {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07002319 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05002320 if (image_stencil_struct != nullptr) {
2321 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
2322 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002323 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
2324 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
2325 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
2326 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002327 }
2328 } else {
2329 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002330 skip |= LogError(
2331 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05002332 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
2333 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
2334 "in VkImageCreateInfo::usage used to create image");
2335 }
2336 }
2337 }
2338 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002339 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
2340 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
2341 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002342 }
sfricke-samsung30e325a2020-07-25 12:56:13 -07002343 if (image_state && !FormatIsDepthOrStencil(image_format)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002344 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014",
2345 "vkCmdClearDepthStencilImage(): called with image %s which doesn't have a depth/stencil format (%s).",
sfricke-samsung30e325a2020-07-25 12:56:13 -07002346 report_data->FormatHandle(image).c_str(), string_VkFormat(image_format));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002347 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002348 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002349 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009",
2350 "vkCmdClearDepthStencilImage(): called with image %s which was not created with the "
2351 "VK_IMAGE_USAGE_TRANSFER_DST_BIT set.",
2352 report_data->FormatHandle(image).c_str());
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002353 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002354 }
2355 return skip;
2356}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002357
John Zulaufeabb4462019-07-05 14:13:03 -06002358void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2359 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
2360 const VkImageSubresourceRange *pRanges) {
2361 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
2362 auto cb_node = GetCBState(commandBuffer);
2363 auto image_state = GetImageState(image);
2364 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002365 for (uint32_t i = 0; i < rangeCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06002366 cb_node->SetImageInitialLayout(image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002367 }
2368 }
2369}
2370
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002371// Returns true if [x, xoffset] and [y, yoffset] overlap
2372static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
2373 bool result = false;
2374 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
2375 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
2376
2377 if (intersection_max > intersection_min) {
2378 result = true;
2379 }
2380 return result;
2381}
2382
Jeff Leger178b1e52020-10-05 12:22:23 -04002383// Returns true if source area of first vkImageCopy/vkImageCopy2KHR region intersects dest area of second region
Dave Houltonc991cc92018-03-06 11:08:51 -07002384// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
Jeff Leger178b1e52020-10-05 12:22:23 -04002385template <typename RegionType>
2386static bool RegionIntersects(const RegionType *rgn0, const RegionType *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002387 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07002388
Dave Houltonc991cc92018-03-06 11:08:51 -07002389 // Separate planes within a multiplane image cannot intersect
2390 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07002391 return result;
2392 }
2393
Dave Houltonc991cc92018-03-06 11:08:51 -07002394 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
2395 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
2396 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002397 result = true;
2398 switch (type) {
2399 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002400 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002401 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002402 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002403 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002404 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002405 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002406 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002407 break;
2408 default:
2409 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2410 assert(false);
2411 }
2412 }
2413 return result;
2414}
2415
Dave Houltonfc1a4052017-04-27 14:32:45 -06002416// Returns non-zero if offset and extent exceed image extents
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002417static const uint32_t kXBit = 1;
2418static const uint32_t kYBit = 2;
2419static const uint32_t kZBit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002420static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002421 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002422 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002423 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2424 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002425 result |= kZBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002426 }
2427 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2428 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002429 result |= kYBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002430 }
2431 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2432 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002433 result |= kXBit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002434 }
2435 return result;
2436}
2437
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002438// Test if two VkExtent3D structs are equivalent
2439static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2440 bool result = true;
2441 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2442 (extent->depth != other_extent->depth)) {
2443 result = false;
2444 }
2445 return result;
2446}
2447
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002448// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002449static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002450 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2451}
2452
2453// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002454VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002455 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2456 VkExtent3D granularity = {0, 0, 0};
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002457 auto pool = cb_node->command_pool.get();
2458 if (pool) {
2459 granularity = GetPhysicalDeviceState()->queue_family_properties[pool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06002460 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002461 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002462 granularity.width *= block_size.width;
2463 granularity.height *= block_size.height;
2464 }
2465 }
2466 return granularity;
2467}
2468
2469// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2470static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2471 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002472 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2473 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002474 valid = false;
2475 }
2476 return valid;
2477}
2478
2479// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002480bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002481 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002482 bool skip = false;
2483 VkExtent3D offset_extent = {};
2484 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2485 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2486 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002487 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002488 // If the queue family image transfer granularity is (0, 0, 0), then the offset must always be (0, 0, 0)
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002489 if (IsExtentAllZeroes(&offset_extent) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002490 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002491 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) must be (x=0, y=0, z=0) when the command buffer's queue family "
2492 "image transfer granularity is (w=0, h=0, d=0).",
2493 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002494 }
2495 } else {
2496 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2497 // integer multiples of the image transfer granularity.
2498 if (IsExtentAligned(&offset_extent, granularity) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002499 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002500 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2501 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2502 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2503 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002504 }
2505 }
2506 return skip;
2507}
2508
2509// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002510bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002511 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002512 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002513 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002514 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002515 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2516 // subresource extent.
2517 if (IsExtentEqual(extent, subresource_extent) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002518 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002519 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2520 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2521 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2522 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002523 }
2524 } else {
2525 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2526 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2527 // subresource extent dimensions.
2528 VkExtent3D offset_extent_sum = {};
2529 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2530 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2531 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002532 bool x_ok = true;
2533 bool y_ok = true;
2534 bool z_ok = true;
2535 switch (image_type) {
2536 case VK_IMAGE_TYPE_3D:
2537 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2538 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002539 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002540 case VK_IMAGE_TYPE_2D:
2541 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2542 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002543 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002544 case VK_IMAGE_TYPE_1D:
2545 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2546 (subresource_extent->width == offset_extent_sum.width));
2547 break;
2548 default:
2549 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2550 assert(false);
2551 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002552 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002553 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002554 LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002555 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2556 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2557 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2558 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2559 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2560 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002561 }
2562 }
2563 return skip;
2564}
2565
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002566bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002567 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002568 bool skip = false;
2569 if (mip_level >= img->createInfo.mipLevels) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002570 skip |= LogError(cb_node->commandBuffer(), vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2571 function, i, member, mip_level, report_data->FormatHandle(img->image()).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002572 }
2573 return skip;
2574}
2575
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002576bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002577 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002578 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002579 bool skip = false;
2580 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2581 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002582 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002583 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2584 "%u, but provided %s has %u array layers.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002585 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image()).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002586 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002587 }
2588 return skip;
2589}
2590
Jeff Leger178b1e52020-10-05 12:22:23 -04002591// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy/VkBufferImageCopy2KHR structure
2592template <typename BufferImageCopyRegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002593bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002594 const BufferImageCopyRegionType *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002595 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002596 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002597 VkExtent3D granularity = GetScaledItg(cb_node, img);
2598 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002599 VkExtent3D subresource_extent = img->GetSubresourceExtent(region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002600 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002601 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002602 return skip;
2603}
2604
Jeff Leger178b1e52020-10-05 12:22:23 -04002605// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy/VkImageCopy2KHR structure
2606template <typename RegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002607bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002608 const IMAGE_STATE *dst_img, const RegionType *region,
2609 const uint32_t i, const char *function,
2610 CopyCommandVersion version) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002611 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002612 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2613 const char *vuid;
2614
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002615 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002616 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002617 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
2618 skip |= CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", vuid);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002619 VkExtent3D subresource_extent = src_img->GetSubresourceExtent(region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002620 const VkExtent3D extent = region->extent;
Jeff Leger178b1e52020-10-05 12:22:23 -04002621 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002622 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04002623 i, function, "extent", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002624
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002625 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002626 granularity = GetScaledItg(cb_node, dst_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002627 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
2628 skip |= CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", vuid);
Dave Houltonee281a52017-12-08 13:51:02 -07002629 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002630 const VkExtent3D dest_effective_extent =
2631 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002632 subresource_extent = dst_img->GetSubresourceExtent(region->dstSubresource);
Jeff Leger178b1e52020-10-05 12:22:23 -04002633 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002634 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Jeff Leger178b1e52020-10-05 12:22:23 -04002635 dst_img->createInfo.imageType, i, function, "extent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002636 return skip;
2637}
2638
Jeff Leger178b1e52020-10-05 12:22:23 -04002639// Validate contents of a VkImageCopy or VkImageCopy2KHR struct
2640template <typename ImageCopyRegionType>
2641bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const ImageCopyRegionType *ic_regions,
2642 const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state,
2643 CopyCommandVersion version) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002644 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002645 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2646 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2647 const char *vuid;
Dave Houlton6f9059e2017-05-02 17:15:13 -06002648
2649 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002650 const ImageCopyRegionType region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002651
2652 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002653 const VkExtent3D src_copy_extent = region.extent;
2654 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002655 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2656
Dave Houlton6f9059e2017-05-02 17:15:13 -06002657 bool slice_override = false;
2658 uint32_t depth_slices = 0;
2659
2660 // Special case for copying between a 1D/2D array and a 3D image
2661 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2662 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002663 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002664 slice_override = (depth_slices != 1);
2665 } else if ((VK_IMAGE_TYPE_3D == dst_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != src_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002666 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002667 slice_override = (depth_slices != 1);
2668 }
2669
2670 // Do all checks on source image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002671 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002672 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002673 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00146" : "VUID-vkCmdCopyImage-srcImage-00146";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002674 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002675 "%s: pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2676 "be 0 and 1, respectively.",
2677 func_name, i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002678 }
2679 }
2680
Dave Houlton533be9f2018-03-26 17:08:30 -06002681 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002682 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01785" : "VUID-vkCmdCopyImage-srcImage-01785";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002683 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002684 "%s: pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002685 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002686 func_name, i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002687 }
2688
Dave Houlton533be9f2018-03-26 17:08:30 -06002689 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002690 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01787" : "VUID-vkCmdCopyImage-srcImage-01787";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002691 skip |= LogError(src_state->image(), vuid, "%s: pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002692 func_name, i, region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002693 }
2694
Dave Houltonc991cc92018-03-06 11:08:51 -07002695 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002696 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002697 if (FormatIsCompressed(src_state->createInfo.format) ||
2698 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002699 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002700 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002701 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2702 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2703 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002704 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01727" : "VUID-vkCmdCopyImage-srcImage-01727";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002705 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002706 "%s: pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002707 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002708 func_name, i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002709 }
2710
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002711 const VkExtent3D mip_extent = src_state->GetSubresourceExtent(region.srcSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07002712 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2713 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002714 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01728" : "VUID-vkCmdCopyImage-srcImage-01728";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002715 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002716 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2717 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2718 func_name, i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002719 }
2720
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002721 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002722 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2723 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002724 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01729" : "VUID-vkCmdCopyImage-srcImage-01729";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002725 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002726 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2727 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2728 func_name, i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002729 }
2730
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002731 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002732 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2733 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002734 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01730" : "VUID-vkCmdCopyImage-srcImage-01730";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002735 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002736 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2737 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2738 func_name, i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002739 }
2740 } // Compressed
2741
2742 // Do all checks on dest image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002743 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002744 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002745 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00152" : "VUID-vkCmdCopyImage-dstImage-00152";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002746 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002747 "%s: pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002748 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002749 func_name, i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002750 }
2751 }
2752
Dave Houlton533be9f2018-03-26 17:08:30 -06002753 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 -04002754 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01786" : "VUID-vkCmdCopyImage-dstImage-01786";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002755 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002756 "%s: pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2757 "and 1, respectively.",
2758 func_name, i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002759 }
2760
Dave Houlton533be9f2018-03-26 17:08:30 -06002761 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002762 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01788" : "VUID-vkCmdCopyImage-dstImage-01788";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002763 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 -04002764 func_name, i, region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002765 }
2766
sfricke-samsung30b094c2020-05-30 11:42:11 -07002767 // Handle difference between Maintenance 1
sfricke-samsung45996a42021-09-16 13:45:27 -07002768 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002769 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2770 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002771 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-04443" : "VUID-vkCmdCopyImage-srcImage-04443";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002772 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002773 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2774 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2775 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002776 }
2777 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002778 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002779 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002780 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-04444" : "VUID-vkCmdCopyImage-dstImage-04444";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002781 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002782 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2783 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2784 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002785 }
2786 }
2787 } else { // Pre maint 1
2788 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002789 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002790 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002791 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002792 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and "
sfricke-samsung30b094c2020-05-30 11:42:11 -07002793 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2794 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002795 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002796 }
Dave Houltonee281a52017-12-08 13:51:02 -07002797 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002798 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002799 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002800 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002801 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2802 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002803 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002804 }
2805 }
2806 }
2807
Dave Houltonc991cc92018-03-06 11:08:51 -07002808 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2809 if (FormatIsCompressed(dst_state->createInfo.format) ||
2810 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002811 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002812
2813 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002814 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2815 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2816 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002817 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01731" : "VUID-vkCmdCopyImage-dstImage-01731";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002818 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002819 "%s: pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002820 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002821 func_name, i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002822 }
2823
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002824 const VkExtent3D mip_extent = dst_state->GetSubresourceExtent(region.dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07002825 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2826 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002827 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01732" : "VUID-vkCmdCopyImage-dstImage-01732";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002828 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002829 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2830 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2831 func_name, i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002832 }
2833
Dave Houltonee281a52017-12-08 13:51:02 -07002834 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2835 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2836 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002837 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01733" : "VUID-vkCmdCopyImage-dstImage-01733";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002838 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002839 "%s: pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002840 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2841 "height (%d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002842 func_name, i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002843 }
2844
Dave Houltonee281a52017-12-08 13:51:02 -07002845 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2846 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2847 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002848 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01734" : "VUID-vkCmdCopyImage-dstImage-01734";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002849 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002850 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2851 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2852 func_name, i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002853 }
2854 } // Compressed
2855 }
2856 return skip;
2857}
2858
Jeff Leger178b1e52020-10-05 12:22:23 -04002859template <typename RegionType>
2860bool CoreChecks::ValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2861 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2862 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002863 const auto *cb_node = GetCBState(commandBuffer);
2864 const auto *src_image_state = GetImageState(srcImage);
2865 const auto *dst_image_state = GetImageState(dstImage);
sfricke-samsungdce5f692020-03-07 13:59:31 -08002866 const VkFormat src_format = src_image_state->createInfo.format;
2867 const VkFormat dst_format = dst_image_state->createInfo.format;
Jeff Leger178b1e52020-10-05 12:22:23 -04002868 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002869 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002870
Jeff Leger178b1e52020-10-05 12:22:23 -04002871 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2872 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGE2KHR : CMD_COPYIMAGE;
2873 const char *vuid;
2874
2875 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state, version);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002876
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002877 VkCommandBuffer command_buffer = cb_node->commandBuffer();
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002878
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002879 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002880 const RegionType region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002881
2882 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2883 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08002884 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07002885
Dave Houlton6f9059e2017-05-02 17:15:13 -06002886 bool slice_override = false;
2887 uint32_t depth_slices = 0;
2888
2889 // Special case for copying between a 1D/2D array and a 3D image
2890 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2891 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2892 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002893 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002894 slice_override = (depth_slices != 1);
2895 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2896 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002897 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002898 slice_override = (depth_slices != 1);
2899 }
2900
Jeff Leger178b1e52020-10-05 12:22:23 -04002901 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, func_name, "srcSubresource", i);
2902 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, func_name, "dstSubresource", i);
2903 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01696" : "VUID-vkCmdCopyImage-srcSubresource-01696";
2904 skip |=
2905 ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
2906 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01697" : "VUID-vkCmdCopyImage-dstSubresource-01697";
2907 skip |=
2908 ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
2909 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01698" : "VUID-vkCmdCopyImage-srcSubresource-01698";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002910 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002911 region.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
2912 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01699" : "VUID-vkCmdCopyImage-dstSubresource-01699";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002913 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002914 region.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002915
sfricke-samsung45996a42021-09-16 13:45:27 -07002916 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002917 // No chance of mismatch if we're overriding depth slice count
2918 if (!slice_override) {
2919 // The number of depth slices in srcSubresource and dstSubresource must match
2920 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2921 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002922 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2923 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002924 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002925 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2926 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002927 if (src_slices != dst_slices) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002928 vuid = is_2khr ? "VUID-VkImageCopy2KHR-extent-00140" : "VUID-VkImageCopy-extent-00140";
2929 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002930 "%s: number of depth slices in source (%u) and destination (%u) subresources for pRegions[%u] "
2931 "do not match.",
2932 func_name, src_slices, dst_slices, i);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002933 }
2934 }
2935 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002936 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002937 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002938 vuid = is_2khr ? "VUID-VkImageCopy2KHR-layerCount-00138" : "VUID-VkImageCopy-layerCount-00138";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002939 skip |=
2940 LogError(command_buffer, vuid,
2941 "%s: number of layers in source (%u) and destination (%u) subresources for pRegions[%u] do not match",
2942 func_name, region.srcSubresource.layerCount, region.dstSubresource.layerCount, i);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002943 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002944 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002945
Dave Houltonc991cc92018-03-06 11:08:51 -07002946 // Do multiplane-specific checks, if extension enabled
sfricke-samsung45996a42021-09-16 13:45:27 -07002947 if (IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)) {
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002948 if ((!FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format))) {
2949 // If neither image is multi-plane the aspectMask member of src and dst must match
2950 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2951 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01551" : "VUID-vkCmdCopyImage-srcImage-01551";
2952 skip |= LogError(command_buffer, vuid,
2953 "%s: Copy between non-multiplane images with differing aspectMasks in pRegions[%u] with "
2954 "source (0x%x) destination (0x%x).",
2955 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
2956 }
2957 } else {
2958 // Source image multiplane checks
2959 uint32_t planes = FormatPlaneCount(src_format);
2960 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2961 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
2962 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01552" : "VUID-vkCmdCopyImage-srcImage-01552";
2963 skip |= LogError(command_buffer, vuid,
2964 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
2965 i, aspect);
2966 }
2967 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
2968 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
2969 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01553" : "VUID-vkCmdCopyImage-srcImage-01553";
2970 skip |= LogError(command_buffer, vuid,
2971 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
2972 i, aspect);
2973 }
2974 // Single-plane to multi-plane
2975 if ((!FormatIsMultiplane(src_format)) && (FormatIsMultiplane(dst_format)) &&
2976 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2977 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01557" : "VUID-vkCmdCopyImage-dstImage-01557";
2978 skip |= LogError(command_buffer, vuid,
2979 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
2980 func_name, i, aspect);
2981 }
Dave Houltonc991cc92018-03-06 11:08:51 -07002982
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002983 // Dest image multiplane checks
2984 planes = FormatPlaneCount(dst_format);
2985 aspect = region.dstSubresource.aspectMask;
2986 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
2987 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01554" : "VUID-vkCmdCopyImage-dstImage-01554";
2988 skip |= LogError(command_buffer, vuid,
2989 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
2990 i, aspect);
2991 }
2992 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
2993 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
2994 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01555" : "VUID-vkCmdCopyImage-dstImage-01555";
2995 skip |= LogError(command_buffer, vuid,
2996 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
2997 i, aspect);
2998 }
2999 // Multi-plane to single-plane
3000 if ((FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format)) &&
3001 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
3002 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01556" : "VUID-vkCmdCopyImage-srcImage-01556";
3003 skip |= LogError(command_buffer, vuid,
3004 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
3005 func_name, i, aspect);
3006 }
3007 }
3008 } else {
3009 // !vk_khr_sampler_ycbcr_conversion
Dave Houltonf5217612018-02-02 16:18:52 -07003010 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
3011 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003012 vuid = is_2khr ? "VUID-VkImageCopy2KHR-aspectMask-00137" : "VUID-VkImageCopy-aspectMask-00137";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003013 skip |= LogError(
3014 command_buffer, vuid,
3015 "%s: Copy between images with differing aspectMasks in pRegions[%u] with source (0x%x) destination (0x%x).",
3016 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
Dave Houltonf5217612018-02-02 16:18:52 -07003017 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003018 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003019
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003020 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08003021 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003022 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00142" : "VUID-vkCmdCopyImage-aspectMask-00142";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003023 skip |=
3024 LogError(command_buffer, vuid,
3025 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) cannot specify aspects not present in source image.",
3026 func_name, i, region.srcSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003027 }
3028
3029 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08003030 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003031 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00143" : "VUID-vkCmdCopyImage-aspectMask-00143";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003032 skip |= LogError(
3033 command_buffer, vuid,
3034 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) cannot specify aspects not present in destination image.",
3035 func_name, i, region.dstSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003036 }
3037
Dave Houltonfc1a4052017-04-27 14:32:45 -06003038 // Each dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003039 VkExtent3D subresource_extent = src_image_state->GetSubresourceExtent(region.srcSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07003040 if (slice_override) src_copy_extent.depth = depth_slices;
3041 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003042 if (extent_check & kXBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003043 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00144" : "VUID-vkCmdCopyImage-srcOffset-00144";
3044 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003045 "%s: Source image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003046 "width [%1d].",
3047 func_name, i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003048 }
3049
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003050 if (extent_check & kYBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003051 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00145" : "VUID-vkCmdCopyImage-srcOffset-00145";
3052 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003053 "%s: Source image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003054 "height [%1d].",
3055 func_name, i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003056 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003057 if (extent_check & kZBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003058 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00147" : "VUID-vkCmdCopyImage-srcOffset-00147";
3059 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003060 "%s: Source image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003061 "depth [%1d].",
3062 func_name, i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003063 }
3064
Dave Houltonee281a52017-12-08 13:51:02 -07003065 // Adjust dest extent if necessary
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003066 subresource_extent = dst_image_state->GetSubresourceExtent(region.dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07003067 if (slice_override) dst_copy_extent.depth = depth_slices;
3068
3069 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003070 if (extent_check & kXBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003071 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00150" : "VUID-vkCmdCopyImage-dstOffset-00150";
3072 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003073 "%s: Dest image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003074 "width [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003075 func_name, i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003076 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003077 if (extent_check & kYBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003078 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00151" : "VUID-vkCmdCopyImage-dstOffset-00151";
3079 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003080 "%s): Dest image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003081 "height [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003082 func_name, i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003083 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003084 if (extent_check & kZBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003085 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00153" : "VUID-vkCmdCopyImage-dstOffset-00153";
3086 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003087 "%s: Dest image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003088 "depth [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003089 func_name, i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003090 }
3091
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003092 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
3093 // must not overlap in memory
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003094 if (src_image_state->image() == dst_image_state->image()) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003095 for (uint32_t j = 0; j < regionCount; j++) {
3096 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
sfricke-samsungdce5f692020-03-07 13:59:31 -08003097 FormatIsMultiplane(src_format))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003098 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-pRegions-00124" : "VUID-vkCmdCopyImage-pRegions-00124";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003099 skip |= LogError(command_buffer, vuid, "%s: pRegion[%u] src overlaps with pRegions[%u].", func_name, i, j);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003100 }
3101 }
3102 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08003103
3104 // 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 -07003105 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
sfricke-samsung48172ca2020-02-13 23:38:11 -08003106 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3107 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3108 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003109 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01790" : "VUID-vkCmdCopyImage-srcImage-01790";
3110 skip |= LogError(command_buffer, vuid,
3111 "%s: pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1",
3112 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003113 }
3114 } else {
3115 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
3116 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3117 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003118 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01789" : "VUID-vkCmdCopyImage-srcImage-01789";
3119 skip |= LogError(command_buffer, vuid,
3120 "%s: pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1",
3121 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003122 }
3123 }
3124
3125 // Check if 2D with 3D and depth not equal to 2D layerCount
3126 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3127 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
3128 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003129 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01791" : "VUID-vkCmdCopyImage-srcImage-01791";
3130 skip |= LogError(command_buffer, vuid,
3131 "%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 -08003132 "srcSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003133 func_name, i, src_copy_extent.depth, region.srcSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003134 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
3135 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
3136 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003137 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01792" : "VUID-vkCmdCopyImage-dstImage-01792";
3138 skip |= LogError(command_buffer, vuid,
3139 "%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 -08003140 "dstSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003141 func_name, i, src_copy_extent.depth, region.dstSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003142 }
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003143
3144 // Check for multi-plane format compatiblity
3145 if (FormatIsMultiplane(src_format) || FormatIsMultiplane(dst_format)) {
sfricke-samsung73e755c2021-09-30 08:34:57 -07003146 const VkFormat src_plane_format = FormatIsMultiplane(src_format)
3147 ? FindMultiplaneCompatibleFormat(src_format, region.srcSubresource.aspectMask)
3148 : src_format;
3149 const VkFormat dst_plane_format = FormatIsMultiplane(dst_format)
3150 ? FindMultiplaneCompatibleFormat(dst_format, region.dstSubresource.aspectMask)
3151 : dst_format;
3152 const size_t src_format_size = FormatElementSize(src_plane_format);
3153 const size_t dst_format_size = FormatElementSize(dst_plane_format);
3154
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003155 // If size is still zero, then format is invalid and will be caught in another VU
3156 if ((src_format_size != dst_format_size) && (src_format_size != 0) && (dst_format_size != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003157 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-None-01549" : "VUID-vkCmdCopyImage-None-01549";
3158 skip |= LogError(command_buffer, vuid,
3159 "%s: pRegions[%u] called with non-compatible image formats. "
3160 "The src format %s with aspectMask %s is not compatible with dst format %s aspectMask %s.",
3161 func_name, i, string_VkFormat(src_format),
3162 string_VkImageAspectFlags(region.srcSubresource.aspectMask).c_str(), string_VkFormat(dst_format),
3163 string_VkImageAspectFlags(region.dstSubresource.aspectMask).c_str());
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003164 }
3165 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003166 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003167
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003168 // The formats of non-multiplane src_image and dst_image must be compatible. Formats are considered compatible if their texel
3169 // size in bytes is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT
3170 // because because both texels are 4 bytes in size.
3171 if (!FormatIsMultiplane(src_format) && !FormatIsMultiplane(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003172 const char *compatible_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003173 IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
Jeff Leger178b1e52020-10-05 12:22:23 -04003174 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01548" : "VUID-vkCmdCopyImage-srcImage-01548")
3175 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00135" : "VUID-vkCmdCopyImage-srcImage-00135");
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003176 // Depth/stencil formats must match exactly.
3177 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3178 if (src_format != dst_format) {
3179 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003180 "%s: Depth/stencil formats must match exactly for src (%s) and dst (%s).", func_name,
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003181 string_VkFormat(src_format), string_VkFormat(dst_format));
3182 }
3183 } else {
Jeff Leger178b1e52020-10-05 12:22:23 -04003184 if (FormatElementSize(src_format) != FormatElementSize(dst_format)) {
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003185 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003186 "%s: Unmatched image format sizes. "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06003187 "The src format %s has size of %" PRIu32 " and dst format %s has size of %" PRIu32 ".",
Jeff Leger178b1e52020-10-05 12:22:23 -04003188 func_name, string_VkFormat(src_format), FormatElementSize(src_format), string_VkFormat(dst_format),
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003189 FormatElementSize(dst_format));
3190 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003191 }
3192 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003193
Dave Houlton33c22b72017-02-28 13:16:02 -07003194 // Source and dest image sample counts must match
3195 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003196 std::stringstream ss;
3197 ss << func_name << " called on image pair with non-identical sample counts.";
3198 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00136" : "VUID-vkCmdCopyImage-srcImage-00136";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003199 skip |=
3200 LogError(command_buffer, vuid, "%s: The src image sample count (%s) dose not match the dst image sample count (%s).",
3201 func_name, string_VkSampleCountFlagBits(src_image_state->createInfo.samples),
3202 string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Dave Houlton33c22b72017-02-28 13:16:02 -07003203 }
3204
sfricke-samsung45996a42021-09-16 13:45:27 -07003205 vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
Tony-LunarG5a066372021-01-21 10:31:34 -07003206 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01546" : "VUID-vkCmdCopyImage-srcImage-01546")
3207 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00127" : "VUID-vkCmdCopyImage-srcImage-00127");
Jeff Leger178b1e52020-10-05 12:22:23 -04003208 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
sfricke-samsung45996a42021-09-16 13:45:27 -07003209 vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
Tony-LunarG5a066372021-01-21 10:31:34 -07003210 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01547" : "VUID-vkCmdCopyImage-dstImage-01547")
3211 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00132" : "VUID-vkCmdCopyImage-dstImage-00132");
3212 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003213 // Validate that SRC & DST images have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04003214 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00126" : "VUID-vkCmdCopyImage-srcImage-00126";
3215 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3216 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3217 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00131" : "VUID-vkCmdCopyImage-dstImage-00131";
3218 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3219 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3220 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01825" : "VUID-vkCmdCopyImage-commandBuffer-01825";
3221 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3222 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01826" : "VUID-vkCmdCopyImage-commandBuffer-01826";
3223 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3224 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01827" : "VUID-vkCmdCopyImage-commandBuffer-01827";
3225 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003226
3227 // Validation for VK_EXT_fragment_density_map
3228 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003229 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3230 skip |=
3231 LogError(command_buffer, vuid,
3232 "%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 +02003233 }
3234 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003235 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3236 skip |=
3237 LogError(command_buffer, vuid,
3238 "%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 +02003239 }
3240
sfricke-samsung45996a42021-09-16 13:45:27 -07003241 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003242 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01995" : "VUID-vkCmdCopyImage-srcImage-01995";
3243 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
3244 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01996" : "VUID-vkCmdCopyImage-dstImage-01996";
3245 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003246 }
Jeff Leger178b1e52020-10-05 12:22:23 -04003247 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Tobin Ehlisc8266452017-04-07 12:20:30 -06003248 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04003249
3250 const char *invalid_src_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003251 (src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003252 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-01917" : "VUID-vkCmdCopyImage-srcImageLayout-01917")
3253 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00129" : "VUID-vkCmdCopyImage-srcImageLayout-00129");
3254 const char *invalid_dst_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003255 (dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003256 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-01395" : "VUID-vkCmdCopyImage-dstImageLayout-01395")
3257 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00134" : "VUID-vkCmdCopyImage-dstImageLayout-00134");
3258
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003259 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003260 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00128" : "VUID-vkCmdCopyImage-srcImageLayout-00128";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003261 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003262 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3263 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00133" : "VUID-vkCmdCopyImage-dstImageLayout-00133";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003264 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003265 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003266 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003267 func_name, version);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003268 }
3269
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003270 return skip;
3271}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003272
Jeff Leger178b1e52020-10-05 12:22:23 -04003273bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3274 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3275 const VkImageCopy *pRegions) const {
3276 return ValidateCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3277 COPY_COMMAND_VERSION_1);
3278}
3279
3280bool CoreChecks::PreCallValidateCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) const {
3281 return ValidateCmdCopyImage(commandBuffer, pCopyImageInfo->srcImage, pCopyImageInfo->srcImageLayout, pCopyImageInfo->dstImage,
3282 pCopyImageInfo->dstImageLayout, pCopyImageInfo->regionCount, pCopyImageInfo->pRegions,
3283 COPY_COMMAND_VERSION_2);
3284}
3285
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003286void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3287 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3288 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003289 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3290 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003291 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003292 auto src_image_state = GetImageState(srcImage);
3293 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003294
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003295 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003296 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06003297 cb_node->SetImageInitialLayout(*src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3298 cb_node->SetImageInitialLayout(*dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003299 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003300}
3301
Jeff Leger178b1e52020-10-05 12:22:23 -04003302void CoreChecks::PreCallRecordCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) {
3303 StateTracker::PreCallRecordCmdCopyImage2KHR(commandBuffer, pCopyImageInfo);
3304 auto cb_node = GetCBState(commandBuffer);
3305 auto src_image_state = GetImageState(pCopyImageInfo->srcImage);
3306 auto dst_image_state = GetImageState(pCopyImageInfo->dstImage);
3307
3308 // Make sure that all image slices are updated to correct layout
3309 for (uint32_t i = 0; i < pCopyImageInfo->regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06003310 cb_node->SetImageInitialLayout(*src_image_state, pCopyImageInfo->pRegions[i].srcSubresource,
3311 pCopyImageInfo->srcImageLayout);
3312 cb_node->SetImageInitialLayout(*dst_image_state, pCopyImageInfo->pRegions[i].dstSubresource,
3313 pCopyImageInfo->dstImageLayout);
Jeff Leger178b1e52020-10-05 12:22:23 -04003314 }
3315}
3316
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003317// Returns true if sub_rect is entirely contained within rect
3318static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
3319 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 -07003320 (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 -07003321 return false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003322 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003323 return true;
3324}
3325
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003326bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003327 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
locke-lunargfc78e932020-11-19 17:06:24 -07003328 const VkRect2D &render_area, uint32_t rect_count, const VkClearRect *clear_rects,
3329 const CMD_BUFFER_STATE *primary_cb_state) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07003330 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07003331 const IMAGE_VIEW_STATE *image_view_state = nullptr;
3332 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06003333 if (primary_cb_state) {
3334 image_view_state = primary_cb_state->GetActiveAttachmentImageViewState(fb_attachment);
3335 } else {
3336 image_view_state = GetCBState(command_buffer)->GetActiveAttachmentImageViewState(fb_attachment);
3337 }
John Zulauff2582972019-02-09 14:53:30 -07003338 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003339
3340 for (uint32_t j = 0; j < rect_count; j++) {
3341 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003342 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00016",
3343 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
3344 "the current render pass instance.",
3345 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07003346 }
3347
3348 if (image_view_state) {
3349 // The layers specified by a given element of pRects must be contained within every attachment that
3350 // pAttachments refers to
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06003351 const auto attachment_layer_count = image_view_state->normalized_subresource_range.layerCount;
John Zulauf3a548ef2019-02-01 16:14:07 -07003352 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
3353 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003354 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00017",
3355 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
3356 "of pAttachment[%d].",
3357 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07003358 }
3359 }
3360 }
3361 return skip;
3362}
3363
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003364bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3365 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003366 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003367 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06003368 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02003369 if (!cb_node) return skip;
3370
Petr Kraus2dffb382019-08-10 02:52:12 +02003371 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003372
3373 // Validate that attachment is in reference list of active subpass
3374 if (cb_node->activeRenderPass) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08003375 const VkRenderPassCreateInfo2 *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07003376 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Mike Schuchardt2df08912020-12-15 16:28:09 -08003377 const VkSubpassDescription2 *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
locke-lunargaecf2152020-05-12 17:15:41 -06003378 const auto *framebuffer = cb_node->activeFramebuffer.get();
John Zulauf3a548ef2019-02-01 16:14:07 -07003379 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003380
John Zulauf3a548ef2019-02-01 16:14:07 -07003381 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3382 auto clear_desc = &pAttachments[attachment_index];
3383 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003384 const VkImageAspectFlags aspect_mask = clear_desc->aspectMask;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003385
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003386 if (aspect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
3387 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020",
3388 "vkCmdClearAttachments() pAttachments[%u] mask contains VK_IMAGE_ASPECT_METADATA_BIT",
3389 attachment_index);
3390 } else if (aspect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
3391 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
3392 skip |=
3393 LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-02246",
3394 "vkCmdClearAttachments() pAttachments[%u] mask contains a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit",
3395 attachment_index);
3396 } else if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07003397 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
3398 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
3399 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3400 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003401 skip |= LogError(
3402 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3403 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
3404 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
3405 attachment_index, clear_desc->colorAttachment,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003406 report_data->FormatHandle(cb_node->activeRenderPass->renderPass()).c_str(), cb_node->activeSubpass,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003407 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07003408
John Zulauff2582972019-02-09 14:53:30 -07003409 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
3410 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003411 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003412 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3413 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
3414 " subpass %u. colorAttachmentCount=%u",
3415 attachment_index, clear_desc->colorAttachment,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003416 report_data->FormatHandle(cb_node->activeRenderPass->renderPass()).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003417 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003418 }
John Zulauff2582972019-02-09 14:53:30 -07003419 fb_attachment = color_attachment;
3420
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003421 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
3422 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
3423 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019",
3424 "vkCmdClearAttachments() pAttachments[%u] aspectMask must set only VK_IMAGE_ASPECT_COLOR_BIT "
3425 "of a color attachment.",
3426 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003427 }
3428 } else { // Must be depth and/or stencil
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003429 bool subpass_depth = false;
3430 bool subpass_stencil = false;
3431 if (subpass_desc->pDepthStencilAttachment &&
3432 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3433 auto index = subpass_desc->pDepthStencilAttachment->attachment;
3434 subpass_depth = FormatHasDepth(renderpass_create_info->pAttachments[index].format);
3435 subpass_stencil = FormatHasStencil(renderpass_create_info->pAttachments[index].format);
3436 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003437 if (!subpass_desc->pDepthStencilAttachment ||
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003438 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3439 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) && !subpass_depth) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003440 skip |= LogError(
3441 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02502",
3442 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_DEPTH_BIT but there is no "
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003443 "depth attachment in subpass",
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003444 attachment_index);
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003445 }
3446 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) && !subpass_stencil) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003447 skip |= LogError(
3448 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02503",
3449 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_STENCIL_BIT but there is no "
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003450 "stencil attachment in subpass",
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003451 attachment_index);
3452 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003453 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07003454 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003455 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08003456 if (subpass_depth) {
3457 skip |= ValidateClearDepthStencilValue(commandBuffer, clear_desc->clearValue.depthStencil,
3458 "vkCmdClearAttachments()");
3459 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003460 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003461 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003462 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3463 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06003464 }
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003465
3466 // Once the framebuffer attachment is found, can get the image view state
3467 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) &&
3468 (fb_attachment < framebuffer->createInfo.attachmentCount)) {
3469 const IMAGE_VIEW_STATE *image_view_state =
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06003470 GetCBState(commandBuffer)->GetActiveAttachmentImageViewState(fb_attachment);
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003471 if (image_view_state != nullptr) {
3472 skip |= ValidateProtectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3473 "VUID-vkCmdClearAttachments-commandBuffer-02504");
3474 skip |= ValidateUnprotectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3475 "VUID-vkCmdClearAttachments-commandBuffer-02505");
3476 }
3477 }
John Zulauf441558b2019-08-12 11:47:39 -06003478 }
ziga-lunargfa335aa2021-08-05 16:59:39 +02003479
3480 // When a subpass uses a non-zero view mask, multiview functionality is considered to be enabled
3481 if (subpass_desc->viewMask > 0) {
3482 for (uint32_t i = 0; i < rectCount; ++i) {
3483 if (pRects[i].baseArrayLayer != 0 || pRects[i].layerCount != 1) {
3484 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-baseArrayLayer-00018",
3485 "vkCmdClearAttachments(): pRects[%" PRIu32 "] baseArrayLayer is %" PRIu32
3486 " and layerCount is %" PRIu32 ", but the render pass instance uses multiview.",
3487 i, pRects[i].baseArrayLayer, pRects[i].layerCount);
3488 }
3489 }
3490 }
John Zulauf441558b2019-08-12 11:47:39 -06003491 }
3492 return skip;
3493}
3494
3495void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3496 const VkClearAttachment *pAttachments, uint32_t rectCount,
3497 const VkClearRect *pRects) {
3498 auto *cb_node = GetCBState(commandBuffer);
3499 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08003500 const VkRenderPassCreateInfo2 *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3501 const VkSubpassDescription2 *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
John Zulauf441558b2019-08-12 11:47:39 -06003502 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
3503 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3504 const auto clear_desc = &pAttachments[attachment_index];
3505 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3506 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3507 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3508 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3509 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3510 subpass_desc->pDepthStencilAttachment) {
3511 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3512 }
3513 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003514 if (!clear_rect_copy) {
3515 // We need a copy of the clear rectangles that will persist until the last lambda executes
3516 // but we want to create it as lazily as possible
3517 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003518 }
John Zulauf441558b2019-08-12 11:47:39 -06003519 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3520 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003521 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
locke-lunargaecf2152020-05-12 17:15:41 -06003522 const CMD_BUFFER_STATE *prim_cb, const FRAMEBUFFER_STATE *fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003523 assert(rectCount == clear_rect_copy->size());
John Zulauf3a548ef2019-02-01 16:14:07 -07003524 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3525 bool skip = false;
locke-lunargaecf2152020-05-12 17:15:41 -06003526 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, fb, fb_attachment, render_area, rectCount,
locke-lunargfc78e932020-11-19 17:06:24 -07003527 clear_rect_copy->data(), prim_cb);
John Zulauf3a548ef2019-02-01 16:14:07 -07003528 return skip;
3529 };
3530 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003531 }
3532 }
3533 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003534}
3535
Jeff Leger178b1e52020-10-05 12:22:23 -04003536template <typename RegionType>
3537bool CoreChecks::ValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3538 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3539 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003540 const auto *cb_node = GetCBState(commandBuffer);
3541 const auto *src_image_state = GetImageState(srcImage);
3542 const auto *dst_image_state = GetImageState(dstImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04003543 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
3544 const char *func_name = is_2khr ? "vkCmdResolveImage2KHR()" : "vkCmdResolveImage()";
3545 const CMD_TYPE cmd_type = is_2khr ? CMD_RESOLVEIMAGE : CMD_RESOLVEIMAGE2KHR;
3546 const char *vuid;
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003547
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003548 bool skip = false;
3549 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003550 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00256" : "VUID-vkCmdResolveImage-srcImage-00256";
3551 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3552 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00258" : "VUID-vkCmdResolveImage-dstImage-00258";
3553 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04003554 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Jeff Leger178b1e52020-10-05 12:22:23 -04003555 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02003" : "VUID-vkCmdResolveImage-dstImage-02003";
3556 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, func_name, vuid);
3557 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01837" : "VUID-vkCmdResolveImage-commandBuffer-01837";
3558 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3559 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01838" : "VUID-vkCmdResolveImage-commandBuffer-01838";
3560 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3561 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01839" : "VUID-vkCmdResolveImage-commandBuffer-01839";
3562 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003563
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003564 // Validation for VK_EXT_fragment_density_map
3565 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003566 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003567 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003568 "%s: srcImage must not have been created with flags containing "
3569 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3570 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003571 }
3572 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003573 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003574 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003575 "%s: dstImage must not have been created with flags containing "
3576 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3577 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003578 }
3579
Cort Stratton7df30962018-05-17 19:45:57 -07003580 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003581 const char *invalid_src_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003582 is_2khr ? ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003583 ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-01400"
Shannon McPhersonc505df62020-10-20 16:27:11 -06003584 : "VUID-VkResolveImageInfo2KHR-srcImageLayout-00261")
sfricke-samsung45996a42021-09-16 13:45:27 -07003585 : ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003586 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3587 : "VUID-vkCmdResolveImage-srcImageLayout-00261");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003588 const char *invalid_dst_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003589 is_2khr ? ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003590 ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-01401"
3591 : "VUID-VkResolveImageInfo2KHR-dstImageLayout-00263")
sfricke-samsung45996a42021-09-16 13:45:27 -07003592 : ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003593 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3594 : "VUID-vkCmdResolveImage-dstImageLayout-00263");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003595 // For each region, the number of layers in the image subresource should not be zero
3596 // For each region, src and dest image aspect must be color only
3597 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003598 const RegionType region = pRegions[i];
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003599 const VkImageSubresourceLayers src_subresource = region.srcSubresource;
3600 const VkImageSubresourceLayers dst_subresource = region.dstSubresource;
Jeff Leger178b1e52020-10-05 12:22:23 -04003601 skip |= ValidateImageSubresourceLayers(cb_node, &src_subresource, func_name, "srcSubresource", i);
3602 skip |= ValidateImageSubresourceLayers(cb_node, &dst_subresource, func_name, "dstSubresource", i);
3603 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-00260" : "VUID-vkCmdResolveImage-srcImageLayout-00260";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003604 skip |= VerifyImageLayout(cb_node, src_image_state, src_subresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003605 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3606 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-00262" : "VUID-vkCmdResolveImage-dstImageLayout-00262";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003607 skip |= VerifyImageLayout(cb_node, dst_image_state, dst_subresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003608 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
3609 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01709" : "VUID-vkCmdResolveImage-srcSubresource-01709";
3610 skip |= ValidateImageMipLevel(cb_node, src_image_state, src_subresource.mipLevel, i, func_name, "srcSubresource", vuid);
3611 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01710" : "VUID-vkCmdResolveImage-dstSubresource-01710";
3612 skip |= ValidateImageMipLevel(cb_node, dst_image_state, dst_subresource.mipLevel, i, func_name, "dstSubresource", vuid);
3613 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01711" : "VUID-vkCmdResolveImage-srcSubresource-01711";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003614 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, src_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003615 src_subresource.layerCount, i, func_name, "srcSubresource", vuid);
3616 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01712" : "VUID-vkCmdResolveImage-dstSubresource-01712";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003617 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, dst_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003618 dst_subresource.layerCount, i, func_name, "srcSubresource", vuid);
Cort Stratton7df30962018-05-17 19:45:57 -07003619
3620 // layer counts must match
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003621 if (src_subresource.layerCount != dst_subresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003622 vuid = is_2khr ? "VUID-VkImageResolve2KHR-layerCount-00267" : "VUID-VkImageResolve-layerCount-00267";
3623 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003624 LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003625 "%s: layerCount in source and destination subresource of pRegions[%u] does not match.", func_name, i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003626 }
Cort Stratton7df30962018-05-17 19:45:57 -07003627 // For each region, src and dest image aspect must be color only
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003628 if ((src_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3629 (dst_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003630 vuid = is_2khr ? "VUID-VkImageResolve2KHR-aspectMask-00266" : "VUID-VkImageResolve-aspectMask-00266";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003631 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003632 "%s: src and dest aspectMasks for pRegions[%u] must specify only VK_IMAGE_ASPECT_COLOR_BIT.",
3633 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003634 }
3635
3636 const VkImageType src_image_type = src_image_state->createInfo.imageType;
3637 const VkImageType dst_image_type = dst_image_state->createInfo.imageType;
3638
3639 if ((VK_IMAGE_TYPE_3D == src_image_type) || (VK_IMAGE_TYPE_3D == dst_image_type)) {
Shannon McPherson74b341c2020-09-08 15:43:05 -06003640 if ((0 != src_subresource.baseArrayLayer) || (1 != src_subresource.layerCount)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003641 LogObjectList objlist(cb_node->commandBuffer());
3642 objlist.add(src_image_state->image());
3643 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003644 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04446" : "VUID-vkCmdResolveImage-srcImage-04446";
3645 skip |= LogError(objlist, vuid,
3646 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
Shannon McPherson74b341c2020-09-08 15:43:05 -06003647 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003648 func_name, i);
Shannon McPherson74b341c2020-09-08 15:43:05 -06003649 }
3650 if ((0 != dst_subresource.baseArrayLayer) || (1 != dst_subresource.layerCount)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003651 LogObjectList objlist(cb_node->commandBuffer());
3652 objlist.add(src_image_state->image());
3653 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003654 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04447" : "VUID-vkCmdResolveImage-srcImage-04447";
3655 skip |= LogError(objlist, vuid,
3656 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003657 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003658 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003659 }
3660 }
3661
3662 if (VK_IMAGE_TYPE_1D == src_image_type) {
3663 if ((pRegions[i].srcOffset.y != 0) || (pRegions[i].extent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003664 LogObjectList objlist(cb_node->commandBuffer());
3665 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003666 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00271" : "VUID-vkCmdResolveImage-srcImage-00271";
3667 skip |= LogError(objlist, vuid,
3668 "%s: srcImage (%s) is 1D but pRegions[%u] srcOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003669 "extent.height (%u) is not 1.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003670 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003671 pRegions[i].srcOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003672 }
3673 }
3674 if ((VK_IMAGE_TYPE_1D == src_image_type) || (VK_IMAGE_TYPE_2D == src_image_type)) {
3675 if ((pRegions[i].srcOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003676 LogObjectList objlist(cb_node->commandBuffer());
3677 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003678 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00273" : "VUID-vkCmdResolveImage-srcImage-00273";
3679 skip |= LogError(objlist, vuid,
3680 "%s: srcImage (%s) is 2D but pRegions[%u] srcOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003681 "extent.depth (%u) is not 1.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003682 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003683 pRegions[i].srcOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003684 }
3685 }
3686
3687 if (VK_IMAGE_TYPE_1D == dst_image_type) {
3688 if ((pRegions[i].dstOffset.y != 0) || (pRegions[i].extent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003689 LogObjectList objlist(cb_node->commandBuffer());
3690 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003691 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00276" : "VUID-vkCmdResolveImage-dstImage-00276";
3692 skip |= LogError(objlist, vuid,
3693 "%s: dstImage (%s) is 1D but pRegions[%u] dstOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003694 "extent.height (%u) is not 1.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003695 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003696 pRegions[i].dstOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003697 }
3698 }
3699 if ((VK_IMAGE_TYPE_1D == dst_image_type) || (VK_IMAGE_TYPE_2D == dst_image_type)) {
3700 if ((pRegions[i].dstOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003701 LogObjectList objlist(cb_node->commandBuffer());
3702 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003703 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00278" : "VUID-vkCmdResolveImage-dstImage-00278";
3704 skip |= LogError(objlist, vuid,
3705 "%s: dstImage (%s) is 2D but pRegions[%u] dstOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003706 "extent.depth (%u) is not 1.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003707 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003708 pRegions[i].dstOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003709 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003710 }
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003711
3712 // Each srcImage dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003713 VkExtent3D subresource_extent = src_image_state->GetSubresourceExtent(src_subresource);
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003714 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3715 // developer
3716 if (src_subresource.mipLevel < src_image_state->createInfo.mipLevels) {
3717 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003718 if ((extent_check & kXBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003719 LogObjectList objlist(cb_node->commandBuffer());
3720 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003721 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00269" : "VUID-vkCmdResolveImage-srcOffset-00269";
3722 skip |= LogError(objlist, vuid,
3723 "%s: srcImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003724 "exceeds subResource width [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003725 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003726 region.extent.width, subresource_extent.width);
3727 }
3728
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003729 if ((extent_check & kYBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003730 LogObjectList objlist(cb_node->commandBuffer());
3731 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003732 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00270" : "VUID-vkCmdResolveImage-srcOffset-00270";
3733 skip |= LogError(objlist, vuid,
3734 "%s: srcImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003735 "exceeds subResource height [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003736 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003737 region.extent.height, subresource_extent.height);
3738 }
3739
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003740 if ((extent_check & kZBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003741 LogObjectList objlist(cb_node->commandBuffer());
3742 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003743 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00272" : "VUID-vkCmdResolveImage-srcOffset-00272";
3744 skip |= LogError(objlist, vuid,
3745 "%s: srcImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003746 "exceeds subResource depth [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003747 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003748 region.extent.depth, subresource_extent.depth);
3749 }
3750 }
3751
3752 // Each dstImage dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003753 subresource_extent = dst_image_state->GetSubresourceExtent(dst_subresource);
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003754 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3755 // developer
3756 if (dst_subresource.mipLevel < dst_image_state->createInfo.mipLevels) {
3757 uint32_t extent_check = ExceedsBounds(&(region.dstOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003758 if ((extent_check & kXBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003759 LogObjectList objlist(cb_node->commandBuffer());
3760 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003761 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00274" : "VUID-vkCmdResolveImage-dstOffset-00274";
3762 skip |= LogError(objlist, vuid,
3763 "%s: dstImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003764 "exceeds subResource width [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003765 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003766 region.extent.width, subresource_extent.width);
3767 }
3768
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003769 if ((extent_check & kYBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003770 LogObjectList objlist(cb_node->commandBuffer());
3771 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003772 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00275" : "VUID-vkCmdResolveImage-dstOffset-00275";
3773 skip |= LogError(objlist, vuid,
3774 "%s: dstImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003775 "exceeds subResource height [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003776 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003777 region.extent.height, subresource_extent.height);
3778 }
3779
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003780 if ((extent_check & kZBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003781 LogObjectList objlist(cb_node->commandBuffer());
3782 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003783 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00277" : "VUID-vkCmdResolveImage-dstOffset-00277";
3784 skip |= LogError(objlist, vuid,
3785 "%s: dstImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003786 "exceeds subResource depth [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003787 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003788 region.extent.depth, subresource_extent.depth);
3789 }
3790 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003791 }
3792
3793 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003794 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-01386" : "VUID-vkCmdResolveImage-srcImage-01386";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003795 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 -04003796 func_name, string_VkFormat(src_image_state->createInfo.format),
3797 string_VkFormat(dst_image_state->createInfo.format));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003798 }
3799 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003800 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_MismatchedImageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04003801 "%s: srcImage type (%s) and dstImage type (%s) are not the same.", func_name,
sfricke-samsungc26350e2020-05-30 12:31:31 -07003802 string_VkImageType(src_image_state->createInfo.imageType),
3803 string_VkImageType(dst_image_state->createInfo.imageType));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003804 }
3805 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003806 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00257" : "VUID-vkCmdResolveImage-srcImage-00257";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003807 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 -07003808 }
3809 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003810 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00259" : "VUID-vkCmdResolveImage-dstImage-00259";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003811 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 -04003812 func_name, string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003813 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003814 } else {
3815 assert(0);
3816 }
3817 return skip;
3818}
3819
Jeff Leger178b1e52020-10-05 12:22:23 -04003820bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3821 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3822 const VkImageResolve *pRegions) const {
3823 return ValidateCmdResolveImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3824 COPY_COMMAND_VERSION_1);
3825}
3826
3827bool CoreChecks::PreCallValidateCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
3828 const VkResolveImageInfo2KHR *pResolveImageInfo) const {
3829 return ValidateCmdResolveImage(commandBuffer, pResolveImageInfo->srcImage, pResolveImageInfo->srcImageLayout,
3830 pResolveImageInfo->dstImage, pResolveImageInfo->dstImageLayout, pResolveImageInfo->regionCount,
3831 pResolveImageInfo->pRegions, COPY_COMMAND_VERSION_2);
3832}
3833
3834template <typename RegionType>
3835bool CoreChecks::ValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3836 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3837 const RegionType *pRegions, VkFilter filter, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003838 const auto *cb_node = GetCBState(commandBuffer);
3839 const auto *src_image_state = GetImageState(srcImage);
3840 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003841
Jeff Leger178b1e52020-10-05 12:22:23 -04003842 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
3843 const char *func_name = is_2khr ? "vkCmdBlitImage2KHR()" : "vkCmdBlitImage()";
3844 const CMD_TYPE cmd_type = is_2khr ? CMD_BLITIMAGE : CMD_BLITIMAGE2KHR;
3845
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003846 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003847 if (cb_node) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003848 skip |= ValidateCmd(cb_node, cmd_type, func_name);
John Zulauf5c2750c2018-01-30 15:04:56 -07003849 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003850 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003851 const char *vuid;
3852 const char *location;
3853 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00233" : "VUID-vkCmdBlitImage-srcImage-00233";
3854 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->srcImage" : "vkCmdBlitImage(): srcImage";
3855 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
3856 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00234" : "VUID-vkCmdBlitImage-dstImage-00234";
3857 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->dstImage" : "vkCmdBlitImage(): dstImage";
3858 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
3859 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00220" : "VUID-vkCmdBlitImage-srcImage-00220";
3860 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3861 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00225" : "VUID-vkCmdBlitImage-dstImage-00225";
3862 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
3863 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00219" : "VUID-vkCmdBlitImage-srcImage-00219";
3864 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3865 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3866 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00224" : "VUID-vkCmdBlitImage-dstImage-00224";
3867 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3868 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04003869 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Jeff Leger178b1e52020-10-05 12:22:23 -04003870 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-01999" : "VUID-vkCmdBlitImage-srcImage-01999";
3871 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, func_name, vuid);
3872 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02000" : "VUID-vkCmdBlitImage-dstImage-02000";
3873 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, func_name, vuid);
3874 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01834" : "VUID-vkCmdBlitImage-commandBuffer-01834";
3875 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3876 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01835" : "VUID-vkCmdBlitImage-commandBuffer-01835";
3877 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3878 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01836" : "VUID-vkCmdBlitImage-commandBuffer-01836";
3879 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
sfricke-samsung022fa252020-07-24 03:26:16 -07003880
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003881 // Validation for VK_EXT_fragment_density_map
3882 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003883 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003884 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003885 "%s: srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3886 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003887 }
3888 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003889 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003890 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003891 "%s: dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3892 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003893 }
3894
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003895 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003896
Dave Houlton33c2d252017-06-09 17:08:32 -06003897 VkFormat src_format = src_image_state->createInfo.format;
3898 VkFormat dst_format = dst_image_state->createInfo.format;
3899 VkImageType src_type = src_image_state->createInfo.imageType;
3900 VkImageType dst_type = dst_image_state->createInfo.imageType;
3901
Cort Stratton186b1a22018-05-01 20:18:06 -04003902 if (VK_FILTER_LINEAR == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003903 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02001" : "VUID-vkCmdBlitImage-filter-02001";
3904 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT, func_name,
3905 vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003906 } else if (VK_FILTER_CUBIC_IMG == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003907 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02002" : "VUID-vkCmdBlitImage-filter-02002";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003908 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
Jeff Leger178b1e52020-10-05 12:22:23 -04003909 func_name, vuid);
Dave Houlton33c2d252017-06-09 17:08:32 -06003910 }
3911
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003912 if (FormatRequiresYcbcrConversion(src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003913 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-01561" : "VUID-vkCmdBlitImage-srcImage-01561";
3914 skip |= LogError(device, vuid,
3915 "%s: srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003916 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04003917 func_name, string_VkFormat(src_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003918 }
3919
3920 if (FormatRequiresYcbcrConversion(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003921 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-01562" : "VUID-vkCmdBlitImage-dstImage-01562";
3922 skip |= LogError(device, vuid,
3923 "%s: dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003924 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04003925 func_name, string_VkFormat(dst_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003926 }
3927
ziga-lunarg52604a12021-09-09 16:02:05 +02003928 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_2D != src_type)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003929 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-00237" : "VUID-vkCmdBlitImage-filter-00237";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003930 skip |= LogError(cb_node->commandBuffer(), vuid,
ziga-lunarg52604a12021-09-09 16:02:05 +02003931 "%s: source image type must be VK_IMAGE_TYPE_2D when cubic filtering is specified.", func_name);
Dave Houlton33c2d252017-06-09 17:08:32 -06003932 }
3933
Dave Houlton33c2d252017-06-09 17:08:32 -06003934 // Validate consistency for unsigned formats
3935 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3936 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003937 ss << func_name << ": If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003938 << "the other one must also have unsigned integer format. "
3939 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003940 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00230" : "VUID-vkCmdBlitImage-srcImage-00230";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003941 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003942 }
3943
3944 // Validate consistency for signed formats
3945 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3946 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003947 ss << func_name << ": If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003948 << "the other one must also have signed integer format. "
3949 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003950 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00229" : "VUID-vkCmdBlitImage-srcImage-00229";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003951 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003952 }
3953
3954 // Validate filter for Depth/Stencil formats
3955 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3956 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003957 ss << func_name << ": If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003958 << "then filter must be VK_FILTER_NEAREST.";
Jeff Leger178b1e52020-10-05 12:22:23 -04003959 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00232" : "VUID-vkCmdBlitImage-srcImage-00232";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003960 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003961 }
3962
3963 // Validate aspect bits and formats for depth/stencil images
3964 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3965 if (src_format != dst_format) {
3966 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003967 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 -06003968 << "stencil, the other one must have exactly the same format. "
3969 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3970 << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003971 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00231" : "VUID-vkCmdBlitImage-srcImage-00231";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003972 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003973 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003974 } // Depth or Stencil
3975
3976 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003977 const char *invalid_src_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003978 is_2khr ? ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003979 ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-01398"
3980 : "VUID-VkBlitImageInfo2KHR-srcImageLayout-00222")
sfricke-samsung45996a42021-09-16 13:45:27 -07003981 : ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003982 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3983 : "VUID-vkCmdBlitImage-srcImageLayout-00222");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003984 const char *invalid_dst_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003985 is_2khr ? ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003986 ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-01399"
3987 : "VUID-VkBlitImageInfo2KHR-dstImageLayout-00227")
sfricke-samsung45996a42021-09-16 13:45:27 -07003988 : ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003989 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3990 : "VUID-vkCmdBlitImage-dstImageLayout-00227");
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003991 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003992 const RegionType rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003993 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04003994 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-00221" : "VUID-vkCmdBlitImage-srcImageLayout-00221";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003995 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003996 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3997 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-00226" : "VUID-vkCmdBlitImage-dstImageLayout-00226";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003998 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003999 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
4000 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, func_name, "srcSubresource", i);
4001 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, func_name, "dstSubresource", i);
4002 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01705" : "VUID-vkCmdBlitImage-srcSubresource-01705";
4003 skip |=
4004 ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
4005 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01706" : "VUID-vkCmdBlitImage-dstSubresource-01706";
4006 skip |=
4007 ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
4008 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01707" : "VUID-vkCmdBlitImage-srcSubresource-01707";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004009 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04004010 rgn.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
4011 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01708" : "VUID-vkCmdBlitImage-dstSubresource-01708";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004012 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04004013 rgn.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004014 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06004015 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
4016 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004017 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004018 ss << func_name << ": pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004019 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004020 }
Dave Houlton48989f32017-05-26 15:01:46 -06004021 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
4022 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004023 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004024 ss << func_name << ": pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004025 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004026 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004027
4028 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06004029 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004030 vuid = is_2khr ? "VUID-VkImageBlit2KHR-layerCount-00239" : "VUID-VkImageBlit-layerCount-00239";
4031 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004032 LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004033 "%s: layerCount in source and destination subresource of pRegions[%d] does not match.", func_name, i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004034 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07004035
Dave Houlton48989f32017-05-26 15:01:46 -06004036 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004037 vuid = is_2khr ? "VUID-VkImageBlit2KHR-aspectMask-00238" : "VUID-VkImageBlit-aspectMask-00238";
4038 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004039 LogError(cb_node->commandBuffer(), vuid, "%s: aspectMask members for pRegion[%d] do not match.", func_name, i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07004040 }
Dave Houlton48989f32017-05-26 15:01:46 -06004041
Dave Houlton33c2d252017-06-09 17:08:32 -06004042 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004043 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00241" : "VUID-vkCmdBlitImage-aspectMask-00241";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004044 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004045 "%s: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004046 "image format %s.",
Jeff Leger178b1e52020-10-05 12:22:23 -04004047 func_name, i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004048 }
4049
4050 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004051 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00242" : "VUID-vkCmdBlitImage-aspectMask-00242";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004052 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004053 "%s: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
4054 func_name, i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004055 }
4056
Dave Houlton48989f32017-05-26 15:01:46 -06004057 // Validate source image offsets
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06004058 VkExtent3D src_extent = src_image_state->GetSubresourceExtent(rgn.srcSubresource);
Dave Houlton33c2d252017-06-09 17:08:32 -06004059 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06004060 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004061 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00245" : "VUID-vkCmdBlitImage-srcImage-00245";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004062 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004063 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
4064 "of (%1d, %1d). These must be (0, 1).",
4065 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004066 }
4067 }
4068
Dave Houlton33c2d252017-06-09 17:08:32 -06004069 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06004070 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004071 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00247" : "VUID-vkCmdBlitImage-srcImage-00247";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004072 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004073 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
4074 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
4075 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004076 }
4077 }
4078
Dave Houlton33c2d252017-06-09 17:08:32 -06004079 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06004080 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
4081 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004082 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004083 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00243" : "VUID-vkCmdBlitImage-srcOffset-00243";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004084 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004085 "%s: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).",
4086 func_name, i, rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004087 }
4088 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
4089 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004090 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004091 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00244" : "VUID-vkCmdBlitImage-srcOffset-00244";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004092 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004093 "%s: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).",
4094 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004095 }
4096 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
4097 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004098 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004099 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00246" : "VUID-vkCmdBlitImage-srcOffset-00246";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004100 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004101 "%s: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).",
4102 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004103 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004104 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004105 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00215" : "VUID-vkCmdBlitImage-pRegions-00215";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004106 skip |= LogError(cb_node->commandBuffer(), vuid, "%s: region [%d] source image blit region exceeds image dimensions.",
Jeff Leger178b1e52020-10-05 12:22:23 -04004107 func_name, i);
Dave Houlton33c2d252017-06-09 17:08:32 -06004108 }
Dave Houlton48989f32017-05-26 15:01:46 -06004109
4110 // Validate dest image offsets
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06004111 VkExtent3D dst_extent = dst_image_state->GetSubresourceExtent(rgn.dstSubresource);
Dave Houlton33c2d252017-06-09 17:08:32 -06004112 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06004113 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004114 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00250" : "VUID-vkCmdBlitImage-dstImage-00250";
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], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
4117 "(%1d, %1d). These must be (0, 1).",
4118 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004119 }
4120 }
4121
Dave Houlton33c2d252017-06-09 17:08:32 -06004122 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06004123 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004124 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00252" : "VUID-vkCmdBlitImage-dstImage-00252";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004125 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004126 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004127 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
Jeff Leger178b1e52020-10-05 12:22:23 -04004128 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004129 }
4130 }
4131
Dave Houlton33c2d252017-06-09 17:08:32 -06004132 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06004133 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
4134 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004135 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004136 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00248" : "VUID-vkCmdBlitImage-dstOffset-00248";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004137 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004138 "%s: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).",
4139 func_name, i, rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004140 }
4141 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
4142 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004143 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004144 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00249" : "VUID-vkCmdBlitImage-dstOffset-00249";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004145 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004146 "%s: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).",
4147 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004148 }
4149 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
4150 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004151 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004152 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00251" : "VUID-vkCmdBlitImage-dstOffset-00251";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004153 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004154 "%s: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).",
4155 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004156 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004157 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004158 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00216" : "VUID-vkCmdBlitImage-pRegions-00216";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004159 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004160 "%s: region [%d] destination image blit region exceeds image dimensions.", func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004161 }
4162
Dave Houlton33c2d252017-06-09 17:08:32 -06004163 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
4164 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
4165 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004166 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00240" : "VUID-vkCmdBlitImage-srcImage-00240";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004167 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004168 "%s: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
4169 "layerCount other than 1.",
4170 func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004171 }
4172 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004173 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004174 } else {
4175 assert(0);
4176 }
4177 return skip;
4178}
4179
Jeff Leger178b1e52020-10-05 12:22:23 -04004180bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4181 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4182 const VkImageBlit *pRegions, VkFilter filter) const {
4183 return ValidateCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter,
4184 COPY_COMMAND_VERSION_1);
4185}
4186
4187bool CoreChecks::PreCallValidateCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) const {
4188 return ValidateCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4189 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4190 pBlitImageInfo->filter, COPY_COMMAND_VERSION_2);
4191}
4192
4193template <typename RegionType>
4194void CoreChecks::RecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
4195 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
4196 VkFilter filter) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004197 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004198 auto src_image_state = GetImageState(srcImage);
4199 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004200
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004201 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004202 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06004203 cb_node->SetImageInitialLayout(*src_image_state, pRegions[i].srcSubresource, srcImageLayout);
4204 cb_node->SetImageInitialLayout(*dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004205 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004206}
4207
Jeff Leger178b1e52020-10-05 12:22:23 -04004208void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4209 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4210 const VkImageBlit *pRegions, VkFilter filter) {
4211 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
4212 pRegions, filter);
4213 RecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter);
4214}
4215
4216void CoreChecks::PreCallRecordCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) {
4217 StateTracker::PreCallRecordCmdBlitImage2KHR(commandBuffer, pBlitImageInfo);
4218 RecordCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4219 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4220 pBlitImageInfo->filter);
4221}
4222
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004223GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap &map, const IMAGE_STATE &image_state) {
John Zulauf2076e812020-01-08 14:55:54 -07004224 // This approach allows for a single hash lookup or/create new
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004225 auto &layout_map = map[image_state.image()];
John Zulauf17708d02021-02-22 11:20:58 -07004226 if (!layout_map) {
4227 layout_map.emplace(image_state.subresource_encoder.SubresourceCount());
John Zulauf2076e812020-01-08 14:55:54 -07004228 }
John Zulauf17708d02021-02-22 11:20:58 -07004229 return &layout_map;
John Zulauf2076e812020-01-08 14:55:54 -07004230}
4231
4232const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, VkImage image) {
4233 auto it = map.find(image);
4234 if (it != map.end()) {
John Zulauf17708d02021-02-22 11:20:58 -07004235 return &it->second;
John Zulauf2076e812020-01-08 14:55:54 -07004236 }
4237 return nullptr;
4238}
4239
Jeremy Gebben53631302021-04-13 16:46:37 -06004240// Helper to update the Global or Overlay layout map
4241struct GlobalLayoutUpdater {
4242 bool update(VkImageLayout &dst, const image_layout_map::ImageSubresourceLayoutMap::LayoutEntry &src) const {
4243 if (src.current_layout != image_layout_map::kInvalidLayout && dst != src.current_layout) {
4244 dst = src.current_layout;
4245 return true;
4246 }
4247 return false;
4248 }
4249
4250 layer_data::optional<VkImageLayout> insert(const image_layout_map::ImageSubresourceLayoutMap::LayoutEntry &src) const {
4251 layer_data::optional<VkImageLayout> result;
4252 if (src.current_layout != image_layout_map::kInvalidLayout) {
4253 result.emplace(src.current_layout);
4254 }
4255 return result;
4256 }
4257};
4258
Shannon McPherson449fa9c2018-10-25 11:51:07 -06004259// 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 -07004260bool CoreChecks::ValidateCmdBufImageLayouts(const Location &loc, const CMD_BUFFER_STATE *pCB,
4261 const GlobalImageLayoutMap &globalImageLayoutMap,
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004262 GlobalImageLayoutMap &overlayLayoutMap) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06004263 if (disabled[image_layout_validation]) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004264 bool skip = false;
John Zulauff660ad62019-03-23 07:16:05 -06004265 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07004266 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06004267 for (const auto &layout_map_entry : pCB->image_layout_map) {
4268 const auto image = layout_map_entry.first;
4269 const auto *image_state = GetImageState(image);
4270 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06004271 const auto &subres_map = layout_map_entry.second;
Jeremy Gebben53631302021-04-13 16:46:37 -06004272 const auto &layout_map = subres_map->GetLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06004273 // Validate the initial_uses for each subresource referenced
Jeremy Gebben53631302021-04-13 16:46:37 -06004274 if (layout_map.empty()) continue;
John Zulauf2076e812020-01-08 14:55:54 -07004275
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004276 auto *overlay_map = GetLayoutRangeMap(overlayLayoutMap, *image_state);
John Zulauf2076e812020-01-08 14:55:54 -07004277 const auto *global_map = GetLayoutRangeMap(globalImageLayoutMap, image);
4278 if (global_map == nullptr) {
4279 global_map = &empty_map;
4280 }
4281
4282 // Note: don't know if it would matter
4283 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
4284
Jeremy Gebben53631302021-04-13 16:46:37 -06004285 auto pos = layout_map.begin();
4286 const auto end = layout_map.end();
4287 sparse_container::parallel_iterator<const GlobalImageLayoutRangeMap> current_layout(*overlay_map, *global_map,
4288 pos->first.begin);
John Zulauf2076e812020-01-08 14:55:54 -07004289 while (pos != end) {
Jeremy Gebben53631302021-04-13 16:46:37 -06004290 VkImageLayout initial_layout = pos->second.initial_layout;
4291 assert(initial_layout != image_layout_map::kInvalidLayout);
4292 if (initial_layout == image_layout_map::kInvalidLayout) {
4293 continue;
4294 }
4295
John Zulauf2076e812020-01-08 14:55:54 -07004296 VkImageLayout image_layout = kInvalidLayout;
Jeremy Gebben53631302021-04-13 16:46:37 -06004297
John Zulauf2076e812020-01-08 14:55:54 -07004298 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 -07004299 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004300 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07004301 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004302 image_layout = current_layout->pos_B->lower_bound->second;
4303 }
4304 const auto intersected_range = pos->first & current_layout->range;
4305 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
4306 // TODO: Set memory invalid which is in mem_tracker currently
4307 } else if (image_layout != initial_layout) {
Hans-Kristian Arntzen6cb03492021-07-05 16:57:31 +02004308 const auto aspect_mask = image_state->subresource_encoder.Decode(intersected_range.begin).aspectMask;
4309 bool matches = ImageLayoutMatches(aspect_mask, image_layout, initial_layout);
John Zulauf2076e812020-01-08 14:55:54 -07004310 if (!matches) {
John Zulauf2076e812020-01-08 14:55:54 -07004311 // We can report all the errors for the intersected range directly
4312 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
locke-lunarg296a3c92020-03-25 01:04:29 -06004313 const auto subresource = image_state->subresource_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004314 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004315 pCB->commandBuffer(), kVUID_Core_DrawState_InvalidImageLayout,
sfricke-samsung6b447aa2021-07-26 09:42:26 -07004316 "%s command buffer %s expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004317 "to be in layout %s--instead, current layout is %s.",
sfricke-samsung6b447aa2021-07-26 09:42:26 -07004318 loc.Message().c_str(), report_data->FormatHandle(pCB->commandBuffer()).c_str(),
John Zulauf2076e812020-01-08 14:55:54 -07004319 report_data->FormatHandle(image).c_str(), subresource.aspectMask, subresource.arrayLayer,
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004320 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
John Zulaufb61ed972019-04-09 16:12:35 -06004321 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004322 }
4323 }
John Zulauf2076e812020-01-08 14:55:54 -07004324 if (pos->first.includes(intersected_range.end)) {
4325 current_layout.seek(intersected_range.end);
4326 } else {
4327 ++pos;
4328 if (pos != end) {
4329 current_layout.seek(pos->first.begin);
4330 }
4331 }
John Zulauff660ad62019-03-23 07:16:05 -06004332 }
locke-lunargf155ccf2020-02-18 11:34:15 -07004333 // Update all layout set operations (which will be a subset of the initial_layouts)
Jeremy Gebben53631302021-04-13 16:46:37 -06004334 sparse_container::splice(*overlay_map, subres_map->GetLayoutMap(), GlobalLayoutUpdater());
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004335 }
John Zulauff660ad62019-03-23 07:16:05 -06004336
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004337 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004338}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07004339
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004340void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06004341 for (const auto &layout_map_entry : pCB->image_layout_map) {
4342 const auto image = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07004343 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06004344 const auto *image_state = GetImageState(image);
4345 if (!image_state) continue; // Can't set layouts of a dead image
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004346 auto *global_map = GetLayoutRangeMap(imageLayoutMap, *image_state);
Jeremy Gebben53631302021-04-13 16:46:37 -06004347 sparse_container::splice(*global_map, subres_map->GetLayoutMap(), GlobalLayoutUpdater());
Tony Barbourdf013b92017-01-25 12:53:48 -07004348 }
4349}
4350
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004351// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004352// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
4353// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004354bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
4355 const VkImageLayout first_layout, const uint32_t attachment,
Mike Schuchardt2df08912020-12-15 16:28:09 -08004356 const VkAttachmentDescription2 &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004357 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004358 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
4359
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004360 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
sfricke-samsung55f01952020-03-24 08:16:41 -07004361 // for both loadOp and stencilLoaOp rp2 has it in 1 VU while rp1 has it in 2 VU with half behind Maintenance2 extension
4362 // Each is VUID is below in following order: rp2 -> rp1 with Maintenance2 -> rp1 with no extenstion
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004363 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07004364 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4365 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4366 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004367 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004368 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004369 string_VkImageLayout(first_layout));
sfricke-samsung45996a42021-09-16 13:45:27 -07004370 } else if ((use_rp2 == false) && IsExtEnabled(device_extensions.vk_khr_maintenance2) &&
sfricke-samsung55f01952020-03-24 08:16:41 -07004371 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL)) {
4372 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01566",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004373 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004374 string_VkImageLayout(first_layout));
4375 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4376 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004377 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004378 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004379 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004380 }
4381 }
sfricke-samsung55f01952020-03-24 08:16:41 -07004382
4383 // Same as above for loadOp, but for stencilLoadOp
4384 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
4385 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4386 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4387 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL))) {
4388 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02523",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004389 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004390 string_VkImageLayout(first_layout));
sfricke-samsung45996a42021-09-16 13:45:27 -07004391 } else if ((use_rp2 == false) && IsExtEnabled(device_extensions.vk_khr_maintenance2) &&
sfricke-samsung55f01952020-03-24 08:16:41 -07004392 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL)) {
4393 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01567",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004394 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004395 string_VkImageLayout(first_layout));
4396 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4397 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
4398 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-02511",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004399 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004400 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02004401 }
4402 }
4403
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004404 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004405}
4406
Mark Lobodzinski96210742017-02-09 10:33:46 -07004407// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4408// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004409template <typename T1>
4410bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
4411 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
4412 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004413 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004414 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004415 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004416 if (strict) {
4417 correct_usage = ((actual & desired) == desired);
4418 } else {
4419 correct_usage = ((actual & desired) != 0);
4420 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004421
Mark Lobodzinski96210742017-02-09 10:33:46 -07004422 if (!correct_usage) {
sfricke-samsungbb971942020-09-10 22:11:56 -07004423 // All callers should have a valid VUID
4424 assert(msgCode != kVUIDUndefined);
4425 skip =
4426 LogError(object, msgCode, "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4427 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004428 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004429 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004430}
4431
4432// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4433// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004434bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004435 char const *func_name, char const *usage_string) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004436 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image(),
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06004437 image_state->Handle(), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004438}
4439
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004440bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004441 char const *func_name, const char *vuid) const {
Cort Stratton186b1a22018-05-01 20:18:06 -04004442 bool skip = false;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004443 const VkFormatFeatureFlags image_format_features = image_state->format_features;
4444 if ((image_format_features & desired) != desired) {
4445 // Same error, but more details if it was an AHB external format
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06004446 if (image_state->HasAHBFormat()) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004447 skip |= LogError(image_state->image(), vuid,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004448 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for the external format "
4449 "found in VkAndroidHardwareBufferFormatPropertiesANDROID::formatFeatures used by %s.",
4450 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004451 report_data->FormatHandle(image_state->image()).c_str());
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004452 } else {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004453 skip |= LogError(image_state->image(), vuid,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004454 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for format %u used by %s "
4455 "with tiling %s.",
4456 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004457 image_state->createInfo.format, report_data->FormatHandle(image_state->image()).c_str(),
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004458 string_VkImageTiling(image_state->createInfo.tiling));
Cort Stratton186b1a22018-05-01 20:18:06 -04004459 }
4460 }
4461 return skip;
4462}
4463
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004464bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004465 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004466 bool skip = false;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004467 const VkImageAspectFlags apsect_mask = subresource_layers->aspectMask;
Cort Strattond619a302018-05-17 19:46:32 -07004468 // layerCount must not be zero
4469 if (subresource_layers->layerCount == 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004470 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-layerCount-01700",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004471 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004472 }
4473 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004474 if (apsect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004475 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-00168",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004476 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004477 }
4478 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004479 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 -06004480 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-00167",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004481 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4482 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4483 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004484 }
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004485 // aspectMask must not contain VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT
4486 if (apsect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
4487 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004488 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-02247",
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004489 "In %s, pRegions[%u].%s.aspectMask has a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit set.", func_name, i,
4490 member);
4491 }
Cort Strattond619a302018-05-17 19:46:32 -07004492 return skip;
4493}
4494
Mark Lobodzinski96210742017-02-09 10:33:46 -07004495// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4496// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004497bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004498 char const *func_name, char const *usage_string) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004499 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer(),
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06004500 buffer_state->Handle(), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004501}
4502
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004503bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004504 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004505 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004506
4507 const VkDeviceSize &range = pCreateInfo->range;
4508 if (range != VK_WHOLE_SIZE) {
4509 // Range must be greater than 0
4510 if (range <= 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004511 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00928",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004512 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004513 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4514 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004515 }
4516 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004517 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4518 if (SafeModulo(range, format_size) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004519 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00929",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004520 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004521 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4522 "(%" PRIu32 ").",
4523 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004524 }
4525 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004526 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004527 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00930",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004528 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004529 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4530 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4531 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004532 }
4533 // The sum of range and offset must be less than or equal to the size of buffer
4534 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004535 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-offset-00931",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004536 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004537 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4538 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4539 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004540 }
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004541 } else {
4542 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4543
4544 // Size of buffer - offset, divided by the element size of format must be less than or equal to
4545 // VkPhysicalDeviceLimits::maxTexelBufferElements
4546 if (SafeDivision(buffer_state->createInfo.size - pCreateInfo->offset, format_size) >
4547 device_limits->maxTexelBufferElements) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004548 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-04059",
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004549 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
4550 ") equals VK_WHOLE_SIZE, the buffer's size (%" PRIuLEAST64 ") minus the offset (%" PRIuLEAST64
4551 "), divided by the element size of the format (%" PRIu32
4552 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4553 range, buffer_state->createInfo.size, pCreateInfo->offset, format_size,
4554 device_limits->maxTexelBufferElements);
4555 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004556 }
4557 return skip;
4558}
4559
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004560bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004561 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004562 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004563 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4564 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004565 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-00933",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004566 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004567 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format (%s) must "
4568 "be supported for uniform texel buffers",
4569 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004570 }
4571 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4572 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004573 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-00934",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004574 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004575 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format (%s) must "
4576 "be supported for storage texel buffers",
4577 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004578 }
4579 return skip;
4580}
4581
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004582bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004583 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004584 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004585
Dave Houltond8ed0212018-05-16 17:18:24 -06004586 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004587
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004588 auto chained_devaddr_struct = LvlFindInChain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
Jeff Bolz87697532019-01-11 22:54:00 -06004589 if (chained_devaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004590 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz87697532019-01-11 22:54:00 -06004591 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004592 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4593 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004594 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004595 }
4596 }
4597
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004598 auto chained_opaqueaddr_struct = LvlFindInChain<VkBufferOpaqueCaptureAddressCreateInfo>(pCreateInfo->pNext);
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004599 if (chained_opaqueaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004600 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004601 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004602 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
Mike Schuchardt2df08912020-12-15 16:28:09 -08004603 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfo::opaqueCaptureAddress"
4604 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004605 }
4606 }
4607
ziga-lunarg2e2be1e2021-07-18 23:09:15 +02004608 auto dedicated_allocation_buffer = LvlFindInChain<VkDedicatedAllocationBufferCreateInfoNV>(pCreateInfo->pNext);
4609 if (dedicated_allocation_buffer && dedicated_allocation_buffer->dedicatedAllocation == VK_TRUE) {
4610 if (pCreateInfo->flags &
4611 (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT)) {
4612 skip |= LogError(device, "VUID-VkBufferCreateInfo-pNext-01571",
4613 "vkCreateBuffer(): pCreateInfos->flags must not include VK_BUFFER_CREATE_SPARSE_BINDING_BIT, "
4614 "VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT, or VK_BUFFER_CREATE_SPARSE_ALIASED_BIT when "
4615 "VkDedicatedAllocationBufferCreateInfoNV is in pNext chain with dedicatedAllocation VK_TRUE.");
4616 }
4617 }
4618
Mike Schuchardt2df08912020-12-15 16:28:09 -08004619 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz33fc6722020-03-31 12:58:16 -05004620 !enabled_features.core12.bufferDeviceAddressCaptureReplay &&
sfricke-samsung828e59d2021-08-22 23:20:49 -07004621 !enabled_features.buffer_device_address_ext_features.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004622 skip |= LogError(
4623 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004624 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004625 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT set.");
Jeff Bolz87697532019-01-11 22:54:00 -06004626 }
4627
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004628 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
sfricke-samsung45996a42021-09-16 13:45:27 -07004629 const char *vuid = IsExtEnabled(device_extensions.vk_khr_get_physical_device_properties2)
4630 ? "VUID-VkBufferCreateInfo-sharingMode-01419"
4631 : "VUID-VkBufferCreateInfo-sharingMode-01391";
Mark Lobodzinski314b9162020-07-16 15:33:08 -06004632 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
ziga-lunarga0b4f8a2021-07-28 13:23:02 +02004633 "vkCreateBuffer", "pCreateInfo->pQueueFamilyIndices", vuid);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004634 }
4635
sfricke-samsungedce77a2020-07-03 22:35:13 -07004636 if ((pCreateInfo->flags & VK_BUFFER_CREATE_PROTECTED_BIT) != 0) {
4637 if (enabled_features.core11.protectedMemory == VK_FALSE) {
4638 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-01887",
4639 "vkCreateBuffer(): the protectedMemory device feature is disabled: Buffers cannot be created with the "
4640 "VK_BUFFER_CREATE_PROTECTED_BIT set.");
4641 }
4642 const VkBufferCreateFlags invalid_flags =
4643 VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT;
4644 if ((pCreateInfo->flags & invalid_flags) != 0) {
4645 skip |= LogError(device, "VUID-VkBufferCreateInfo-None-01888",
4646 "vkCreateBuffer(): VK_BUFFER_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at "
4647 "same time (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | "
4648 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT).");
4649 }
4650 }
4651
Mark Lobodzinski96210742017-02-09 10:33:46 -07004652 return skip;
4653}
4654
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004655bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004656 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004657 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004658 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
sfricke-samsung2e827212021-09-28 07:52:08 -07004659
4660 if (FormatIsDepthOrStencil(pCreateInfo->format)) {
4661 // Should never hopefully get here, but there are known driver advertising the wrong feature flags
4662 // see https://gitlab.khronos.org/vulkan/vulkan/-/merge_requests/4849
4663 skip |= LogError(device, kVUID_Core_invalidDepthStencilFormat,
4664 "vkCreateBufferView(): format is a depth/stencil format (%s) but depth/stencil formats do not have a "
4665 "defined sizes for alignment, replace with a color format.",
4666 string_VkFormat(pCreateInfo->format));
4667 }
4668
Mark Lobodzinski96210742017-02-09 10:33:46 -07004669 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4670 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004671 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004672 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4673 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004674 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004675 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4676 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4677 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004678
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004679 // Buffer view offset must be less than the size of buffer
4680 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004681 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-offset-00925",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004682 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004683 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4684 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004685 }
4686
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004687 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004688 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4689 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4690 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
sfricke-samsung45996a42021-09-16 13:45:27 -07004691 const char *vuid = IsExtEnabled(device_extensions.vk_ext_texel_buffer_alignment)
4692 ? "VUID-VkBufferViewCreateInfo-offset-02749"
4693 : "VUID-VkBufferViewCreateInfo-offset-00926";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004694 skip |= LogError(buffer_state->buffer(), vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004695 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004696 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4697 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004698 }
4699
4700 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004701 VkDeviceSize element_size = FormatElementSize(pCreateInfo->format);
4702 if ((element_size % 3) == 0) {
4703 element_size /= 3;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004704 }
4705 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004706 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05004707 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4708 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004709 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004710 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004711 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004712 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004713 buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-02750",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004714 "vkCreateBufferView(): If buffer was created with usage containing "
4715 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004716 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4717 ") must be a multiple of the lesser of "
4718 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4719 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4720 "(%" PRId32
4721 ") is VK_TRUE, the size of a texel of the requested format. "
4722 "If the size of a texel is a multiple of three bytes, then the size of a "
4723 "single component of format is used instead",
4724 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4725 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4726 }
4727 }
4728 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_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.uniformTexelBufferOffsetAlignmentBytes;
4731 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
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-02751",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004737 "vkCreateBufferView(): If buffer was created with usage containing "
4738 "VK_BUFFER_USAGE_UNIFORM_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::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4742 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
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.uniformTexelBufferOffsetAlignmentBytes,
4748 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4749 }
4750 }
4751 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004752
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004753 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004754
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004755 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004756 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004757 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004758}
4759
Mark Lobodzinski602de982017-02-09 11:01:33 -07004760// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004761bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004762 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004763 bool skip = false;
sfricke-samsung79b00482020-04-01 21:15:50 -07004764 const IMAGE_STATE *image_state = GetImageState(image);
4765 // checks color format and (single-plane or non-disjoint)
4766 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
sfricke-samsung71bc6572020-04-29 15:49:43 -07004767 if ((FormatIsColor(format)) && ((FormatIsMultiplane(format) == false) || (image_state->disjoint == false))) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004768 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004769 skip |= LogError(
4770 image, vuid,
4771 "%s: Using format (%s) with aspect flags (%s) but color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.",
4772 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004773 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004774 skip |= LogError(image, vuid,
4775 "%s: Using format (%s) with aspect flags (%s) but color image formats must have ONLY the "
4776 "VK_IMAGE_ASPECT_COLOR_BIT set.",
4777 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004778 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004779 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004780 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004781 skip |= LogError(image, vuid,
sfricke-samsung7687a482021-01-29 23:19:22 -08004782 "%s: Using format (%s) with aspect flags (%s) but depth/stencil image formats must have at least one "
4783 "of VK_IMAGE_ASPECT_DEPTH_BIT and VK_IMAGE_ASPECT_STENCIL_BIT set.",
4784 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004785 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004786 skip |= LogError(image, vuid,
sfricke-samsung7687a482021-01-29 23:19:22 -08004787 "%s: Using format (%s) with aspect flags (%s) but combination depth/stencil image formats can have "
4788 "only the VK_IMAGE_ASPECT_DEPTH_BIT and VK_IMAGE_ASPECT_STENCIL_BIT set.",
4789 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004790 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004791 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004792 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004793 skip |= LogError(image, vuid,
4794 "%s: Using format (%s) with aspect flags (%s) but depth-only image formats must have the "
4795 "VK_IMAGE_ASPECT_DEPTH_BIT set.",
4796 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004797 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004798 skip |= LogError(image, vuid,
4799 "%s: Using format (%s) with aspect flags (%s) but depth-only image formats can have only the "
4800 "VK_IMAGE_ASPECT_DEPTH_BIT set.",
4801 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004802 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004803 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004804 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004805 skip |= LogError(image, vuid,
4806 "%s: Using format (%s) with aspect flags (%s) but stencil-only image formats must have the "
4807 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4808 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004809 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004810 skip |= LogError(image, vuid,
4811 "%s: Using format (%s) with aspect flags (%s) but stencil-only image formats can have only the "
4812 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4813 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004814 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004815 } else if (FormatIsMultiplane(format)) {
4816 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4817 if (3 == FormatPlaneCount(format)) {
4818 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4819 }
4820 if ((aspect_mask & valid_flags) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004821 skip |= LogError(image, vuid,
4822 "%s: Using format (%s) with aspect flags (%s) but multi-plane image formats may have only "
4823 "VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs set, where n = [0, 1, 2].",
4824 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Dave Houlton501b15b2018-03-30 15:07:41 -06004825 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004826 }
4827 return skip;
4828}
4829
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004830bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4831 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004832 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
Jeremy Gebben5573a8c2021-06-04 08:55:10 -06004833 const SubresourceRangeErrorCodes &errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004834 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004835
4836 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004837 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004838 skip |= LogError(image, errorCodes.base_mip_err,
4839 "%s: %s.baseMipLevel (= %" PRIu32
4840 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4841 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004842 }
Petr Kraus4d718682017-05-18 03:38:41 +02004843
Petr Krausffa94af2017-08-08 21:46:02 +02004844 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4845 if (subresourceRange.levelCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004846 skip |=
4847 LogError(image, "VUID-VkImageSubresourceRange-levelCount-01720", "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004848 } else {
4849 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004850
Petr Krausffa94af2017-08-08 21:46:02 +02004851 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004852 skip |= LogError(image, errorCodes.mip_count_err,
4853 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4854 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
4855 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
4856 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004857 }
Petr Kraus4d718682017-05-18 03:38:41 +02004858 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004859 }
Petr Kraus4d718682017-05-18 03:38:41 +02004860
4861 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004862 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004863 skip |= LogError(image, errorCodes.base_layer_err,
4864 "%s: %s.baseArrayLayer (= %" PRIu32
4865 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4866 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004867 }
Petr Kraus4d718682017-05-18 03:38:41 +02004868
Petr Krausffa94af2017-08-08 21:46:02 +02004869 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4870 if (subresourceRange.layerCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004871 skip |=
4872 LogError(image, "VUID-VkImageSubresourceRange-layerCount-01721", "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004873 } else {
4874 const uint64_t necessary_layer_count =
4875 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004876
Petr Krausffa94af2017-08-08 21:46:02 +02004877 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004878 skip |= LogError(image, errorCodes.layer_count_err,
4879 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4880 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
4881 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
4882 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004883 }
Petr Kraus4d718682017-05-18 03:38:41 +02004884 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004885 }
Petr Kraus4d718682017-05-18 03:38:41 +02004886
ziga-lunargb4e90752021-08-02 13:58:29 +02004887 if (subresourceRange.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
4888 if (subresourceRange.aspectMask &
4889 (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT)) {
4890 skip |= LogError(image, "VUID-VkImageSubresourceRange-aspectMask-01670",
4891 "%s: aspectMask includes both VK_IMAGE_ASPECT_COLOR_BIT and one of VK_IMAGE_ASPECT_PLANE_0_BIT, "
4892 "VK_IMAGE_ASPECT_PLANE_1_BIT, or VK_IMAGE_ASPECT_PLANE_2_BIT.",
4893 cmd_name);
4894 }
4895 }
4896
Mark Lobodzinski602de982017-02-09 11:01:33 -07004897 return skip;
4898}
4899
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004900bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004901 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004902 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004903 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
Mike Schuchardt2df08912020-12-15 16:28:09 -08004904 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004905 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 +02004906
David McFarland2853f2f2020-11-30 15:50:39 -04004907 uint32_t image_layer_count;
4908
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004909 if (is_3_d_to_2_d_map) {
David McFarland2853f2f2020-11-30 15:50:39 -04004910 const auto layers = LayersFromRange(subresourceRange);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06004911 const auto extent = image_state->GetSubresourceExtent(layers);
David McFarland2853f2f2020-11-30 15:50:39 -04004912 image_layer_count = extent.depth;
4913 } else {
4914 image_layer_count = image_state->createInfo.arrayLayers;
4915 }
4916
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004917 const auto image_layer_count_var_name = is_3_d_to_2_d_map ? "extent.depth" : "arrayLayers";
Petr Krausffa94af2017-08-08 21:46:02 +02004918
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004919 SubresourceRangeErrorCodes subresource_range_error_codes = {};
4920 subresource_range_error_codes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4921 subresource_range_error_codes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
4922 subresource_range_error_codes.base_layer_err =
4923 is_khr_maintenance1
4924 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-image-02724" : "VUID-VkImageViewCreateInfo-image-01482")
4925 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4926 subresource_range_error_codes.layer_count_err = is_khr_maintenance1
4927 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
4928 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4929 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004930
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004931 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004932 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004933 image_state->image(), subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02004934}
4935
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004936bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004937 const VkImageSubresourceRange &subresourceRange,
4938 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004939 SubresourceRangeErrorCodes subresource_range_error_codes = {};
4940 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4941 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4942 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4943 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004944
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004945 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004946 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image(),
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004947 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02004948}
4949
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004950bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004951 const VkImageSubresourceRange &subresourceRange,
4952 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004953 SubresourceRangeErrorCodes subresource_range_error_codes = {};
4954 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4955 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4956 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4957 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004958
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004959 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004960 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image(),
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004961 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02004962}
4963
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07004964bool CoreChecks::ValidateImageBarrierSubresourceRange(const Location &loc, const IMAGE_STATE *image_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07004965 const VkImageSubresourceRange &subresourceRange) const {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004966 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004967 loc.StringFunc().c_str(), loc.StringField().c_str(), "arrayLayers", image_state->image(),
Jeremy Gebbenbb845612021-02-18 18:16:05 -07004968 sync_vuid_maps::GetSubResourceVUIDs(loc));
Petr Krausffa94af2017-08-08 21:46:02 +02004969}
4970
Jeremy Gebben50e0b412021-02-18 10:39:41 -07004971namespace barrier_queue_families {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07004972using sync_vuid_maps::GetBarrierQueueVUID;
4973using sync_vuid_maps::kQueueErrorSummary;
4974using sync_vuid_maps::QueueError;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07004975
4976class ValidatorState {
4977 public:
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07004978 ValidatorState(const ValidationStateTracker *device_data, LogObjectList &&obj, const core_error::Location &location,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07004979 const VulkanTypedHandle &barrier_handle, const VkSharingMode sharing_mode)
4980 : device_data_(device_data),
John Zulaufbea70432021-02-23 07:03:12 -07004981 objects_(std::move(obj)),
Jeremy Gebbene60d4172021-02-02 15:42:15 -07004982 loc_(location),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07004983 barrier_handle_(barrier_handle),
4984 sharing_mode_(sharing_mode),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07004985 limit_(static_cast<uint32_t>(device_data->physical_device_state->queue_family_properties.size())),
4986 mem_ext_(IsExtEnabled(device_data->device_extensions.vk_khr_external_memory)) {}
4987
4988 // Log the messages using boilerplate from object state, and Vu specific information from the template arg
4989 // 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 -07004990 bool LogMsg(QueueError vu_index, uint32_t family, const char *param_name) const {
4991 const std::string val_code = GetBarrierQueueVUID(loc_, vu_index);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07004992 const char *annotation = GetFamilyAnnotation(family);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07004993 return device_data_->LogError(objects_, val_code, "%s Barrier using %s %s created with sharingMode %s, has %s %u%s. %s",
4994 loc_.Message().c_str(), GetTypeString(),
4995 device_data_->report_data->FormatHandle(barrier_handle_).c_str(), GetModeString(), param_name,
4996 family, annotation, kQueueErrorSummary.at(vu_index).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07004997 }
4998
Jeremy Gebbene60d4172021-02-02 15:42:15 -07004999 bool LogMsg(QueueError vu_index, uint32_t src_family, uint32_t dst_family) const {
5000 const std::string val_code = GetBarrierQueueVUID(loc_, vu_index);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005001 const char *src_annotation = GetFamilyAnnotation(src_family);
5002 const char *dst_annotation = GetFamilyAnnotation(dst_family);
5003 return device_data_->LogError(
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005004 objects_, val_code,
5005 "%s Barrier using %s %s created with sharingMode %s, has srcQueueFamilyIndex %u%s and dstQueueFamilyIndex %u%s. %s",
5006 loc_.Message().c_str(), GetTypeString(), device_data_->report_data->FormatHandle(barrier_handle_).c_str(),
5007 GetModeString(), src_family, src_annotation, dst_family, dst_annotation, kQueueErrorSummary.at(vu_index).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005008 }
5009
5010 // This abstract Vu can only be tested at submit time, thus we need a callback from the closure containing the needed
5011 // data. Note that the mem_barrier is copied to the closure as the lambda lifespan exceed the guarantees of validity for
5012 // application input.
5013 static bool ValidateAtQueueSubmit(const QUEUE_STATE *queue_state, const ValidationStateTracker *device_data,
5014 uint32_t src_family, uint32_t dst_family, const ValidatorState &val) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005015 auto error_code = QueueError::kSubmitQueueMustMatchSrcOrDst;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005016 uint32_t queue_family = queue_state->queueFamilyIndex;
5017 if ((src_family != queue_family) && (dst_family != queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005018 const std::string val_code = GetBarrierQueueVUID(val.loc_, error_code);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005019 const char *src_annotation = val.GetFamilyAnnotation(src_family);
5020 const char *dst_annotation = val.GetFamilyAnnotation(dst_family);
5021 return device_data->LogError(
Jeremy Gebben63f3cb02021-09-07 15:16:32 -06005022 queue_state->Handle(), val_code,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005023 "%s Barrier submitted to queue with family index %u, using %s %s created with sharingMode %s, has "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005024 "srcQueueFamilyIndex %u%s and dstQueueFamilyIndex %u%s. %s",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005025 val.loc_.Message().c_str(), queue_family, val.GetTypeString(),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005026 device_data->report_data->FormatHandle(val.barrier_handle_).c_str(), val.GetModeString(), src_family,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005027 src_annotation, dst_family, dst_annotation, kQueueErrorSummary.at(error_code).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005028 }
5029 return false;
5030 }
5031 // Logical helpers for semantic clarity
5032 inline bool KhrExternalMem() const { return mem_ext_; }
5033 inline bool IsValid(uint32_t queue_family) const { return (queue_family < limit_); }
5034 inline bool IsValidOrSpecial(uint32_t queue_family) const {
5035 return IsValid(queue_family) || (mem_ext_ && QueueFamilyIsExternal(queue_family));
5036 }
5037
5038 // Helpers for LogMsg
5039 const char *GetModeString() const { return string_VkSharingMode(sharing_mode_); }
5040
5041 // Descriptive text for the various types of queue family index
5042 const char *GetFamilyAnnotation(uint32_t family) const {
5043 const char *external = " (VK_QUEUE_FAMILY_EXTERNAL)";
5044 const char *foreign = " (VK_QUEUE_FAMILY_FOREIGN_EXT)";
5045 const char *ignored = " (VK_QUEUE_FAMILY_IGNORED)";
5046 const char *valid = " (VALID)";
5047 const char *invalid = " (INVALID)";
5048 switch (family) {
5049 case VK_QUEUE_FAMILY_EXTERNAL:
5050 return external;
5051 case VK_QUEUE_FAMILY_FOREIGN_EXT:
5052 return foreign;
5053 case VK_QUEUE_FAMILY_IGNORED:
5054 return ignored;
5055 default:
5056 if (IsValid(family)) {
5057 return valid;
5058 }
5059 return invalid;
5060 };
5061 }
5062 const char *GetTypeString() const { return object_string[barrier_handle_.type]; }
5063 VkSharingMode GetSharingMode() const { return sharing_mode_; }
5064
5065 protected:
5066 const ValidationStateTracker *device_data_;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005067 const LogObjectList objects_;
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005068 const core_error::Location loc_;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005069 const VulkanTypedHandle barrier_handle_;
5070 const VkSharingMode sharing_mode_;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005071 const uint32_t limit_;
5072 const bool mem_ext_;
5073};
5074
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005075bool Validate(const CoreChecks *device_data, const CMD_BUFFER_STATE *cb_state, const ValidatorState &val,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005076 const uint32_t src_queue_family, const uint32_t dst_queue_family) {
5077 bool skip = false;
5078
5079 const bool mode_concurrent = val.GetSharingMode() == VK_SHARING_MODE_CONCURRENT;
5080 const bool src_ignored = QueueFamilyIsIgnored(src_queue_family);
5081 const bool dst_ignored = QueueFamilyIsIgnored(dst_queue_family);
5082 if (val.KhrExternalMem()) {
5083 if (mode_concurrent) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005084 bool sync2 = device_data->enabled_features.synchronization2_features.synchronization2 != 0;
5085 // this requirement is removed by VK_KHR_synchronization2
5086 if (!(src_ignored || dst_ignored) && !sync2) {
5087 skip |= val.LogMsg(QueueError::kSrcOrDstMustBeIgnore, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005088 }
5089 if ((src_ignored && !(dst_ignored || QueueFamilyIsExternal(dst_queue_family))) ||
5090 (dst_ignored && !(src_ignored || QueueFamilyIsExternal(src_queue_family)))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005091 skip |= val.LogMsg(QueueError::kSpecialOrIgnoreOnly, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005092 }
5093 } else {
5094 // VK_SHARING_MODE_EXCLUSIVE
5095 if (src_queue_family != dst_queue_family) {
5096 if (!val.IsValidOrSpecial(dst_queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005097 skip |= val.LogMsg(QueueError::kSrcAndDstValidOrSpecial, dst_queue_family, "dstQueueFamilyIndex");
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005098 }
5099 if (!val.IsValidOrSpecial(src_queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005100 skip |= val.LogMsg(QueueError::kSrcAndDstValidOrSpecial, src_queue_family, "srcQueueFamilyIndex");
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005101 }
5102 }
5103 }
5104 } else {
5105 // No memory extension
5106 if (mode_concurrent) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005107 bool sync2 = device_data->enabled_features.synchronization2_features.synchronization2 != 0;
5108 // this requirement is removed by VK_KHR_synchronization2
5109 if ((!src_ignored || !dst_ignored) && !sync2) {
5110 skip |= val.LogMsg(QueueError::kSrcAndDestMustBeIgnore, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005111 }
5112 } else {
5113 // VK_SHARING_MODE_EXCLUSIVE
5114 if ((src_queue_family != dst_queue_family) && !(val.IsValid(src_queue_family) && val.IsValid(dst_queue_family))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005115 skip |= val.LogMsg(QueueError::kSrcAndDstBothValid, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005116 }
5117 }
5118 }
5119 return skip;
5120}
5121} // namespace barrier_queue_families
5122
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005123bool CoreChecks::ValidateConcurrentBarrierAtSubmit(const Location &loc, const ValidationStateTracker *state_data,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005124 const QUEUE_STATE *queue_state, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005125 const VulkanTypedHandle &typed_handle, uint32_t src_queue_family,
5126 uint32_t dst_queue_family) {
5127 using barrier_queue_families::ValidatorState;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005128 ValidatorState val(state_data, LogObjectList(cb_state->commandBuffer()), loc, typed_handle, VK_SHARING_MODE_CONCURRENT);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005129 return ValidatorState::ValidateAtQueueSubmit(queue_state, state_data, src_queue_family, dst_queue_family, val);
5130}
5131
5132// Type specific wrapper for image barriers
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005133template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005134bool CoreChecks::ValidateBarrierQueueFamilies(const Location &loc, const CMD_BUFFER_STATE *cb_state, const ImgBarrier &barrier,
5135 const IMAGE_STATE *state_data) const {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005136 // State data is required
5137 if (!state_data) {
5138 return false;
5139 }
5140
5141 // Create the validator state from the image state
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005142 barrier_queue_families::ValidatorState val(this, LogObjectList(cb_state->commandBuffer()), loc,
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06005143 state_data->Handle(), state_data->createInfo.sharingMode);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005144 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
5145 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005146 return barrier_queue_families::Validate(this, cb_state, val, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005147}
5148
5149// Type specific wrapper for buffer barriers
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005150template <typename BufBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005151bool CoreChecks::ValidateBarrierQueueFamilies(const Location &loc, const CMD_BUFFER_STATE *cb_state, const BufBarrier &barrier,
5152 const BUFFER_STATE *state_data) const {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005153 // State data is required
5154 if (!state_data) {
5155 return false;
5156 }
5157
5158 // Create the validator state from the buffer state
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005159 barrier_queue_families::ValidatorState val(this, LogObjectList(cb_state->commandBuffer()), loc,
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06005160 state_data->Handle(), state_data->createInfo.sharingMode);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005161 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
5162 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005163 return barrier_queue_families::Validate(this, cb_state, val, src_queue_family, dst_queue_family);
5164}
5165
5166template <typename Barrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005167bool CoreChecks::ValidateBufferBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005168 const Barrier &mem_barrier) const {
5169 using sync_vuid_maps::BufferError;
5170 using sync_vuid_maps::GetBufferBarrierVUID;
5171
5172 bool skip = false;
5173
5174 skip |= ValidateQFOTransferBarrierUniqueness(loc, cb_state, mem_barrier, cb_state->qfo_transfer_buffer_barriers);
5175
5176 // Validate buffer barrier queue family indices
5177 auto buffer_state = GetBufferState(mem_barrier.buffer);
5178 if (buffer_state) {
5179 auto buf_loc = loc.dot(Field::buffer);
5180 const auto &mem_vuid = GetBufferBarrierVUID(buf_loc, BufferError::kNoMemory);
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005181 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, loc.StringFunc().c_str(), mem_vuid.c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005182
5183 skip |= ValidateBarrierQueueFamilies(buf_loc, cb_state, mem_barrier, buffer_state);
5184
5185 auto buffer_size = buffer_state->createInfo.size;
5186 if (mem_barrier.offset >= buffer_size) {
5187 auto offset_loc = loc.dot(Field::offset);
5188 const auto &vuid = GetBufferBarrierVUID(offset_loc, BufferError::kOffsetTooBig);
5189
5190 skip |= LogError(objects, vuid, "%s %s has offset 0x%" PRIx64 " which is not less than total size 0x%" PRIx64 ".",
5191 offset_loc.Message().c_str(), report_data->FormatHandle(mem_barrier.buffer).c_str(),
5192 HandleToUint64(mem_barrier.offset), HandleToUint64(buffer_size));
5193 } else if (mem_barrier.size != VK_WHOLE_SIZE && (mem_barrier.offset + mem_barrier.size > buffer_size)) {
5194 auto size_loc = loc.dot(Field::size);
5195 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kSizeOutOfRange);
5196 skip |= LogError(objects, vuid,
5197 "%s %s has offset 0x%" PRIx64 " and size 0x%" PRIx64 " whose sum is greater than total size 0x%" PRIx64
5198 ".",
5199 size_loc.Message().c_str(), report_data->FormatHandle(mem_barrier.buffer).c_str(),
5200 HandleToUint64(mem_barrier.offset), HandleToUint64(mem_barrier.size), HandleToUint64(buffer_size));
5201 }
5202 if (mem_barrier.size == 0) {
5203 auto size_loc = loc.dot(Field::size);
5204 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kSizeZero);
5205 skip |= LogError(objects, vuid, "%s %s has a size of 0.", loc.Message().c_str(),
5206 report_data->FormatHandle(mem_barrier.buffer).c_str());
5207 }
5208 }
5209 return skip;
5210}
5211
5212template <typename Barrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005213bool CoreChecks::ValidateImageBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005214 const Barrier &mem_barrier) const {
5215 bool skip = false;
5216
5217 skip |= ValidateQFOTransferBarrierUniqueness(loc, cb_state, mem_barrier, cb_state->qfo_transfer_image_barriers);
5218
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005219 bool is_ilt = true;
5220 if (enabled_features.synchronization2_features.synchronization2) {
5221 is_ilt = mem_barrier.oldLayout != mem_barrier.newLayout;
5222 }
5223
5224 if (is_ilt) {
5225 if (mem_barrier.newLayout == VK_IMAGE_LAYOUT_UNDEFINED || mem_barrier.newLayout == VK_IMAGE_LAYOUT_PREINITIALIZED) {
5226 auto layout_loc = loc.dot(Field::newLayout);
5227 const auto &vuid = sync_vuid_maps::GetImageBarrierVUID(loc, sync_vuid_maps::ImageError::kBadLayout);
5228 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005229 LogError(cb_state->commandBuffer(), vuid, "%s Image Layout cannot be transitioned to UNDEFINED or PREINITIALIZED.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005230 layout_loc.Message().c_str());
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005231 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005232 }
5233
5234 auto image_data = GetImageState(mem_barrier.image);
5235 if (image_data) {
5236 auto image_loc = loc.dot(Field::image);
5237
John Zulaufbea70432021-02-23 07:03:12 -07005238 skip |= ValidateMemoryIsBoundToImage(image_data, loc);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005239
5240 skip |= ValidateBarrierQueueFamilies(image_loc, cb_state, mem_barrier, image_data);
5241
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005242 skip |= ValidateImageAspectMask(image_data->image(), image_data->createInfo.format, mem_barrier.subresourceRange.aspectMask,
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005243 loc.StringFunc().c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005244
5245 skip |= ValidateImageBarrierSubresourceRange(loc.dot(Field::subresourceRange), image_data, mem_barrier.subresourceRange);
5246 }
5247 return skip;
5248}
5249
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005250bool CoreChecks::ValidateBarriers(const Location &outer_loc, const CMD_BUFFER_STATE *cb_state, VkPipelineStageFlags src_stage_mask,
5251 VkPipelineStageFlags dst_stage_mask, uint32_t memBarrierCount,
5252 const VkMemoryBarrier *pMemBarriers, uint32_t bufferBarrierCount,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005253 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
5254 const VkImageMemoryBarrier *pImageMemBarriers) const {
5255 bool skip = false;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005256 LogObjectList objects(cb_state->commandBuffer());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005257
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005258 for (uint32_t i = 0; i < memBarrierCount; ++i) {
5259 const auto &mem_barrier = pMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005260 auto loc = outer_loc.dot(Struct::VkMemoryBarrier, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005261 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005262 }
5263 for (uint32_t i = 0; i < imageMemBarrierCount; ++i) {
5264 const auto &mem_barrier = pImageMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005265 auto loc = outer_loc.dot(Struct::VkImageMemoryBarrier, Field::pImageMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005266 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005267 skip |= ValidateImageBarrier(objects, loc, cb_state, mem_barrier);
5268 }
5269 {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005270 Location loc(outer_loc.function, Struct::VkImageMemoryBarrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005271 skip |= ValidateBarriersToImages(loc, cb_state, imageMemBarrierCount, pImageMemBarriers);
5272 }
5273 for (uint32_t i = 0; i < bufferBarrierCount; ++i) {
5274 const auto &mem_barrier = pBufferMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005275 auto loc = outer_loc.dot(Struct::VkBufferMemoryBarrier, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005276 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005277 skip |= ValidateBufferBarrier(objects, loc, cb_state, mem_barrier);
5278 }
5279 return skip;
5280}
5281
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005282bool CoreChecks::ValidateDependencyInfo(const LogObjectList &objects, const Location &outer_loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbenefead332021-06-18 08:22:44 -06005283 const VkDependencyInfoKHR *dep_info) const {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005284 bool skip = false;
5285
5286 if (cb_state->activeRenderPass) {
5287 skip |= ValidateRenderPassPipelineBarriers(outer_loc, cb_state, dep_info);
5288 if (skip) return true; // Early return to avoid redundant errors from below calls
5289 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005290 for (uint32_t i = 0; i < dep_info->memoryBarrierCount; ++i) {
5291 const auto &mem_barrier = dep_info->pMemoryBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005292 auto loc = outer_loc.dot(Struct::VkMemoryBarrier2KHR, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005293 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005294 }
5295 for (uint32_t i = 0; i < dep_info->imageMemoryBarrierCount; ++i) {
5296 const auto &mem_barrier = dep_info->pImageMemoryBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005297 auto loc = outer_loc.dot(Struct::VkImageMemoryBarrier2KHR, Field::pImageMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005298 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005299 skip |= ValidateImageBarrier(objects, loc, cb_state, mem_barrier);
5300 }
5301 {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005302 Location loc(outer_loc.function, Struct::VkImageMemoryBarrier2KHR);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005303 skip |= ValidateBarriersToImages(loc, cb_state, dep_info->imageMemoryBarrierCount, dep_info->pImageMemoryBarriers);
5304 }
5305
5306 for (uint32_t i = 0; i < dep_info->bufferMemoryBarrierCount; ++i) {
5307 const auto &mem_barrier = dep_info->pBufferMemoryBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005308 auto loc = outer_loc.dot(Struct::VkBufferMemoryBarrier2KHR, Field::pBufferMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005309 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005310 skip |= ValidateBufferBarrier(objects, loc, cb_state, mem_barrier);
5311 }
5312
5313 return skip;
5314}
5315
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005316// template to check all original barrier structures
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005317template <typename Barrier>
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005318bool CoreChecks::ValidateMemoryBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
5319 const Barrier &barrier, VkPipelineStageFlags src_stage_mask,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005320 VkPipelineStageFlags dst_stage_mask) const {
5321 bool skip = false;
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005322 assert(cb_state);
5323 auto queue_flags = cb_state->GetQueueFlags();
5324
5325 if (!cb_state->IsAcquireOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005326 skip |= ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), queue_flags, barrier.srcAccessMask, src_stage_mask);
5327 }
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005328 if (!cb_state->IsReleaseOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005329 skip |= ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), queue_flags, barrier.dstAccessMask, dst_stage_mask);
5330 }
5331 return skip;
5332}
5333
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005334// template to check all synchronization2 barrier structures
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005335template <typename Barrier>
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005336bool CoreChecks::ValidateMemoryBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
5337 const Barrier &barrier) const {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005338 bool skip = false;
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005339 assert(cb_state);
5340 auto queue_flags = cb_state->GetQueueFlags();
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005341
Jeremy Gebbenefead332021-06-18 08:22:44 -06005342 skip |= ValidatePipelineStage(objects, loc.dot(Field::srcStageMask), queue_flags, barrier.srcStageMask);
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005343 if (!cb_state->IsAcquireOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005344 skip |=
5345 ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), queue_flags, barrier.srcAccessMask, barrier.srcStageMask);
5346 }
Jeremy Gebbenefead332021-06-18 08:22:44 -06005347
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005348 skip |= ValidatePipelineStage(objects, loc.dot(Field::dstStageMask), queue_flags, barrier.dstStageMask);
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005349 if (!cb_state->IsReleaseOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005350 skip |=
5351 ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), queue_flags, barrier.dstAccessMask, barrier.dstStageMask);
5352 }
5353 return skip;
5354}
5355
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005356// VkSubpassDependency validation happens when vkCreateRenderPass() is called.
5357// Dependencies between subpasses can only use pipeline stages compatible with VK_QUEUE_GRAPHICS_BIT,
5358// for external subpasses we don't have a yet command buffer so we have to assume all of them are valid.
5359static inline VkQueueFlags SubpassToQueueFlags(uint32_t subpass) {
5360 return subpass == VK_SUBPASS_EXTERNAL ? sync_utils::kAllQueueTypes : static_cast<VkQueueFlags>(VK_QUEUE_GRAPHICS_BIT);
5361}
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005362
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005363bool CoreChecks::ValidateSubpassDependency(const LogObjectList &objects, const Location &in_loc,
5364 const VkSubpassDependency2 &dependency) const {
5365 bool skip = false;
5366 Location loc = in_loc;
5367 VkMemoryBarrier2KHR converted_barrier;
5368 const auto *mem_barrier = LvlFindInChain<VkMemoryBarrier2KHR>(dependency.pNext);
5369
5370 if (mem_barrier && enabled_features.synchronization2_features.synchronization2) {
5371 if (dependency.srcAccessMask != 0) {
5372 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-srcAccessMask",
5373 "%s is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5374 loc.dot(Field::srcAccessMask).Message().c_str());
5375 }
5376 if (dependency.dstAccessMask != 0) {
5377 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-dstAccessMask",
5378 "%s dstAccessMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5379 loc.dot(Field::dstAccessMask).Message().c_str());
5380 }
5381 if (dependency.srcStageMask != 0) {
5382 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-srcStageMask",
5383 "%s srcStageMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5384 loc.dot(Field::srcStageMask).Message().c_str());
5385 }
5386 if (dependency.dstStageMask != 0) {
5387 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-dstStageMask",
5388 "%s dstStageMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5389 loc.dot(Field::dstStageMask).Message().c_str());
5390 }
5391 loc = in_loc.dot(Field::pNext);
5392 converted_barrier = *mem_barrier;
5393 } else {
5394 if (mem_barrier) {
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005395 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-pNext",
5396 "%s a VkMemoryBarrier2KHR is present in pNext but synchronization2 is not enabled.",
5397 loc.Message().c_str());
5398 }
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005399 // use the subpass dependency flags, upconverted into wider synchronization2 fields.
5400 converted_barrier.srcStageMask = dependency.srcStageMask;
5401 converted_barrier.dstStageMask = dependency.dstStageMask;
5402 converted_barrier.srcAccessMask = dependency.srcAccessMask;
5403 converted_barrier.dstAccessMask = dependency.dstAccessMask;
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005404 }
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005405 auto src_queue_flags = SubpassToQueueFlags(dependency.srcSubpass);
5406 skip |= ValidatePipelineStage(objects, loc.dot(Field::srcStageMask), src_queue_flags, converted_barrier.srcStageMask);
5407 skip |= ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), src_queue_flags, converted_barrier.srcAccessMask,
5408 converted_barrier.srcStageMask);
5409
5410 auto dst_queue_flags = SubpassToQueueFlags(dependency.dstSubpass);
5411 skip |= ValidatePipelineStage(objects, loc.dot(Field::dstStageMask), dst_queue_flags, converted_barrier.dstStageMask);
5412 skip |= ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), dst_queue_flags, converted_barrier.dstAccessMask,
5413 converted_barrier.dstStageMask);
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005414 return skip;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005415}
5416
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005417bool CoreChecks::ValidateImageViewFormatFeatures(const IMAGE_STATE *image_state, const VkFormat view_format,
5418 const VkImageUsageFlags image_usage) const {
5419 // Pass in image_usage here instead of extracting it from image_state in case there's a chained VkImageViewUsageCreateInfo
5420 bool skip = false;
5421
5422 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
5423 const VkImageTiling image_tiling = image_state->createInfo.tiling;
5424
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06005425 if (image_state->HasAHBFormat()) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005426 // AHB image view and image share same feature sets
5427 tiling_features = image_state->format_features;
5428 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5429 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
sfricke-samsung45996a42021-09-16 13:45:27 -07005430 assert(IsExtEnabled(device_extensions.vk_ext_image_drm_format_modifier));
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005431 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = {VK_STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_PROPERTIES_EXT,
5432 nullptr};
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005433 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image_state->image(), &drm_format_properties);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005434
5435 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
5436 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
5437 nullptr};
5438 format_properties_2.pNext = (void *)&drm_properties_list;
5439 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
5440
nyorain38a9d232021-03-06 13:06:12 +01005441 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
5442 drm_properties.resize(drm_properties_list.drmFormatModifierCount);
5443 drm_properties_list.pDrmFormatModifierProperties = drm_properties.data();
5444
5445 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
5446
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005447 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
5448 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_properties.drmFormatModifier) !=
5449 0) {
5450 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
5451 }
5452 }
5453 } else {
5454 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
5455 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
5456 : format_properties.optimalTilingFeatures;
5457 }
5458
5459 if (tiling_features == 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005460 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-None-02273",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005461 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
5462 "physical device.",
5463 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5464 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005465 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02274",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005466 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5467 "VK_IMAGE_USAGE_SAMPLED_BIT.",
5468 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5469 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005470 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02275",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005471 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5472 "VK_IMAGE_USAGE_STORAGE_BIT.",
5473 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5474 } 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 -06005475 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02276",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005476 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5477 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
5478 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5479 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
5480 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005481 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02277",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005482 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5483 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5484 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5485 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
5486 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005487 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02652",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005488 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5489 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5490 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Tobias Hector6663c9b2020-11-05 10:18:02 +00005491 } else if ((image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) &&
5492 !(tiling_features & VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR)) {
5493 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005494 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-04550",
Tobias Hector6663c9b2020-11-05 10:18:02 +00005495 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5496 "VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR.",
5497 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5498 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005499 }
5500
5501 return skip;
5502}
5503
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005504bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005505 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005506 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005507 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005508 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005509 skip |=
5510 ValidateImageUsageFlags(image_state,
5511 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
5512 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
sfricke-samsungbb971942020-09-10 22:11:56 -07005513 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV |
5514 VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
5515 false, "VUID-VkImageViewCreateInfo-image-04441", "vkCreateImageView()",
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005516 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
sfricke-samsungbb971942020-09-10 22:11:56 -07005517 "TRANSIENT_ATTACHMENT|SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005518 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005519 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005520 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02005521 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005522 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005523 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005524
5525 VkImageCreateFlags image_flags = image_state->createInfo.flags;
5526 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005527 VkImageUsageFlags image_usage = image_state->createInfo.usage;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005528 VkFormat view_format = pCreateInfo->format;
5529 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06005530 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005531 VkImageViewType view_type = pCreateInfo->viewType;
sfricke-samsung20a8a372021-07-14 06:12:17 -07005532 uint32_t layer_count = pCreateInfo->subresourceRange.layerCount;
Mark Lobodzinski602de982017-02-09 11:01:33 -07005533
Dave Houltonbd2e2622018-04-10 16:41:14 -06005534 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005535 auto chained_ivuci_struct = LvlFindInChain<VkImageViewUsageCreateInfo>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06005536 if (chained_ivuci_struct) {
sfricke-samsung45996a42021-09-16 13:45:27 -07005537 if (IsExtEnabled(device_extensions.vk_khr_maintenance2)) {
5538 if (!IsExtEnabled(device_extensions.vk_ext_separate_stencil_usage)) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05005539 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005540 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
5541 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
5542 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05005543 }
5544 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005545 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05005546 if (image_stencil_struct == nullptr) {
5547 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005548 skip |= LogError(
5549 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005550 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
5551 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
5552 "any bits that were not set in VkImageCreateInfo::usage used to create image");
5553 }
5554 } else {
5555 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
5556 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
5557 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005558 skip |= LogError(
5559 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005560 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5561 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5562 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
5563 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
5564 }
5565 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
5566 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005567 skip |= LogError(
5568 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005569 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5570 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5571 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
5572 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
5573 }
5574 }
5575 }
5576 }
5577
Dave Houltonbd2e2622018-04-10 16:41:14 -06005578 image_usage = chained_ivuci_struct->usage;
5579 }
5580
sfricke-samsungf60b6c82021-04-05 22:59:20 -07005581 // If image used VkImageFormatListCreateInfo need to make sure a format from list is used
5582 const auto format_list_info = LvlFindInChain<VkImageFormatListCreateInfo>(image_state->createInfo.pNext);
5583 if (format_list_info && (format_list_info->viewFormatCount > 0)) {
5584 bool foundFormat = false;
5585 for (uint32_t i = 0; i < format_list_info->viewFormatCount; i++) {
5586 if (format_list_info->pViewFormats[i] == view_format) {
5587 foundFormat = true;
5588 break;
5589 }
5590 }
5591 if (foundFormat == false) {
5592 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-01585",
5593 "vkCreateImageView(): image was created with a VkImageFormatListCreateInfo in pNext of "
5594 "vkImageCreateInfo, but none of the formats match the VkImageViewCreateInfo::format (%s).",
5595 string_VkFormat(view_format));
5596 }
5597 }
5598
Dave Houlton6f5f20a2018-05-04 12:37:44 -06005599 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
5600 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005601 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01005602 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06005603 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01005604 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06005605 std::stringstream ss;
5606 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01005607 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06005608 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005609 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005610 }
5611 } else {
Mike Schuchardt2df08912020-12-15 16:28:09 -08005612 if (!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005613 // 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 -07005614 const VkFormatCompatibilityClass imageClass = FormatCompatibilityClass(image_format);
5615 const VkFormatCompatibilityClass viewClass = FormatCompatibilityClass(view_format);
5616 // Need to only check if one is NONE_BIT to handle edge case both are NONE_BIT
5617 if ((imageClass != viewClass) || (imageClass == VK_FORMAT_COMPATIBILITY_CLASS_NONE_BIT)) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005618 const char *error_vuid;
sfricke-samsung45996a42021-09-16 13:45:27 -07005619 if ((!IsExtEnabled(device_extensions.vk_khr_maintenance2)) &&
5620 (!IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion))) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005621 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
sfricke-samsung45996a42021-09-16 13:45:27 -07005622 } else if ((IsExtEnabled(device_extensions.vk_khr_maintenance2)) &&
5623 (!IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion))) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005624 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
sfricke-samsung45996a42021-09-16 13:45:27 -07005625 } else if ((!IsExtEnabled(device_extensions.vk_khr_maintenance2)) &&
5626 (IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion))) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005627 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
5628 } else {
5629 // both enabled
5630 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
5631 }
Dave Houltonc7988072018-04-16 11:46:56 -06005632 std::stringstream ss;
5633 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06005634 << " is not in the same format compatibility class as "
5635 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06005636 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
5637 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005638 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005639 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06005640 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005641 }
5642 } else {
5643 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07005644 // Unless it is a multi-planar color bit aspect
5645 if ((image_format != view_format) &&
5646 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
sfricke-samsung45996a42021-09-16 13:45:27 -07005647 const char *vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
5648 ? "VUID-VkImageViewCreateInfo-image-01762"
5649 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07005650 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06005651 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07005652 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07005653 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07005654 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005655 }
5656 }
5657
ziga-lunargebb32de2021-08-29 21:24:30 +02005658 if (image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT && view_type != VK_IMAGE_VIEW_TYPE_2D &&
5659 view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5660 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04972",
5661 "vkCreateImageView(): image was created with sample count %s, but pCreateInfo->viewType is %s.",
5662 string_VkSampleCountFlagBits(image_state->createInfo.samples), string_VkImageViewType(view_type));
5663 }
5664
Mark Lobodzinski602de982017-02-09 11:01:33 -07005665 // Validate correct image aspect bits for desired formats and format consistency
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005666 skip |= ValidateImageAspectMask(image_state->image(), image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06005667
sfricke-samsung20a8a372021-07-14 06:12:17 -07005668 // Valdiate Image/ImageView type compatibility #resources-image-views-compatibility
Jeremy Kniager846ab732017-07-10 13:12:04 -06005669 switch (image_type) {
5670 case VK_IMAGE_TYPE_1D:
5671 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005672 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5673 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5674 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005675 }
5676 break;
5677 case VK_IMAGE_TYPE_2D:
5678 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5679 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
5680 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005681 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
5682 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5683 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005684 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005685 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5686 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5687 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005688 }
5689 }
5690 break;
5691 case VK_IMAGE_TYPE_3D:
sfricke-samsung45996a42021-09-16 13:45:27 -07005692 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06005693 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
5694 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08005695 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005696 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005697 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
sfricke-samsungd9b3e122021-07-15 22:50:00 -07005698 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type "
5699 "%s since the image doesn't have VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT flag set.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005700 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005701 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
5702 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005703 skip |= LogError(
sfricke-samsungd9b3e122021-07-15 22:50:00 -07005704 pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04971",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005705 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
5706 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
5707 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
5708 string_VkImageViewType(view_type), string_VkImageType(image_type));
sfricke-samsungd9b3e122021-07-15 22:50:00 -07005709 } else if (pCreateInfo->subresourceRange.levelCount != 1) {
5710 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04970",
5711 "vkCreateImageView(): pCreateInfo->viewType %s is with image type %s must have a "
5712 "levelCount of 1 but it is %u.",
5713 string_VkImageViewType(view_type), string_VkImageType(image_type),
5714 pCreateInfo->subresourceRange.levelCount);
Jeremy Kniager846ab732017-07-10 13:12:04 -06005715 }
5716 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005717 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5718 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5719 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005720 }
5721 }
5722 } else {
5723 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
sfricke-samsungd9b3e122021-07-15 22:50:00 -07005724 // Help point to VK_KHR_maintenance1
5725 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
5726 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5727 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
5728 "without VK_KHR_maintenance1 enabled which was promoted in Vulkan 1.0.",
5729 string_VkImageViewType(view_type), string_VkImageType(image_type));
5730 } else {
5731 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5732 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5733 string_VkImageViewType(view_type), string_VkImageType(image_type));
5734 }
Jeremy Kniager846ab732017-07-10 13:12:04 -06005735 }
5736 }
5737 break;
5738 default:
5739 break;
5740 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005741
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005742 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
sfricke-samsung45996a42021-09-16 13:45:27 -07005743 if (IsExtEnabled(device_extensions.vk_android_external_memory_android_hardware_buffer)) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005744 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005745 }
5746
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005747 skip |= ValidateImageViewFormatFeatures(image_state, view_format, image_usage);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005748
sfricke-samsung828e59d2021-08-22 23:20:49 -07005749 if (enabled_features.shading_rate_image_features.shadingRateImage) {
Tobias Hector6663c9b2020-11-05 10:18:02 +00005750 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
5751 if (view_format != VK_FORMAT_R8_UINT) {
5752 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
5753 "vkCreateImageView() If image was created with usage containing "
5754 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
5755 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05005756 }
Tobias Hector6663c9b2020-11-05 10:18:02 +00005757 }
5758
sfricke-samsung828e59d2021-08-22 23:20:49 -07005759 if (enabled_features.shading_rate_image_features.shadingRateImage ||
Tobias Hector6663c9b2020-11-05 10:18:02 +00005760 enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
5761 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) {
5762 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5763 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
5764 "vkCreateImageView() If image was created with usage containing "
5765 "VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR, viewType must be "
5766 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
5767 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05005768 }
5769 }
Jeff Bolz99e3f632020-03-24 22:59:22 -05005770
Tobias Hector6663c9b2020-11-05 10:18:02 +00005771 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate &&
5772 !phys_dev_ext_props.fragment_shading_rate_props.layeredShadingRateAttachments &&
sfricke-samsung20a8a372021-07-14 06:12:17 -07005773 image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR && layer_count != 1) {
Tobias Hector6663c9b2020-11-05 10:18:02 +00005774 skip |= LogError(device, "VUID-VkImageViewCreateInfo-usage-04551",
5775 "vkCreateImageView(): subresourceRange.layerCount is %u for a shading rate attachment image view.",
sfricke-samsung20a8a372021-07-14 06:12:17 -07005776 layer_count);
Tobias Hector6663c9b2020-11-05 10:18:02 +00005777 }
5778
sfricke-samsung20a8a372021-07-14 06:12:17 -07005779 if (layer_count == VK_REMAINING_ARRAY_LAYERS) {
5780 const uint32_t remaining_layers = image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer;
5781 if (view_type == VK_IMAGE_VIEW_TYPE_CUBE && remaining_layers != 6) {
Jeff Bolz99e3f632020-03-24 22:59:22 -05005782 skip |= LogError(device, "VUID-VkImageViewCreateInfo-viewType-02962",
5783 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be 6",
sfricke-samsung20a8a372021-07-14 06:12:17 -07005784 remaining_layers);
Jeff Bolz99e3f632020-03-24 22:59:22 -05005785 }
sfricke-samsung20a8a372021-07-14 06:12:17 -07005786 if (view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY && ((remaining_layers) % 6) != 0) {
Jeff Bolz99e3f632020-03-24 22:59:22 -05005787 skip |= LogError(
5788 device, "VUID-VkImageViewCreateInfo-viewType-02963",
5789 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be a multiple of 6",
sfricke-samsung20a8a372021-07-14 06:12:17 -07005790 remaining_layers);
5791 }
5792 if ((remaining_layers != 1) && ((view_type == VK_IMAGE_VIEW_TYPE_1D) || (view_type == VK_IMAGE_VIEW_TYPE_2D) ||
5793 (view_type == VK_IMAGE_VIEW_TYPE_3D))) {
5794 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-imageViewType-04974",
5795 "vkCreateImageView(): Using pCreateInfo->viewType %s and the subresourceRange.layerCount "
5796 "VK_REMAINING_ARRAY_LAYERS=(%d) and must 1 (try looking into VK_IMAGE_VIEW_TYPE_*_ARRAY).",
5797 string_VkImageViewType(view_type), remaining_layers);
5798 }
5799 } else {
5800 if ((layer_count != 1) && ((view_type == VK_IMAGE_VIEW_TYPE_1D) || (view_type == VK_IMAGE_VIEW_TYPE_2D) ||
5801 (view_type == VK_IMAGE_VIEW_TYPE_3D))) {
5802 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-imageViewType-04973",
5803 "vkCreateImageView(): Using pCreateInfo->viewType %s and the subresourceRange.layerCount is %d "
5804 "and must 1 (try looking into VK_IMAGE_VIEW_TYPE_*_ARRAY).",
5805 string_VkImageViewType(view_type), layer_count);
Jeff Bolz99e3f632020-03-24 22:59:22 -05005806 }
5807 }
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005808
5809 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5810 if (pCreateInfo->subresourceRange.levelCount != 1) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005811 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02571",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005812 "vkCreateImageView(): If image was created with usage containing "
5813 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, subresourceRange.levelCount (%d) must: be 1",
5814 pCreateInfo->subresourceRange.levelCount);
5815 }
5816 }
5817 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5818 if (!enabled_features.fragment_density_map_features.fragmentDensityMapDynamic) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005819 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-02572",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005820 "vkCreateImageView(): If the fragmentDensityMapDynamic feature is not enabled, "
5821 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5822 }
5823 } else {
5824 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5825 if (image_flags & (VK_IMAGE_CREATE_PROTECTED_BIT | VK_IMAGE_CREATE_SPARSE_BINDING_BIT |
5826 VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT)) {
Shannon McPherson8d0d1f92020-07-06 11:58:21 -06005827 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-04116",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005828 "vkCreateImageView(): If image was created with usage containing "
5829 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT flags must not contain any of "
5830 "VK_IMAGE_CREATE_PROTECTED_BIT, VK_IMAGE_CREATE_SPARSE_BINDING_BIT, "
5831 "VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or VK_IMAGE_CREATE_SPARSE_ALIASED_BIT");
5832 }
5833 }
5834 }
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005835
ziga-lunarg966ac0e2021-07-18 11:51:44 +02005836 if (image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
5837 if (pCreateInfo->subresourceRange.levelCount != 1) {
5838 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01584",
5839 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit, "
5840 "but subresourcesRange.levelCount (%" PRIu32 ") is not 1.",
5841 pCreateInfo->subresourceRange.levelCount);
5842 }
5843 if (pCreateInfo->subresourceRange.layerCount != 1) {
5844 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01584",
5845 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit, "
5846 "but subresourcesRange.layerCount (%" PRIu32 ") is not 1.",
5847 pCreateInfo->subresourceRange.layerCount);
5848 }
5849 }
5850
Nathaniel Cesario42d5b282021-08-17 12:47:24 -06005851 if (image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT && !FormatIsCompressed(view_format) &&
ziga-lunargc290c7f2021-07-31 22:01:46 +02005852 pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_3D) {
5853 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04739",
5854 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit and "
5855 "non-compressed format (%s), but pCreateInfo->viewType is VK_IMAGE_VIEW_TYPE_3D.",
5856 string_VkFormat(image_format));
5857 }
5858
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005859 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT) {
5860 if (!enabled_features.fragment_density_map2_features.fragmentDensityMapDeferred) {
5861 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03567",
5862 "vkCreateImageView(): If the fragmentDensityMapDeferred feature is not enabled, "
5863 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT");
5864 }
5865 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5866 skip |=
5867 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03568",
5868 "vkCreateImageView(): If flags contains VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT, "
5869 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5870 }
5871 }
sfricke-samsung45996a42021-09-16 13:45:27 -07005872 if (IsExtEnabled(device_extensions.vk_ext_fragment_density_map2)) {
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005873 if ((image_flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) && (image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) &&
sfricke-samsung20a8a372021-07-14 06:12:17 -07005874 (layer_count > phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers)) {
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005875 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-03569",
5876 "vkCreateImageView(): If image was created with flags containing "
5877 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT and usage containing VK_IMAGE_USAGE_SAMPLED_BIT "
5878 "subresourceRange.layerCount (%d) must: be less than or equal to maxSubsampledArrayLayers (%d)",
sfricke-samsung20a8a372021-07-14 06:12:17 -07005879 layer_count, phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers);
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005880 }
5881 }
5882
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005883 auto astc_decode_mode = LvlFindInChain<VkImageViewASTCDecodeModeEXT>(pCreateInfo->pNext);
sfricke-samsung45996a42021-09-16 13:45:27 -07005884 if (IsExtEnabled(device_extensions.vk_ext_astc_decode_mode) && (astc_decode_mode != nullptr)) {
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005885 if ((enabled_features.astc_decode_features.decodeModeSharedExponent == VK_FALSE) &&
5886 (astc_decode_mode->decodeMode == VK_FORMAT_E5B9G9R9_UFLOAT_PACK32)) {
5887 skip |= LogError(device, "VUID-VkImageViewASTCDecodeModeEXT-decodeMode-02231",
5888 "vkCreateImageView(): decodeModeSharedExponent is not enabled but "
5889 "VkImageViewASTCDecodeModeEXT::decodeMode is VK_FORMAT_E5B9G9R9_UFLOAT_PACK32.");
5890 }
5891 }
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005892
sfricke-samsung45996a42021-09-16 13:45:27 -07005893 if (IsExtEnabled(device_extensions.vk_khr_portability_subset)) {
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005894 // If swizzling is disabled, make sure it isn't used
Nathaniel Cesario17d057e2021-06-21 22:58:45 -06005895 // NOTE: as of spec version 1.2.183, VUID 04465 states: "all elements of components _must_ be
5896 // VK_COMPONENT_SWIZZLE_IDENTITY."
5897 // However, issue https://github.com/KhronosGroup/Vulkan-Portability/issues/27 points out that the identity can
5898 // also be defined via R, G, B, A enums in the correct order.
5899 // Spec change is at https://gitlab.khronos.org/vulkan/vulkan/-/merge_requests/4600
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005900 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatSwizzle) &&
Nathaniel Cesario17d057e2021-06-21 22:58:45 -06005901 !IsIdentitySwizzle(pCreateInfo->components)) {
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005902 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatSwizzle-04465",
5903 "vkCreateImageView (portability error): swizzle is disabled for this device.");
5904 }
5905
5906 // Ensure ImageView's format has the same number of bits and components as Image's format if format reinterpretation is
5907 // disabled
5908 // TODO (ncesario): This is not correct for some cases (e.g., VK_FORMAT_B10G11R11_UFLOAT_PACK32 and
5909 // VK_FORMAT_E5B9G9R9_UFLOAT_PACK32), but requires additional information that should probably be generated from the
5910 // spec. See Github issue #2361.
5911 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatReinterpretation) &&
5912 ((FormatElementSize(pCreateInfo->format, VK_IMAGE_ASPECT_COLOR_BIT) !=
5913 FormatElementSize(image_state->createInfo.format, VK_IMAGE_ASPECT_COLOR_BIT)) ||
sfricke-samsunged028b02021-09-06 23:14:51 -07005914 (FormatComponentCount(pCreateInfo->format) != FormatComponentCount(image_state->createInfo.format)))) {
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005915 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatReinterpretation-04466",
5916 "vkCreateImageView (portability error): ImageView format must have"
5917 " the same number of components and bits per component as the Image's format");
5918 }
5919 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005920 }
5921 return skip;
5922}
5923
Jeff Leger178b1e52020-10-05 12:22:23 -04005924template <typename RegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005925bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
Jeff Leger178b1e52020-10-05 12:22:23 -04005926 uint32_t regionCount, const RegionType *pRegions, CopyCommandVersion version) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005927 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04005928 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5929 const char *func_name = is_2khr ? "vkCmdCopyBuffer2KHR()" : "vkCmdCopyBuffer()";
5930 const char *vuid;
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005931
5932 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
5933 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
5934 VkDeviceSize src_min = UINT64_MAX;
5935 VkDeviceSize src_max = 0;
5936 VkDeviceSize dst_min = UINT64_MAX;
5937 VkDeviceSize dst_max = 0;
5938
5939 for (uint32_t i = 0; i < regionCount; i++) {
5940 src_min = std::min(src_min, pRegions[i].srcOffset);
5941 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
5942 dst_min = std::min(dst_min, pRegions[i].dstOffset);
5943 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
5944
5945 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
5946 if (pRegions[i].srcOffset >= src_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005947 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-srcOffset-00113" : "VUID-vkCmdCopyBuffer-srcOffset-00113";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005948 skip |= LogError(src_buffer_state->buffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005949 "%s: pRegions[%d].srcOffset (%" PRIuLEAST64 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5950 func_name, i, pRegions[i].srcOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005951 }
5952
5953 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
5954 if (pRegions[i].dstOffset >= dst_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005955 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-dstOffset-00114" : "VUID-vkCmdCopyBuffer-dstOffset-00114";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005956 skip |= LogError(dst_buffer_state->buffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005957 "%s: pRegions[%d].dstOffset (%" PRIuLEAST64 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5958 func_name, i, pRegions[i].dstOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005959 }
5960
5961 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
5962 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005963 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00115" : "VUID-vkCmdCopyBuffer-size-00115";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005964 skip |= LogError(src_buffer_state->buffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005965 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the source buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005966 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04005967 func_name, i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005968 }
5969
5970 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
5971 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005972 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00116" : "VUID-vkCmdCopyBuffer-size-00116";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005973 skip |= LogError(dst_buffer_state->buffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005974 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the destination buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005975 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04005976 func_name, i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005977 }
5978 }
5979
5980 // 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 -06005981 if (src_buffer_state->buffer() == dst_buffer_state->buffer()) {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005982 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005983 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-pRegions-00117" : "VUID-vkCmdCopyBuffer-pRegions-00117";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005984 skip |= LogError(src_buffer_state->buffer(), vuid, "%s: Detected overlap between source and dest regions in memory.",
Jeff Leger178b1e52020-10-05 12:22:23 -04005985 func_name);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005986 }
5987 }
5988
5989 return skip;
5990}
5991
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005992bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005993 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005994 const auto cb_node = GetCBState(commandBuffer);
5995 const auto src_buffer_state = GetBufferState(srcBuffer);
5996 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005997
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005998 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005999 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
6000 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006001 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06006002 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006003 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
6004 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06006005 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006006 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
6007 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07006008 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
Jeff Leger178b1e52020-10-05 12:22:23 -04006009 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, regionCount, pRegions, COPY_COMMAND_VERSION_1);
sfricke-samsung022fa252020-07-24 03:26:16 -07006010 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01822");
6011 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01823");
6012 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01824");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006013 return skip;
6014}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07006015
Jeff Leger178b1e52020-10-05 12:22:23 -04006016bool CoreChecks::PreCallValidateCmdCopyBuffer2KHR(VkCommandBuffer commandBuffer,
6017 const VkCopyBufferInfo2KHR *pCopyBufferInfos) const {
6018 const auto cb_node = GetCBState(commandBuffer);
6019 const auto src_buffer_state = GetBufferState(pCopyBufferInfos->srcBuffer);
6020 const auto dst_buffer_state = GetBufferState(pCopyBufferInfos->dstBuffer);
6021
6022 bool skip = false;
6023 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-VkCopyBufferInfo2KHR-srcBuffer-00119");
6024 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-VkCopyBufferInfo2KHR-dstBuffer-00121");
6025 // Validate that SRC & DST buffers have correct usage flags set
6026 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
6027 "VUID-VkCopyBufferInfo2KHR-srcBuffer-00118", "vkCmdCopyBuffer2KHR()",
6028 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
6029 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
6030 "VUID-VkCopyBufferInfo2KHR-dstBuffer-00120", "vkCmdCopyBuffer2KHR()",
6031 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006032 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER2KHR, "vkCmdCopyBuffer2KHR()");
Jeff Leger178b1e52020-10-05 12:22:23 -04006033 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, pCopyBufferInfos->regionCount,
6034 pCopyBufferInfos->pRegions, COPY_COMMAND_VERSION_2);
6035 skip |=
6036 ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01822");
6037 skip |=
6038 ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01823");
6039 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer2KHR()",
6040 "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01824");
6041 return skip;
6042}
6043
Jeff Bolz46c0ea02019-10-09 13:06:29 -05006044bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006045 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07006046 auto buffer_state = GetBufferState(buffer);
sfricke-samsung9c7d8552020-08-16 22:12:21 -07006047 if (buffer_state) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06006048 if (buffer_state->InUse()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006049 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
6050 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006051 }
6052 }
6053 return skip;
6054}
6055
Jeff Bolz5c801d12019-10-09 10:38:45 -05006056bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
6057 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05006058 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07006059
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006060 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07006061 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07006062 skip |=
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06006063 ValidateObjectNotInUse(image_view_state, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006064 }
6065 return skip;
6066}
6067
Jeff Bolz5c801d12019-10-09 10:38:45 -05006068bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07006069 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07006070
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006071 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07006072 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07006073 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006074 }
6075 return skip;
6076}
6077
Nathaniel Cesario42ac6ca2021-06-15 17:23:05 -06006078void CoreChecks::PreCallRecordDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
6079 const auto buffer_state = Get<BUFFER_STATE>(buffer);
6080 if (buffer_state) {
6081 auto itr = buffer_address_map_.find(buffer_state->deviceAddress);
6082 if (itr != buffer_address_map_.end()) {
6083 buffer_address_map_.erase(itr);
6084 }
6085 }
6086 StateTracker::PreCallRecordDestroyBuffer(device, buffer, pAllocator);
6087}
6088
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006089bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006090 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07006091 auto buffer_view_state = GetBufferViewState(bufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006092 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07006093 if (buffer_view_state) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06006094 skip |= ValidateObjectNotInUse(buffer_view_state, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06006095 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006096 }
6097 return skip;
6098}
6099
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006100bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006101 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06006102 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07006103 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006104 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07006105 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07006106 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006107 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006108 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
6109 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006110
sfricke-samsung022fa252020-07-24 03:26:16 -07006111 skip |= ValidateProtectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01811");
6112 skip |= ValidateUnprotectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01812");
6113
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006114 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006115 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
6116 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
6117 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
6118 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006119 }
6120
6121 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006122 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
6123 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
6124 ") minus dstOffset (0x%" PRIxLEAST64 ").",
6125 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006126 }
6127
sfricke-samsung45996a42021-09-16 13:45:27 -07006128 if (!IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
ziga-lunarg3c5c84e2021-08-04 15:18:56 +02006129 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
6130 "VUID-vkCmdFillBuffer-commandBuffer-00030");
6131 }
6132
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006133 return skip;
6134}
6135
Jeff Leger178b1e52020-10-05 12:22:23 -04006136template <typename BufferImageCopyRegionType>
sfricke-samsungd0659242020-08-18 22:38:43 -07006137bool CoreChecks::ValidateBufferImageCopyData(const CMD_BUFFER_STATE *cb_node, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04006138 const BufferImageCopyRegionType *pRegions, const IMAGE_STATE *image_state,
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006139 const char *function, CopyCommandVersion version, bool image_to_buffer) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006140 bool skip = false;
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07006141 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
6142 const char *vuid;
Jeff Leger178b1e52020-10-05 12:22:23 -04006143
sfricke-samsung125d2b42020-05-28 06:32:43 -07006144 assert(image_state != nullptr);
6145 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006146
6147 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006148 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006149 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
6150 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006151 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00199", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006152 "%s: pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
6153 "and 1, respectively.",
6154 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006155 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006156 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006157
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006158 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
6159 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006160 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00201", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006161 "%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 -07006162 "must be 0 and 1, respectively.",
6163 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006164 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006165 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006166
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006167 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
6168 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006169 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00213", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006170 "%s: pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006171 "For 3D images these must be 0 and 1, respectively.",
6172 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006173 }
6174 }
6175
6176 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07006177 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
sfricke-samsung73e755c2021-09-30 08:34:57 -07006178 const uint32_t element_size =
6179 FormatIsDepthOrStencil(image_format) ? 0 : FormatElementSize(image_format, region_aspect_mask);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006180 const VkDeviceSize bufferOffset = pRegions[i].bufferOffset;
Locke497739c2019-03-08 11:50:47 -07006181
sfricke-samsung8feecc12021-01-23 03:28:38 -08006182 if (FormatIsDepthOrStencil(image_format)) {
6183 if (SafeModulo(bufferOffset, 4) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006184 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("04053", image_to_buffer, is_2khr),
sfricke-samsung8feecc12021-01-23 03:28:38 -08006185 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6186 " must be a multiple 4 if using a depth/stencil format (%s).",
6187 function, i, bufferOffset, string_VkFormat(image_format));
6188 }
6189 } else {
6190 // If not depth/stencil and not multi-plane
6191 if (!FormatIsMultiplane(image_format) && (SafeModulo(bufferOffset, element_size) != 0)) {
sfricke-samsung45996a42021-09-16 13:45:27 -07006192 vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
sfricke-samsung8feecc12021-01-23 03:28:38 -08006193 ? GetBufferImageCopyCommandVUID("01558", image_to_buffer, is_2khr)
6194 : GetBufferImageCopyCommandVUID("00193", image_to_buffer, is_2khr);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006195 skip |= LogError(image_state->image(), vuid,
sfricke-samsung8feecc12021-01-23 03:28:38 -08006196 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6197 " must be a multiple of this format's texel size (%" PRIu32 ").",
6198 function, i, bufferOffset, element_size);
6199 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006200 }
6201
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006202 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
6203 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006204 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferRowLength-00195" : "VUID-VkBufferImageCopy-bufferRowLength-00195";
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06006205 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006206 LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006207 "%s: pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006208 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006209 }
6210
6211 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
6212 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006213 vuid =
6214 (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferImageHeight-00196" : "VUID-VkBufferImageCopy-bufferImageHeight-00196";
Jeff Leger178b1e52020-10-05 12:22:23 -04006215 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006216 LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006217 "%s: pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
6218 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006219 }
6220
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006221 // Calculate adjusted image extent, accounting for multiplane image factors
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06006222 VkExtent3D adjusted_image_extent = image_state->GetSubresourceExtent(pRegions[i].imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006223 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006224 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 -06006225 ((pRegions[i].imageOffset.x + static_cast<int32_t>(pRegions[i].imageExtent.width)) >
6226 static_cast<int32_t>(adjusted_image_extent.width))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006227 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00197", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006228 "%s: Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006229 "zero or <= image subresource width (%d).",
6230 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006231 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006232 }
6233
6234 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006235 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 -06006236 ((pRegions[i].imageOffset.y + static_cast<int32_t>(pRegions[i].imageExtent.height)) >
6237 static_cast<int32_t>(adjusted_image_extent.height))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006238 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00198", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006239 "%s: Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006240 "zero or <= image subresource height (%d).",
6241 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006242 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006243 }
6244
6245 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006246 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 -06006247 ((pRegions[i].imageOffset.z + static_cast<int32_t>(pRegions[i].imageExtent.depth)) >
6248 static_cast<int32_t>(adjusted_image_extent.depth))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006249 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00200", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006250 "%s: Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006251 "zero or <= image subresource depth (%d).",
6252 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006253 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006254 }
6255
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006256 // subresource aspectMask must have exactly 1 bit set
6257 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
sfricke-samsung125d2b42020-05-28 06:32:43 -07006258 std::bitset<num_bits> aspect_mask_bits(region_aspect_mask);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006259 if (aspect_mask_bits.count() != 1) {
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07006260 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-aspectMask-00212" : "VUID-VkBufferImageCopy-aspectMask-00212";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006261 skip |= LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006262 "%s: aspectMasks for imageSubresource in pRegion[%d] must have only a single bit set.", function, i);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006263 }
6264
6265 // image subresource aspect bit must match format
sfricke-samsung125d2b42020-05-28 06:32:43 -07006266 if (!VerifyAspectsPresent(region_aspect_mask, image_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006267 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006268 LogError(image_state->image(), GetBufferImageCopyCommandVUID("00211", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006269 "%s: pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
6270 function, i, region_aspect_mask, image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006271 }
6272
6273 // Checks that apply only to compressed images
sfricke-samsung125d2b42020-05-28 06:32:43 -07006274 if (FormatIsCompressed(image_format) || FormatIsSinglePlane_422(image_format)) {
6275 auto block_size = FormatTexelBlockExtent(image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006276
6277 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06006278 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006279 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006280 LogError(image_state->image(), GetBufferImageCopyCommandVUID("00203", image_to_buffer, is_2khr),
Petr Krausb0d5e592021-05-21 23:37:11 +02006281 "%s: pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04006282 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006283 }
6284
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006285 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06006286 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006287 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006288 image_state->image(), GetBufferImageCopyCommandVUID("00204", image_to_buffer, is_2khr),
Petr Krausb0d5e592021-05-21 23:37:11 +02006289 "%s: pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06006290 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006291 }
6292
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006293 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06006294 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
6295 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
6296 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006297 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00205", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006298 "%s: pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
Petr Krausb0d5e592021-05-21 23:37:11 +02006299 "width & height (%d, %d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006300 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
6301 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006302 }
6303
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006304 // bufferOffset must be a multiple of block size (linear bytes)
sfricke-samsung73e755c2021-09-30 08:34:57 -07006305 if (SafeModulo(bufferOffset, element_size) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006306 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00206", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006307 "%s: pRegion[%d] bufferOffset (0x%" PRIxLEAST64
Petr Krausb0d5e592021-05-21 23:37:11 +02006308 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ").",
sfricke-samsung73e755c2021-09-30 08:34:57 -07006309 function, i, bufferOffset, element_size);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006310 }
Dave Houlton67e9b532017-03-02 17:00:10 -07006311
6312 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06006313 VkExtent3D mip_extent = image_state->GetSubresourceExtent(pRegions[i].imageSubresource);
Dave Houlton1d2022c2017-03-29 11:43:58 -06006314 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006315 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006316 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00207", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006317 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Petr Krausb0d5e592021-05-21 23:37:11 +02006318 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006319 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
6320 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07006321 }
6322
6323 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06006324 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006325 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006326 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00208", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006327 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Petr Krausb0d5e592021-05-21 23:37:11 +02006328 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006329 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
6330 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07006331 }
6332
6333 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06006334 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006335 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006336 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00209", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006337 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Petr Krausb0d5e592021-05-21 23:37:11 +02006338 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006339 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
6340 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07006341 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006342 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08006343
6344 // Checks that apply only to multi-planar format images
sfricke-samsung125d2b42020-05-28 06:32:43 -07006345 if (FormatIsMultiplane(image_format)) {
sfricke-samsung552d5e12020-01-07 22:00:20 -08006346 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
sfricke-samsung125d2b42020-05-28 06:32:43 -07006347 if ((FormatPlaneCount(image_format) < 3) && (region_aspect_mask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006348 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006349 "%s: pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006350 "format has three planes.",
6351 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08006352 }
6353
6354 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
sfricke-samsung125d2b42020-05-28 06:32:43 -07006355 if (0 ==
6356 (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 -06006357 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006358 "%s: pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006359 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
6360 function, i);
sfricke-samsung125d2b42020-05-28 06:32:43 -07006361 } else {
6362 // Know aspect mask is valid
6363 const VkFormat compatible_format = FindMultiplaneCompatibleFormat(image_format, region_aspect_mask);
6364 const uint32_t compatible_size = FormatElementSize(compatible_format);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006365 if (SafeModulo(bufferOffset, compatible_size) != 0) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006366 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006367 image_state->image(), GetBufferImageCopyCommandVUID("01559", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006368 "%s: pRegion[%d]->bufferOffset is 0x%" PRIxLEAST64
sfricke-samsung125d2b42020-05-28 06:32:43 -07006369 " 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 -08006370 function, i, bufferOffset, element_size, GetPlaneIndex(region_aspect_mask),
sfricke-samsung125d2b42020-05-28 06:32:43 -07006371 string_VkFormat(compatible_format));
6372 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08006373 }
6374 }
sfricke-samsung8feecc12021-01-23 03:28:38 -08006375
6376 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
6377 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool.get();
6378 assert(command_pool != nullptr);
6379 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
6380 const VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[queue_family_index].queueFlags;
6381 if (((queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT)) == 0) && (SafeModulo(bufferOffset, 4) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006382 LogObjectList objlist(cb_node->commandBuffer());
6383 objlist.add(command_pool->commandPool());
6384 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("04052", image_to_buffer, is_2khr),
sfricke-samsung8feecc12021-01-23 03:28:38 -08006385 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6386 " must be a multiple 4 because the command buffer %s was allocated from the command pool %s "
6387 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT or "
6388 "VK_QUEUE_COMPUTE_BIT flag.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006389 function, i, bufferOffset, report_data->FormatHandle(cb_node->commandBuffer()).c_str(),
6390 report_data->FormatHandle(command_pool->commandPool()).c_str(), queue_family_index);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006391 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006392 }
6393
6394 return skip;
6395}
6396
Jeff Leger178b1e52020-10-05 12:22:23 -04006397template <typename BufferImageCopyRegionType>
6398bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount,
6399 const BufferImageCopyRegionType *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006400 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006401 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006402
6403 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006404 VkExtent3D extent = pRegions[i].imageExtent;
6405 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006406
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006407 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
6408 {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006409 skip |= LogWarning(image_state->image(), kVUID_Core_Image_ZeroAreaSubregion,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006410 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
6411 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006412 }
6413
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06006414 VkExtent3D image_extent = image_state->GetSubresourceExtent(pRegions[i].imageSubresource);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006415
6416 // If we're using a compressed format, valid extent is rounded up to multiple of block size (per 18.1)
unknown948b6ba2019-09-19 17:32:54 -06006417 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07006418 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006419 if (image_extent.width % block_extent.width) {
6420 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
6421 }
6422 if (image_extent.height % block_extent.height) {
6423 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
6424 }
6425 if (image_extent.depth % block_extent.depth) {
6426 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
6427 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006428 }
6429
Dave Houltonfc1a4052017-04-27 14:32:45 -06006430 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Petr Krausb0d5e592021-05-21 23:37:11 +02006431 skip |= LogError(image_state->image(), msg_code, "%s: pRegion[%d] exceeds image bounds.", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006432 }
6433 }
6434
6435 return skip;
6436}
6437
Jeff Leger178b1e52020-10-05 12:22:23 -04006438template <typename BufferImageCopyRegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006439bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04006440 const BufferImageCopyRegionType *pRegions, const char *func_name,
6441 const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006442 bool skip = false;
6443
6444 VkDeviceSize buffer_size = buff_state->createInfo.size;
6445
6446 for (uint32_t i = 0; i < regionCount; i++) {
locke-lunarga19c71d2020-03-02 18:17:04 -07006447 VkDeviceSize max_buffer_offset =
6448 GetBufferSizeFromCopyImage(pRegions[i], image_state->createInfo.format) + pRegions[i].bufferOffset;
6449 if (buffer_size < max_buffer_offset) {
6450 skip |=
Petr Krausb0d5e592021-05-21 23:37:11 +02006451 LogError(device, msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes.", func_name, i, buffer_size);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006452 }
6453 }
6454
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006455 return skip;
6456}
6457
Jeff Leger178b1e52020-10-05 12:22:23 -04006458template <typename BufferImageCopyRegionType>
6459bool CoreChecks::ValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6460 VkBuffer dstBuffer, uint32_t regionCount, const BufferImageCopyRegionType *pRegions,
6461 CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06006462 const auto cb_node = GetCBState(commandBuffer);
6463 const auto src_image_state = GetImageState(srcImage);
6464 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006465
Jeff Leger178b1e52020-10-05 12:22:23 -04006466 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
6467 const char *func_name = is_2khr ? "vkCmdCopyImageToBuffer2KHR()" : "vkCmdCopyImageToBuffer()";
6468 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGETOBUFFER2KHR : CMD_COPYIMAGETOBUFFER;
6469 const char *vuid;
6470
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006471 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, src_image_state, func_name, version, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006472
6473 // Validate command buffer state
Jeff Leger178b1e52020-10-05 12:22:23 -04006474 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006475
6476 // Command pool must support graphics, compute, or transfer operations
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07006477 const auto pool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006478
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07006479 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07006480
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006481 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006482 vuid =
6483 is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool";
6484 skip |= LogError(cb_node->createInfo.commandPool, vuid,
6485 "Cannot call %s on a command buffer allocated from a pool without graphics, compute, "
6486 "or transfer capabilities.",
6487 func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006488 }
Mike Schuchardt7b152fa2021-08-03 16:30:27 -07006489 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00182" : "VUID-vkCmdCopyImageToBuffer-pRegions-06220";
Jeff Leger178b1e52020-10-05 12:22:23 -04006490 skip |= ValidateImageBounds(src_image_state, regionCount, pRegions, func_name, vuid);
6491 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00183" : "VUID-vkCmdCopyImageToBuffer-pRegions-00183";
6492 skip |= ValidateBufferBounds(src_image_state, dst_buffer_state, regionCount, pRegions, func_name, vuid);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006493
Jeff Leger178b1e52020-10-05 12:22:23 -04006494 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00188" : "VUID-vkCmdCopyImageToBuffer-srcImage-00188";
6495 const char *location = is_2khr ? "vkCmdCopyImageToBuffer2KHR(): srcImage" : "vkCmdCopyImageToBuffer(): srcImage";
6496 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
6497
6498 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00187" : "VUID-vkCmdCopyImageToBuffer-srcImage-00187";
6499 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
6500 vuid = is_2khr ? "vkCmdCopyImageToBuffer-dstBuffer2KHR-00192" : "vkCmdCopyImageToBuffer dstBuffer-00192";
6501 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, func_name, vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006502
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006503 // Validate that SRC image & DST buffer have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04006504 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00186" : "VUID-vkCmdCopyImageToBuffer-srcImage-00186";
6505 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006506 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006507 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-dstBuffer-00191" : "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191";
6508 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006509 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006510 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01831" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01831";
6511 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
6512 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01832" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01832";
6513 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
6514 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01833" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01833";
6515 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006516
6517 // Validation for VK_EXT_fragment_density_map
6518 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006519 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-02544" : "VUID-vkCmdCopyImageToBuffer-srcImage-02544";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006520 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006521 "%s: srcImage must not have been created with flags containing "
6522 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
6523 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006524 }
6525
sfricke-samsung45996a42021-09-16 13:45:27 -07006526 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006527 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-01998" : "VUID-vkCmdCopyImageToBuffer-srcImage-01998";
6528 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04006529 }
Tobin Ehlisc8266452017-04-07 12:20:30 -06006530 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04006531
sfricke-samsung45996a42021-09-16 13:45:27 -07006532 const char *src_invalid_layout_vuid =
6533 (src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
6534 ? (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-01397"
6535 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397")
6536 : (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00190"
6537 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190");
Jeff Leger178b1e52020-10-05 12:22:23 -04006538
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006539 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006540 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
6541 vuid =
6542 is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00189" : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07006543 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04006544 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, src_invalid_layout_vuid, vuid, &hit_error);
6545 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-01794" : "VUID-vkCmdCopyImageToBuffer-imageOffset-01794";
6546 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, src_image_state, &pRegions[i], i, func_name, vuid);
6547 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01703"
6548 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703";
6549 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
6550 "imageSubresource", vuid);
6551 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01704"
6552 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006553 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04006554 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006555 }
6556 return skip;
6557}
6558
Jeff Leger178b1e52020-10-05 12:22:23 -04006559bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6560 VkBuffer dstBuffer, uint32_t regionCount,
6561 const VkBufferImageCopy *pRegions) const {
6562 return ValidateCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions,
6563 COPY_COMMAND_VERSION_1);
6564}
6565
6566bool CoreChecks::PreCallValidateCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
6567 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) const {
6568 return ValidateCmdCopyImageToBuffer(commandBuffer, pCopyImageToBufferInfo->srcImage, pCopyImageToBufferInfo->srcImageLayout,
6569 pCopyImageToBufferInfo->dstBuffer, pCopyImageToBufferInfo->regionCount,
6570 pCopyImageToBufferInfo->pRegions, COPY_COMMAND_VERSION_2);
6571}
6572
John Zulauf1686f232019-07-09 16:27:11 -06006573void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6574 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
6575 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
6576
6577 auto cb_node = GetCBState(commandBuffer);
6578 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06006579 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006580 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06006581 cb_node->SetImageInitialLayout(*src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06006582 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006583}
6584
Jeff Leger178b1e52020-10-05 12:22:23 -04006585void CoreChecks::PreCallRecordCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
6586 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) {
6587 StateTracker::PreCallRecordCmdCopyImageToBuffer2KHR(commandBuffer, pCopyImageToBufferInfo);
6588
6589 auto cb_node = GetCBState(commandBuffer);
6590 auto src_image_state = GetImageState(pCopyImageToBufferInfo->srcImage);
6591 // Make sure that all image slices record referenced layout
6592 for (uint32_t i = 0; i < pCopyImageToBufferInfo->regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06006593 cb_node->SetImageInitialLayout(*src_image_state, pCopyImageToBufferInfo->pRegions[i].imageSubresource,
6594 pCopyImageToBufferInfo->srcImageLayout);
Jeff Leger178b1e52020-10-05 12:22:23 -04006595 }
6596}
6597
6598template <typename RegionType>
6599bool CoreChecks::ValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6600 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
6601 CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06006602 const auto cb_node = GetCBState(commandBuffer);
6603 const auto src_buffer_state = GetBufferState(srcBuffer);
6604 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006605
Jeff Leger178b1e52020-10-05 12:22:23 -04006606 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
6607 const char *func_name = is_2khr ? "vkCmdCopyBufferToImage2KHR()" : "vkCmdCopyBufferToImage()";
6608 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYBUFFERTOIMAGE2KHR : CMD_COPYBUFFERTOIMAGE;
6609 const char *vuid;
6610
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006611 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, dst_image_state, func_name, version, false);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006612
6613 // Validate command buffer state
Jeff Leger178b1e52020-10-05 12:22:23 -04006614 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006615
Mike Schuchardt7b152fa2021-08-03 16:30:27 -07006616 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00172" : "VUID-vkCmdCopyBufferToImage-pRegions-06217";
Jeff Leger178b1e52020-10-05 12:22:23 -04006617 skip |= ValidateImageBounds(dst_image_state, regionCount, pRegions, func_name, vuid);
6618 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00171" : "VUID-vkCmdCopyBufferToImage-pRegions-00171";
6619 skip |= ValidateBufferBounds(dst_image_state, src_buffer_state, regionCount, pRegions, func_name, vuid);
6620
6621 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00179" : "VUID-vkCmdCopyBufferToImage-dstImage-00179";
6622 const char *location = is_2khr ? "vkCmdCopyBufferToImage2KHR(): dstImage" : "vkCmdCopyBufferToImage(): dstImage";
6623 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
6624 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00176" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00176";
6625 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, func_name, vuid);
6626 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00178" : "VUID-vkCmdCopyBufferToImage-dstImage-00178";
6627 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
6628 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00174" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00174";
6629 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006630 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006631 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00177" : "VUID-vkCmdCopyBufferToImage-dstImage-00177";
6632 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006633 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006634 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01828" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01828";
6635 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, func_name, vuid);
6636 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01829" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01829";
6637 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
6638 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage-commandBuffer-01830" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01830";
6639 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006640
6641 // Validation for VK_EXT_fragment_density_map
6642 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006643 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-02543" : "VUID-vkCmdCopyBufferToImage-dstImage-02543";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006644 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006645 "%s: dstImage must not have been created with flags containing "
6646 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
6647 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006648 }
6649
sfricke-samsung45996a42021-09-16 13:45:27 -07006650 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006651 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-01997" : "VUID-vkCmdCopyBufferToImage-dstImage-01997";
6652 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04006653 }
Tobin Ehlisc8266452017-04-07 12:20:30 -06006654 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04006655
sfricke-samsung45996a42021-09-16 13:45:27 -07006656 const char *dst_invalid_layout_vuid =
6657 (dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
6658 ? (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-01396"
6659 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396")
6660 : (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00181"
6661 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181");
Jeff Leger178b1e52020-10-05 12:22:23 -04006662
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006663 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006664 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
6665 vuid =
6666 is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00180" : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07006667 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04006668 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, dst_invalid_layout_vuid, vuid, &hit_error);
6669 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-01793" : "VUID-vkCmdCopyBufferToImage-imageOffset-01793";
6670 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, dst_image_state, &pRegions[i], i, func_name, vuid);
6671 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01701"
6672 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01701";
6673 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
6674 "imageSubresource", vuid);
6675 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01702"
6676 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01702";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006677 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04006678 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
sfricke-samsungea4fd142020-10-17 23:51:59 -07006679
6680 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
6681 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool.get();
6682 assert(command_pool != nullptr);
6683 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
6684 const VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[queue_family_index].queueFlags;
6685 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
6686 if (((queue_flags & VK_QUEUE_GRAPHICS_BIT) == 0) &&
6687 ((region_aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006688 LogObjectList objlist(cb_node->commandBuffer());
6689 objlist.add(command_pool->commandPool());
sfricke-samsungea4fd142020-10-17 23:51:59 -07006690 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-commandBuffer-04477"
6691 : "VUID-vkCmdCopyBufferToImage-commandBuffer-04477";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006692 skip |= LogError(dst_image_state->image(), vuid,
sfricke-samsungea4fd142020-10-17 23:51:59 -07006693 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies VK_IMAGE_ASPECT_DEPTH_BIT or "
6694 "VK_IMAGE_ASPECT_STENCIL_BIT but the command buffer %s was allocated from the command pool %s "
6695 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT flag.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006696 func_name, i, region_aspect_mask, report_data->FormatHandle(cb_node->commandBuffer()).c_str(),
6697 report_data->FormatHandle(command_pool->commandPool()).c_str(), queue_family_index);
sfricke-samsungea4fd142020-10-17 23:51:59 -07006698 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006699 }
6700 return skip;
6701}
6702
Jeff Leger178b1e52020-10-05 12:22:23 -04006703bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6704 VkImageLayout dstImageLayout, uint32_t regionCount,
6705 const VkBufferImageCopy *pRegions) const {
6706 return ValidateCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions,
6707 COPY_COMMAND_VERSION_1);
6708}
6709
6710bool CoreChecks::PreCallValidateCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
6711 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo) const {
6712 return ValidateCmdCopyBufferToImage(commandBuffer, pCopyBufferToImageInfo->srcBuffer, pCopyBufferToImageInfo->dstImage,
6713 pCopyBufferToImageInfo->dstImageLayout, pCopyBufferToImageInfo->regionCount,
6714 pCopyBufferToImageInfo->pRegions, COPY_COMMAND_VERSION_2);
6715}
6716
John Zulauf1686f232019-07-09 16:27:11 -06006717void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6718 VkImageLayout dstImageLayout, uint32_t regionCount,
6719 const VkBufferImageCopy *pRegions) {
6720 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
6721
6722 auto cb_node = GetCBState(commandBuffer);
6723 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06006724 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006725 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06006726 cb_node->SetImageInitialLayout(*dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06006727 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006728}
Mike Weiblen672b58b2017-02-21 14:32:53 -07006729
Jeff Leger178b1e52020-10-05 12:22:23 -04006730void CoreChecks::PreCallRecordCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
6731 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo2KHR) {
6732 StateTracker::PreCallRecordCmdCopyBufferToImage2KHR(commandBuffer, pCopyBufferToImageInfo2KHR);
6733
6734 auto cb_node = GetCBState(commandBuffer);
6735 auto dst_image_state = GetImageState(pCopyBufferToImageInfo2KHR->dstImage);
6736 // Make sure that all image slices are record referenced layout
6737 for (uint32_t i = 0; i < pCopyBufferToImageInfo2KHR->regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06006738 cb_node->SetImageInitialLayout(*dst_image_state, pCopyBufferToImageInfo2KHR->pRegions[i].imageSubresource,
6739 pCopyBufferToImageInfo2KHR->dstImageLayout);
Jeff Leger178b1e52020-10-05 12:22:23 -04006740 }
6741}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006742bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006743 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07006744 bool skip = false;
6745 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
6746
Dave Houlton1d960ff2018-01-19 12:17:05 -07006747 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07006748 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
6749 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
6750 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006751 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
6752 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006753 }
6754
John Zulaufa26d3c82019-08-14 16:09:08 -06006755 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006756 if (!image_entry) {
6757 return skip;
6758 }
6759
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006760 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
sfricke-samsung45996a42021-09-16 13:45:27 -07006761 if (IsExtEnabled(device_extensions.vk_ext_image_drm_format_modifier)) {
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006762 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
6763 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006764 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
6765 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
6766 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006767 }
6768 } else {
6769 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006770 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
6771 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006772 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07006773 }
6774
Dave Houlton1d960ff2018-01-19 12:17:05 -07006775 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07006776 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006777 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
6778 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
6779 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006780 }
6781
Dave Houlton1d960ff2018-01-19 12:17:05 -07006782 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07006783 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006784 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
6785 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
6786 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006787 }
6788
Dave Houlton1d960ff2018-01-19 12:17:05 -07006789 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07006790 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006791 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
6792 if (FormatIsMultiplane(img_format)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08006793 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006794 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
6795 if (FormatPlaneCount(img_format) > 2u) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08006796 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006797 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
6798 }
6799 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006800 skip |= LogError(image, vuid,
6801 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
6802 ") must be a single-plane specifier flag.",
6803 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006804 }
6805 } else if (FormatIsColor(img_format)) {
6806 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
ziga-lunargcc568bc2021-09-05 13:45:45 +02006807 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04461",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006808 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
6809 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006810 }
6811 } else if (FormatIsDepthOrStencil(img_format)) {
Nathaniel Cesario8c80f352021-07-15 15:06:48 -06006812 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006813 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07006814 }
ziga-lunarg4ecbd5b2021-07-15 20:48:30 +02006815 if (!FormatIsDepthAndStencil(img_format) && !FormatIsDepthOnly(img_format)) {
6816 if (sub_aspect & VK_IMAGE_ASPECT_DEPTH_BIT) {
6817 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04464",
6818 "vkGetImageSubresourceLayout(): Image format (%s) does not contain a depth component, "
6819 "but VkImageSubresource.aspectMask contains VK_IMAGE_ASPECT_DEPTH_BIT.",
6820 string_VkFormat(img_format));
6821 }
6822 } else {
6823 if ((sub_aspect & VK_IMAGE_ASPECT_DEPTH_BIT) == 0) {
6824 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04462",
6825 "vkGetImageSubresourceLayout(): Image format (%s) contains a depth component, "
6826 "but VkImageSubresource.aspectMask does not contain VK_IMAGE_ASPECT_DEPTH_BIT.",
6827 string_VkFormat(img_format));
6828 }
6829 }
6830 if (!FormatIsDepthAndStencil(img_format) && !FormatIsStencilOnly(img_format)) {
6831 if (sub_aspect & VK_IMAGE_ASPECT_STENCIL_BIT) {
6832 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04464",
6833 "vkGetImageSubresourceLayout(): Image format (%s) does not contain a stencil component, "
6834 "but VkImageSubresource.aspectMask contains VK_IMAGE_ASPECT_STENCIL_BIT.",
6835 string_VkFormat(img_format));
6836 }
6837 } else {
6838 if ((sub_aspect & VK_IMAGE_ASPECT_STENCIL_BIT) == 0) {
6839 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04463",
6840 "vkGetImageSubresourceLayout(): Image format (%s) contains a stencil component, "
6841 "but VkImageSubresource.aspectMask does not contain VK_IMAGE_ASPECT_STENCIL_BIT.",
6842 string_VkFormat(img_format));
6843 }
6844 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006845 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
6846 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
6847 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
6848 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006849 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
6850 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
6851 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006852 }
6853 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006854
sfricke-samsung45996a42021-09-16 13:45:27 -07006855 if (IsExtEnabled(device_extensions.vk_android_external_memory_android_hardware_buffer)) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07006856 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006857 }
6858
Mike Weiblen672b58b2017-02-21 14:32:53 -07006859 return skip;
6860}
sfricke-samsung022fa252020-07-24 03:26:16 -07006861
6862// Validates the image is allowed to be protected
6863bool CoreChecks::ValidateProtectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006864 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006865 bool skip = false;
6866 if ((cb_state->unprotected == true) && (image_state->unprotected == false)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006867 LogObjectList objlist(cb_state->commandBuffer());
6868 objlist.add(image_state->image());
locke-lunarg351c9d82020-10-23 14:43:21 -06006869 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 -06006870 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
6871 report_data->FormatHandle(image_state->image()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006872 }
6873 return skip;
6874}
6875
6876// Validates the image is allowed to be unprotected
6877bool CoreChecks::ValidateUnprotectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006878 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006879 bool skip = false;
6880 if ((cb_state->unprotected == false) && (image_state->unprotected == true)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006881 LogObjectList objlist(cb_state->commandBuffer());
6882 objlist.add(image_state->image());
locke-lunarg351c9d82020-10-23 14:43:21 -06006883 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 -06006884 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
6885 report_data->FormatHandle(image_state->image()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006886 }
6887 return skip;
6888}
6889
6890// Validates the buffer is allowed to be protected
6891bool CoreChecks::ValidateProtectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006892 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006893 bool skip = false;
6894 if ((cb_state->unprotected == true) && (buffer_state->unprotected == false)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006895 LogObjectList objlist(cb_state->commandBuffer());
6896 objlist.add(buffer_state->buffer());
locke-lunarg351c9d82020-10-23 14:43:21 -06006897 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 -06006898 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
6899 report_data->FormatHandle(buffer_state->buffer()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006900 }
6901 return skip;
6902}
6903
6904// Validates the buffer is allowed to be unprotected
6905bool CoreChecks::ValidateUnprotectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006906 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006907 bool skip = false;
6908 if ((cb_state->unprotected == false) && (buffer_state->unprotected == true)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006909 LogObjectList objlist(cb_state->commandBuffer());
6910 objlist.add(buffer_state->buffer());
locke-lunarg351c9d82020-10-23 14:43:21 -06006911 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 -06006912 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
6913 report_data->FormatHandle(buffer_state->buffer()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006914 }
6915 return skip;
6916}