blob: 0d56b2dd601b3ac4252fa5b90ae9ec14aca7e9e8 [file] [log] [blame]
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001/* Copyright (c) 2015-2021 The Khronos Group Inc.
2 * Copyright (c) 2015-2021 Valve Corporation
3 * Copyright (c) 2015-2021 LunarG, Inc.
4 * Copyright (C) 2015-2021 Google Inc.
Tony-LunarG5a066372021-01-21 10:31:34 -07005 * Modifications Copyright (C) 2020-2021 Advanced Micro Devices, Inc. All rights reserved.
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -07006 *
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 *
19 * Author: Mark Lobodzinski <mark@lunarg.com>
Dave Houlton4eaaf3a2017-03-14 11:31:20 -060020 * Author: Dave Houlton <daveh@lunarg.com>
Shannon McPherson3ea65132018-12-05 10:37:39 -070021 * Shannon McPherson <shannon@lunarg.com>
Tobias Hector6663c9b2020-11-05 10:18:02 +000022 * Author: Tobias Hector <tobias.hector@amd.com>
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070023 */
24
Dave Houlton0d4ad6f2018-09-05 14:53:34 -060025#include <cmath>
26#include <set>
Mark Lobodzinski90224de2017-01-26 15:23:11 -070027#include <sstream>
Petr Kraus4d718682017-05-18 03:38:41 +020028#include <string>
Jeremy Gebben579aaca2021-02-15 13:36:18 -070029#include <iostream>
Mark Lobodzinski90224de2017-01-26 15:23:11 -070030
31#include "vk_enum_string_helper.h"
Petr Kraus5a01b472019-08-10 01:40:28 +020032#include "vk_format_utils.h"
Mark Lobodzinski90224de2017-01-26 15:23:11 -070033#include "vk_layer_data.h"
34#include "vk_layer_utils.h"
35#include "vk_layer_logging.h"
Dave Houltonbd2e2622018-04-10 16:41:14 -060036#include "vk_typemap_helper.h"
Mark Lobodzinski90224de2017-01-26 15:23:11 -070037
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -070038#include "chassis.h"
Mark Lobodzinski76d76662019-02-14 14:38:21 -070039#include "core_validation.h"
Jeremy Gebbene60d4172021-02-02 15:42:15 -070040#include "core_error_location.h"
Mark Lobodzinski76d76662019-02-14 14:38:21 -070041#include "shader_validation.h"
42#include "descriptor_sets.h"
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070043#include "buffer_validation.h"
Jeremy Gebben7ba56152021-06-18 10:40:10 -060044#include "sync_utils.h"
Jeremy Gebbene60d4172021-02-02 15:42:15 -070045#include "sync_vuid_maps.h"
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -070046
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070047// All VUID from copy_bufferimage_to_imagebuffer_common.txt
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070048static const char *GetBufferImageCopyCommandVUID(std::string id, bool image_to_buffer, bool copy2) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070049 // clang-format off
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070050 static const std::map<std::string, std::array<const char *, 4>> copy_imagebuffer_vuid = {
51 {"00193", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070052 "VUID-vkCmdCopyBufferToImage-bufferOffset-00193", // !copy2 & !image_to_buffer
53 "VUID-vkCmdCopyImageToBuffer-bufferOffset-00193", // !copy2 & image_to_buffer
54 "VUID-VkCopyBufferToImageInfo2KHR-bufferOffset-00193", // copy2 & !image_to_buffer
55 "VUID-VkCopyImageToBufferInfo2KHR-bufferOffset-00193", // copy2 & image_to_buffer
56 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070057 {"01558", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070058 "VUID-vkCmdCopyBufferToImage-bufferOffset-01558",
59 "VUID-vkCmdCopyImageToBuffer-bufferOffset-01558",
60 "VUID-VkCopyBufferToImageInfo2KHR-bufferOffset-01558",
61 "VUID-VkCopyImageToBufferInfo2KHR-bufferOffset-01558",
62 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070063 {"01559", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070064 "VUID-vkCmdCopyBufferToImage-bufferOffset-01559",
65 "VUID-vkCmdCopyImageToBuffer-bufferOffset-01559",
66 "VUID-VkCopyBufferToImageInfo2KHR-bufferOffset-01559",
67 "VUID-VkCopyImageToBufferInfo2KHR-bufferOffset-01559",
68 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070069 {"00197", {
Mike Schuchardt7b152fa2021-08-03 16:30:27 -070070 "VUID-vkCmdCopyBufferToImage-pRegions-06218",
71 "VUID-vkCmdCopyImageToBuffer-pRegions-06221",
72 "VUID-VkCopyBufferToImageInfo2KHR-pRegions-06223",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070073 "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-00197",
74 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070075 {"00198", {
Mike Schuchardt7b152fa2021-08-03 16:30:27 -070076 "VUID-vkCmdCopyBufferToImage-pRegions-06219",
77 "VUID-vkCmdCopyImageToBuffer-pRegions-06222",
78 "VUID-VkCopyBufferToImageInfo2KHR-pRegions-06224",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070079 "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-00198",
80 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070081 {"00199", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070082 "VUID-vkCmdCopyBufferToImage-srcImage-00199",
83 "VUID-vkCmdCopyImageToBuffer-srcImage-00199",
84 "VUID-VkCopyBufferToImageInfo2KHR-srcImage-00199",
85 "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00199",
86 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070087 {"00200", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070088 "VUID-vkCmdCopyBufferToImage-imageOffset-00200",
89 "VUID-vkCmdCopyImageToBuffer-imageOffset-00200",
90 "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-00200",
91 "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-00200",
92 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070093 {"00201", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070094 "VUID-vkCmdCopyBufferToImage-srcImage-00201",
95 "VUID-vkCmdCopyImageToBuffer-srcImage-00201",
96 "VUID-VkCopyBufferToImageInfo2KHR-srcImage-00201",
97 "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00201",
98 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070099 {"00203", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700100 "VUID-vkCmdCopyBufferToImage-bufferRowLength-00203",
101 "VUID-vkCmdCopyImageToBuffer-bufferRowLength-00203",
102 "VUID-VkCopyBufferToImageInfo2KHR-bufferRowLength-00203",
103 "VUID-VkCopyImageToBufferInfo2KHR-bufferRowLength-00203",
104 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700105 {"00204", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700106 "VUID-vkCmdCopyBufferToImage-bufferImageHeight-00204",
107 "VUID-vkCmdCopyImageToBuffer-bufferImageHeight-00204",
108 "VUID-VkCopyBufferToImageInfo2KHR-bufferImageHeight-00204",
109 "VUID-VkCopyImageToBufferInfo2KHR-bufferImageHeight-00204",
110 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700111 {"00205", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700112 "VUID-vkCmdCopyBufferToImage-imageOffset-00205",
113 "VUID-vkCmdCopyImageToBuffer-imageOffset-00205",
114 "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-00205",
115 "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-00205",
116 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700117 {"00206", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700118 "VUID-vkCmdCopyBufferToImage-bufferOffset-00206",
119 "VUID-vkCmdCopyImageToBuffer-bufferOffset-00206",
120 "VUID-VkCopyBufferToImageInfo2KHR-bufferOffset-00206",
121 "VUID-VkCopyImageToBufferInfo2KHR-bufferOffset-00206",
122 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700123 {"00207", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700124 "VUID-vkCmdCopyBufferToImage-imageExtent-00207",
125 "VUID-vkCmdCopyImageToBuffer-imageExtent-00207",
126 "VUID-VkCopyBufferToImageInfo2KHR-imageExtent-00207",
127 "VUID-VkCopyImageToBufferInfo2KHR-imageExtent-00207",
128 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700129 {"00208", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700130 "VUID-vkCmdCopyBufferToImage-imageExtent-00208",
131 "VUID-vkCmdCopyImageToBuffer-imageExtent-00208",
132 "VUID-VkCopyBufferToImageInfo2KHR-imageExtent-00208",
133 "VUID-VkCopyImageToBufferInfo2KHR-imageExtent-00208",
134 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700135 {"00209", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700136 "VUID-vkCmdCopyBufferToImage-imageExtent-00209",
137 "VUID-vkCmdCopyImageToBuffer-imageExtent-00209",
138 "VUID-VkCopyBufferToImageInfo2KHR-imageExtent-00209",
139 "VUID-VkCopyImageToBufferInfo2KHR-imageExtent-00209",
140 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700141 {"00211", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700142 "VUID-vkCmdCopyBufferToImage-aspectMask-00211",
143 "VUID-vkCmdCopyImageToBuffer-aspectMask-00211",
144 "VUID-VkCopyBufferToImageInfo2KHR-aspectMask-00211",
145 "VUID-VkCopyImageToBufferInfo2KHR-aspectMask-00211",
146 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700147 {"01560", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700148 "VUID-vkCmdCopyBufferToImage-aspectMask-01560",
149 "VUID-vkCmdCopyImageToBuffer-aspectMask-01560",
150 "VUID-VkCopyBufferToImageInfo2KHR-aspectMask-01560",
151 "VUID-VkCopyImageToBufferInfo2KHR-aspectMask-01560",
152 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700153 {"00213", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700154 "VUID-vkCmdCopyBufferToImage-baseArrayLayer-00213",
155 "VUID-vkCmdCopyImageToBuffer-baseArrayLayer-00213",
156 "VUID-VkCopyBufferToImageInfo2KHR-baseArrayLayer-00213",
157 "VUID-VkCopyImageToBufferInfo2KHR-baseArrayLayer-00213",
sfricke-samsung8feecc12021-01-23 03:28:38 -0800158 }},
159 {"04052", {
160 "VUID-vkCmdCopyBufferToImage-commandBuffer-04052",
161 "VUID-vkCmdCopyImageToBuffer-commandBuffer-04052",
162 "VUID-VkCopyBufferToImageInfo2KHR-commandBuffer-04052",
163 "VUID-VkCopyImageToBufferInfo2KHR-commandBuffer-04052",
164 }},
165 {"04053", {
166 "VUID-vkCmdCopyBufferToImage-srcImage-04053",
167 "VUID-vkCmdCopyImageToBuffer-srcImage-04053",
168 "VUID-VkCopyBufferToImageInfo2KHR-srcImage-04053",
169 "VUID-VkCopyImageToBufferInfo2KHR-srcImage-04053",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700170 }}
171 };
172 // clang-format on
173
174 uint8_t index = 0;
Artem Bolgar82d08362021-06-03 13:11:13 -0700175 index |= uint8_t((image_to_buffer) ? 0x1 : 0);
176 index |= uint8_t((copy2) ? 0x2 : 0);
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700177 return copy_imagebuffer_vuid.at(id).at(index);
178}
179
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700180static VkImageLayout NormalizeDepthImageLayout(VkImageLayout layout) {
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200181 switch (layout) {
182 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
183 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
184 return VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL;
185
186 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
187 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
188 return VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL;
189
190 default:
191 return layout;
192 }
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700193}
194
195static VkImageLayout NormalizeStencilImageLayout(VkImageLayout layout) {
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200196 switch (layout) {
197 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
198 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
199 return VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL;
200
201 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
202 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
203 return VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL;
204
205 default:
206 return layout;
207 }
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700208}
209
Jeremy Gebben579aaca2021-02-15 13:36:18 -0700210static VkImageLayout NormalizeSynchronization2Layout(const VkImageAspectFlags aspect_mask, VkImageLayout layout) {
211 if (layout == VK_IMAGE_LAYOUT_ATTACHMENT_OPTIMAL_KHR) {
212 if (aspect_mask == VK_IMAGE_ASPECT_COLOR_BIT) {
213 layout = VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL;
214 } else if (aspect_mask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
215 layout = VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL;
216 } else if (aspect_mask == VK_IMAGE_ASPECT_DEPTH_BIT) {
217 layout = VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL;
218 } else if (aspect_mask == VK_IMAGE_ASPECT_STENCIL_BIT) {
219 layout = VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL;
220 }
221 } else if (layout == VK_IMAGE_LAYOUT_READ_ONLY_OPTIMAL_KHR) {
222 if (aspect_mask == VK_IMAGE_ASPECT_COLOR_BIT) {
223 layout = VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL;
224 } else if (aspect_mask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
225 layout = VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL;
226 } else if (aspect_mask == VK_IMAGE_ASPECT_DEPTH_BIT) {
227 layout = VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL;
228 } else if (aspect_mask == VK_IMAGE_ASPECT_STENCIL_BIT) {
229 layout = VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL;
230 }
231 }
232 return layout;
233}
234
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700235static bool ImageLayoutMatches(const VkImageAspectFlags aspect_mask, VkImageLayout a, VkImageLayout b) {
236 bool matches = (a == b);
237 if (!matches) {
John Zulaufbea70432021-02-23 07:03:12 -0700238 a = NormalizeSynchronization2Layout(aspect_mask, a);
239 b = NormalizeSynchronization2Layout(aspect_mask, b);
240 matches = (a == b);
241 if (!matches) {
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200242 // Relaxed rules when referencing *only* the depth or stencil aspects.
243 // When accessing both, normalize layouts for aspects separately.
244 if (aspect_mask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
245 matches = NormalizeDepthImageLayout(a) == NormalizeDepthImageLayout(b) &&
246 NormalizeStencilImageLayout(a) == NormalizeStencilImageLayout(b);
247 } else if (aspect_mask == VK_IMAGE_ASPECT_DEPTH_BIT) {
John Zulaufbea70432021-02-23 07:03:12 -0700248 matches = NormalizeDepthImageLayout(a) == NormalizeDepthImageLayout(b);
249 } else if (aspect_mask == VK_IMAGE_ASPECT_STENCIL_BIT) {
250 matches = NormalizeStencilImageLayout(a) == NormalizeStencilImageLayout(b);
251 }
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700252 }
253 }
254 return matches;
255}
256
257// Utility type for ForRange callbacks
258struct LayoutUseCheckAndMessage {
259 const static VkImageAspectFlags kDepthOrStencil = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
260 const ImageSubresourceLayoutMap *layout_map;
261 const VkImageAspectFlags aspect_mask;
262 const char *message;
263 VkImageLayout layout;
264
265 LayoutUseCheckAndMessage() = delete;
266 LayoutUseCheckAndMessage(const ImageSubresourceLayoutMap *layout_map_, const VkImageAspectFlags aspect_mask_ = 0)
267 : layout_map(layout_map_), aspect_mask{aspect_mask_}, message(nullptr), layout(kInvalidLayout) {}
268 bool Check(const VkImageSubresource &subres, VkImageLayout check, VkImageLayout current_layout, VkImageLayout initial_layout) {
269 message = nullptr;
270 layout = kInvalidLayout; // Success status
271 if (current_layout != kInvalidLayout && !ImageLayoutMatches(aspect_mask, check, current_layout)) {
272 message = "previous known";
273 layout = current_layout;
274 } else if ((initial_layout != kInvalidLayout) && !ImageLayoutMatches(aspect_mask, check, initial_layout)) {
275 // To check the relaxed rule matching we need to see how the initial use was used
276 const auto initial_layout_state = layout_map->GetSubresourceInitialLayoutState(subres);
277 assert(initial_layout_state); // If we have an initial layout, we better have a state for it
278 if (!((initial_layout_state->aspect_mask & kDepthOrStencil) &&
279 ImageLayoutMatches(initial_layout_state->aspect_mask, check, initial_layout))) {
280 message = "previously used";
281 layout = initial_layout;
282 }
283 }
284 return layout == kInvalidLayout;
285 }
286};
287
locke-lunarg540b2252020-08-03 13:23:36 -0600288bool IMAGE_VIEW_STATE::OverlapSubresource(const IMAGE_VIEW_STATE &compare_view) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600289 if (image_view() == compare_view.image_view()) {
locke-lunarg540b2252020-08-03 13:23:36 -0600290 return true;
291 }
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600292 if (image_state->image() != compare_view.image_state->image()) {
locke-lunargdc287022020-08-21 12:03:57 -0600293 return false;
294 }
locke-lunarg540b2252020-08-03 13:23:36 -0600295 if (normalized_subresource_range.aspectMask != compare_view.normalized_subresource_range.aspectMask) {
296 return false;
297 }
298
299 // compare if overlap mip level
locke-lunarg540b2252020-08-03 13:23:36 -0600300 if ((normalized_subresource_range.baseMipLevel < compare_view.normalized_subresource_range.baseMipLevel) &&
locke-lunargdc287022020-08-21 12:03:57 -0600301 ((normalized_subresource_range.baseMipLevel + normalized_subresource_range.levelCount) <=
locke-lunarg540b2252020-08-03 13:23:36 -0600302 compare_view.normalized_subresource_range.baseMipLevel)) {
locke-lunargdc287022020-08-21 12:03:57 -0600303 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600304 }
305
306 if ((normalized_subresource_range.baseMipLevel > compare_view.normalized_subresource_range.baseMipLevel) &&
locke-lunargdc287022020-08-21 12:03:57 -0600307 (normalized_subresource_range.baseMipLevel >=
locke-lunarg540b2252020-08-03 13:23:36 -0600308 (compare_view.normalized_subresource_range.baseMipLevel + compare_view.normalized_subresource_range.levelCount))) {
locke-lunargdc287022020-08-21 12:03:57 -0600309 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600310 }
311
312 // compare if overlap array layer
locke-lunarg540b2252020-08-03 13:23:36 -0600313 if ((normalized_subresource_range.baseArrayLayer < compare_view.normalized_subresource_range.baseArrayLayer) &&
locke-lunargdc287022020-08-21 12:03:57 -0600314 ((normalized_subresource_range.baseArrayLayer + normalized_subresource_range.layerCount) <=
locke-lunarg540b2252020-08-03 13:23:36 -0600315 compare_view.normalized_subresource_range.baseArrayLayer)) {
locke-lunargdc287022020-08-21 12:03:57 -0600316 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600317 }
318
319 if ((normalized_subresource_range.baseArrayLayer > compare_view.normalized_subresource_range.baseArrayLayer) &&
locke-lunargdc287022020-08-21 12:03:57 -0600320 (normalized_subresource_range.baseArrayLayer >=
locke-lunarg540b2252020-08-03 13:23:36 -0600321 (compare_view.normalized_subresource_range.baseArrayLayer + compare_view.normalized_subresource_range.layerCount))) {
locke-lunargdc287022020-08-21 12:03:57 -0600322 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600323 }
locke-lunargdc287022020-08-21 12:03:57 -0600324 return true;
locke-lunarg540b2252020-08-03 13:23:36 -0600325}
326
Dave Houltond9611312018-11-19 17:03:36 -0700327uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
328 // uint cast applies floor()
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700329 return 1u + static_cast<uint32_t>(log2(std::max({height, width, depth})));
Dave Houltond9611312018-11-19 17:03:36 -0700330}
331
332uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
333
334uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
335
John Zulauf2d60a452021-03-04 15:12:03 -0700336bool CoreChecks::FindLayouts(const IMAGE_STATE &image_state, std::vector<VkImageLayout> &layouts) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600337 const auto *layout_range_map = GetLayoutRangeMap(imageLayoutMap, image_state.image());
John Zulauf2076e812020-01-08 14:55:54 -0700338 if (!layout_range_map) return false;
locke-lunargf155ccf2020-02-18 11:34:15 -0700339 // TODO: FindLayouts function should mutate into a ValidatePresentableLayout with the loop wrapping the LogError
340 // from the caller. You can then use decode to add the subresource of the range::begin to the error message.
341
John Zulauf2076e812020-01-08 14:55:54 -0700342 // TODO: what is this test and what is it supposed to do?! -- the logic doesn't match the comment below?!
343
344 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
John Zulauf2d60a452021-03-04 15:12:03 -0700345 if (layout_range_map->size() >= (image_state.createInfo.arrayLayers * image_state.createInfo.mipLevels + 1)) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700346 return false;
347 }
locke-lunargcba7d5f2019-12-30 16:59:11 -0700348
John Zulauf79f06582021-02-27 18:38:39 -0700349 for (const auto &entry : *layout_range_map) {
John Zulauf2076e812020-01-08 14:55:54 -0700350 layouts.push_back(entry.second);
Tony Barbourdf013b92017-01-25 12:53:48 -0700351 }
352 return true;
353}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700354
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700355bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
356 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700357 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600358 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100359 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700360 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100361 const char *vuid;
362 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700363 const char *function_name = use_rp2 ? "vkCmdBeginRenderPass2()" : "vkCmdBeginRenderPass()";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100364
365 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600366 LogObjectList objlist(image);
367 objlist.add(renderpass);
368 objlist.add(framebuffer);
369 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700370 skip |=
371 LogError(image, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
372 "%s: RenderPass %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
373 function_name, report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
374 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100375 return skip;
376 }
377
378 auto image_usage = image_state->createInfo.usage;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700379 const auto stencil_usage_info = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Ricardo Garcia3f5984c2020-04-09 10:56:34 +0200380 if (stencil_usage_info) {
381 image_usage |= stencil_usage_info->stencilUsage;
382 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100383
384 // Check for layouts that mismatch image usages in the framebuffer
385 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800386 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600387 LogObjectList objlist(image);
388 objlist.add(renderpass);
389 objlist.add(framebuffer);
390 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700391 skip |= LogError(objlist, vuid,
392 "%s: Layout/usage mismatch for attachment %u in %s"
393 " - the %s is %s but the image attached to %s via %s"
394 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
395 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
396 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
397 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100398 }
399
400 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
401 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800402 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600403 LogObjectList objlist(image);
404 objlist.add(renderpass);
405 objlist.add(framebuffer);
406 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700407 skip |= LogError(objlist, vuid,
408 "%s: Layout/usage mismatch for attachment %u in %s"
409 " - the %s is %s but the image attached to %s via %s"
410 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
411 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
412 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
413 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100414 }
415
416 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800417 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600418 LogObjectList objlist(image);
419 objlist.add(renderpass);
420 objlist.add(framebuffer);
421 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700422 skip |= LogError(objlist, vuid,
423 "%s: Layout/usage mismatch for attachment %u in %s"
424 " - the %s is %s but the image attached to %s via %s"
425 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
426 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
427 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
428 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100429 }
430
431 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800432 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600433 LogObjectList objlist(image);
434 objlist.add(renderpass);
435 objlist.add(framebuffer);
436 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700437 skip |= LogError(objlist, vuid,
438 "%s: Layout/usage mismatch for attachment %u in %s"
439 " - the %s is %s but the image attached to %s via %s"
440 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
441 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
442 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
443 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100444 }
445
sfricke-samsung45996a42021-09-16 13:45:27 -0700446 if (IsExtEnabled(device_extensions.vk_khr_maintenance2)) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100447 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
448 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
449 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
450 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
451 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800452 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600453 LogObjectList objlist(image);
454 objlist.add(renderpass);
455 objlist.add(framebuffer);
456 objlist.add(image_view);
457 skip |= LogError(objlist, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700458 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700459 " - the %s is %s but the image attached to %s via %s"
460 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700461 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700462 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
463 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100464 }
465 } else {
466 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
467 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
468 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
469 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600470 LogObjectList objlist(image);
471 objlist.add(renderpass);
472 objlist.add(framebuffer);
473 objlist.add(image_view);
474 skip |= LogError(objlist, "VUID-vkCmdBeginRenderPass-initialLayout-00896",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700475 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700476 " - the %s is %s but the image attached to %s via %s"
477 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700478 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700479 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
480 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100481 }
482 }
483 return skip;
484}
485
John Zulauf17a01bb2019-08-09 16:41:19 -0600486bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700487 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600488 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600489 bool skip = false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700490 auto const render_pass_info = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
491 auto const &framebuffer_info = framebuffer_state->createInfo;
492 const VkImageView *attachments = framebuffer_info.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100493
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600494 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass();
495 auto framebuffer = framebuffer_state->framebuffer();
Tobias Hectorbbb12282018-10-22 15:17:59 +0100496
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700497 if (render_pass_info->attachmentCount != framebuffer_info.attachmentCount) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600498 skip |= LogError(pCB->commandBuffer(), kVUID_Core_DrawState_InvalidRenderpass,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700499 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700500 }
John Zulauf8e308292018-09-21 11:34:37 -0600501
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700502 const auto *attachment_info = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext);
Mike Schuchardt2df08912020-12-15 16:28:09 -0800503 if (((framebuffer_info.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) != 0) && attachment_info != nullptr) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700504 attachments = attachment_info->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100505 }
506
Tobias Hectorc9057422019-07-23 12:15:52 +0100507 if (attachments != nullptr) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700508 const auto *const_p_cb = static_cast<const CMD_BUFFER_STATE *>(pCB);
509 for (uint32_t i = 0; i < render_pass_info->attachmentCount; ++i) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100510 auto image_view = attachments[i];
511 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100512
Tobias Hectorc9057422019-07-23 12:15:52 +0100513 if (!view_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600514 LogObjectList objlist(pRenderPassBegin->renderPass);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600515 objlist.add(framebuffer_state->framebuffer());
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600516 objlist.add(image_view);
517 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700518 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600519 report_data->FormatHandle(framebuffer_state->framebuffer()).c_str(), i,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700520 report_data->FormatHandle(image_view).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100521 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100522 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100523
524 const VkImage image = view_state->create_info.image;
525 const IMAGE_STATE *image_state = GetImageState(image);
526
527 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600528 LogObjectList objlist(pRenderPassBegin->renderPass);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600529 objlist.add(framebuffer_state->framebuffer());
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600530 objlist.add(image_view);
531 objlist.add(image);
532 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700533 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600534 report_data->FormatHandle(framebuffer_state->framebuffer()).c_str(), i,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700535 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100536 continue;
537 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700538 auto attachment_initial_layout = render_pass_info->pAttachments[i].initialLayout;
539 auto final_layout = render_pass_info->pAttachments[i].finalLayout;
Tobias Hectorc9057422019-07-23 12:15:52 +0100540
Piers Daniell7f894f62020-01-09 16:33:48 -0700541 // Default to expecting stencil in the same layout.
542 auto attachment_stencil_initial_layout = attachment_initial_layout;
543
544 // If a separate layout is specified, look for that.
545 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700546 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(render_pass_info->pAttachments[i].pNext);
Piers Daniell7f894f62020-01-09 16:33:48 -0700547 if (attachment_description_stencil_layout) {
548 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
549 }
550
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200551 const ImageSubresourceLayoutMap *subresource_map = nullptr;
552 bool has_queried_map = false;
553 bool subres_skip = false;
Tobias Hectorc9057422019-07-23 12:15:52 +0100554
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200555 for (uint32_t aspect_index = 0; aspect_index < 32; aspect_index++) {
556 VkImageAspectFlags test_aspect = 1u << aspect_index;
557 if ((view_state->normalized_subresource_range.aspectMask & test_aspect) == 0) {
558 continue;
559 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700560
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200561 // Allow for differing depth and stencil layouts
562 VkImageLayout check_layout = attachment_initial_layout;
563 if (test_aspect == VK_IMAGE_ASPECT_STENCIL_BIT) {
564 check_layout = attachment_stencil_initial_layout;
565 }
566
567 if (check_layout != VK_IMAGE_LAYOUT_UNDEFINED) { // If no layout information for image yet, will be checked at QueueSubmit time
568 if (!has_queried_map) {
569 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
570 // in common with the non-const version.)
571 // The lookup is expensive, so cache it.
572 subresource_map = const_p_cb->GetImageSubresourceLayoutMap(image);
573 has_queried_map = true;
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200574 }
John Zulauf5e617452019-11-19 14:44:16 -0700575
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200576 if (subresource_map) {
577 auto normalized_range = view_state->normalized_subresource_range;
578 normalized_range.aspectMask = test_aspect;
579 auto pos = subresource_map->Find(normalized_range);
580 LayoutUseCheckAndMessage layout_check(subresource_map, test_aspect);
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200581
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200582 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to the next "constant value" range
583 for (; !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
584 const VkImageSubresource &subres = pos->subresource;
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200585
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200586 if (!layout_check.Check(subres, check_layout, pos->current_layout, pos->initial_layout)) {
587 subres_skip |= LogError(
588 device, kVUID_Core_DrawState_InvalidRenderpass,
589 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
590 "and the %s layout of the attachment is %s. The layouts must match, or the render "
591 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
592 i, string_VkImageLayout(check_layout), layout_check.message,
593 string_VkImageLayout(layout_check.layout));
594 }
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200595 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100596 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700597 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100598 }
599
Hans-Kristian Arntzene12b4b82021-07-05 15:58:46 +0200600 skip |= subres_skip;
601
Tobias Hectorc9057422019-07-23 12:15:52 +0100602 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view,
603 framebuffer, render_pass, i, "initial layout");
604
605 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer,
606 render_pass, i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100607 }
608
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700609 for (uint32_t j = 0; j < render_pass_info->subpassCount; ++j) {
610 auto &subpass = render_pass_info->pSubpasses[j];
611 for (uint32_t k = 0; k < render_pass_info->pSubpasses[j].inputAttachmentCount; ++k) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100612 auto &attachment_ref = subpass.pInputAttachments[k];
613 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
614 auto image_view = attachments[attachment_ref.attachment];
615 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100616
Tobias Hectorc9057422019-07-23 12:15:52 +0100617 if (view_state) {
618 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700619 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
620 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100621 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100622 }
623 }
624 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100625
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700626 for (uint32_t k = 0; k < render_pass_info->pSubpasses[j].colorAttachmentCount; ++k) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100627 auto &attachment_ref = subpass.pColorAttachments[k];
628 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
629 auto image_view = attachments[attachment_ref.attachment];
630 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100631
Tobias Hectorc9057422019-07-23 12:15:52 +0100632 if (view_state) {
633 auto image = view_state->create_info.image;
634 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
635 framebuffer, render_pass, attachment_ref.attachment,
636 "color attachment layout");
637 if (subpass.pResolveAttachments) {
638 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
639 rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
640 attachment_ref.attachment, "resolve attachment layout");
641 }
642 }
643 }
644 }
645
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700646 if (render_pass_info->pSubpasses[j].pDepthStencilAttachment) {
Tobias Hectorc9057422019-07-23 12:15:52 +0100647 auto &attachment_ref = *subpass.pDepthStencilAttachment;
648 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
649 auto image_view = attachments[attachment_ref.attachment];
650 auto view_state = GetImageViewState(image_view);
651
652 if (view_state) {
653 auto image = view_state->create_info.image;
654 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
655 framebuffer, render_pass, attachment_ref.attachment,
656 "input attachment layout");
657 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100658 }
659 }
660 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700661 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600662 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700663}
664
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600665void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700666 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700667 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -0600668 IMAGE_VIEW_STATE *image_view = pCB->GetActiveAttachmentImageViewState(ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600669 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700670 VkImageLayout stencil_layout = kInvalidLayout;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700671 const auto *attachment_reference_stencil_layout = LvlFindInChain<VkAttachmentReferenceStencilLayout>(ref.pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700672 if (attachment_reference_stencil_layout) {
673 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
674 }
675
Jeremy Gebben1ec89332021-08-05 13:51:49 -0600676 pCB->SetImageViewLayout(*image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600677 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700678 }
679}
680
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600681void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
682 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700683 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700684
685 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700686 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700687 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700688 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700689 }
690 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700691 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700692 }
693 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700694 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700695 }
696 }
697}
698
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700699// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
700// 1. Transition into initialLayout state
701// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600702void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700703 FRAMEBUFFER_STATE *framebuffer_state) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700704 // First record expected initialLayout as a potential initial layout usage.
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700705 auto const rpci = render_pass_state->createInfo.ptr();
706 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -0600707 auto *view_state = cb_state->GetActiveAttachmentImageViewState(i);
John Zulauf8e308292018-09-21 11:34:37 -0600708 if (view_state) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700709 IMAGE_STATE *image_state = view_state->image_state.get();
710 const auto initial_layout = rpci->pAttachments[i].initialLayout;
Piers Daniell4fde9b72019-11-27 16:19:46 -0700711 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700712 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(rpci->pAttachments[i].pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700713 if (attachment_description_stencil_layout) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700714 const auto stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
715 VkImageSubresourceRange sub_range = view_state->normalized_subresource_range;
716 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
Jeremy Gebben1ec89332021-08-05 13:51:49 -0600717 cb_state->SetImageInitialLayout(*image_state, sub_range, initial_layout);
John Zulauf81dd1f12021-01-26 16:49:16 -0700718 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
Jeremy Gebben1ec89332021-08-05 13:51:49 -0600719 cb_state->SetImageInitialLayout(*image_state, sub_range, stencil_initial_layout);
John Zulauf81dd1f12021-01-26 16:49:16 -0700720 } else {
Jeremy Gebben1ec89332021-08-05 13:51:49 -0600721 cb_state->SetImageInitialLayout(*image_state, view_state->normalized_subresource_range, initial_layout);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700722 }
John Zulauf8e308292018-09-21 11:34:37 -0600723 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700724 }
725 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700726 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700727}
728
Dave Houlton10b39482017-03-16 13:18:15 -0600729bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600730 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600731 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600732 }
733 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600734 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600735 }
736 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600737 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600738 }
Mike Schuchardt2df08912020-12-15 16:28:09 -0800739 if (0 != (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT))) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700740 if (FormatPlaneCount(format) == 1) return false;
741 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600742 return true;
743}
744
sfricke-samsung10b35ce2021-09-29 08:50:20 -0700745// There is a table in the Vulkan spec to list all formats that implicitly require YCbCr conversion,
746// but some features/extensions can explicitly turn that restriction off
747// The implicit check is done in format utils, while feature checks are done here in CoreChecks
748bool CoreChecks::FormatRequiresYcbcrConversionExplicitly(const VkFormat format) const {
749 if (format == VK_FORMAT_R10X6G10X6B10X6A10X6_UNORM_4PACK16 &&
750 enabled_features.rgba10x6_formats_features.formatRgba10x6WithoutYCbCrSampler) {
751 return false;
752 }
753 return FormatRequiresYcbcrConversion(format);
754}
755
Mike Weiblen62d08a32017-03-07 22:18:27 -0700756// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -0700757bool CoreChecks::ValidateBarrierLayoutToImageUsage(const Location &loc, VkImage image, VkImageLayout layout,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700758 VkImageUsageFlags usage_flags) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700759 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700760 bool is_error = false;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700761 switch (layout) {
762 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700763 is_error = ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700764 break;
765 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700766 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700767 break;
768 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700769 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700770 break;
771 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700772 is_error = ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700773 break;
774 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700775 is_error = ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700776 break;
777 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700778 is_error = ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700779 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600780 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700781 is_error = ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0);
Jeff Bolz9af91c52018-09-01 21:53:57 -0500782 break;
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700783 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700784 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700785 break;
786 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700787 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700788 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700789 default:
790 // Other VkImageLayout values do not have VUs defined in this context.
791 break;
792 }
793
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700794 if (is_error) {
795 const auto &vuid = sync_vuid_maps::GetBadImageLayoutVUID(loc, layout);
796
797 skip |=
798 LogError(image, vuid, "%s Image barrier Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".",
799 loc.Message().c_str(), string_VkImageLayout(layout), report_data->FormatHandle(image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700800 }
801 return skip;
802}
803
804// Verify image barriers are compatible with the images they reference.
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700805template <typename ImageBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -0700806bool CoreChecks::ValidateBarriersToImages(const Location &outer_loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700807 uint32_t imageMemoryBarrierCount, const ImageBarrier *pImageMemoryBarriers) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700808 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700809 using sync_vuid_maps::GetImageBarrierVUID;
810 using sync_vuid_maps::ImageError;
Petr Krausad0096a2019-08-09 18:35:04 +0200811 // Scoreboard for checking for duplicate and inconsistent barriers to images
812 struct ImageBarrierScoreboardEntry {
813 uint32_t index;
814 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
815 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700816 const ImageBarrier *barrier;
Petr Krausad0096a2019-08-09 18:35:04 +0200817 };
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700818 // Necessary to resolve warning C4503 when building with Visual Studio 2015.
819 // Adding a struct wrapper is their recommend solution for the expanded type name growing too long
820 // when creating maps full of maps.
821 struct ImageBarrierScoreboardSubresMap {
Jeremy Gebbencbf22862021-03-03 12:01:22 -0700822 layer_data::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry> map;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700823 };
Jeremy Gebbencbf22862021-03-03 12:01:22 -0700824 using ImageBarrierScoreboardImageMap = layer_data::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
Petr Krausad0096a2019-08-09 18:35:04 +0200825
John Zulauf463c51e2018-05-31 13:29:20 -0600826 // Scoreboard for duplicate layout transition barriers within the list
827 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
828 ImageBarrierScoreboardImageMap layout_transitions;
829
Mike Weiblen62d08a32017-03-07 22:18:27 -0700830 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700831 auto loc = outer_loc.dot(Field::pImageMemoryBarriers, i);
Petr Krausad0096a2019-08-09 18:35:04 +0200832 const auto &img_barrier = pImageMemoryBarriers[i];
Mike Weiblen62d08a32017-03-07 22:18:27 -0700833
John Zulauf463c51e2018-05-31 13:29:20 -0600834 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
835 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
836 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +0200837 if (img_barrier.oldLayout != img_barrier.newLayout) {
838 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
839 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -0600840 if (image_it != layout_transitions.end()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700841 auto &subres_map = image_it->second.map;
Petr Krausad0096a2019-08-09 18:35:04 +0200842 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -0600843 if (subres_it != subres_map.end()) {
844 auto &entry = subres_it->second;
Jeremy Gebben579aaca2021-02-15 13:36:18 -0700845 auto entry_layout =
846 NormalizeSynchronization2Layout(entry.barrier->subresourceRange.aspectMask, entry.barrier->newLayout);
847 auto old_layout =
848 NormalizeSynchronization2Layout(img_barrier.subresourceRange.aspectMask, img_barrier.oldLayout);
849 if ((entry_layout != old_layout) && (old_layout != VK_IMAGE_LAYOUT_UNDEFINED)) {
Petr Krausad0096a2019-08-09 18:35:04 +0200850 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700851 const auto &vuid = GetImageBarrierVUID(loc, ImageError::kConflictingLayout);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700852 skip = LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600853 cb_state->commandBuffer(), vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700854 "%s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600855 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
856 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700857 loc.Message().c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
Petr Krausad0096a2019-08-09 18:35:04 +0200858 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
859 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600860 }
861 entry = new_entry;
862 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200863 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600864 }
865 } else {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700866 layout_transitions[img_barrier.image].map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600867 }
868 }
869
Petr Krausad0096a2019-08-09 18:35:04 +0200870 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600871 if (image_state) {
872 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700873 skip |=
874 ValidateBarrierLayoutToImageUsage(loc.dot(Field::oldLayout), img_barrier.image, img_barrier.oldLayout, usage_flags);
875 skip |=
876 ValidateBarrierLayoutToImageUsage(loc.dot(Field::newLayout), img_barrier.image, img_barrier.newLayout, usage_flags);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600877
878 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
879 if (image_state->layout_locked) {
880 // TODO: Add unique id for error when available
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700881 skip |= LogError(
882 img_barrier.image, 0,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700883 "%s Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600884 " from layout %s to layout %s, but image has already been presented and cannot have its layout transitioned.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700885 loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
886 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600887 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600888
John Zulaufa4472282019-08-22 14:44:34 -0600889 const VkImageCreateInfo &image_create_info = image_state->createInfo;
sfricke-samsung79b00482020-04-01 21:15:50 -0700890 const VkFormat image_format = image_create_info.format;
891 const VkImageAspectFlags aspect_mask = img_barrier.subresourceRange.aspectMask;
John Zulauff660ad62019-03-23 07:16:05 -0600892 // For a Depth/Stencil image both aspects MUST be set
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700893 auto image_loc = loc.dot(Field::image);
sfricke-samsung79b00482020-04-01 21:15:50 -0700894 if (FormatIsDepthAndStencil(image_format)) {
Piers Daniell41b8c5d2020-01-10 15:42:00 -0700895 if (enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -0600896 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700897 auto vuid = GetImageBarrierVUID(loc, ImageError::kNotDepthOrStencilAspect);
898 skip |= LogError(img_barrier.image, vuid,
899 "%s references %s of format %s that must have either the depth or stencil "
900 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
901 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
902 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600903 }
904 } else {
905 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
906 if ((aspect_mask & ds_mask) != (ds_mask)) {
sfricke-samsung45996a42021-09-16 13:45:27 -0700907 auto error = IsExtEnabled(device_extensions.vk_khr_separate_depth_stencil_layouts)
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700908 ? ImageError::kNotSeparateDepthAndStencilAspect
909 : ImageError::kNotDepthAndStencilAspect;
910 auto vuid = GetImageBarrierVUID(image_loc, error);
sfricke-samsung38d280b2020-05-16 08:02:56 -0700911 skip |= LogError(img_barrier.image, vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700912 "%s references %s of format %s that must have the depth and stencil "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700913 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700914 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700915 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600916 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700917 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700918 }
John Zulauff660ad62019-03-23 07:16:05 -0600919
Jeremy Gebben159b3cc2021-06-03 09:09:03 -0600920 const auto *subresource_map = cb_state->GetImageSubresourceLayoutMap(img_barrier.image);
Petr Krausad0096a2019-08-09 18:35:04 +0200921 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -0600922 // TODO: Set memory invalid which is in mem_tracker currently
923 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
924 // subresource.
John Zulaufcea64cb2020-06-10 17:17:27 -0600925 } else if (subresource_map && !QueueFamilyIsExternal(img_barrier.srcQueueFamilyIndex)) {
John Zulauff660ad62019-03-23 07:16:05 -0600926 bool subres_skip = false;
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200927
928 // Validate aspects in isolation.
929 // This is required when handling separate depth-stencil layouts.
930 for (uint32_t aspect_index = 0; aspect_index < 32; aspect_index++) {
931 VkImageAspectFlags test_aspect = 1u << aspect_index;
932 if ((img_barrier.subresourceRange.aspectMask & test_aspect) == 0) {
933 continue;
934 }
935
936 LayoutUseCheckAndMessage layout_check(subresource_map, test_aspect);
937 auto normalized_isr = image_state->NormalizeSubresourceRange(img_barrier.subresourceRange);
938 normalized_isr.aspectMask = test_aspect;
939
940 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to the next "constant value" range
941 for (auto pos = subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
942 const auto &value = *pos;
943 auto old_layout =
944 NormalizeSynchronization2Layout(test_aspect, img_barrier.oldLayout);
945 if (!layout_check.Check(value.subresource, old_layout, value.current_layout, value.initial_layout)) {
946 const auto &vuid = GetImageBarrierVUID(loc, ImageError::kConflictingLayout);
947 subres_skip =
948 LogError(cb_state->commandBuffer(), vuid,
949 "%s %s cannot transition the layout of aspect=%d level=%d layer=%d from %s when the "
950 "%s layout is %s.",
951 loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
952 value.subresource.aspectMask, value.subresource.mipLevel, value.subresource.arrayLayer,
953 string_VkImageLayout(img_barrier.oldLayout), layout_check.message,
954 string_VkImageLayout(layout_check.layout));
955 }
John Zulauff660ad62019-03-23 07:16:05 -0600956 }
John Zulauf5e617452019-11-19 14:44:16 -0700957 }
John Zulauff660ad62019-03-23 07:16:05 -0600958 skip |= subres_skip;
959 }
sfricke-samsung79b00482020-04-01 21:15:50 -0700960
961 // checks color format and (single-plane or non-disjoint)
962 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
963 if ((FormatIsColor(image_format) == true) &&
sfricke-samsung71bc6572020-04-29 15:49:43 -0700964 ((FormatIsMultiplane(image_format) == false) || (image_state->disjoint == false))) {
sfricke-samsung79b00482020-04-01 21:15:50 -0700965 if (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsung45996a42021-09-16 13:45:27 -0700966 auto error = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion) ? ImageError::kNotColorAspect
967 : ImageError::kNotColorAspectYcbcr;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700968 const auto &vuid = GetImageBarrierVUID(loc, error);
sfricke-samsung79b00482020-04-01 21:15:50 -0700969 skip |= LogError(img_barrier.image, vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700970 "%s references %s of format %s that must be only VK_IMAGE_ASPECT_COLOR_BIT, "
sfricke-samsung79b00482020-04-01 21:15:50 -0700971 "but its aspectMask is 0x%" PRIx32 ".",
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700972 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700973 string_VkFormat(image_format), aspect_mask);
974 }
975 }
976
977 VkImageAspectFlags valid_disjoint_mask =
978 VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT | VK_IMAGE_ASPECT_COLOR_BIT;
sfricke-samsung71bc6572020-04-29 15:49:43 -0700979 if ((FormatIsMultiplane(image_format) == true) && (image_state->disjoint == true) &&
sfricke-samsung79b00482020-04-01 21:15:50 -0700980 ((aspect_mask & valid_disjoint_mask) == 0)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700981 const auto &vuid = GetImageBarrierVUID(image_loc, ImageError::kBadMultiplanarAspect);
982 skip |= LogError(img_barrier.image, vuid,
983 "%s references %s of format %s has aspectMask (0x%" PRIx32
sfricke-samsung79b00482020-04-01 21:15:50 -0700984 ") but needs to include either an VK_IMAGE_ASPECT_PLANE_*_BIT or VK_IMAGE_ASPECT_COLOR_BIT.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700985 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700986 string_VkFormat(image_format), aspect_mask);
987 }
988
989 if ((FormatPlaneCount(image_format) == 2) && ((aspect_mask & VK_IMAGE_ASPECT_PLANE_2_BIT) != 0)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700990 const auto &vuid = GetImageBarrierVUID(image_loc, ImageError::kBadPlaneCount);
991 skip |= LogError(img_barrier.image, vuid,
992 "%s references %s of format %s has only two planes but included "
sfricke-samsung79b00482020-04-01 21:15:50 -0700993 "VK_IMAGE_ASPECT_PLANE_2_BIT in its aspectMask (0x%" PRIx32 ").",
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700994 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700995 string_VkFormat(image_format), aspect_mask);
996 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700997 }
998 }
999 return skip;
1000}
1001
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001002template <typename Barrier, typename TransferBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001003bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const Location &loc, const CMD_BUFFER_STATE *cb_state, const Barrier &barrier,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001004 const QFOTransferBarrierSets<TransferBarrier> &barrier_sets) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001005 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001006 const char *handle_name = TransferBarrier::HandleName();
John Zulauf6b4aae82018-05-09 13:03:36 -06001007 const char *transfer_type = nullptr;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001008 if (!IsTransferOp(barrier)) {
1009 return skip;
1010 }
1011 const TransferBarrier *barrier_record = nullptr;
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001012 if (cb_state->IsReleaseOp(barrier) && !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001013 const auto found = barrier_sets.release.find(barrier);
1014 if (found != barrier_sets.release.cend()) {
1015 barrier_record = &(*found);
1016 transfer_type = "releasing";
John Zulauf6b4aae82018-05-09 13:03:36 -06001017 }
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001018 } else if (cb_state->IsAcquireOp(barrier) && !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001019 const auto found = barrier_sets.acquire.find(barrier);
1020 if (found != barrier_sets.acquire.cend()) {
1021 barrier_record = &(*found);
1022 transfer_type = "acquiring";
John Zulauf6b4aae82018-05-09 13:03:36 -06001023 }
1024 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001025 if (barrier_record != nullptr) {
1026 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001027 LogWarning(cb_state->commandBuffer(), TransferBarrier::ErrMsgDuplicateQFOInCB(),
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001028 "%s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
1029 " duplicates existing barrier recorded in this command buffer.",
1030 loc.Message().c_str(), transfer_type, handle_name, report_data->FormatHandle(barrier_record->handle).c_str(),
1031 barrier_record->srcQueueFamilyIndex, barrier_record->dstQueueFamilyIndex);
1032 }
John Zulauf6b4aae82018-05-09 13:03:36 -06001033 return skip;
1034}
1035
John Zulaufa4472282019-08-22 14:44:34 -06001036VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
1037 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1038}
1039
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001040VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier2KHR &barrier) {
1041 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1042}
1043
John Zulaufa4472282019-08-22 14:44:34 -06001044const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
1045 return device_state.GetImageState(barrier.image);
1046}
1047
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001048const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier2KHR &barrier) {
1049 return device_state.GetImageState(barrier.image);
1050}
1051
John Zulaufa4472282019-08-22 14:44:34 -06001052VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
1053 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1054}
1055
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001056VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier2KHR &barrier) {
1057 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1058}
1059
John Zulaufa4472282019-08-22 14:44:34 -06001060const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
1061 return device_state.GetBufferState(barrier.buffer);
1062}
1063
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001064const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier2KHR &barrier) {
1065 return device_state.GetBufferState(barrier.buffer);
1066}
John Zulaufa4472282019-08-22 14:44:34 -06001067
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001068template <typename Barrier, typename TransferBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001069void CoreChecks::RecordBarrierValidationInfo(const Location &loc, CMD_BUFFER_STATE *cb_state, const Barrier &barrier,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001070 QFOTransferBarrierSets<TransferBarrier> &barrier_sets) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001071 if (IsTransferOp(barrier)) {
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001072 if (cb_state->IsReleaseOp(barrier) && !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001073 barrier_sets.release.emplace(barrier);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001074 } else if (cb_state->IsAcquireOp(barrier) && !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001075 barrier_sets.acquire.emplace(barrier);
John Zulaufa4472282019-08-22 14:44:34 -06001076 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001077 }
John Zulaufa4472282019-08-22 14:44:34 -06001078
David Zhao Akeleyd76df472021-05-15 17:25:59 -07001079 // 7.7.4: If the values of srcQueueFamilyIndex and dstQueueFamilyIndex are equal, no ownership transfer is performed, and the
1080 // barrier operates as if they were both set to VK_QUEUE_FAMILY_IGNORED.
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001081 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
1082 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
David Zhao Akeleyd76df472021-05-15 17:25:59 -07001083 const bool is_ownership_transfer = src_queue_family != dst_queue_family;
1084
1085 if (is_ownership_transfer) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001086 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
1087 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
1088 auto handle_state = BarrierHandleState(*this, barrier);
1089 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
1090 if (!mode_concurrent) {
1091 const auto typed_handle = BarrierTypedHandle(barrier);
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001092 core_error::LocationCapture loc_capture(loc);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001093 cb_state->queue_submit_functions.emplace_back(
John Zulaufb4438f02021-02-20 20:22:16 -07001094 [loc_capture, cb_state, typed_handle, src_queue_family, dst_queue_family](const ValidationStateTracker *device_data,
1095 const QUEUE_STATE *queue_state) {
1096 return ValidateConcurrentBarrierAtSubmit(loc_capture.Get(), device_data, queue_state, cb_state, typed_handle,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001097 src_queue_family, dst_queue_family);
1098 });
John Zulauf6b4aae82018-05-09 13:03:36 -06001099 }
1100 }
1101}
1102
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001103// Verify image barrier image state and that the image is consistent with FB image
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001104template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001105bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001106 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1107 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001108 const ImgBarrier &img_barrier, const CMD_BUFFER_STATE *primary_cb_state) const {
1109 using sync_vuid_maps::GetImageBarrierVUID;
1110 using sync_vuid_maps::ImageError;
1111
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001112 bool skip = false;
1113 const auto *fb_state = framebuffer;
1114 assert(fb_state);
1115 const auto img_bar_image = img_barrier.image;
1116 bool image_match = false;
1117 bool sub_image_found = false; // Do we find a corresponding subpass description
1118 VkImageLayout sub_image_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1119 uint32_t attach_index = 0;
1120 // Verify that a framebuffer image matches barrier image
1121 const auto attachment_count = fb_state->createInfo.attachmentCount;
1122 for (uint32_t attachment = 0; attachment < attachment_count; ++attachment) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06001123 auto view_state = primary_cb_state ? primary_cb_state->GetActiveAttachmentImageViewState(attachment) : cb_state->GetActiveAttachmentImageViewState(attachment);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001124 if (view_state && (img_bar_image == view_state->create_info.image)) {
1125 image_match = true;
1126 attach_index = attachment;
1127 break;
1128 }
1129 }
1130 if (image_match) { // Make sure subpass is referring to matching attachment
1131 if (sub_desc.pDepthStencilAttachment && sub_desc.pDepthStencilAttachment->attachment == attach_index) {
1132 sub_image_layout = sub_desc.pDepthStencilAttachment->layout;
1133 sub_image_found = true;
1134 }
sfricke-samsung45996a42021-09-16 13:45:27 -07001135 if (!sub_image_found && IsExtEnabled(device_extensions.vk_khr_depth_stencil_resolve)) {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001136 const auto *resolve = LvlFindInChain<VkSubpassDescriptionDepthStencilResolve>(sub_desc.pNext);
1137 if (resolve && resolve->pDepthStencilResolveAttachment &&
1138 resolve->pDepthStencilResolveAttachment->attachment == attach_index) {
1139 sub_image_layout = resolve->pDepthStencilResolveAttachment->layout;
1140 sub_image_found = true;
1141 }
1142 }
1143 if (!sub_image_found) {
1144 for (uint32_t j = 0; j < sub_desc.colorAttachmentCount; ++j) {
1145 if (sub_desc.pColorAttachments && sub_desc.pColorAttachments[j].attachment == attach_index) {
1146 sub_image_layout = sub_desc.pColorAttachments[j].layout;
1147 sub_image_found = true;
1148 break;
1149 }
1150 if (!sub_image_found && sub_desc.pResolveAttachments &&
1151 sub_desc.pResolveAttachments[j].attachment == attach_index) {
1152 sub_image_layout = sub_desc.pResolveAttachments[j].layout;
1153 sub_image_found = true;
1154 break;
1155 }
1156 }
1157 }
1158 if (!sub_image_found) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001159 auto img_loc = loc.dot(Field::image);
1160 const auto &vuid = GetImageBarrierVUID(img_loc, ImageError::kRenderPassMismatch);
1161 skip |=
1162 LogError(rp_handle, vuid,
1163 "%s Barrier for %s is not referenced by the VkSubpassDescription for active subpass (%d) of current %s.",
1164 img_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(), active_subpass,
1165 report_data->FormatHandle(rp_handle).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001166 }
1167 } else { // !image_match
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001168 auto img_loc = loc.dot(Field::image);
1169 const auto &vuid = GetImageBarrierVUID(img_loc, ImageError::kRenderPassMismatch);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001170 skip |= LogError(fb_state->framebuffer(), vuid, "%s Barrier for %s does not match an image from the current %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001171 img_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001172 report_data->FormatHandle(fb_state->framebuffer()).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001173 }
1174 if (img_barrier.oldLayout != img_barrier.newLayout) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001175 auto layout_loc = loc.dot(Field::oldLayout);
1176 const auto &vuid = GetImageBarrierVUID(layout_loc, ImageError::kRenderPassLayoutChange);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001177 skip |= LogError(cb_state->commandBuffer(), vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001178 "%s As the Image Barrier for %s is being executed within a render pass instance, oldLayout must "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001179 "equal newLayout yet they are %s and %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001180 layout_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001181 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(img_barrier.newLayout));
1182 } else {
1183 if (sub_image_found && sub_image_layout != img_barrier.oldLayout) {
1184 LogObjectList objlist(rp_handle);
1185 objlist.add(img_bar_image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001186 auto layout_loc = loc.dot(Field::oldLayout);
1187 const auto &vuid = GetImageBarrierVUID(layout_loc, ImageError::kRenderPassLayoutChange);
1188 skip |= LogError(objlist, vuid,
1189 "%s Barrier for %s is referenced by the VkSubpassDescription for active "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001190 "subpass (%d) of current %s as having layout %s, but image barrier has layout %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001191 layout_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(), active_subpass,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001192 report_data->FormatHandle(rp_handle).c_str(), string_VkImageLayout(sub_image_layout),
1193 string_VkImageLayout(img_barrier.oldLayout));
1194 }
1195 }
1196 return skip;
1197}
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001198// explictly instantiate so these can be used in core_validation.cpp
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001199template bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001200 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1201 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
1202 const VkImageMemoryBarrier &img_barrier,
1203 const CMD_BUFFER_STATE *primary_cb_state) const;
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001204template bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001205 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1206 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
1207 const VkImageMemoryBarrier2KHR &img_barrier,
1208 const CMD_BUFFER_STATE *primary_cb_state) const;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001209
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001210template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001211void CoreChecks::EnqueueSubmitTimeValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001212 const ImgBarrier &barrier) {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001213 // Secondary CBs can have null framebuffer so queue up validation in that case 'til FB is known
1214 if ((cb_state->activeRenderPass) && (VK_NULL_HANDLE == cb_state->activeFramebuffer) &&
1215 (VK_COMMAND_BUFFER_LEVEL_SECONDARY == cb_state->createInfo.level)) {
1216 const auto active_subpass = cb_state->activeSubpass;
1217 const auto rp_state = cb_state->activeRenderPass;
1218 const auto &sub_desc = rp_state->createInfo.pSubpasses[active_subpass];
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001219 // Secondary CB case w/o FB specified delay validation
1220 auto *this_ptr = this; // Required for older compilers with c++20 compatibility
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001221 core_error::LocationCapture loc_capture(loc);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001222 const auto render_pass = rp_state->renderPass();
John Zulaufb4438f02021-02-20 20:22:16 -07001223 cb_state->cmd_execute_commands_functions.emplace_back(
1224 [this_ptr, loc_capture, cb_state, active_subpass, sub_desc, render_pass, barrier](const CMD_BUFFER_STATE *primary_cb,
1225 const FRAMEBUFFER_STATE *fb) {
1226 return this_ptr->ValidateImageBarrierAttachment(loc_capture.Get(), cb_state, fb, active_subpass, sub_desc,
1227 render_pass, barrier, primary_cb);
1228 });
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001229 }
1230}
1231
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001232void CoreChecks::RecordBarriers(Func func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001233 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1234 const VkImageMemoryBarrier *pImageMemBarriers) {
1235 for (uint32_t i = 0; i < bufferBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001236 Location loc(func_name, Struct::VkBufferMemoryBarrier, Field::pBufferMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001237 RecordBarrierValidationInfo(loc, cb_state, pBufferMemBarriers[i], cb_state->qfo_transfer_buffer_barriers);
1238 }
1239 for (uint32_t i = 0; i < imageMemBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001240 Location loc(func_name, Struct::VkImageMemoryBarrier, Field::pImageMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001241 const auto &img_barrier = pImageMemBarriers[i];
1242 RecordBarrierValidationInfo(loc, cb_state, img_barrier, cb_state->qfo_transfer_image_barriers);
1243 EnqueueSubmitTimeValidateImageBarrierAttachment(loc, cb_state, img_barrier);
1244 }
1245}
1246
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001247void CoreChecks::RecordBarriers(Func func_name, CMD_BUFFER_STATE *cb_state, const VkDependencyInfoKHR &dep_info) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001248 for (uint32_t i = 0; i < dep_info.bufferMemoryBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001249 Location loc(func_name, Struct::VkBufferMemoryBarrier2KHR, Field::pBufferMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001250 RecordBarrierValidationInfo(loc, cb_state, dep_info.pBufferMemoryBarriers[i], cb_state->qfo_transfer_buffer_barriers);
1251 }
1252 for (uint32_t i = 0; i < dep_info.imageMemoryBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001253 Location loc(func_name, Struct::VkImageMemoryBarrier2KHR, Field::pImageMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001254 const auto &img_barrier = dep_info.pImageMemoryBarriers[i];
1255 RecordBarrierValidationInfo(loc, cb_state, img_barrier, cb_state->qfo_transfer_image_barriers);
1256 EnqueueSubmitTimeValidateImageBarrierAttachment(loc, cb_state, img_barrier);
1257 }
1258}
1259
1260template <typename TransferBarrier, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001261bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001262 const char *operation, const TransferBarrier &barrier,
1263 Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001264 // Record to the scoreboard or report that we have a duplication
1265 bool skip = false;
Jeremy Gebbencbf22862021-03-03 12:01:22 -07001266 auto inserted = scoreboard->emplace(barrier, cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001267 if (!inserted.second && inserted.first->second != cb_state) {
1268 // This is a duplication (but don't report duplicates from the same CB, as we do that at record time
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001269 LogObjectList objlist(cb_state->commandBuffer());
Mark Lobodzinskiea561582020-03-16 18:13:56 -06001270 objlist.add(barrier.handle);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001271 objlist.add(inserted.first->second->commandBuffer());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001272 skip = LogWarning(objlist, TransferBarrier::ErrMsgDuplicateQFOInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001273 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1274 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001275 "vkQueueSubmit()", TransferBarrier::BarrierName(), operation, TransferBarrier::HandleName(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001276 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001277 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer()).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001278 }
1279 return skip;
1280}
1281
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001282template <typename TransferBarrier>
1283bool CoreChecks::ValidateQueuedQFOTransferBarriers(
1284 const CMD_BUFFER_STATE *cb_state, QFOTransferCBScoreboards<TransferBarrier> *scoreboards,
1285 const GlobalQFOTransferBarrierMap<TransferBarrier> &global_release_barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001286 bool skip = false;
Jeremy Gebben159b3cc2021-06-03 09:09:03 -06001287 const auto &cb_barriers = cb_state->GetQFOBarrierSets(TransferBarrier());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001288 const char *barrier_name = TransferBarrier::BarrierName();
1289 const char *handle_name = TransferBarrier::HandleName();
John Zulauf6b4aae82018-05-09 13:03:36 -06001290 // No release should have an extant duplicate (WARNING)
1291 for (const auto &release : cb_barriers.release) {
1292 // Check the global pending release barriers
1293 const auto set_it = global_release_barriers.find(release.handle);
1294 if (set_it != global_release_barriers.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001295 const QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001296 const auto found = set_for_handle.find(release);
1297 if (found != set_for_handle.cend()) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001298 skip |= LogWarning(cb_state->commandBuffer(), TransferBarrier::ErrMsgDuplicateQFOSubmitted(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001299 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1300 " to dstQueueFamilyIndex %" PRIu32
1301 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1302 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1303 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001304 }
1305 }
1306 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1307 }
1308 // Each acquire must have a matching release (ERROR)
1309 for (const auto &acquire : cb_barriers.acquire) {
1310 const auto set_it = global_release_barriers.find(acquire.handle);
1311 bool matching_release_found = false;
1312 if (set_it != global_release_barriers.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001313 const QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001314 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1315 }
1316 if (!matching_release_found) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001317 skip |= LogError(cb_state->commandBuffer(), TransferBarrier::ErrMsgMissingQFOReleaseInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001318 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1319 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1320 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1321 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001322 }
1323 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1324 }
1325 return skip;
1326}
1327
John Zulauf3b04ebd2019-07-18 14:08:11 -06001328bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001329 QFOTransferCBScoreboards<QFOImageTransferBarrier> *qfo_image_scoreboards,
1330 QFOTransferCBScoreboards<QFOBufferTransferBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001331 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001332 skip |=
1333 ValidateQueuedQFOTransferBarriers<QFOImageTransferBarrier>(cb_state, qfo_image_scoreboards, qfo_release_image_barrier_map);
1334 skip |= ValidateQueuedQFOTransferBarriers<QFOBufferTransferBarrier>(cb_state, qfo_buffer_scoreboards,
1335 qfo_release_buffer_barrier_map);
John Zulauf6b4aae82018-05-09 13:03:36 -06001336 return skip;
1337}
1338
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001339template <typename TransferBarrier>
1340void RecordQueuedQFOTransferBarriers(QFOTransferBarrierSets<TransferBarrier> &cb_barriers,
1341 GlobalQFOTransferBarrierMap<TransferBarrier> &global_release_barriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001342 // Add release barriers from this submit to the global map
1343 for (const auto &release : cb_barriers.release) {
1344 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1345 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1346 global_release_barriers[release.handle].insert(release);
1347 }
1348
1349 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1350 for (const auto &acquire : cb_barriers.acquire) {
1351 // NOTE: We're not using [] because we don't want to create entries for missing releases
1352 auto set_it = global_release_barriers.find(acquire.handle);
1353 if (set_it != global_release_barriers.end()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001354 QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001355 set_for_handle.erase(acquire);
1356 if (set_for_handle.size() == 0) { // Clean up empty sets
1357 global_release_barriers.erase(set_it);
1358 }
1359 }
1360 }
1361}
1362
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001363void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001364 RecordQueuedQFOTransferBarriers<QFOImageTransferBarrier>(cb_state->qfo_transfer_image_barriers, qfo_release_image_barrier_map);
1365 RecordQueuedQFOTransferBarriers<QFOBufferTransferBarrier>(cb_state->qfo_transfer_buffer_barriers,
1366 qfo_release_buffer_barrier_map);
John Zulauf6b4aae82018-05-09 13:03:36 -06001367}
1368
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001369template <typename ImgBarrier>
1370void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count, const ImgBarrier *barriers) {
1371 // For ownership transfers, the barrier is specified twice; as a release
1372 // operation on the yielding queue family, and as an acquire operation
1373 // on the acquiring queue family. This barrier may also include a layout
1374 // transition, which occurs 'between' the two operations. For validation
1375 // purposes it doesn't seem important which side performs the layout
1376 // transition, but it must not be performed twice. We'll arbitrarily
1377 // choose to perform it as part of the acquire operation.
1378 //
1379 // However, we still need to record initial layout for the "initial layout" validation
1380 for (uint32_t i = 0; i < barrier_count; i++) {
1381 const auto &mem_barrier = barriers[i];
Jeremy Gebbenefead332021-06-18 08:22:44 -06001382 const bool is_release_op = cb_state->IsReleaseOp(mem_barrier);
Petr Krausad0096a2019-08-09 18:35:04 +02001383 auto *image_state = GetImageState(mem_barrier.image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001384 if (image_state) {
1385 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
1386 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001387 }
1388}
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001389// explictly instantiate this template so it can be used in core_validation.cpp
1390template void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1391 const VkImageMemoryBarrier *barrier);
1392template void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1393 const VkImageMemoryBarrier2KHR *barrier);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001394
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001395VkImageLayout NormalizeSynchronization2Layout(const VkImageAspectFlags aspect_mask, VkImageLayout layout);
1396
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001397template <typename ImgBarrier>
unknown86bcb3a2019-07-11 13:05:36 -06001398void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001399 const ImgBarrier &mem_barrier, bool is_release_op) {
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001400 if (enabled_features.synchronization2_features.synchronization2) {
1401 if (mem_barrier.oldLayout == mem_barrier.newLayout) {
1402 return;
1403 }
1404 }
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06001405 auto normalized_isr = image_state->NormalizeSubresourceRange(mem_barrier.subresourceRange);
unknown86bcb3a2019-07-11 13:05:36 -06001406
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001407 VkImageLayout initial_layout = NormalizeSynchronization2Layout(mem_barrier.subresourceRange.aspectMask, mem_barrier.oldLayout);
1408 VkImageLayout new_layout = NormalizeSynchronization2Layout(mem_barrier.subresourceRange.aspectMask, mem_barrier.newLayout);
Michael Spang8af7c102020-05-03 20:50:09 -04001409
1410 // Layout transitions in external instance are not tracked, so don't validate initial layout.
John Zulaufcea64cb2020-06-10 17:17:27 -06001411 if (QueueFamilyIsExternal(mem_barrier.srcQueueFamilyIndex)) {
Michael Spang8af7c102020-05-03 20:50:09 -04001412 initial_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1413 }
1414
John Zulauf2be3fe02019-12-30 09:48:02 -07001415 if (is_release_op) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06001416 cb_state->SetImageInitialLayout(*image_state, normalized_isr, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001417 } else {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06001418 cb_state->SetImageLayout(*image_state, normalized_isr, new_layout, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001419 }
unknown86bcb3a2019-07-11 13:05:36 -06001420}
1421
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001422bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1423 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1424 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1425 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06001426 if (disabled[image_layout_validation]) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001427 assert(cb_node);
1428 assert(image_state);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001429 const auto image = image_state->image();
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001430 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001431
Jeremy Gebben159b3cc2021-06-03 09:09:03 -06001432 const auto *subresource_map = cb_node->GetImageSubresourceLayoutMap(image);
John Zulauff660ad62019-03-23 07:16:05 -06001433 if (subresource_map) {
1434 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001435 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
Tony Barbour55688172020-09-23 15:19:50 -07001436 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
1437 // the next "constant value" range
1438 for (auto pos = subresource_map->Find(range); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07001439 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001440 *error = true;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001441 subres_skip |= LogError(cb_node->commandBuffer(), layout_mismatch_msg_code,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001442 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1443 "%s layout %s.",
1444 caller, report_data->FormatHandle(image).c_str(), pos->subresource.arrayLayer,
1445 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1446 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001447 }
John Zulauf5e617452019-11-19 14:44:16 -07001448 }
John Zulauff660ad62019-03-23 07:16:05 -06001449 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001450 }
John Zulauff660ad62019-03-23 07:16:05 -06001451
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001452 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1453 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1454 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001455 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1456 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001457 skip |= LogPerformanceWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001458 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
1459 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001460 }
sfricke-samsung45996a42021-09-16 13:45:27 -07001461 } else if (IsExtEnabled(device_extensions.vk_khr_shared_presentable_image)) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001462 if (image_state->shared_presentable) {
1463 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001464 skip |=
1465 LogError(device, layout_invalid_msg_code,
1466 "%s: Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1467 caller, string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001468 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001469 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001470 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001471 *error = true;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001472 skip |= LogError(cb_node->commandBuffer(), layout_invalid_msg_code,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001473 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1474 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1475 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001476 }
1477 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001478 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001479}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001480bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001481 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1482 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001483 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001484 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1485 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1486}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001487
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001488void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001489 FRAMEBUFFER_STATE *framebuffer_state) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001490 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass);
1491 if (!render_pass) return;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001492
Mike Schuchardt2df08912020-12-15 16:28:09 -08001493 const VkRenderPassCreateInfo2 *render_pass_info = render_pass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001494 if (framebuffer_state) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001495 for (uint32_t i = 0; i < render_pass_info->attachmentCount; ++i) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06001496 auto *view_state = pCB->GetActiveAttachmentImageViewState(i);
John Zulauf8e308292018-09-21 11:34:37 -06001497 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001498 VkImageLayout stencil_layout = kInvalidLayout;
1499 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001500 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(render_pass_info->pAttachments[i].pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -07001501 if (attachment_description_stencil_layout) {
1502 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1503 }
Jeremy Gebben1ec89332021-08-05 13:51:49 -06001504 pCB->SetImageViewLayout(*view_state, render_pass_info->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001505 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001506 }
1507 }
1508}
Dave Houltone19e20d2018-02-02 16:32:41 -07001509
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001510#ifdef VK_USE_PLATFORM_ANDROID_KHR
1511// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1512// This could also move into a seperate core_validation_android.cpp file... ?
1513
1514//
1515// AHB-specific validation within non-AHB APIs
1516//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001517bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001518 bool skip = false;
1519
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001520 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(create_info->pNext);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001521 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001522 if (0 != ext_fmt_android->externalFormat) {
1523 if (VK_FORMAT_UNDEFINED != create_info->format) {
1524 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001525 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1526 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1527 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001528 }
1529
1530 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001531 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1532 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1533 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001534 }
1535
1536 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001537 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1538 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06001539 "non-zero externalFormat, but usage includes bits (0x%" PRIx32 ") other than VK_IMAGE_USAGE_SAMPLED_BIT.",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001540 create_info->usage);
Dave Houltond9611312018-11-19 17:03:36 -07001541 }
1542
1543 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001544 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1545 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1546 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001547 }
1548 }
1549
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001550 if ((0 != ext_fmt_android->externalFormat) &&
1551 (ahb_ext_formats_map.find(ext_fmt_android->externalFormat) == ahb_ext_formats_map.end())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001552 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001553 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat (%" PRIu64
1554 ") which has "
1555 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().",
1556 ext_fmt_android->externalFormat);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001557 }
1558 }
1559
Dave Houltond9611312018-11-19 17:03:36 -07001560 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001561 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001562 skip |=
1563 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1564 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1565 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001566 }
1567 }
1568
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001569 const VkExternalMemoryImageCreateInfo *emici = LvlFindInChain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001570 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1571 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001572 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001573 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1574 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1575 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1576 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001577 }
1578
1579 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001580 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1581 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1582 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1583 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1584 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001585 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001586 }
1587
1588 return skip;
1589}
1590
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001591bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001592 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001593 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001594
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06001595 if (image_state->HasAHBFormat()) {
Dave Houltond9611312018-11-19 17:03:36 -07001596 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001597 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1598 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001599 "format member is %s and must be VK_FORMAT_UNDEFINED.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001600 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001601 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001602
Dave Houltond9611312018-11-19 17:03:36 -07001603 // Chain must include a compatible ycbcr conversion
1604 bool conv_found = false;
1605 uint64_t external_format = 0;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001606 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = LvlFindInChain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001607 if (ycbcr_conv_info != nullptr) {
Jeremy Gebbenf4fb2a02021-07-08 09:57:46 -06001608 auto ycbcr_state = GetSamplerYcbcrConversionState(ycbcr_conv_info->conversion);
1609 if (ycbcr_state) {
Dave Houltond9611312018-11-19 17:03:36 -07001610 conv_found = true;
Jeremy Gebbenf4fb2a02021-07-08 09:57:46 -06001611 external_format = ycbcr_state->external_format;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001612 }
Dave Houltond9611312018-11-19 17:03:36 -07001613 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001614 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001615 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001616 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1617 "an externalFormat (%" PRIu64
1618 ") but needs a chained VkSamplerYcbcrConversionInfo struct with a VkSamplerYcbcrConversion created "
1619 "with the same external format.",
1620 image_state->ahb_format);
Dave Houltond9611312018-11-19 17:03:36 -07001621 }
1622
1623 // Errors in create_info swizzles
sfricke-samsungbd0e8052020-06-06 01:36:39 -07001624 if (IsIdentitySwizzle(create_info->components) == false) {
1625 skip |= LogError(
1626 create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1627 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1628 "includes one or more non-identity component swizzles, r swizzle = %s, g swizzle = %s, b swizzle = %s, a swizzle "
1629 "= %s.",
1630 string_VkComponentSwizzle(create_info->components.r), string_VkComponentSwizzle(create_info->components.g),
1631 string_VkComponentSwizzle(create_info->components.b), string_VkComponentSwizzle(create_info->components.a));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001632 }
1633 }
Dave Houltond9611312018-11-19 17:03:36 -07001634
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001635 return skip;
1636}
1637
John Zulaufa26d3c82019-08-14 16:09:08 -06001638bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001639 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001640
John Zulaufa26d3c82019-08-14 16:09:08 -06001641 const IMAGE_STATE *image_state = GetImageState(image);
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001642 if (image_state != nullptr) {
Jeremy Gebben6fbf8242021-06-21 09:14:46 -06001643 if (image_state->IsExternalAHB() && (0 == image_state->GetBoundMemory().size())) {
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001644 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1645 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1646 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1647 "bound to memory.");
1648 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001649 }
1650 return skip;
1651}
1652
1653#else
1654
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001655bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001656 return false;
1657}
1658
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001659bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001660
John Zulaufa26d3c82019-08-14 16:09:08 -06001661bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001662
1663#endif // VK_USE_PLATFORM_ANDROID_KHR
1664
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001665bool CoreChecks::ValidateImageFormatFeatures(const VkImageCreateInfo *pCreateInfo) const {
1666 bool skip = false;
1667
1668 // validates based on imageCreateFormatFeatures from vkspec.html#resources-image-creation-limits
1669 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
1670 const VkImageTiling image_tiling = pCreateInfo->tiling;
1671 const VkFormat image_format = pCreateInfo->format;
1672
1673 if (image_format == VK_FORMAT_UNDEFINED) {
1674 // VU 01975 states format can't be undefined unless an android externalFormat
1675#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001676 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001677 if ((image_tiling == VK_IMAGE_TILING_OPTIMAL) && (ext_fmt_android != nullptr) && (0 != ext_fmt_android->externalFormat)) {
1678 auto it = ahb_ext_formats_map.find(ext_fmt_android->externalFormat);
1679 if (it != ahb_ext_formats_map.end()) {
1680 tiling_features = it->second;
1681 }
1682 }
1683#endif
1684 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1685 uint64_t drm_format_modifier = 0;
1686 const VkImageDrmFormatModifierExplicitCreateInfoEXT *drm_explicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001687 LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001688 const VkImageDrmFormatModifierListCreateInfoEXT *drm_implicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001689 LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001690
1691 if (drm_explicit != nullptr) {
1692 drm_format_modifier = drm_explicit->drmFormatModifier;
1693 } else {
1694 // VUID 02261 makes sure its only explict or implict in parameter checking
1695 assert(drm_implicit != nullptr);
1696 for (uint32_t i = 0; i < drm_implicit->drmFormatModifierCount; i++) {
1697 drm_format_modifier |= drm_implicit->pDrmFormatModifiers[i];
1698 }
1699 }
1700
1701 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
1702 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
1703 nullptr};
1704 format_properties_2.pNext = (void *)&drm_properties_list;
1705 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Lionel Landwerlin09351a72020-06-22 18:15:59 +03001706 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
1707 drm_properties.resize(drm_properties_list.drmFormatModifierCount);
1708 drm_properties_list.pDrmFormatModifierProperties = &drm_properties[0];
1709 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001710
1711 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
1712 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_modifier) != 0) {
1713 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
1714 }
1715 }
1716 } else {
1717 VkFormatProperties format_properties = GetPDFormatProperties(image_format);
1718 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
1719 : format_properties.optimalTilingFeatures;
1720 }
1721
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001722 // Lack of disjoint format feature support while using the flag
1723 if (FormatIsMultiplane(image_format) && ((pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT) != 0) &&
1724 ((tiling_features & VK_FORMAT_FEATURE_DISJOINT_BIT) == 0)) {
1725 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateFormatFeatures-02260",
1726 "vkCreateImage(): can't use VK_IMAGE_CREATE_DISJOINT_BIT because %s doesn't support "
1727 "VK_FORMAT_FEATURE_DISJOINT_BIT based on imageCreateFormatFeatures.",
1728 string_VkFormat(pCreateInfo->format));
1729 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001730
1731 return skip;
1732}
1733
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001734bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001735 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001736 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001737
sfricke-samsung45996a42021-09-16 13:45:27 -07001738 if (IsExtEnabled(device_extensions.vk_android_external_memory_android_hardware_buffer)) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001739 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001740 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1741 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001742 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1743 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001744 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001745 }
1746
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001747 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1748 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001749 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1750 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1751 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001752 }
Dave Houlton130c0212018-01-29 13:39:56 -07001753 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001754
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001755 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001756 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1757 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1758 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001759 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001760 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width (%u) exceeds "
1761 "device maxFramebufferWidth (%u).",
1762 pCreateInfo->extent.width, device_limits->maxFramebufferWidth);
Dave Houlton130c0212018-01-29 13:39:56 -07001763 }
1764
1765 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001766 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001767 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height (%u) exceeds "
1768 "device maxFramebufferHeight (%u).",
1769 pCreateInfo->extent.height, device_limits->maxFramebufferHeight);
Dave Houlton130c0212018-01-29 13:39:56 -07001770 }
1771
ziga-lunarg44cba6e2021-07-13 17:58:06 +02001772 VkImageCreateFlags sparseFlags =
1773 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
1774 if ((pCreateInfo->flags & sparseFlags) && (pCreateInfo->usage & VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT)) {
1775 skip |= LogError(
1776 device, "VUID-VkImageCreateInfo-None-01925",
1777 "vkCreateImage(): images using sparse memory cannot have VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT set");
1778 }
1779
sfricke-samsung45996a42021-09-16 13:45:27 -07001780 if (IsExtEnabled(device_extensions.vk_ext_fragment_density_map) ||
1781 IsExtEnabled(device_extensions.vk_ext_fragment_density_map2)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001782 uint32_t ceiling_width = static_cast<uint32_t>(ceil(
1783 static_cast<float>(device_limits->maxFramebufferWidth) /
1784 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001785 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1786 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001787 LogError(device, "VUID-VkImageCreateInfo-usage-02559",
1788 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1789 "ceiling of device "
1790 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1791 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1792 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001793 }
1794
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001795 uint32_t ceiling_height = static_cast<uint32_t>(ceil(
1796 static_cast<float>(device_limits->maxFramebufferHeight) /
1797 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001798 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1799 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001800 LogError(device, "VUID-VkImageCreateInfo-usage-02560",
1801 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1802 "ceiling of device "
1803 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1804 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1805 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001806 }
1807 }
1808
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001809 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001810 VkResult result = VK_SUCCESS;
1811 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1812 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1813 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1814 &format_limits);
1815 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001816 auto modifier_list = LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1817 auto explicit_modifier = LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001818 if (modifier_list) {
1819 for (uint32_t i = 0; i < modifier_list->drmFormatModifierCount; i++) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001820 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001821 drm_format_modifier.drmFormatModifier = modifier_list->pDrmFormatModifiers[i];
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001822 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001823 image_format_info.type = pCreateInfo->imageType;
1824 image_format_info.format = pCreateInfo->format;
1825 image_format_info.tiling = pCreateInfo->tiling;
1826 image_format_info.usage = pCreateInfo->usage;
1827 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001828 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001829
1830 result =
1831 DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1832 format_limits = image_format_properties.imageFormatProperties;
1833
1834 /* The application gives a list of modifier and the driver
1835 * selects one. If one is wrong, stop there.
1836 */
1837 if (result != VK_SUCCESS) break;
1838 }
1839 } else if (explicit_modifier) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001840 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001841 drm_format_modifier.drmFormatModifier = explicit_modifier->drmFormatModifier;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001842 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001843 image_format_info.type = pCreateInfo->imageType;
1844 image_format_info.format = pCreateInfo->format;
1845 image_format_info.tiling = pCreateInfo->tiling;
1846 image_format_info.usage = pCreateInfo->usage;
1847 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001848 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001849
1850 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1851 format_limits = image_format_properties.imageFormatProperties;
1852 }
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001853 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001854
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001855 // 1. vkGetPhysicalDeviceImageFormatProperties[2] only success code is VK_SUCCESS
1856 // 2. If call returns an error, then "imageCreateImageFormatPropertiesList" is defined to be the empty list
1857 // 3. All values in 02251 are undefined if "imageCreateImageFormatPropertiesList" is empty.
1858 if (result != VK_SUCCESS) {
1859 // External memory will always have a "imageCreateImageFormatPropertiesList" so skip
Lockee87f87c2019-04-23 17:53:10 -06001860#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001861 if (!LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext)) {
Lockee87f87c2019-04-23 17:53:10 -06001862#endif // VK_USE_PLATFORM_ANDROID_KHR
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001863 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateMaxMipLevels-02251",
Spencer Frickec46fc6d2020-04-16 06:23:05 -07001864 "vkCreateImage(): Format %s is not supported for this combination of parameters and "
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001865 "VkGetPhysicalDeviceImageFormatProperties returned back %s.",
1866 string_VkFormat(pCreateInfo->format), string_VkResult(result));
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001867#ifdef VK_USE_PLATFORM_ANDROID_KHR
1868 }
1869#endif // VK_USE_PLATFORM_ANDROID_KHR
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001870 } else {
1871 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1872 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001873 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1874 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1875 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001876 }
Dave Houlton130c0212018-01-29 13:39:56 -07001877
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001878 uint64_t texel_count = static_cast<uint64_t>(pCreateInfo->extent.width) *
1879 static_cast<uint64_t>(pCreateInfo->extent.height) *
1880 static_cast<uint64_t>(pCreateInfo->extent.depth) * static_cast<uint64_t>(pCreateInfo->arrayLayers) *
1881 static_cast<uint64_t>(pCreateInfo->samples);
Dave Houlton130c0212018-01-29 13:39:56 -07001882
sfricke-samsung2e827212021-09-28 07:52:08 -07001883 // Depth/Stencil formats size can't be accurately calculated
1884 if (!FormatIsDepthAndStencil(pCreateInfo->format)) {
1885 uint64_t total_size =
1886 static_cast<uint64_t>(std::ceil(FormatTexelSize(pCreateInfo->format) * static_cast<double>(texel_count)));
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001887
sfricke-samsung2e827212021-09-28 07:52:08 -07001888 // Round up to imageGranularity boundary
1889 VkDeviceSize image_granularity = phys_dev_props.limits.bufferImageGranularity;
1890 uint64_t ig_mask = image_granularity - 1;
1891 total_size = (total_size + ig_mask) & ~ig_mask;
1892
1893 if (total_size > format_limits.maxResourceSize) {
1894 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
1895 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1896 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1897 total_size, format_limits.maxResourceSize);
1898 }
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001899 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001900
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001901 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001902 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
1903 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1904 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001905 }
1906
1907 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001908 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
1909 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
1910 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001911 }
sfricke-samsung612f3622020-06-20 20:42:46 -07001912
1913 if (pCreateInfo->extent.width > format_limits.maxExtent.width) {
1914 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02252",
1915 "vkCreateImage(): extent.width %u exceeds allowable maximum image extent width %u.",
1916 pCreateInfo->extent.width, format_limits.maxExtent.width);
1917 }
1918
1919 if (pCreateInfo->extent.height > format_limits.maxExtent.height) {
1920 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02253",
1921 "vkCreateImage(): extent.height %u exceeds allowable maximum image extent height %u.",
1922 pCreateInfo->extent.height, format_limits.maxExtent.height);
1923 }
1924
1925 if (pCreateInfo->extent.depth > format_limits.maxExtent.depth) {
1926 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02254",
1927 "vkCreateImage(): extent.depth %u exceeds allowable maximum image extent depth %u.",
1928 pCreateInfo->extent.depth, format_limits.maxExtent.depth);
1929 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001930 }
1931
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001932 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsung10b35ce2021-09-29 08:50:20 -07001933 if (FormatRequiresYcbcrConversionExplicitly(pCreateInfo->format)) {
sfricke-samsungcead0802020-01-30 22:20:10 -08001934 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
sfricke-samsung45996a42021-09-16 13:45:27 -07001935 const char *error_vuid = IsExtEnabled(device_extensions.vk_ext_ycbcr_image_arrays)
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07001936 ? "VUID-VkImageCreateInfo-format-06414"
1937 : "VUID-VkImageCreateInfo-format-06413";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001938 skip |= LogError(device, error_vuid,
1939 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
1940 "YCbCr Conversion format, arrayLayers must be 1",
1941 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001942 }
1943
1944 if (pCreateInfo->mipLevels != 1) {
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07001945 skip |= LogError(device, "VUID-VkImageCreateInfo-format-06410",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001946 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
1947 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001948 }
1949
1950 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001951 skip |= LogError(
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07001952 device, "VUID-VkImageCreateInfo-format-06411",
sfricke-samsungcead0802020-01-30 22:20:10 -08001953 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
1954 string_VkSampleCountFlagBits(pCreateInfo->samples));
1955 }
1956
1957 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001958 skip |= LogError(
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07001959 device, "VUID-VkImageCreateInfo-format-06412",
sfricke-samsungcead0802020-01-30 22:20:10 -08001960 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
1961 string_VkImageType(pCreateInfo->imageType));
1962 }
1963 }
1964
sfricke-samsung45996a42021-09-16 13:45:27 -07001965 if (IsExtEnabled(device_extensions.vk_khr_maintenance2)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001966 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
sfricke-samsung08796682021-09-13 07:47:20 -07001967 if (!FormatIsCompressed(pCreateInfo->format)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001968 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01572",
1969 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
sfricke-samsung08796682021-09-13 07:47:20 -07001970 "format must be a compressed image format, but is %s",
Spencer Fricke48db59b2020-03-23 10:31:46 -07001971 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001972 }
1973 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001974 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01573",
1975 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1976 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001977 }
1978 }
1979 }
1980
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001981 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
sfricke-samsung45996a42021-09-16 13:45:27 -07001982 const char *vuid = IsExtEnabled(device_extensions.vk_khr_get_physical_device_properties2)
1983 ? "VUID-VkImageCreateInfo-sharingMode-01420"
1984 : "VUID-VkImageCreateInfo-sharingMode-01392";
Mark Lobodzinski314b9162020-07-16 15:33:08 -06001985 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
ziga-lunarge2e283d2021-08-01 09:55:04 +02001986 "vkCreateImage", "pCreateInfo->pQueueFamilyIndices", vuid);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001987 }
1988
unknown2c877272019-07-11 12:56:50 -06001989 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
1990 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
1991 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001992 LogError(device, "VUID-VkImageCreateInfo-format-01577",
1993 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
1994 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06001995 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001996
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001997 const auto swapchain_create_info = LvlFindInChain<VkImageSwapchainCreateInfoKHR>(pCreateInfo->pNext);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07001998 if (swapchain_create_info != nullptr) {
1999 if (swapchain_create_info->swapchain != VK_NULL_HANDLE) {
2000 const SWAPCHAIN_NODE *swapchain_state = GetSwapchainState(swapchain_create_info->swapchain);
2001 const VkSwapchainCreateFlagsKHR swapchain_flags = swapchain_state->createInfo.flags;
2002
2003 // Validate rest of Swapchain Image create check that require swapchain state
2004 const char *vuid = "VUID-VkImageSwapchainCreateInfoKHR-swapchain-00995";
2005 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR) != 0) &&
2006 ((pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) == 0)) {
2007 skip |= LogError(
2008 device, vuid,
2009 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR flag so "
2010 "all swapchain images must have the VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT flag set.");
2011 }
2012 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR) != 0) &&
2013 ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) == 0)) {
2014 skip |= LogError(device, vuid,
2015 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR flag so all "
2016 "swapchain images must have the VK_IMAGE_CREATE_PROTECTED_BIT flag set.");
2017 }
Mike Schuchardt2df08912020-12-15 16:28:09 -08002018 const VkImageCreateFlags mutable_flags = (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT | VK_IMAGE_CREATE_EXTENDED_USAGE_BIT);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002019 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR) != 0) &&
2020 ((pCreateInfo->flags & mutable_flags) != mutable_flags)) {
2021 skip |= LogError(device, vuid,
2022 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR flag so "
2023 "all swapchain images must have the VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT and "
Mike Schuchardt2df08912020-12-15 16:28:09 -08002024 "VK_IMAGE_CREATE_EXTENDED_USAGE_BIT flags both set.");
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002025 }
2026 }
2027 }
2028
sfricke-samsungedce77a2020-07-03 22:35:13 -07002029 if ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) != 0) {
2030 if (enabled_features.core11.protectedMemory == VK_FALSE) {
2031 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01890",
2032 "vkCreateImage(): the protectedMemory device feature is disabled: Images cannot be created with the "
2033 "VK_IMAGE_CREATE_PROTECTED_BIT set.");
2034 }
2035 const VkImageCreateFlags invalid_flags =
2036 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
2037 if ((pCreateInfo->flags & invalid_flags) != 0) {
2038 skip |= LogError(device, "VUID-VkImageCreateInfo-None-01891",
2039 "vkCreateImage(): VK_IMAGE_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at same "
2040 "time (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | "
2041 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT).");
2042 }
2043 }
2044
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002045 skip |= ValidateImageFormatFeatures(pCreateInfo);
2046
Nathaniel Cesarioc02c2512020-11-13 12:04:24 -07002047 // Check compatibility with VK_KHR_portability_subset
sfricke-samsung45996a42021-09-16 13:45:27 -07002048 if (IsExtEnabled(device_extensions.vk_khr_portability_subset)) {
Nathaniel Cesarioc02c2512020-11-13 12:04:24 -07002049 if (VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT & pCreateInfo->flags &&
2050 VK_FALSE == enabled_features.portability_subset_features.imageView2DOn3DImage) {
2051 skip |= LogError(device, "VUID-VkImageCreateInfo-imageView2DOn3DImage-04459",
2052 "vkCreateImage (portability error): VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT is not supported.");
2053 }
2054 if ((VK_SAMPLE_COUNT_1_BIT != pCreateInfo->samples) && (1 != pCreateInfo->arrayLayers) &&
2055 (VK_FALSE == enabled_features.portability_subset_features.multisampleArrayImage)) {
2056 skip |=
2057 LogError(device, "VUID-VkImageCreateInfo-multisampleArrayImage-04460",
2058 "vkCreateImage (portability error): Cannot create an image with samples/texel > 1 && arrayLayers != 1");
2059 }
2060 }
2061
ziga-lunarg63f8d7a2021-07-20 22:10:31 +02002062 const auto external_memory_create_info_nv = LvlFindInChain<VkExternalMemoryImageCreateInfoNV>(pCreateInfo->pNext);
ziga-lunarg62aa24f2021-10-09 11:58:30 +02002063 const auto external_memory_create_info = LvlFindInChain<VkExternalMemoryImageCreateInfo>(pCreateInfo->pNext);
2064 if (external_memory_create_info_nv != nullptr && external_memory_create_info != nullptr) {
2065 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-00988",
2066 "vkCreateImage(): VkImageCreateInfo struct has both VkExternalMemoryImageCreateInfoNV and "
2067 "VkExternalMemoryImageCreateInfo chained structs.");
2068 }
2069 if (external_memory_create_info) {
2070 if (external_memory_create_info->handleTypes != 0 && pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_UNDEFINED) {
2071 skip |= LogError(
2072 device, "VUID-VkImageCreateInfo-pNext-01443",
2073 "vkCreateImage: VkImageCreateInfo pNext chain includes VkExternalMemoryImageCreateInfo with handleTypes %" PRIu32
2074 " but pCreateInfo->initialLayout is %s.",
2075 external_memory_create_info->handleTypes, string_VkImageLayout(pCreateInfo->initialLayout));
2076 }
2077 } else if (external_memory_create_info_nv) {
2078 if (external_memory_create_info_nv->handleTypes != 0 && pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_UNDEFINED) {
2079 skip |= LogError(
2080 device, "VUID-VkImageCreateInfo-pNext-01443",
2081 "vkCreateImage: VkImageCreateInfo pNext chain includes VkExternalMemoryImageCreateInfoNV with handleTypes %" PRIu32
2082 " but pCreateInfo->initialLayout is %s.",
2083 external_memory_create_info_nv->handleTypes, string_VkImageLayout(pCreateInfo->initialLayout));
ziga-lunarg63f8d7a2021-07-20 22:10:31 +02002084 }
2085 }
2086
ziga-lunarg374fd9a2021-07-18 10:32:52 +02002087 if (device_group_create_info.physicalDeviceCount == 1) {
2088 if (pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) {
2089 skip |= LogError(device, "VUID-VkImageCreateInfo-physicalDeviceCount-01421",
2090 "vkCreateImage: Device was created with VkDeviceGroupDeviceCreateInfo::physicalDeviceCount 1, but "
2091 "flags contain VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT bit.");
2092 }
2093 }
2094
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002095 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002096}
2097
John Zulauf7eeb6f72019-06-17 11:56:36 -06002098void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
2099 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
2100 if (VK_SUCCESS != result) return;
2101
2102 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
locke-lunarg20699892020-01-02 19:17:29 -07002103 auto image_state = Get<IMAGE_STATE>(*pImage);
2104 AddInitialLayoutintoImageLayoutMap(*image_state, imageLayoutMap);
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07002105}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002106
Jeff Bolz5c801d12019-10-09 10:38:45 -05002107bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05002108 const IMAGE_STATE *image_state = GetImageState(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002109 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07002110 if (image_state) {
Jeremy Gebben82e11d52021-07-26 09:19:37 -06002111 if (image_state->IsSwapchainImage()) {
sfricke-samsung73452522021-06-17 08:44:46 -07002112 skip |= LogError(device, "VUID-vkDestroyImage-image-04882",
sfricke-samsung9056cc12021-04-18 22:51:00 -07002113 "vkDestroyImage(): %s is a presentable image and it is controlled by the implementation and is "
2114 "destroyed with vkDestroySwapchainKHR.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002115 report_data->FormatHandle(image_state->image()).c_str());
sfricke-samsung9056cc12021-04-18 22:51:00 -07002116 }
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06002117 skip |= ValidateObjectNotInUse(image_state, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002118 }
2119 return skip;
2120}
2121
John Zulauf7eeb6f72019-06-17 11:56:36 -06002122void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
2123 // Clean up validation specific data
Jeremy Gebbene60d4172021-02-02 15:42:15 -07002124 qfo_release_image_barrier_map.erase(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002125
locke-lunargcba7d5f2019-12-30 16:59:11 -07002126 imageLayoutMap.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06002127
2128 // Clean up generic image state
2129 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002130}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002131
sfricke-samsungcd924d92020-05-20 23:51:17 -07002132bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range,
2133 const char *param_name) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002134 bool skip = false;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002135 const VkImage image = image_state->image();
sfricke-samsungcd924d92020-05-20 23:51:17 -07002136 const VkFormat format = image_state->createInfo.format;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002137
2138 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002139 skip |= LogError(image, "VUID-vkCmdClearColorImage-aspectMask-02498",
2140 "vkCmdClearColorImage(): %s.aspectMasks must only be set to VK_IMAGE_ASPECT_COLOR_BIT.", param_name);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002141 }
2142
sfricke-samsungcd924d92020-05-20 23:51:17 -07002143 if (FormatIsDepthOrStencil(format)) {
2144 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2145 "vkCmdClearColorImage(): %s called with image %s which has a depth/stencil format (%s).", param_name,
2146 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
2147 } else if (FormatIsCompressed(format)) {
2148 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2149 "vkCmdClearColorImage(): %s called with image %s which has a compressed format (%s).", param_name,
2150 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002151 }
2152
2153 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002154 skip |=
2155 LogError(image, "VUID-vkCmdClearColorImage-image-00002",
2156 "vkCmdClearColorImage() %s called with image %s which was created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.",
2157 param_name, report_data->FormatHandle(image).c_str());
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002158 }
2159 return skip;
2160}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002161
John Zulauf07288512019-07-05 11:09:50 -06002162bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
2163 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
2164 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002165 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002166 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2167 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002168 skip |= LogError(image_state->image(), "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002169 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2170 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002171 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002172
2173 } else {
2174 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
sfricke-samsung45996a42021-09-16 13:45:27 -07002175 if (!IsExtEnabled(device_extensions.vk_khr_shared_presentable_image)) {
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002176 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002177 skip |= LogError(image_state->image(), "VUID-vkCmdClearColorImage-imageLayout-00005",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002178 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2179 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002180 }
2181 } else {
2182 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
2183 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002184 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002185 image_state->image(), "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002186 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
2187 func_name, string_VkImageLayout(dest_image_layout));
2188 }
2189 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002190 }
2191
John Zulauff660ad62019-03-23 07:16:05 -06002192 // Cast to const to prevent creation at validate time.
Jeremy Gebben159b3cc2021-06-03 09:09:03 -06002193 const auto *subresource_map = cb_node->GetImageSubresourceLayoutMap(image_state->image());
John Zulauff660ad62019-03-23 07:16:05 -06002194 if (subresource_map) {
2195 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06002196 LayoutUseCheckAndMessage layout_check(subresource_map);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002197 auto normalized_isr = image_state->NormalizeSubresourceRange(range);
Tony Barbour55688172020-09-23 15:19:50 -07002198 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
2199 // the next "constant value" range
2200 for (auto pos = subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07002201 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06002202 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
2203 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2204 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
2205 } else {
2206 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002207 }
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002208 subres_skip |= LogError(cb_node->commandBuffer(), error_code,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002209 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
2210 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
2211 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002212 }
John Zulauf5e617452019-11-19 14:44:16 -07002213 }
John Zulauff660ad62019-03-23 07:16:05 -06002214 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002215 }
2216
2217 return skip;
2218}
2219
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002220bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2221 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002222 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002223 bool skip = false;
2224 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06002225 const auto *cb_node = GetCBState(commandBuffer);
2226 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002227 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002228 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
sfricke-samsung85584a72021-09-30 21:43:38 -07002229 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE);
sfricke-samsung45996a42021-09-16 13:45:27 -07002230 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002231 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
2232 "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04002233 }
sfricke-samsung022fa252020-07-24 03:26:16 -07002234 skip |=
2235 ValidateProtectedImage(cb_node, image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-commandBuffer-01805");
2236 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearColorImage()",
2237 "VUID-vkCmdClearColorImage-commandBuffer-01806");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002238 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002239 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002240 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
sfricke-samsungcd924d92020-05-20 23:51:17 -07002241 skip |= ValidateImageAttributes(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002242 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002243 }
sfricke-samsunge775d492020-02-28 09:02:25 -08002244 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsung10b35ce2021-09-29 08:50:20 -07002245 if (FormatRequiresYcbcrConversionExplicitly(image_state->createInfo.format)) {
sfricke-samsunge775d492020-02-28 09:02:25 -08002246 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
2247 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
2248 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
2249 string_VkFormat(image_state->createInfo.format));
2250 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002251 }
2252 return skip;
2253}
2254
John Zulaufeabb4462019-07-05 14:13:03 -06002255void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2256 const VkClearColorValue *pColor, uint32_t rangeCount,
2257 const VkImageSubresourceRange *pRanges) {
2258 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
2259
2260 auto cb_node = GetCBState(commandBuffer);
2261 auto image_state = GetImageState(image);
2262 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002263 for (uint32_t i = 0; i < rangeCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06002264 cb_node->SetImageInitialLayout(image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002265 }
2266 }
2267}
2268
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002269bool CoreChecks::ValidateClearDepthStencilValue(VkCommandBuffer commandBuffer, VkClearDepthStencilValue clearValue,
2270 const char *apiName) const {
2271 bool skip = false;
2272
2273 // The extension was not created with a feature bit whichs prevents displaying the 2 variations of the VUIDs
sfricke-samsung45996a42021-09-16 13:45:27 -07002274 if (!IsExtEnabled(device_extensions.vk_ext_depth_range_unrestricted)) {
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002275 if (!(clearValue.depth >= 0.0) || !(clearValue.depth <= 1.0)) {
2276 // Also VUID-VkClearDepthStencilValue-depth-00022
2277 skip |= LogError(commandBuffer, "VUID-VkClearDepthStencilValue-depth-02506",
2278 "%s: VK_EXT_depth_range_unrestricted extension is not enabled and VkClearDepthStencilValue::depth "
2279 "(=%f) is not within the [0.0, 1.0] range.",
2280 apiName, clearValue.depth);
2281 }
2282 }
2283
2284 return skip;
2285}
2286
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002287bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2288 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002289 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002290 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002291
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002292 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06002293 const auto *cb_node = GetCBState(commandBuffer);
2294 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002295 if (cb_node && image_state) {
sfricke-samsung30e325a2020-07-25 12:56:13 -07002296 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002297 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002298 "VUID-vkCmdClearDepthStencilImage-image-00010");
sfricke-samsung85584a72021-09-30 21:43:38 -07002299 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE);
sfricke-samsung45996a42021-09-16 13:45:27 -07002300 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002301 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002302 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04002303 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002304 skip |= ValidateClearDepthStencilValue(commandBuffer, *pDepthStencil, "vkCmdClearDepthStencilImage()");
sfricke-samsung022fa252020-07-24 03:26:16 -07002305 skip |= ValidateProtectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2306 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01807");
2307 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2308 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01808");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002309
2310 bool any_include_aspect_depth_bit = false;
2311 bool any_include_aspect_stencil_bit = false;
2312
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002313 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002314 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002315 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002316 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002317 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06002318 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
2319 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002320 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-aspectMask-02824",
2321 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask can only be VK_IMAGE_ASPECT_DEPTH_BIT "
2322 "and/or VK_IMAGE_ASPECT_STENCIL_BIT.",
2323 i);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002324 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002325 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
2326 any_include_aspect_depth_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002327 if (FormatHasDepth(image_format) == false) {
2328 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02826",
2329 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_DEPTH_BIT but %s "
2330 "doesn't have a depth component.",
2331 i, string_VkFormat(image_format));
2332 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002333 }
2334 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
2335 any_include_aspect_stencil_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002336 if (FormatHasStencil(image_format) == false) {
2337 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02825",
2338 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_STENCIL_BIT but "
2339 "%s doesn't have a stencil component.",
2340 i, string_VkFormat(image_format));
2341 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002342 }
2343 }
2344 if (any_include_aspect_stencil_bit) {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07002345 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05002346 if (image_stencil_struct != nullptr) {
2347 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
2348 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002349 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
2350 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
2351 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
2352 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002353 }
2354 } else {
2355 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002356 skip |= LogError(
2357 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05002358 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
2359 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
2360 "in VkImageCreateInfo::usage used to create image");
2361 }
2362 }
2363 }
2364 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002365 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
2366 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
2367 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002368 }
sfricke-samsung30e325a2020-07-25 12:56:13 -07002369 if (image_state && !FormatIsDepthOrStencil(image_format)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002370 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014",
2371 "vkCmdClearDepthStencilImage(): called with image %s which doesn't have a depth/stencil format (%s).",
sfricke-samsung30e325a2020-07-25 12:56:13 -07002372 report_data->FormatHandle(image).c_str(), string_VkFormat(image_format));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002373 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002374 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002375 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009",
2376 "vkCmdClearDepthStencilImage(): called with image %s which was not created with the "
2377 "VK_IMAGE_USAGE_TRANSFER_DST_BIT set.",
2378 report_data->FormatHandle(image).c_str());
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002379 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002380 }
2381 return skip;
2382}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002383
John Zulaufeabb4462019-07-05 14:13:03 -06002384void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2385 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
2386 const VkImageSubresourceRange *pRanges) {
2387 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
2388 auto cb_node = GetCBState(commandBuffer);
2389 auto image_state = GetImageState(image);
2390 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002391 for (uint32_t i = 0; i < rangeCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06002392 cb_node->SetImageInitialLayout(image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002393 }
2394 }
2395}
2396
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002397// Returns true if [x, xoffset] and [y, yoffset] overlap
2398static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
2399 bool result = false;
2400 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
2401 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
2402
2403 if (intersection_max > intersection_min) {
2404 result = true;
2405 }
2406 return result;
2407}
2408
Jeff Leger178b1e52020-10-05 12:22:23 -04002409// Returns true if source area of first vkImageCopy/vkImageCopy2KHR region intersects dest area of second region
Dave Houltonc991cc92018-03-06 11:08:51 -07002410// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
Jeff Leger178b1e52020-10-05 12:22:23 -04002411template <typename RegionType>
2412static bool RegionIntersects(const RegionType *rgn0, const RegionType *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002413 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07002414
Dave Houltonc991cc92018-03-06 11:08:51 -07002415 // Separate planes within a multiplane image cannot intersect
2416 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07002417 return result;
2418 }
2419
Dave Houltonc991cc92018-03-06 11:08:51 -07002420 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
2421 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
2422 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002423 result = true;
2424 switch (type) {
2425 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002426 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002427 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002428 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002429 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002430 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002431 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002432 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002433 break;
2434 default:
2435 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2436 assert(false);
2437 }
2438 }
2439 return result;
2440}
2441
Dave Houltonfc1a4052017-04-27 14:32:45 -06002442// Returns non-zero if offset and extent exceed image extents
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002443static const uint32_t kXBit = 1;
2444static const uint32_t kYBit = 2;
2445static const uint32_t kZBit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002446static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002447 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002448 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002449 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2450 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002451 result |= kZBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002452 }
2453 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2454 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002455 result |= kYBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002456 }
2457 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2458 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002459 result |= kXBit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002460 }
2461 return result;
2462}
2463
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002464// Test if two VkExtent3D structs are equivalent
2465static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2466 bool result = true;
2467 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2468 (extent->depth != other_extent->depth)) {
2469 result = false;
2470 }
2471 return result;
2472}
2473
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002474// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002475static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002476 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2477}
2478
2479// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002480VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002481 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2482 VkExtent3D granularity = {0, 0, 0};
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002483 auto pool = cb_node->command_pool.get();
2484 if (pool) {
2485 granularity = GetPhysicalDeviceState()->queue_family_properties[pool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06002486 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002487 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002488 granularity.width *= block_size.width;
2489 granularity.height *= block_size.height;
2490 }
2491 }
2492 return granularity;
2493}
2494
2495// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2496static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2497 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002498 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2499 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002500 valid = false;
2501 }
2502 return valid;
2503}
2504
2505// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002506bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002507 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002508 bool skip = false;
2509 VkExtent3D offset_extent = {};
2510 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2511 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2512 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002513 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002514 // If the queue family image transfer granularity is (0, 0, 0), then the offset must always be (0, 0, 0)
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002515 if (IsExtentAllZeroes(&offset_extent) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002516 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002517 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) must be (x=0, y=0, z=0) when the command buffer's queue family "
2518 "image transfer granularity is (w=0, h=0, d=0).",
2519 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002520 }
2521 } else {
2522 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2523 // integer multiples of the image transfer granularity.
2524 if (IsExtentAligned(&offset_extent, granularity) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002525 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002526 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2527 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2528 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2529 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002530 }
2531 }
2532 return skip;
2533}
2534
2535// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002536bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002537 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002538 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002539 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002540 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002541 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2542 // subresource extent.
2543 if (IsExtentEqual(extent, subresource_extent) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002544 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002545 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2546 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2547 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2548 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002549 }
2550 } else {
2551 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2552 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2553 // subresource extent dimensions.
2554 VkExtent3D offset_extent_sum = {};
2555 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2556 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2557 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002558 bool x_ok = true;
2559 bool y_ok = true;
2560 bool z_ok = true;
2561 switch (image_type) {
2562 case VK_IMAGE_TYPE_3D:
2563 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2564 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002565 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002566 case VK_IMAGE_TYPE_2D:
2567 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2568 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002569 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002570 case VK_IMAGE_TYPE_1D:
2571 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2572 (subresource_extent->width == offset_extent_sum.width));
2573 break;
2574 default:
2575 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2576 assert(false);
2577 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002578 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002579 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002580 LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002581 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2582 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2583 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2584 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2585 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2586 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002587 }
2588 }
2589 return skip;
2590}
2591
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002592bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002593 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002594 bool skip = false;
2595 if (mip_level >= img->createInfo.mipLevels) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002596 skip |= LogError(cb_node->commandBuffer(), vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2597 function, i, member, mip_level, report_data->FormatHandle(img->image()).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002598 }
2599 return skip;
2600}
2601
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002602bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002603 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002604 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002605 bool skip = false;
2606 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2607 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002608 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002609 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2610 "%u, but provided %s has %u array layers.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002611 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image()).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002612 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002613 }
2614 return skip;
2615}
2616
Jeff Leger178b1e52020-10-05 12:22:23 -04002617// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy/VkBufferImageCopy2KHR structure
2618template <typename BufferImageCopyRegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002619bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002620 const BufferImageCopyRegionType *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002621 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002622 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002623 VkExtent3D granularity = GetScaledItg(cb_node, img);
2624 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002625 VkExtent3D subresource_extent = img->GetSubresourceExtent(region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002626 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002627 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002628 return skip;
2629}
2630
Jeff Leger178b1e52020-10-05 12:22:23 -04002631// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy/VkImageCopy2KHR structure
2632template <typename RegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002633bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002634 const IMAGE_STATE *dst_img, const RegionType *region,
2635 const uint32_t i, const char *function,
2636 CopyCommandVersion version) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002637 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002638 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2639 const char *vuid;
2640
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002641 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002642 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002643 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
2644 skip |= CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", vuid);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002645 VkExtent3D subresource_extent = src_img->GetSubresourceExtent(region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002646 const VkExtent3D extent = region->extent;
Jeff Leger178b1e52020-10-05 12:22:23 -04002647 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002648 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04002649 i, function, "extent", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002650
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002651 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002652 granularity = GetScaledItg(cb_node, dst_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002653 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
2654 skip |= CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", vuid);
Dave Houltonee281a52017-12-08 13:51:02 -07002655 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002656 const VkExtent3D dest_effective_extent =
2657 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002658 subresource_extent = dst_img->GetSubresourceExtent(region->dstSubresource);
Jeff Leger178b1e52020-10-05 12:22:23 -04002659 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002660 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Jeff Leger178b1e52020-10-05 12:22:23 -04002661 dst_img->createInfo.imageType, i, function, "extent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002662 return skip;
2663}
2664
Jeff Leger178b1e52020-10-05 12:22:23 -04002665// Validate contents of a VkImageCopy or VkImageCopy2KHR struct
2666template <typename ImageCopyRegionType>
2667bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const ImageCopyRegionType *ic_regions,
2668 const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state,
2669 CopyCommandVersion version) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002670 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002671 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2672 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2673 const char *vuid;
Dave Houlton6f9059e2017-05-02 17:15:13 -06002674
2675 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002676 const ImageCopyRegionType region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002677
2678 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002679 const VkExtent3D src_copy_extent = region.extent;
2680 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002681 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2682
Dave Houlton6f9059e2017-05-02 17:15:13 -06002683 bool slice_override = false;
2684 uint32_t depth_slices = 0;
2685
2686 // Special case for copying between a 1D/2D array and a 3D image
2687 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2688 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002689 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002690 slice_override = (depth_slices != 1);
2691 } else if ((VK_IMAGE_TYPE_3D == dst_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != src_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002692 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002693 slice_override = (depth_slices != 1);
2694 }
2695
2696 // Do all checks on source image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002697 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002698 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002699 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00146" : "VUID-vkCmdCopyImage-srcImage-00146";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002700 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002701 "%s: pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2702 "be 0 and 1, respectively.",
2703 func_name, i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002704 }
2705 }
2706
Dave Houlton533be9f2018-03-26 17:08:30 -06002707 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002708 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01785" : "VUID-vkCmdCopyImage-srcImage-01785";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002709 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002710 "%s: pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002711 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002712 func_name, i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002713 }
2714
Dave Houlton533be9f2018-03-26 17:08:30 -06002715 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002716 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01787" : "VUID-vkCmdCopyImage-srcImage-01787";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002717 skip |= LogError(src_state->image(), vuid, "%s: pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002718 func_name, i, region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002719 }
2720
Dave Houltonc991cc92018-03-06 11:08:51 -07002721 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002722 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002723 if (FormatIsCompressed(src_state->createInfo.format) ||
2724 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002725 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002726 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002727 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2728 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2729 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002730 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01727" : "VUID-vkCmdCopyImage-srcImage-01727";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002731 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002732 "%s: pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002733 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002734 func_name, i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002735 }
2736
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002737 const VkExtent3D mip_extent = src_state->GetSubresourceExtent(region.srcSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07002738 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2739 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002740 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01728" : "VUID-vkCmdCopyImage-srcImage-01728";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002741 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002742 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2743 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2744 func_name, i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002745 }
2746
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002747 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002748 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2749 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002750 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01729" : "VUID-vkCmdCopyImage-srcImage-01729";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002751 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002752 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2753 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2754 func_name, i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002755 }
2756
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002757 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002758 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2759 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002760 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01730" : "VUID-vkCmdCopyImage-srcImage-01730";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002761 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002762 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2763 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2764 func_name, i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002765 }
2766 } // Compressed
2767
2768 // Do all checks on dest image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002769 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002770 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002771 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00152" : "VUID-vkCmdCopyImage-dstImage-00152";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002772 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002773 "%s: pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002774 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002775 func_name, i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002776 }
2777 }
2778
Dave Houlton533be9f2018-03-26 17:08:30 -06002779 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 -04002780 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01786" : "VUID-vkCmdCopyImage-dstImage-01786";
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] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2783 "and 1, respectively.",
2784 func_name, i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002785 }
2786
Dave Houlton533be9f2018-03-26 17:08:30 -06002787 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002788 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01788" : "VUID-vkCmdCopyImage-dstImage-01788";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002789 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 -04002790 func_name, i, region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002791 }
2792
sfricke-samsung30b094c2020-05-30 11:42:11 -07002793 // Handle difference between Maintenance 1
sfricke-samsung45996a42021-09-16 13:45:27 -07002794 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002795 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2796 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002797 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-04443" : "VUID-vkCmdCopyImage-srcImage-04443";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002798 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002799 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2800 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2801 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002802 }
2803 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002804 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002805 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002806 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-04444" : "VUID-vkCmdCopyImage-dstImage-04444";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002807 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002808 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2809 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2810 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002811 }
2812 }
2813 } else { // Pre maint 1
2814 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002815 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002816 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002817 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002818 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and "
sfricke-samsung30b094c2020-05-30 11:42:11 -07002819 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2820 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002821 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002822 }
Dave Houltonee281a52017-12-08 13:51:02 -07002823 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002824 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002825 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002826 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002827 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2828 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002829 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002830 }
2831 }
2832 }
2833
Dave Houltonc991cc92018-03-06 11:08:51 -07002834 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2835 if (FormatIsCompressed(dst_state->createInfo.format) ||
2836 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002837 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002838
2839 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002840 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2841 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2842 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002843 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01731" : "VUID-vkCmdCopyImage-dstImage-01731";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002844 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002845 "%s: pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002846 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002847 func_name, i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002848 }
2849
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002850 const VkExtent3D mip_extent = dst_state->GetSubresourceExtent(region.dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07002851 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2852 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002853 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01732" : "VUID-vkCmdCopyImage-dstImage-01732";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002854 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002855 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2856 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2857 func_name, i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002858 }
2859
Dave Houltonee281a52017-12-08 13:51:02 -07002860 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2861 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2862 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002863 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01733" : "VUID-vkCmdCopyImage-dstImage-01733";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002864 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002865 "%s: pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002866 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2867 "height (%d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002868 func_name, i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002869 }
2870
Dave Houltonee281a52017-12-08 13:51:02 -07002871 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2872 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2873 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002874 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01734" : "VUID-vkCmdCopyImage-dstImage-01734";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002875 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002876 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2877 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2878 func_name, i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002879 }
2880 } // Compressed
2881 }
2882 return skip;
2883}
2884
Jeff Leger178b1e52020-10-05 12:22:23 -04002885template <typename RegionType>
2886bool CoreChecks::ValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2887 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2888 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002889 const auto *cb_node = GetCBState(commandBuffer);
2890 const auto *src_image_state = GetImageState(srcImage);
2891 const auto *dst_image_state = GetImageState(dstImage);
sfricke-samsungdce5f692020-03-07 13:59:31 -08002892 const VkFormat src_format = src_image_state->createInfo.format;
2893 const VkFormat dst_format = dst_image_state->createInfo.format;
Jeff Leger178b1e52020-10-05 12:22:23 -04002894 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002895 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002896
Jeff Leger178b1e52020-10-05 12:22:23 -04002897 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGE2KHR : CMD_COPYIMAGE;
sfricke-samsung85584a72021-09-30 21:43:38 -07002898 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04002899 const char *vuid;
2900
2901 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state, version);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002902
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002903 VkCommandBuffer command_buffer = cb_node->commandBuffer();
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002904
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002905 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002906 const RegionType region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002907
2908 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2909 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08002910 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07002911
Dave Houlton6f9059e2017-05-02 17:15:13 -06002912 bool slice_override = false;
2913 uint32_t depth_slices = 0;
2914
2915 // Special case for copying between a 1D/2D array and a 3D image
2916 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2917 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2918 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002919 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002920 slice_override = (depth_slices != 1);
2921 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2922 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002923 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002924 slice_override = (depth_slices != 1);
2925 }
2926
Jeff Leger178b1e52020-10-05 12:22:23 -04002927 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, func_name, "srcSubresource", i);
2928 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, func_name, "dstSubresource", i);
2929 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01696" : "VUID-vkCmdCopyImage-srcSubresource-01696";
2930 skip |=
2931 ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
2932 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01697" : "VUID-vkCmdCopyImage-dstSubresource-01697";
2933 skip |=
2934 ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
2935 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01698" : "VUID-vkCmdCopyImage-srcSubresource-01698";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002936 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002937 region.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
2938 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01699" : "VUID-vkCmdCopyImage-dstSubresource-01699";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002939 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002940 region.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002941
sfricke-samsung45996a42021-09-16 13:45:27 -07002942 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002943 // No chance of mismatch if we're overriding depth slice count
2944 if (!slice_override) {
2945 // The number of depth slices in srcSubresource and dstSubresource must match
2946 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2947 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002948 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2949 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002950 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002951 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2952 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002953 if (src_slices != dst_slices) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002954 vuid = is_2khr ? "VUID-VkImageCopy2KHR-extent-00140" : "VUID-VkImageCopy-extent-00140";
2955 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002956 "%s: number of depth slices in source (%u) and destination (%u) subresources for pRegions[%u] "
2957 "do not match.",
2958 func_name, src_slices, dst_slices, i);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002959 }
2960 }
2961 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002962 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002963 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002964 vuid = is_2khr ? "VUID-VkImageCopy2KHR-layerCount-00138" : "VUID-VkImageCopy-layerCount-00138";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002965 skip |=
2966 LogError(command_buffer, vuid,
2967 "%s: number of layers in source (%u) and destination (%u) subresources for pRegions[%u] do not match",
2968 func_name, region.srcSubresource.layerCount, region.dstSubresource.layerCount, i);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002969 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002970 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002971
Dave Houltonc991cc92018-03-06 11:08:51 -07002972 // Do multiplane-specific checks, if extension enabled
sfricke-samsung45996a42021-09-16 13:45:27 -07002973 if (IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)) {
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002974 if ((!FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format))) {
2975 // If neither image is multi-plane the aspectMask member of src and dst must match
2976 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2977 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01551" : "VUID-vkCmdCopyImage-srcImage-01551";
2978 skip |= LogError(command_buffer, vuid,
2979 "%s: Copy between non-multiplane images with differing aspectMasks in pRegions[%u] with "
2980 "source (0x%x) destination (0x%x).",
2981 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
2982 }
2983 } else {
2984 // Source image multiplane checks
2985 uint32_t planes = FormatPlaneCount(src_format);
2986 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2987 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
2988 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01552" : "VUID-vkCmdCopyImage-srcImage-01552";
2989 skip |= LogError(command_buffer, vuid,
2990 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
2991 i, aspect);
2992 }
2993 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
2994 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
2995 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01553" : "VUID-vkCmdCopyImage-srcImage-01553";
2996 skip |= LogError(command_buffer, vuid,
2997 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
2998 i, aspect);
2999 }
3000 // Single-plane to multi-plane
3001 if ((!FormatIsMultiplane(src_format)) && (FormatIsMultiplane(dst_format)) &&
3002 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
3003 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01557" : "VUID-vkCmdCopyImage-dstImage-01557";
3004 skip |= LogError(command_buffer, vuid,
3005 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
3006 func_name, i, aspect);
3007 }
Dave Houltonc991cc92018-03-06 11:08:51 -07003008
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003009 // Dest image multiplane checks
3010 planes = FormatPlaneCount(dst_format);
3011 aspect = region.dstSubresource.aspectMask;
3012 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
3013 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01554" : "VUID-vkCmdCopyImage-dstImage-01554";
3014 skip |= LogError(command_buffer, vuid,
3015 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
3016 i, aspect);
3017 }
3018 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
3019 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
3020 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01555" : "VUID-vkCmdCopyImage-dstImage-01555";
3021 skip |= LogError(command_buffer, vuid,
3022 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
3023 i, aspect);
3024 }
3025 // Multi-plane to single-plane
3026 if ((FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format)) &&
3027 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
3028 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01556" : "VUID-vkCmdCopyImage-srcImage-01556";
3029 skip |= LogError(command_buffer, vuid,
3030 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
3031 func_name, i, aspect);
3032 }
3033 }
3034 } else {
3035 // !vk_khr_sampler_ycbcr_conversion
Dave Houltonf5217612018-02-02 16:18:52 -07003036 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
3037 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003038 vuid = is_2khr ? "VUID-VkImageCopy2KHR-aspectMask-00137" : "VUID-VkImageCopy-aspectMask-00137";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003039 skip |= LogError(
3040 command_buffer, vuid,
3041 "%s: Copy between images with differing aspectMasks in pRegions[%u] with source (0x%x) destination (0x%x).",
3042 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
Dave Houltonf5217612018-02-02 16:18:52 -07003043 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003044 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003045
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003046 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08003047 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003048 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00142" : "VUID-vkCmdCopyImage-aspectMask-00142";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003049 skip |=
3050 LogError(command_buffer, vuid,
3051 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) cannot specify aspects not present in source image.",
3052 func_name, i, region.srcSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003053 }
3054
3055 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08003056 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003057 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00143" : "VUID-vkCmdCopyImage-aspectMask-00143";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003058 skip |= LogError(
3059 command_buffer, vuid,
3060 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) cannot specify aspects not present in destination image.",
3061 func_name, i, region.dstSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003062 }
3063
Dave Houltonfc1a4052017-04-27 14:32:45 -06003064 // Each dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003065 VkExtent3D subresource_extent = src_image_state->GetSubresourceExtent(region.srcSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07003066 if (slice_override) src_copy_extent.depth = depth_slices;
3067 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003068 if (extent_check & kXBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003069 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00144" : "VUID-vkCmdCopyImage-srcOffset-00144";
3070 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003071 "%s: Source image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003072 "width [%1d].",
3073 func_name, i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003074 }
3075
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003076 if (extent_check & kYBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003077 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00145" : "VUID-vkCmdCopyImage-srcOffset-00145";
3078 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003079 "%s: Source image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003080 "height [%1d].",
3081 func_name, i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003082 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003083 if (extent_check & kZBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003084 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00147" : "VUID-vkCmdCopyImage-srcOffset-00147";
3085 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003086 "%s: Source image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003087 "depth [%1d].",
3088 func_name, i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003089 }
3090
Dave Houltonee281a52017-12-08 13:51:02 -07003091 // Adjust dest extent if necessary
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003092 subresource_extent = dst_image_state->GetSubresourceExtent(region.dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07003093 if (slice_override) dst_copy_extent.depth = depth_slices;
3094
3095 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003096 if (extent_check & kXBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003097 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00150" : "VUID-vkCmdCopyImage-dstOffset-00150";
3098 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003099 "%s: Dest image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003100 "width [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003101 func_name, i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003102 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003103 if (extent_check & kYBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003104 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00151" : "VUID-vkCmdCopyImage-dstOffset-00151";
3105 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003106 "%s): Dest image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003107 "height [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003108 func_name, i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003109 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003110 if (extent_check & kZBit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003111 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00153" : "VUID-vkCmdCopyImage-dstOffset-00153";
3112 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003113 "%s: Dest image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003114 "depth [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003115 func_name, i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003116 }
3117
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003118 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
3119 // must not overlap in memory
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003120 if (src_image_state->image() == dst_image_state->image()) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003121 for (uint32_t j = 0; j < regionCount; j++) {
3122 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
sfricke-samsungdce5f692020-03-07 13:59:31 -08003123 FormatIsMultiplane(src_format))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003124 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-pRegions-00124" : "VUID-vkCmdCopyImage-pRegions-00124";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003125 skip |= LogError(command_buffer, vuid, "%s: pRegion[%u] src overlaps with pRegions[%u].", func_name, i, j);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003126 }
3127 }
3128 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08003129
3130 // 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 -07003131 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
sfricke-samsung48172ca2020-02-13 23:38:11 -08003132 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3133 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3134 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003135 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01790" : "VUID-vkCmdCopyImage-srcImage-01790";
3136 skip |= LogError(command_buffer, vuid,
3137 "%s: pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1",
3138 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003139 }
3140 } else {
3141 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
3142 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3143 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003144 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01789" : "VUID-vkCmdCopyImage-srcImage-01789";
3145 skip |= LogError(command_buffer, vuid,
3146 "%s: pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1",
3147 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003148 }
3149 }
3150
3151 // Check if 2D with 3D and depth not equal to 2D layerCount
3152 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3153 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
3154 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003155 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01791" : "VUID-vkCmdCopyImage-srcImage-01791";
3156 skip |= LogError(command_buffer, vuid,
3157 "%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 -08003158 "srcSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003159 func_name, i, src_copy_extent.depth, region.srcSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003160 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
3161 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
3162 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003163 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01792" : "VUID-vkCmdCopyImage-dstImage-01792";
3164 skip |= LogError(command_buffer, vuid,
3165 "%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 -08003166 "dstSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003167 func_name, i, src_copy_extent.depth, region.dstSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003168 }
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003169
3170 // Check for multi-plane format compatiblity
3171 if (FormatIsMultiplane(src_format) || FormatIsMultiplane(dst_format)) {
sfricke-samsung73e755c2021-09-30 08:34:57 -07003172 const VkFormat src_plane_format = FormatIsMultiplane(src_format)
3173 ? FindMultiplaneCompatibleFormat(src_format, region.srcSubresource.aspectMask)
3174 : src_format;
3175 const VkFormat dst_plane_format = FormatIsMultiplane(dst_format)
3176 ? FindMultiplaneCompatibleFormat(dst_format, region.dstSubresource.aspectMask)
3177 : dst_format;
3178 const size_t src_format_size = FormatElementSize(src_plane_format);
3179 const size_t dst_format_size = FormatElementSize(dst_plane_format);
3180
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003181 // If size is still zero, then format is invalid and will be caught in another VU
3182 if ((src_format_size != dst_format_size) && (src_format_size != 0) && (dst_format_size != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003183 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-None-01549" : "VUID-vkCmdCopyImage-None-01549";
3184 skip |= LogError(command_buffer, vuid,
3185 "%s: pRegions[%u] called with non-compatible image formats. "
3186 "The src format %s with aspectMask %s is not compatible with dst format %s aspectMask %s.",
3187 func_name, i, string_VkFormat(src_format),
3188 string_VkImageAspectFlags(region.srcSubresource.aspectMask).c_str(), string_VkFormat(dst_format),
3189 string_VkImageAspectFlags(region.dstSubresource.aspectMask).c_str());
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003190 }
3191 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003192 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003193
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003194 // The formats of non-multiplane src_image and dst_image must be compatible. Formats are considered compatible if their texel
3195 // size in bytes is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT
3196 // because because both texels are 4 bytes in size.
3197 if (!FormatIsMultiplane(src_format) && !FormatIsMultiplane(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003198 const char *compatible_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003199 IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
Jeff Leger178b1e52020-10-05 12:22:23 -04003200 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01548" : "VUID-vkCmdCopyImage-srcImage-01548")
3201 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00135" : "VUID-vkCmdCopyImage-srcImage-00135");
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003202 // Depth/stencil formats must match exactly.
3203 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3204 if (src_format != dst_format) {
3205 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003206 "%s: Depth/stencil formats must match exactly for src (%s) and dst (%s).", func_name,
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003207 string_VkFormat(src_format), string_VkFormat(dst_format));
3208 }
3209 } else {
Jeff Leger178b1e52020-10-05 12:22:23 -04003210 if (FormatElementSize(src_format) != FormatElementSize(dst_format)) {
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003211 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003212 "%s: Unmatched image format sizes. "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06003213 "The src format %s has size of %" PRIu32 " and dst format %s has size of %" PRIu32 ".",
Jeff Leger178b1e52020-10-05 12:22:23 -04003214 func_name, string_VkFormat(src_format), FormatElementSize(src_format), string_VkFormat(dst_format),
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003215 FormatElementSize(dst_format));
3216 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003217 }
3218 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003219
Dave Houlton33c22b72017-02-28 13:16:02 -07003220 // Source and dest image sample counts must match
3221 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003222 std::stringstream ss;
3223 ss << func_name << " called on image pair with non-identical sample counts.";
3224 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00136" : "VUID-vkCmdCopyImage-srcImage-00136";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003225 skip |=
3226 LogError(command_buffer, vuid, "%s: The src image sample count (%s) dose not match the dst image sample count (%s).",
3227 func_name, string_VkSampleCountFlagBits(src_image_state->createInfo.samples),
3228 string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Dave Houlton33c22b72017-02-28 13:16:02 -07003229 }
3230
sfricke-samsung45996a42021-09-16 13:45:27 -07003231 vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
Tony-LunarG5a066372021-01-21 10:31:34 -07003232 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01546" : "VUID-vkCmdCopyImage-srcImage-01546")
3233 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00127" : "VUID-vkCmdCopyImage-srcImage-00127");
Jeff Leger178b1e52020-10-05 12:22:23 -04003234 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
sfricke-samsung45996a42021-09-16 13:45:27 -07003235 vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
Tony-LunarG5a066372021-01-21 10:31:34 -07003236 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01547" : "VUID-vkCmdCopyImage-dstImage-01547")
3237 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00132" : "VUID-vkCmdCopyImage-dstImage-00132");
3238 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003239 // Validate that SRC & DST images have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04003240 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00126" : "VUID-vkCmdCopyImage-srcImage-00126";
3241 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3242 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3243 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00131" : "VUID-vkCmdCopyImage-dstImage-00131";
3244 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3245 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3246 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01825" : "VUID-vkCmdCopyImage-commandBuffer-01825";
3247 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3248 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01826" : "VUID-vkCmdCopyImage-commandBuffer-01826";
3249 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3250 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01827" : "VUID-vkCmdCopyImage-commandBuffer-01827";
3251 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003252
3253 // Validation for VK_EXT_fragment_density_map
3254 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003255 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3256 skip |=
3257 LogError(command_buffer, vuid,
3258 "%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 +02003259 }
3260 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003261 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3262 skip |=
3263 LogError(command_buffer, vuid,
3264 "%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 +02003265 }
3266
sfricke-samsung45996a42021-09-16 13:45:27 -07003267 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003268 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01995" : "VUID-vkCmdCopyImage-srcImage-01995";
3269 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
3270 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01996" : "VUID-vkCmdCopyImage-dstImage-01996";
3271 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003272 }
sfricke-samsung85584a72021-09-30 21:43:38 -07003273 skip |= ValidateCmd(cb_node, cmd_type);
Tobin Ehlisc8266452017-04-07 12:20:30 -06003274 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04003275
3276 const char *invalid_src_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003277 (src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003278 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-01917" : "VUID-vkCmdCopyImage-srcImageLayout-01917")
3279 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00129" : "VUID-vkCmdCopyImage-srcImageLayout-00129");
3280 const char *invalid_dst_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003281 (dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003282 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-01395" : "VUID-vkCmdCopyImage-dstImageLayout-01395")
3283 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00134" : "VUID-vkCmdCopyImage-dstImageLayout-00134");
3284
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003285 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003286 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00128" : "VUID-vkCmdCopyImage-srcImageLayout-00128";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003287 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003288 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3289 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00133" : "VUID-vkCmdCopyImage-dstImageLayout-00133";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003290 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003291 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003292 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003293 func_name, version);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003294 }
3295
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003296 return skip;
3297}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003298
Jeff Leger178b1e52020-10-05 12:22:23 -04003299bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3300 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3301 const VkImageCopy *pRegions) const {
3302 return ValidateCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3303 COPY_COMMAND_VERSION_1);
3304}
3305
3306bool CoreChecks::PreCallValidateCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) const {
3307 return ValidateCmdCopyImage(commandBuffer, pCopyImageInfo->srcImage, pCopyImageInfo->srcImageLayout, pCopyImageInfo->dstImage,
3308 pCopyImageInfo->dstImageLayout, pCopyImageInfo->regionCount, pCopyImageInfo->pRegions,
3309 COPY_COMMAND_VERSION_2);
3310}
3311
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003312void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3313 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3314 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003315 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3316 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003317 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003318 auto src_image_state = GetImageState(srcImage);
3319 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003320
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003321 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003322 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06003323 cb_node->SetImageInitialLayout(*src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3324 cb_node->SetImageInitialLayout(*dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003325 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003326}
3327
Jeff Leger178b1e52020-10-05 12:22:23 -04003328void CoreChecks::PreCallRecordCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) {
3329 StateTracker::PreCallRecordCmdCopyImage2KHR(commandBuffer, pCopyImageInfo);
3330 auto cb_node = GetCBState(commandBuffer);
3331 auto src_image_state = GetImageState(pCopyImageInfo->srcImage);
3332 auto dst_image_state = GetImageState(pCopyImageInfo->dstImage);
3333
3334 // Make sure that all image slices are updated to correct layout
3335 for (uint32_t i = 0; i < pCopyImageInfo->regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06003336 cb_node->SetImageInitialLayout(*src_image_state, pCopyImageInfo->pRegions[i].srcSubresource,
3337 pCopyImageInfo->srcImageLayout);
3338 cb_node->SetImageInitialLayout(*dst_image_state, pCopyImageInfo->pRegions[i].dstSubresource,
3339 pCopyImageInfo->dstImageLayout);
Jeff Leger178b1e52020-10-05 12:22:23 -04003340 }
3341}
3342
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003343// Returns true if sub_rect is entirely contained within rect
3344static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
3345 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 -07003346 (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 -07003347 return false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003348 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003349 return true;
3350}
3351
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003352bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003353 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
locke-lunargfc78e932020-11-19 17:06:24 -07003354 const VkRect2D &render_area, uint32_t rect_count, const VkClearRect *clear_rects,
3355 const CMD_BUFFER_STATE *primary_cb_state) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07003356 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07003357 const IMAGE_VIEW_STATE *image_view_state = nullptr;
3358 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06003359 if (primary_cb_state) {
3360 image_view_state = primary_cb_state->GetActiveAttachmentImageViewState(fb_attachment);
3361 } else {
3362 image_view_state = GetCBState(command_buffer)->GetActiveAttachmentImageViewState(fb_attachment);
3363 }
John Zulauff2582972019-02-09 14:53:30 -07003364 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003365
3366 for (uint32_t j = 0; j < rect_count; j++) {
3367 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003368 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00016",
3369 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
3370 "the current render pass instance.",
3371 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07003372 }
3373
3374 if (image_view_state) {
3375 // The layers specified by a given element of pRects must be contained within every attachment that
3376 // pAttachments refers to
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06003377 const auto attachment_layer_count = image_view_state->normalized_subresource_range.layerCount;
John Zulauf3a548ef2019-02-01 16:14:07 -07003378 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
3379 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003380 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00017",
3381 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
3382 "of pAttachment[%d].",
3383 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07003384 }
3385 }
3386 }
3387 return skip;
3388}
3389
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003390bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3391 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003392 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003393 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06003394 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02003395 if (!cb_node) return skip;
3396
sfricke-samsung85584a72021-09-30 21:43:38 -07003397 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003398
3399 // Validate that attachment is in reference list of active subpass
3400 if (cb_node->activeRenderPass) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08003401 const VkRenderPassCreateInfo2 *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07003402 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Mike Schuchardt2df08912020-12-15 16:28:09 -08003403 const VkSubpassDescription2 *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
locke-lunargaecf2152020-05-12 17:15:41 -06003404 const auto *framebuffer = cb_node->activeFramebuffer.get();
John Zulauf3a548ef2019-02-01 16:14:07 -07003405 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003406
John Zulauf3a548ef2019-02-01 16:14:07 -07003407 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3408 auto clear_desc = &pAttachments[attachment_index];
3409 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003410 const VkImageAspectFlags aspect_mask = clear_desc->aspectMask;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003411
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003412 if (aspect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
3413 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020",
3414 "vkCmdClearAttachments() pAttachments[%u] mask contains VK_IMAGE_ASPECT_METADATA_BIT",
3415 attachment_index);
3416 } else if (aspect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
3417 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
3418 skip |=
3419 LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-02246",
3420 "vkCmdClearAttachments() pAttachments[%u] mask contains a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit",
3421 attachment_index);
3422 } else if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07003423 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
3424 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
3425 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3426 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003427 skip |= LogError(
3428 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3429 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
3430 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
3431 attachment_index, clear_desc->colorAttachment,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003432 report_data->FormatHandle(cb_node->activeRenderPass->renderPass()).c_str(), cb_node->activeSubpass,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003433 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07003434
John Zulauff2582972019-02-09 14:53:30 -07003435 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
3436 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003437 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003438 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3439 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
3440 " subpass %u. colorAttachmentCount=%u",
3441 attachment_index, clear_desc->colorAttachment,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003442 report_data->FormatHandle(cb_node->activeRenderPass->renderPass()).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003443 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003444 }
John Zulauff2582972019-02-09 14:53:30 -07003445 fb_attachment = color_attachment;
3446
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003447 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
3448 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
3449 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019",
3450 "vkCmdClearAttachments() pAttachments[%u] aspectMask must set only VK_IMAGE_ASPECT_COLOR_BIT "
3451 "of a color attachment.",
3452 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003453 }
3454 } else { // Must be depth and/or stencil
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003455 bool subpass_depth = false;
3456 bool subpass_stencil = false;
3457 if (subpass_desc->pDepthStencilAttachment &&
3458 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3459 auto index = subpass_desc->pDepthStencilAttachment->attachment;
3460 subpass_depth = FormatHasDepth(renderpass_create_info->pAttachments[index].format);
3461 subpass_stencil = FormatHasStencil(renderpass_create_info->pAttachments[index].format);
3462 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003463 if (!subpass_desc->pDepthStencilAttachment ||
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003464 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3465 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) && !subpass_depth) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003466 skip |= LogError(
3467 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02502",
3468 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_DEPTH_BIT but there is no "
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003469 "depth attachment in subpass",
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003470 attachment_index);
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003471 }
3472 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) && !subpass_stencil) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003473 skip |= LogError(
3474 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02503",
3475 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_STENCIL_BIT but there is no "
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003476 "stencil attachment in subpass",
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003477 attachment_index);
3478 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003479 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07003480 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003481 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08003482 if (subpass_depth) {
3483 skip |= ValidateClearDepthStencilValue(commandBuffer, clear_desc->clearValue.depthStencil,
3484 "vkCmdClearAttachments()");
3485 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003486 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003487 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003488 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3489 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06003490 }
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003491
3492 // Once the framebuffer attachment is found, can get the image view state
3493 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) &&
3494 (fb_attachment < framebuffer->createInfo.attachmentCount)) {
3495 const IMAGE_VIEW_STATE *image_view_state =
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06003496 GetCBState(commandBuffer)->GetActiveAttachmentImageViewState(fb_attachment);
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003497 if (image_view_state != nullptr) {
3498 skip |= ValidateProtectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3499 "VUID-vkCmdClearAttachments-commandBuffer-02504");
3500 skip |= ValidateUnprotectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3501 "VUID-vkCmdClearAttachments-commandBuffer-02505");
3502 }
3503 }
John Zulauf441558b2019-08-12 11:47:39 -06003504 }
ziga-lunargfa335aa2021-08-05 16:59:39 +02003505
3506 // When a subpass uses a non-zero view mask, multiview functionality is considered to be enabled
3507 if (subpass_desc->viewMask > 0) {
3508 for (uint32_t i = 0; i < rectCount; ++i) {
3509 if (pRects[i].baseArrayLayer != 0 || pRects[i].layerCount != 1) {
3510 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-baseArrayLayer-00018",
3511 "vkCmdClearAttachments(): pRects[%" PRIu32 "] baseArrayLayer is %" PRIu32
3512 " and layerCount is %" PRIu32 ", but the render pass instance uses multiview.",
3513 i, pRects[i].baseArrayLayer, pRects[i].layerCount);
3514 }
3515 }
3516 }
John Zulauf441558b2019-08-12 11:47:39 -06003517 }
3518 return skip;
3519}
3520
3521void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3522 const VkClearAttachment *pAttachments, uint32_t rectCount,
3523 const VkClearRect *pRects) {
3524 auto *cb_node = GetCBState(commandBuffer);
3525 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08003526 const VkRenderPassCreateInfo2 *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3527 const VkSubpassDescription2 *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
John Zulauf441558b2019-08-12 11:47:39 -06003528 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
3529 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3530 const auto clear_desc = &pAttachments[attachment_index];
3531 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3532 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3533 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3534 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3535 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3536 subpass_desc->pDepthStencilAttachment) {
3537 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3538 }
3539 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003540 if (!clear_rect_copy) {
3541 // We need a copy of the clear rectangles that will persist until the last lambda executes
3542 // but we want to create it as lazily as possible
3543 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003544 }
John Zulauf441558b2019-08-12 11:47:39 -06003545 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3546 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003547 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
locke-lunargaecf2152020-05-12 17:15:41 -06003548 const CMD_BUFFER_STATE *prim_cb, const FRAMEBUFFER_STATE *fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003549 assert(rectCount == clear_rect_copy->size());
John Zulauf3a548ef2019-02-01 16:14:07 -07003550 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3551 bool skip = false;
locke-lunargaecf2152020-05-12 17:15:41 -06003552 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, fb, fb_attachment, render_area, rectCount,
locke-lunargfc78e932020-11-19 17:06:24 -07003553 clear_rect_copy->data(), prim_cb);
John Zulauf3a548ef2019-02-01 16:14:07 -07003554 return skip;
3555 };
3556 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003557 }
3558 }
3559 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003560}
3561
Jeff Leger178b1e52020-10-05 12:22:23 -04003562template <typename RegionType>
3563bool CoreChecks::ValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3564 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3565 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003566 const auto *cb_node = GetCBState(commandBuffer);
3567 const auto *src_image_state = GetImageState(srcImage);
3568 const auto *dst_image_state = GetImageState(dstImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04003569 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
sfricke-samsung85584a72021-09-30 21:43:38 -07003570 const CMD_TYPE cmd_type = is_2khr ? CMD_RESOLVEIMAGE2KHR : CMD_RESOLVEIMAGE;
3571 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04003572 const char *vuid;
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003573
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003574 bool skip = false;
3575 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003576 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00256" : "VUID-vkCmdResolveImage-srcImage-00256";
3577 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3578 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00258" : "VUID-vkCmdResolveImage-dstImage-00258";
3579 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
sfricke-samsung85584a72021-09-30 21:43:38 -07003580 skip |= ValidateCmd(cb_node, cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04003581 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02003" : "VUID-vkCmdResolveImage-dstImage-02003";
3582 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, func_name, vuid);
3583 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01837" : "VUID-vkCmdResolveImage-commandBuffer-01837";
3584 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3585 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01838" : "VUID-vkCmdResolveImage-commandBuffer-01838";
3586 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3587 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01839" : "VUID-vkCmdResolveImage-commandBuffer-01839";
3588 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003589
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003590 // Validation for VK_EXT_fragment_density_map
3591 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003592 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003593 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003594 "%s: srcImage must not have been created with flags containing "
3595 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3596 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003597 }
3598 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003599 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003600 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003601 "%s: dstImage must not have been created with flags containing "
3602 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3603 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003604 }
3605
Cort Stratton7df30962018-05-17 19:45:57 -07003606 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003607 const char *invalid_src_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003608 is_2khr ? ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003609 ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-01400"
Shannon McPhersonc505df62020-10-20 16:27:11 -06003610 : "VUID-VkResolveImageInfo2KHR-srcImageLayout-00261")
sfricke-samsung45996a42021-09-16 13:45:27 -07003611 : ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003612 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3613 : "VUID-vkCmdResolveImage-srcImageLayout-00261");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003614 const char *invalid_dst_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003615 is_2khr ? ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003616 ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-01401"
3617 : "VUID-VkResolveImageInfo2KHR-dstImageLayout-00263")
sfricke-samsung45996a42021-09-16 13:45:27 -07003618 : ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003619 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3620 : "VUID-vkCmdResolveImage-dstImageLayout-00263");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003621 // For each region, the number of layers in the image subresource should not be zero
3622 // For each region, src and dest image aspect must be color only
3623 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003624 const RegionType region = pRegions[i];
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003625 const VkImageSubresourceLayers src_subresource = region.srcSubresource;
3626 const VkImageSubresourceLayers dst_subresource = region.dstSubresource;
Jeff Leger178b1e52020-10-05 12:22:23 -04003627 skip |= ValidateImageSubresourceLayers(cb_node, &src_subresource, func_name, "srcSubresource", i);
3628 skip |= ValidateImageSubresourceLayers(cb_node, &dst_subresource, func_name, "dstSubresource", i);
3629 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-00260" : "VUID-vkCmdResolveImage-srcImageLayout-00260";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003630 skip |= VerifyImageLayout(cb_node, src_image_state, src_subresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003631 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3632 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-00262" : "VUID-vkCmdResolveImage-dstImageLayout-00262";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003633 skip |= VerifyImageLayout(cb_node, dst_image_state, dst_subresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003634 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
3635 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01709" : "VUID-vkCmdResolveImage-srcSubresource-01709";
3636 skip |= ValidateImageMipLevel(cb_node, src_image_state, src_subresource.mipLevel, i, func_name, "srcSubresource", vuid);
3637 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01710" : "VUID-vkCmdResolveImage-dstSubresource-01710";
3638 skip |= ValidateImageMipLevel(cb_node, dst_image_state, dst_subresource.mipLevel, i, func_name, "dstSubresource", vuid);
3639 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01711" : "VUID-vkCmdResolveImage-srcSubresource-01711";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003640 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, src_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003641 src_subresource.layerCount, i, func_name, "srcSubresource", vuid);
3642 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01712" : "VUID-vkCmdResolveImage-dstSubresource-01712";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003643 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, dst_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003644 dst_subresource.layerCount, i, func_name, "srcSubresource", vuid);
Cort Stratton7df30962018-05-17 19:45:57 -07003645
3646 // layer counts must match
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003647 if (src_subresource.layerCount != dst_subresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003648 vuid = is_2khr ? "VUID-VkImageResolve2KHR-layerCount-00267" : "VUID-VkImageResolve-layerCount-00267";
3649 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003650 LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003651 "%s: layerCount in source and destination subresource of pRegions[%u] does not match.", func_name, i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003652 }
Cort Stratton7df30962018-05-17 19:45:57 -07003653 // For each region, src and dest image aspect must be color only
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003654 if ((src_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3655 (dst_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003656 vuid = is_2khr ? "VUID-VkImageResolve2KHR-aspectMask-00266" : "VUID-VkImageResolve-aspectMask-00266";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003657 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003658 "%s: src and dest aspectMasks for pRegions[%u] must specify only VK_IMAGE_ASPECT_COLOR_BIT.",
3659 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003660 }
3661
3662 const VkImageType src_image_type = src_image_state->createInfo.imageType;
3663 const VkImageType dst_image_type = dst_image_state->createInfo.imageType;
3664
3665 if ((VK_IMAGE_TYPE_3D == src_image_type) || (VK_IMAGE_TYPE_3D == dst_image_type)) {
Shannon McPherson74b341c2020-09-08 15:43:05 -06003666 if ((0 != src_subresource.baseArrayLayer) || (1 != src_subresource.layerCount)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003667 LogObjectList objlist(cb_node->commandBuffer());
3668 objlist.add(src_image_state->image());
3669 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003670 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04446" : "VUID-vkCmdResolveImage-srcImage-04446";
3671 skip |= LogError(objlist, vuid,
3672 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
Shannon McPherson74b341c2020-09-08 15:43:05 -06003673 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003674 func_name, i);
Shannon McPherson74b341c2020-09-08 15:43:05 -06003675 }
3676 if ((0 != dst_subresource.baseArrayLayer) || (1 != dst_subresource.layerCount)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003677 LogObjectList objlist(cb_node->commandBuffer());
3678 objlist.add(src_image_state->image());
3679 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003680 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04447" : "VUID-vkCmdResolveImage-srcImage-04447";
3681 skip |= LogError(objlist, vuid,
3682 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003683 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003684 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003685 }
3686 }
3687
3688 if (VK_IMAGE_TYPE_1D == src_image_type) {
3689 if ((pRegions[i].srcOffset.y != 0) || (pRegions[i].extent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003690 LogObjectList objlist(cb_node->commandBuffer());
3691 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003692 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00271" : "VUID-vkCmdResolveImage-srcImage-00271";
3693 skip |= LogError(objlist, vuid,
3694 "%s: srcImage (%s) is 1D but pRegions[%u] srcOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003695 "extent.height (%u) is not 1.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003696 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003697 pRegions[i].srcOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003698 }
3699 }
3700 if ((VK_IMAGE_TYPE_1D == src_image_type) || (VK_IMAGE_TYPE_2D == src_image_type)) {
3701 if ((pRegions[i].srcOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003702 LogObjectList objlist(cb_node->commandBuffer());
3703 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003704 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00273" : "VUID-vkCmdResolveImage-srcImage-00273";
3705 skip |= LogError(objlist, vuid,
3706 "%s: srcImage (%s) is 2D but pRegions[%u] srcOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003707 "extent.depth (%u) is not 1.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003708 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003709 pRegions[i].srcOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003710 }
3711 }
3712
3713 if (VK_IMAGE_TYPE_1D == dst_image_type) {
3714 if ((pRegions[i].dstOffset.y != 0) || (pRegions[i].extent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003715 LogObjectList objlist(cb_node->commandBuffer());
3716 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003717 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00276" : "VUID-vkCmdResolveImage-dstImage-00276";
3718 skip |= LogError(objlist, vuid,
3719 "%s: dstImage (%s) is 1D but pRegions[%u] dstOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003720 "extent.height (%u) is not 1.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003721 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003722 pRegions[i].dstOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003723 }
3724 }
3725 if ((VK_IMAGE_TYPE_1D == dst_image_type) || (VK_IMAGE_TYPE_2D == dst_image_type)) {
3726 if ((pRegions[i].dstOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003727 LogObjectList objlist(cb_node->commandBuffer());
3728 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003729 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00278" : "VUID-vkCmdResolveImage-dstImage-00278";
3730 skip |= LogError(objlist, vuid,
3731 "%s: dstImage (%s) is 2D but pRegions[%u] dstOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003732 "extent.depth (%u) is not 1.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003733 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003734 pRegions[i].dstOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003735 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003736 }
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003737
3738 // Each srcImage dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003739 VkExtent3D subresource_extent = src_image_state->GetSubresourceExtent(src_subresource);
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003740 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3741 // developer
3742 if (src_subresource.mipLevel < src_image_state->createInfo.mipLevels) {
3743 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003744 if ((extent_check & kXBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003745 LogObjectList objlist(cb_node->commandBuffer());
3746 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003747 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00269" : "VUID-vkCmdResolveImage-srcOffset-00269";
3748 skip |= LogError(objlist, vuid,
3749 "%s: srcImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003750 "exceeds subResource width [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003751 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003752 region.extent.width, subresource_extent.width);
3753 }
3754
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003755 if ((extent_check & kYBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003756 LogObjectList objlist(cb_node->commandBuffer());
3757 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003758 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00270" : "VUID-vkCmdResolveImage-srcOffset-00270";
3759 skip |= LogError(objlist, vuid,
3760 "%s: srcImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003761 "exceeds subResource height [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003762 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003763 region.extent.height, subresource_extent.height);
3764 }
3765
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003766 if ((extent_check & kZBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003767 LogObjectList objlist(cb_node->commandBuffer());
3768 objlist.add(src_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003769 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00272" : "VUID-vkCmdResolveImage-srcOffset-00272";
3770 skip |= LogError(objlist, vuid,
3771 "%s: srcImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003772 "exceeds subResource depth [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003773 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003774 region.extent.depth, subresource_extent.depth);
3775 }
3776 }
3777
3778 // Each dstImage dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003779 subresource_extent = dst_image_state->GetSubresourceExtent(dst_subresource);
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003780 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3781 // developer
3782 if (dst_subresource.mipLevel < dst_image_state->createInfo.mipLevels) {
3783 uint32_t extent_check = ExceedsBounds(&(region.dstOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003784 if ((extent_check & kXBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003785 LogObjectList objlist(cb_node->commandBuffer());
3786 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003787 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00274" : "VUID-vkCmdResolveImage-dstOffset-00274";
3788 skip |= LogError(objlist, vuid,
3789 "%s: dstImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003790 "exceeds subResource width [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003791 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003792 region.extent.width, subresource_extent.width);
3793 }
3794
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003795 if ((extent_check & kYBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003796 LogObjectList objlist(cb_node->commandBuffer());
3797 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003798 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00275" : "VUID-vkCmdResolveImage-dstOffset-00275";
3799 skip |= LogError(objlist, vuid,
3800 "%s: dstImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003801 "exceeds subResource height [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003802 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003803 region.extent.height, subresource_extent.height);
3804 }
3805
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003806 if ((extent_check & kZBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003807 LogObjectList objlist(cb_node->commandBuffer());
3808 objlist.add(dst_image_state->image());
Jeff Leger178b1e52020-10-05 12:22:23 -04003809 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00277" : "VUID-vkCmdResolveImage-dstOffset-00277";
3810 skip |= LogError(objlist, vuid,
3811 "%s: dstImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003812 "exceeds subResource depth [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003813 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003814 region.extent.depth, subresource_extent.depth);
3815 }
3816 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003817 }
3818
3819 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003820 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-01386" : "VUID-vkCmdResolveImage-srcImage-01386";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003821 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 -04003822 func_name, string_VkFormat(src_image_state->createInfo.format),
3823 string_VkFormat(dst_image_state->createInfo.format));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003824 }
3825 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003826 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_MismatchedImageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04003827 "%s: srcImage type (%s) and dstImage type (%s) are not the same.", func_name,
sfricke-samsungc26350e2020-05-30 12:31:31 -07003828 string_VkImageType(src_image_state->createInfo.imageType),
3829 string_VkImageType(dst_image_state->createInfo.imageType));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003830 }
3831 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003832 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00257" : "VUID-vkCmdResolveImage-srcImage-00257";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003833 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 -07003834 }
3835 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003836 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00259" : "VUID-vkCmdResolveImage-dstImage-00259";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003837 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 -04003838 func_name, string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003839 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003840 } else {
3841 assert(0);
3842 }
3843 return skip;
3844}
3845
Jeff Leger178b1e52020-10-05 12:22:23 -04003846bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3847 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3848 const VkImageResolve *pRegions) const {
3849 return ValidateCmdResolveImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3850 COPY_COMMAND_VERSION_1);
3851}
3852
3853bool CoreChecks::PreCallValidateCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
3854 const VkResolveImageInfo2KHR *pResolveImageInfo) const {
3855 return ValidateCmdResolveImage(commandBuffer, pResolveImageInfo->srcImage, pResolveImageInfo->srcImageLayout,
3856 pResolveImageInfo->dstImage, pResolveImageInfo->dstImageLayout, pResolveImageInfo->regionCount,
3857 pResolveImageInfo->pRegions, COPY_COMMAND_VERSION_2);
3858}
3859
3860template <typename RegionType>
3861bool CoreChecks::ValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3862 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3863 const RegionType *pRegions, VkFilter filter, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003864 const auto *cb_node = GetCBState(commandBuffer);
3865 const auto *src_image_state = GetImageState(srcImage);
3866 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003867
Jeff Leger178b1e52020-10-05 12:22:23 -04003868 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
sfricke-samsung85584a72021-09-30 21:43:38 -07003869 const CMD_TYPE cmd_type = is_2khr ? CMD_BLITIMAGE2KHR : CMD_BLITIMAGE;
3870 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04003871
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003872 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003873 if (cb_node) {
sfricke-samsung85584a72021-09-30 21:43:38 -07003874 skip |= ValidateCmd(cb_node, cmd_type);
John Zulauf5c2750c2018-01-30 15:04:56 -07003875 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003876 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003877 const char *vuid;
3878 const char *location;
3879 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00233" : "VUID-vkCmdBlitImage-srcImage-00233";
3880 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->srcImage" : "vkCmdBlitImage(): srcImage";
3881 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
3882 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00234" : "VUID-vkCmdBlitImage-dstImage-00234";
3883 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->dstImage" : "vkCmdBlitImage(): dstImage";
3884 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
3885 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00220" : "VUID-vkCmdBlitImage-srcImage-00220";
3886 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3887 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00225" : "VUID-vkCmdBlitImage-dstImage-00225";
3888 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
3889 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00219" : "VUID-vkCmdBlitImage-srcImage-00219";
3890 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3891 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3892 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00224" : "VUID-vkCmdBlitImage-dstImage-00224";
3893 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3894 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
sfricke-samsung85584a72021-09-30 21:43:38 -07003895 skip |= ValidateCmd(cb_node, cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04003896 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-01999" : "VUID-vkCmdBlitImage-srcImage-01999";
3897 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, func_name, vuid);
3898 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02000" : "VUID-vkCmdBlitImage-dstImage-02000";
3899 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, func_name, vuid);
3900 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01834" : "VUID-vkCmdBlitImage-commandBuffer-01834";
3901 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3902 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01835" : "VUID-vkCmdBlitImage-commandBuffer-01835";
3903 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3904 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01836" : "VUID-vkCmdBlitImage-commandBuffer-01836";
3905 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
sfricke-samsung022fa252020-07-24 03:26:16 -07003906
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003907 // Validation for VK_EXT_fragment_density_map
3908 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003909 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003910 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003911 "%s: srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3912 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003913 }
3914 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003915 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003916 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003917 "%s: dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3918 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003919 }
3920
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003921 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003922
Dave Houlton33c2d252017-06-09 17:08:32 -06003923 VkFormat src_format = src_image_state->createInfo.format;
3924 VkFormat dst_format = dst_image_state->createInfo.format;
3925 VkImageType src_type = src_image_state->createInfo.imageType;
3926 VkImageType dst_type = dst_image_state->createInfo.imageType;
3927
Cort Stratton186b1a22018-05-01 20:18:06 -04003928 if (VK_FILTER_LINEAR == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003929 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02001" : "VUID-vkCmdBlitImage-filter-02001";
3930 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT, func_name,
3931 vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003932 } else if (VK_FILTER_CUBIC_IMG == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003933 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02002" : "VUID-vkCmdBlitImage-filter-02002";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003934 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
Jeff Leger178b1e52020-10-05 12:22:23 -04003935 func_name, vuid);
Dave Houlton33c2d252017-06-09 17:08:32 -06003936 }
3937
sfricke-samsung10b35ce2021-09-29 08:50:20 -07003938 if (FormatRequiresYcbcrConversionExplicitly(src_format)) {
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07003939 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-06421" : "VUID-vkCmdBlitImage-srcImage-06421";
Jeff Leger178b1e52020-10-05 12:22:23 -04003940 skip |= LogError(device, vuid,
3941 "%s: srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003942 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04003943 func_name, string_VkFormat(src_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003944 }
3945
sfricke-samsung10b35ce2021-09-29 08:50:20 -07003946 if (FormatRequiresYcbcrConversionExplicitly(dst_format)) {
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07003947 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-06422" : "VUID-vkCmdBlitImage-dstImage-06422";
Jeff Leger178b1e52020-10-05 12:22:23 -04003948 skip |= LogError(device, vuid,
3949 "%s: dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003950 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04003951 func_name, string_VkFormat(dst_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003952 }
3953
ziga-lunarg52604a12021-09-09 16:02:05 +02003954 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_2D != src_type)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003955 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-00237" : "VUID-vkCmdBlitImage-filter-00237";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003956 skip |= LogError(cb_node->commandBuffer(), vuid,
ziga-lunarg52604a12021-09-09 16:02:05 +02003957 "%s: source image type must be VK_IMAGE_TYPE_2D when cubic filtering is specified.", func_name);
Dave Houlton33c2d252017-06-09 17:08:32 -06003958 }
3959
Dave Houlton33c2d252017-06-09 17:08:32 -06003960 // Validate consistency for unsigned formats
3961 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3962 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003963 ss << func_name << ": If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003964 << "the other one must also have unsigned integer format. "
3965 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003966 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00230" : "VUID-vkCmdBlitImage-srcImage-00230";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003967 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003968 }
3969
3970 // Validate consistency for signed formats
3971 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3972 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003973 ss << func_name << ": If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003974 << "the other one must also have signed integer format. "
3975 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003976 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00229" : "VUID-vkCmdBlitImage-srcImage-00229";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003977 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003978 }
3979
3980 // Validate filter for Depth/Stencil formats
3981 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3982 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003983 ss << func_name << ": If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003984 << "then filter must be VK_FILTER_NEAREST.";
Jeff Leger178b1e52020-10-05 12:22:23 -04003985 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00232" : "VUID-vkCmdBlitImage-srcImage-00232";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003986 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003987 }
3988
3989 // Validate aspect bits and formats for depth/stencil images
3990 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3991 if (src_format != dst_format) {
3992 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003993 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 -06003994 << "stencil, the other one must have exactly the same format. "
3995 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3996 << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003997 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00231" : "VUID-vkCmdBlitImage-srcImage-00231";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003998 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003999 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004000 } // Depth or Stencil
4001
4002 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004003 const char *invalid_src_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07004004 is_2khr ? ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04004005 ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-01398"
4006 : "VUID-VkBlitImageInfo2KHR-srcImageLayout-00222")
sfricke-samsung45996a42021-09-16 13:45:27 -07004007 : ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04004008 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
4009 : "VUID-vkCmdBlitImage-srcImageLayout-00222");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004010 const char *invalid_dst_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07004011 is_2khr ? ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04004012 ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-01399"
4013 : "VUID-VkBlitImageInfo2KHR-dstImageLayout-00227")
sfricke-samsung45996a42021-09-16 13:45:27 -07004014 : ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04004015 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
4016 : "VUID-vkCmdBlitImage-dstImageLayout-00227");
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004017 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004018 const RegionType rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004019 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04004020 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-00221" : "VUID-vkCmdBlitImage-srcImageLayout-00221";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004021 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04004022 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
4023 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-00226" : "VUID-vkCmdBlitImage-dstImageLayout-00226";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004024 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04004025 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
4026 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, func_name, "srcSubresource", i);
4027 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, func_name, "dstSubresource", i);
4028 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01705" : "VUID-vkCmdBlitImage-srcSubresource-01705";
4029 skip |=
4030 ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
4031 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01706" : "VUID-vkCmdBlitImage-dstSubresource-01706";
4032 skip |=
4033 ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
4034 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01707" : "VUID-vkCmdBlitImage-srcSubresource-01707";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004035 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04004036 rgn.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
4037 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01708" : "VUID-vkCmdBlitImage-dstSubresource-01708";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004038 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04004039 rgn.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004040 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06004041 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
4042 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004043 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004044 ss << func_name << ": pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004045 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004046 }
Dave Houlton48989f32017-05-26 15:01:46 -06004047 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
4048 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004049 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004050 ss << func_name << ": pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004051 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004052 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004053
4054 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06004055 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004056 vuid = is_2khr ? "VUID-VkImageBlit2KHR-layerCount-00239" : "VUID-VkImageBlit-layerCount-00239";
4057 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004058 LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004059 "%s: layerCount in source and destination subresource of pRegions[%d] does not match.", func_name, i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004060 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07004061
Dave Houlton48989f32017-05-26 15:01:46 -06004062 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004063 vuid = is_2khr ? "VUID-VkImageBlit2KHR-aspectMask-00238" : "VUID-VkImageBlit-aspectMask-00238";
4064 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004065 LogError(cb_node->commandBuffer(), vuid, "%s: aspectMask members for pRegion[%d] do not match.", func_name, i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07004066 }
Dave Houlton48989f32017-05-26 15:01:46 -06004067
Dave Houlton33c2d252017-06-09 17:08:32 -06004068 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004069 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00241" : "VUID-vkCmdBlitImage-aspectMask-00241";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004070 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004071 "%s: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004072 "image format %s.",
Jeff Leger178b1e52020-10-05 12:22:23 -04004073 func_name, i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004074 }
4075
4076 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004077 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00242" : "VUID-vkCmdBlitImage-aspectMask-00242";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004078 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004079 "%s: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
4080 func_name, i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004081 }
4082
Dave Houlton48989f32017-05-26 15:01:46 -06004083 // Validate source image offsets
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06004084 VkExtent3D src_extent = src_image_state->GetSubresourceExtent(rgn.srcSubresource);
Dave Houlton33c2d252017-06-09 17:08:32 -06004085 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06004086 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004087 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00245" : "VUID-vkCmdBlitImage-srcImage-00245";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004088 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004089 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
4090 "of (%1d, %1d). These must be (0, 1).",
4091 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004092 }
4093 }
4094
Dave Houlton33c2d252017-06-09 17:08:32 -06004095 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06004096 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004097 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00247" : "VUID-vkCmdBlitImage-srcImage-00247";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004098 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004099 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
4100 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
4101 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004102 }
4103 }
4104
Dave Houlton33c2d252017-06-09 17:08:32 -06004105 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06004106 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
4107 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004108 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004109 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00243" : "VUID-vkCmdBlitImage-srcOffset-00243";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004110 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004111 "%s: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).",
4112 func_name, i, rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004113 }
4114 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
4115 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004116 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004117 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00244" : "VUID-vkCmdBlitImage-srcOffset-00244";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004118 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004119 "%s: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).",
4120 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004121 }
4122 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
4123 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004124 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004125 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00246" : "VUID-vkCmdBlitImage-srcOffset-00246";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004126 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004127 "%s: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).",
4128 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004129 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004130 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004131 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00215" : "VUID-vkCmdBlitImage-pRegions-00215";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004132 skip |= LogError(cb_node->commandBuffer(), vuid, "%s: region [%d] source image blit region exceeds image dimensions.",
Jeff Leger178b1e52020-10-05 12:22:23 -04004133 func_name, i);
Dave Houlton33c2d252017-06-09 17:08:32 -06004134 }
Dave Houlton48989f32017-05-26 15:01:46 -06004135
4136 // Validate dest image offsets
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06004137 VkExtent3D dst_extent = dst_image_state->GetSubresourceExtent(rgn.dstSubresource);
Dave Houlton33c2d252017-06-09 17:08:32 -06004138 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06004139 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004140 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00250" : "VUID-vkCmdBlitImage-dstImage-00250";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004141 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004142 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
4143 "(%1d, %1d). These must be (0, 1).",
4144 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004145 }
4146 }
4147
Dave Houlton33c2d252017-06-09 17:08:32 -06004148 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06004149 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004150 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00252" : "VUID-vkCmdBlitImage-dstImage-00252";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004151 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004152 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004153 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
Jeff Leger178b1e52020-10-05 12:22:23 -04004154 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004155 }
4156 }
4157
Dave Houlton33c2d252017-06-09 17:08:32 -06004158 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06004159 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
4160 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004161 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004162 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00248" : "VUID-vkCmdBlitImage-dstOffset-00248";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004163 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004164 "%s: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).",
4165 func_name, i, rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004166 }
4167 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
4168 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004169 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004170 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00249" : "VUID-vkCmdBlitImage-dstOffset-00249";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004171 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004172 "%s: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).",
4173 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004174 }
4175 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
4176 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004177 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004178 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00251" : "VUID-vkCmdBlitImage-dstOffset-00251";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004179 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004180 "%s: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).",
4181 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004182 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004183 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004184 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00216" : "VUID-vkCmdBlitImage-pRegions-00216";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004185 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004186 "%s: region [%d] destination image blit region exceeds image dimensions.", func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004187 }
4188
Dave Houlton33c2d252017-06-09 17:08:32 -06004189 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
4190 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
4191 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004192 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00240" : "VUID-vkCmdBlitImage-srcImage-00240";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004193 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004194 "%s: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
4195 "layerCount other than 1.",
4196 func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004197 }
4198 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004199 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004200 } else {
4201 assert(0);
4202 }
4203 return skip;
4204}
4205
Jeff Leger178b1e52020-10-05 12:22:23 -04004206bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4207 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4208 const VkImageBlit *pRegions, VkFilter filter) const {
4209 return ValidateCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter,
4210 COPY_COMMAND_VERSION_1);
4211}
4212
4213bool CoreChecks::PreCallValidateCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) const {
4214 return ValidateCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4215 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4216 pBlitImageInfo->filter, COPY_COMMAND_VERSION_2);
4217}
4218
4219template <typename RegionType>
4220void CoreChecks::RecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
4221 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
4222 VkFilter filter) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004223 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004224 auto src_image_state = GetImageState(srcImage);
4225 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004226
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004227 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004228 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06004229 cb_node->SetImageInitialLayout(*src_image_state, pRegions[i].srcSubresource, srcImageLayout);
4230 cb_node->SetImageInitialLayout(*dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004231 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004232}
4233
Jeff Leger178b1e52020-10-05 12:22:23 -04004234void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4235 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4236 const VkImageBlit *pRegions, VkFilter filter) {
4237 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
4238 pRegions, filter);
4239 RecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter);
4240}
4241
4242void CoreChecks::PreCallRecordCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) {
4243 StateTracker::PreCallRecordCmdBlitImage2KHR(commandBuffer, pBlitImageInfo);
4244 RecordCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4245 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4246 pBlitImageInfo->filter);
4247}
4248
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004249GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap &map, const IMAGE_STATE &image_state) {
John Zulauf2076e812020-01-08 14:55:54 -07004250 // This approach allows for a single hash lookup or/create new
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004251 auto &layout_map = map[image_state.image()];
John Zulauf17708d02021-02-22 11:20:58 -07004252 if (!layout_map) {
4253 layout_map.emplace(image_state.subresource_encoder.SubresourceCount());
John Zulauf2076e812020-01-08 14:55:54 -07004254 }
John Zulauf17708d02021-02-22 11:20:58 -07004255 return &layout_map;
John Zulauf2076e812020-01-08 14:55:54 -07004256}
4257
4258const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, VkImage image) {
4259 auto it = map.find(image);
4260 if (it != map.end()) {
John Zulauf17708d02021-02-22 11:20:58 -07004261 return &it->second;
John Zulauf2076e812020-01-08 14:55:54 -07004262 }
4263 return nullptr;
4264}
4265
Jeremy Gebben53631302021-04-13 16:46:37 -06004266// Helper to update the Global or Overlay layout map
4267struct GlobalLayoutUpdater {
4268 bool update(VkImageLayout &dst, const image_layout_map::ImageSubresourceLayoutMap::LayoutEntry &src) const {
4269 if (src.current_layout != image_layout_map::kInvalidLayout && dst != src.current_layout) {
4270 dst = src.current_layout;
4271 return true;
4272 }
4273 return false;
4274 }
4275
4276 layer_data::optional<VkImageLayout> insert(const image_layout_map::ImageSubresourceLayoutMap::LayoutEntry &src) const {
4277 layer_data::optional<VkImageLayout> result;
4278 if (src.current_layout != image_layout_map::kInvalidLayout) {
4279 result.emplace(src.current_layout);
4280 }
4281 return result;
4282 }
4283};
4284
Shannon McPherson449fa9c2018-10-25 11:51:07 -06004285// 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 -07004286bool CoreChecks::ValidateCmdBufImageLayouts(const Location &loc, const CMD_BUFFER_STATE *pCB,
4287 const GlobalImageLayoutMap &globalImageLayoutMap,
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004288 GlobalImageLayoutMap &overlayLayoutMap) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06004289 if (disabled[image_layout_validation]) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004290 bool skip = false;
John Zulauff660ad62019-03-23 07:16:05 -06004291 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07004292 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06004293 for (const auto &layout_map_entry : pCB->image_layout_map) {
4294 const auto image = layout_map_entry.first;
4295 const auto *image_state = GetImageState(image);
4296 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06004297 const auto &subres_map = layout_map_entry.second;
Jeremy Gebben53631302021-04-13 16:46:37 -06004298 const auto &layout_map = subres_map->GetLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06004299 // Validate the initial_uses for each subresource referenced
Jeremy Gebben53631302021-04-13 16:46:37 -06004300 if (layout_map.empty()) continue;
John Zulauf2076e812020-01-08 14:55:54 -07004301
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004302 auto *overlay_map = GetLayoutRangeMap(overlayLayoutMap, *image_state);
John Zulauf2076e812020-01-08 14:55:54 -07004303 const auto *global_map = GetLayoutRangeMap(globalImageLayoutMap, image);
4304 if (global_map == nullptr) {
4305 global_map = &empty_map;
4306 }
4307
4308 // Note: don't know if it would matter
4309 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
4310
Jeremy Gebben53631302021-04-13 16:46:37 -06004311 auto pos = layout_map.begin();
4312 const auto end = layout_map.end();
4313 sparse_container::parallel_iterator<const GlobalImageLayoutRangeMap> current_layout(*overlay_map, *global_map,
4314 pos->first.begin);
John Zulauf2076e812020-01-08 14:55:54 -07004315 while (pos != end) {
Jeremy Gebben53631302021-04-13 16:46:37 -06004316 VkImageLayout initial_layout = pos->second.initial_layout;
4317 assert(initial_layout != image_layout_map::kInvalidLayout);
4318 if (initial_layout == image_layout_map::kInvalidLayout) {
4319 continue;
4320 }
4321
John Zulauf2076e812020-01-08 14:55:54 -07004322 VkImageLayout image_layout = kInvalidLayout;
Jeremy Gebben53631302021-04-13 16:46:37 -06004323
John Zulauf2076e812020-01-08 14:55:54 -07004324 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 -07004325 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004326 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07004327 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004328 image_layout = current_layout->pos_B->lower_bound->second;
4329 }
4330 const auto intersected_range = pos->first & current_layout->range;
4331 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
4332 // TODO: Set memory invalid which is in mem_tracker currently
4333 } else if (image_layout != initial_layout) {
Hans-Kristian Arntzen6cb03492021-07-05 16:57:31 +02004334 const auto aspect_mask = image_state->subresource_encoder.Decode(intersected_range.begin).aspectMask;
4335 bool matches = ImageLayoutMatches(aspect_mask, image_layout, initial_layout);
John Zulauf2076e812020-01-08 14:55:54 -07004336 if (!matches) {
John Zulauf2076e812020-01-08 14:55:54 -07004337 // We can report all the errors for the intersected range directly
4338 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
locke-lunarg296a3c92020-03-25 01:04:29 -06004339 const auto subresource = image_state->subresource_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004340 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004341 pCB->commandBuffer(), kVUID_Core_DrawState_InvalidImageLayout,
sfricke-samsung6b447aa2021-07-26 09:42:26 -07004342 "%s command buffer %s expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004343 "to be in layout %s--instead, current layout is %s.",
sfricke-samsung6b447aa2021-07-26 09:42:26 -07004344 loc.Message().c_str(), report_data->FormatHandle(pCB->commandBuffer()).c_str(),
John Zulauf2076e812020-01-08 14:55:54 -07004345 report_data->FormatHandle(image).c_str(), subresource.aspectMask, subresource.arrayLayer,
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004346 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
John Zulaufb61ed972019-04-09 16:12:35 -06004347 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004348 }
4349 }
John Zulauf2076e812020-01-08 14:55:54 -07004350 if (pos->first.includes(intersected_range.end)) {
4351 current_layout.seek(intersected_range.end);
4352 } else {
4353 ++pos;
4354 if (pos != end) {
4355 current_layout.seek(pos->first.begin);
4356 }
4357 }
John Zulauff660ad62019-03-23 07:16:05 -06004358 }
locke-lunargf155ccf2020-02-18 11:34:15 -07004359 // Update all layout set operations (which will be a subset of the initial_layouts)
Jeremy Gebben53631302021-04-13 16:46:37 -06004360 sparse_container::splice(*overlay_map, subres_map->GetLayoutMap(), GlobalLayoutUpdater());
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004361 }
John Zulauff660ad62019-03-23 07:16:05 -06004362
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004363 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004364}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07004365
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004366void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06004367 for (const auto &layout_map_entry : pCB->image_layout_map) {
4368 const auto image = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07004369 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06004370 const auto *image_state = GetImageState(image);
4371 if (!image_state) continue; // Can't set layouts of a dead image
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004372 auto *global_map = GetLayoutRangeMap(imageLayoutMap, *image_state);
Jeremy Gebben53631302021-04-13 16:46:37 -06004373 sparse_container::splice(*global_map, subres_map->GetLayoutMap(), GlobalLayoutUpdater());
Tony Barbourdf013b92017-01-25 12:53:48 -07004374 }
4375}
4376
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004377// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004378// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
4379// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004380bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
4381 const VkImageLayout first_layout, const uint32_t attachment,
Mike Schuchardt2df08912020-12-15 16:28:09 -08004382 const VkAttachmentDescription2 &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004383 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004384 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
4385
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004386 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
sfricke-samsung55f01952020-03-24 08:16:41 -07004387 // for both loadOp and stencilLoaOp rp2 has it in 1 VU while rp1 has it in 2 VU with half behind Maintenance2 extension
4388 // Each is VUID is below in following order: rp2 -> rp1 with Maintenance2 -> rp1 with no extenstion
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004389 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07004390 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4391 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4392 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004393 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004394 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004395 string_VkImageLayout(first_layout));
sfricke-samsung45996a42021-09-16 13:45:27 -07004396 } else if ((use_rp2 == false) && IsExtEnabled(device_extensions.vk_khr_maintenance2) &&
sfricke-samsung55f01952020-03-24 08:16:41 -07004397 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL)) {
4398 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01566",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004399 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004400 string_VkImageLayout(first_layout));
4401 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4402 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004403 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004404 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004405 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004406 }
4407 }
sfricke-samsung55f01952020-03-24 08:16:41 -07004408
4409 // Same as above for loadOp, but for stencilLoadOp
4410 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
4411 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4412 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4413 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL))) {
4414 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02523",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004415 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004416 string_VkImageLayout(first_layout));
sfricke-samsung45996a42021-09-16 13:45:27 -07004417 } else if ((use_rp2 == false) && IsExtEnabled(device_extensions.vk_khr_maintenance2) &&
sfricke-samsung55f01952020-03-24 08:16:41 -07004418 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL)) {
4419 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01567",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004420 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004421 string_VkImageLayout(first_layout));
4422 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4423 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
4424 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-02511",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004425 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004426 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02004427 }
4428 }
4429
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004430 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004431}
4432
Mark Lobodzinski96210742017-02-09 10:33:46 -07004433// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4434// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004435template <typename T1>
4436bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
4437 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
4438 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004439 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004440 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004441 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004442 if (strict) {
4443 correct_usage = ((actual & desired) == desired);
4444 } else {
4445 correct_usage = ((actual & desired) != 0);
4446 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004447
Mark Lobodzinski96210742017-02-09 10:33:46 -07004448 if (!correct_usage) {
sfricke-samsungbb971942020-09-10 22:11:56 -07004449 // All callers should have a valid VUID
4450 assert(msgCode != kVUIDUndefined);
4451 skip =
4452 LogError(object, msgCode, "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4453 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004454 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004455 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004456}
4457
4458// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4459// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004460bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004461 char const *func_name, char const *usage_string) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004462 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image(),
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06004463 image_state->Handle(), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004464}
4465
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004466bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004467 char const *func_name, const char *vuid) const {
Cort Stratton186b1a22018-05-01 20:18:06 -04004468 bool skip = false;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004469 const VkFormatFeatureFlags image_format_features = image_state->format_features;
4470 if ((image_format_features & desired) != desired) {
4471 // Same error, but more details if it was an AHB external format
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06004472 if (image_state->HasAHBFormat()) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004473 skip |= LogError(image_state->image(), vuid,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004474 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for the external format "
4475 "found in VkAndroidHardwareBufferFormatPropertiesANDROID::formatFeatures used by %s.",
4476 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004477 report_data->FormatHandle(image_state->image()).c_str());
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004478 } else {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004479 skip |= LogError(image_state->image(), vuid,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004480 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for format %u used by %s "
4481 "with tiling %s.",
4482 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004483 image_state->createInfo.format, report_data->FormatHandle(image_state->image()).c_str(),
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004484 string_VkImageTiling(image_state->createInfo.tiling));
Cort Stratton186b1a22018-05-01 20:18:06 -04004485 }
4486 }
4487 return skip;
4488}
4489
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004490bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004491 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004492 bool skip = false;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004493 const VkImageAspectFlags apsect_mask = subresource_layers->aspectMask;
Cort Strattond619a302018-05-17 19:46:32 -07004494 // layerCount must not be zero
4495 if (subresource_layers->layerCount == 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004496 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-layerCount-01700",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004497 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004498 }
4499 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004500 if (apsect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004501 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-00168",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004502 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004503 }
4504 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004505 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 -06004506 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-00167",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004507 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4508 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4509 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004510 }
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004511 // aspectMask must not contain VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT
4512 if (apsect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
4513 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004514 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-02247",
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004515 "In %s, pRegions[%u].%s.aspectMask has a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit set.", func_name, i,
4516 member);
4517 }
Cort Strattond619a302018-05-17 19:46:32 -07004518 return skip;
4519}
4520
Mark Lobodzinski96210742017-02-09 10:33:46 -07004521// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4522// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004523bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004524 char const *func_name, char const *usage_string) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004525 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer(),
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06004526 buffer_state->Handle(), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004527}
4528
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004529bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004530 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004531 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004532
4533 const VkDeviceSize &range = pCreateInfo->range;
4534 if (range != VK_WHOLE_SIZE) {
4535 // Range must be greater than 0
4536 if (range <= 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004537 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00928",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004538 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004539 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4540 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004541 }
4542 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004543 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4544 if (SafeModulo(range, format_size) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004545 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00929",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004546 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004547 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4548 "(%" PRIu32 ").",
4549 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004550 }
4551 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004552 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004553 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00930",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004554 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004555 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4556 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4557 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004558 }
4559 // The sum of range and offset must be less than or equal to the size of buffer
4560 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004561 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-offset-00931",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004562 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004563 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4564 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4565 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004566 }
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004567 } else {
4568 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4569
4570 // Size of buffer - offset, divided by the element size of format must be less than or equal to
4571 // VkPhysicalDeviceLimits::maxTexelBufferElements
4572 if (SafeDivision(buffer_state->createInfo.size - pCreateInfo->offset, format_size) >
4573 device_limits->maxTexelBufferElements) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004574 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-04059",
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004575 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
4576 ") equals VK_WHOLE_SIZE, the buffer's size (%" PRIuLEAST64 ") minus the offset (%" PRIuLEAST64
4577 "), divided by the element size of the format (%" PRIu32
4578 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4579 range, buffer_state->createInfo.size, pCreateInfo->offset, format_size,
4580 device_limits->maxTexelBufferElements);
4581 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004582 }
4583 return skip;
4584}
4585
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004586bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004587 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004588 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004589 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4590 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004591 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-00933",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004592 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004593 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format (%s) must "
4594 "be supported for uniform texel buffers",
4595 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004596 }
4597 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4598 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004599 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-00934",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004600 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004601 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format (%s) must "
4602 "be supported for storage texel buffers",
4603 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004604 }
4605 return skip;
4606}
4607
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004608bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004609 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004610 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004611
Dave Houltond8ed0212018-05-16 17:18:24 -06004612 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004613
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004614 auto chained_devaddr_struct = LvlFindInChain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
Jeff Bolz87697532019-01-11 22:54:00 -06004615 if (chained_devaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004616 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz87697532019-01-11 22:54:00 -06004617 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004618 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4619 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004620 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004621 }
4622 }
4623
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004624 auto chained_opaqueaddr_struct = LvlFindInChain<VkBufferOpaqueCaptureAddressCreateInfo>(pCreateInfo->pNext);
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004625 if (chained_opaqueaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004626 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004627 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004628 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
Mike Schuchardt2df08912020-12-15 16:28:09 -08004629 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfo::opaqueCaptureAddress"
4630 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004631 }
4632 }
4633
ziga-lunarg2e2be1e2021-07-18 23:09:15 +02004634 auto dedicated_allocation_buffer = LvlFindInChain<VkDedicatedAllocationBufferCreateInfoNV>(pCreateInfo->pNext);
4635 if (dedicated_allocation_buffer && dedicated_allocation_buffer->dedicatedAllocation == VK_TRUE) {
4636 if (pCreateInfo->flags &
4637 (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT)) {
4638 skip |= LogError(device, "VUID-VkBufferCreateInfo-pNext-01571",
4639 "vkCreateBuffer(): pCreateInfos->flags must not include VK_BUFFER_CREATE_SPARSE_BINDING_BIT, "
4640 "VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT, or VK_BUFFER_CREATE_SPARSE_ALIASED_BIT when "
4641 "VkDedicatedAllocationBufferCreateInfoNV is in pNext chain with dedicatedAllocation VK_TRUE.");
4642 }
4643 }
4644
Mike Schuchardt2df08912020-12-15 16:28:09 -08004645 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz33fc6722020-03-31 12:58:16 -05004646 !enabled_features.core12.bufferDeviceAddressCaptureReplay &&
sfricke-samsung828e59d2021-08-22 23:20:49 -07004647 !enabled_features.buffer_device_address_ext_features.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004648 skip |= LogError(
4649 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004650 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004651 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT set.");
Jeff Bolz87697532019-01-11 22:54:00 -06004652 }
4653
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004654 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
sfricke-samsung45996a42021-09-16 13:45:27 -07004655 const char *vuid = IsExtEnabled(device_extensions.vk_khr_get_physical_device_properties2)
4656 ? "VUID-VkBufferCreateInfo-sharingMode-01419"
4657 : "VUID-VkBufferCreateInfo-sharingMode-01391";
Mark Lobodzinski314b9162020-07-16 15:33:08 -06004658 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
ziga-lunarga0b4f8a2021-07-28 13:23:02 +02004659 "vkCreateBuffer", "pCreateInfo->pQueueFamilyIndices", vuid);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004660 }
4661
sfricke-samsungedce77a2020-07-03 22:35:13 -07004662 if ((pCreateInfo->flags & VK_BUFFER_CREATE_PROTECTED_BIT) != 0) {
4663 if (enabled_features.core11.protectedMemory == VK_FALSE) {
4664 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-01887",
4665 "vkCreateBuffer(): the protectedMemory device feature is disabled: Buffers cannot be created with the "
4666 "VK_BUFFER_CREATE_PROTECTED_BIT set.");
4667 }
4668 const VkBufferCreateFlags invalid_flags =
4669 VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT;
4670 if ((pCreateInfo->flags & invalid_flags) != 0) {
4671 skip |= LogError(device, "VUID-VkBufferCreateInfo-None-01888",
4672 "vkCreateBuffer(): VK_BUFFER_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at "
4673 "same time (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | "
4674 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT).");
4675 }
4676 }
4677
Mark Lobodzinski96210742017-02-09 10:33:46 -07004678 return skip;
4679}
4680
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004681bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004682 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004683 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004684 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
sfricke-samsung2e827212021-09-28 07:52:08 -07004685
4686 if (FormatIsDepthOrStencil(pCreateInfo->format)) {
4687 // Should never hopefully get here, but there are known driver advertising the wrong feature flags
4688 // see https://gitlab.khronos.org/vulkan/vulkan/-/merge_requests/4849
4689 skip |= LogError(device, kVUID_Core_invalidDepthStencilFormat,
4690 "vkCreateBufferView(): format is a depth/stencil format (%s) but depth/stencil formats do not have a "
4691 "defined sizes for alignment, replace with a color format.",
4692 string_VkFormat(pCreateInfo->format));
4693 }
4694
Mark Lobodzinski96210742017-02-09 10:33:46 -07004695 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4696 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004697 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004698 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4699 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004700 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004701 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4702 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4703 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004704
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004705 // Buffer view offset must be less than the size of buffer
4706 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004707 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-offset-00925",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004708 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004709 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4710 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004711 }
4712
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004713 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004714 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4715 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4716 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
sfricke-samsung45996a42021-09-16 13:45:27 -07004717 const char *vuid = IsExtEnabled(device_extensions.vk_ext_texel_buffer_alignment)
4718 ? "VUID-VkBufferViewCreateInfo-offset-02749"
4719 : "VUID-VkBufferViewCreateInfo-offset-00926";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004720 skip |= LogError(buffer_state->buffer(), vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004721 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004722 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4723 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004724 }
4725
4726 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004727 VkDeviceSize element_size = FormatElementSize(pCreateInfo->format);
4728 if ((element_size % 3) == 0) {
4729 element_size /= 3;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004730 }
4731 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004732 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05004733 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4734 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004735 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004736 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004737 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004738 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004739 buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-02750",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004740 "vkCreateBufferView(): If buffer was created with usage containing "
4741 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004742 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4743 ") must be a multiple of the lesser of "
4744 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4745 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4746 "(%" PRId32
4747 ") is VK_TRUE, the size of a texel of the requested format. "
4748 "If the size of a texel is a multiple of three bytes, then the size of a "
4749 "single component of format is used instead",
4750 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4751 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4752 }
4753 }
4754 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004755 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05004756 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4757 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004758 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004759 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004760 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004761 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004762 buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-02751",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004763 "vkCreateBufferView(): If buffer was created with usage containing "
4764 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004765 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4766 ") must be a multiple of the lesser of "
4767 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4768 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4769 "(%" PRId32
4770 ") is VK_TRUE, the size of a texel of the requested format. "
4771 "If the size of a texel is a multiple of three bytes, then the size of a "
4772 "single component of format is used instead",
4773 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4774 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4775 }
4776 }
4777 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004778
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004779 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004780
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004781 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004782 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004783 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004784}
4785
Mark Lobodzinski602de982017-02-09 11:01:33 -07004786// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004787bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004788 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004789 bool skip = false;
sfricke-samsung79b00482020-04-01 21:15:50 -07004790 const IMAGE_STATE *image_state = GetImageState(image);
4791 // checks color format and (single-plane or non-disjoint)
4792 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
sfricke-samsung71bc6572020-04-29 15:49:43 -07004793 if ((FormatIsColor(format)) && ((FormatIsMultiplane(format) == false) || (image_state->disjoint == false))) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004794 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004795 skip |= LogError(
4796 image, vuid,
4797 "%s: Using format (%s) with aspect flags (%s) but color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.",
4798 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004799 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004800 skip |= LogError(image, vuid,
4801 "%s: Using format (%s) with aspect flags (%s) but color image formats must have ONLY the "
4802 "VK_IMAGE_ASPECT_COLOR_BIT set.",
4803 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004804 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004805 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004806 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004807 skip |= LogError(image, vuid,
sfricke-samsung7687a482021-01-29 23:19:22 -08004808 "%s: Using format (%s) with aspect flags (%s) but depth/stencil image formats must have at least one "
4809 "of VK_IMAGE_ASPECT_DEPTH_BIT and VK_IMAGE_ASPECT_STENCIL_BIT set.",
4810 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004811 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004812 skip |= LogError(image, vuid,
sfricke-samsung7687a482021-01-29 23:19:22 -08004813 "%s: Using format (%s) with aspect flags (%s) but combination depth/stencil image formats can have "
4814 "only the VK_IMAGE_ASPECT_DEPTH_BIT and VK_IMAGE_ASPECT_STENCIL_BIT set.",
4815 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004816 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004817 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004818 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004819 skip |= LogError(image, vuid,
4820 "%s: Using format (%s) with aspect flags (%s) but depth-only image formats must have the "
4821 "VK_IMAGE_ASPECT_DEPTH_BIT set.",
4822 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004823 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004824 skip |= LogError(image, vuid,
4825 "%s: Using format (%s) with aspect flags (%s) but depth-only image formats can have only the "
4826 "VK_IMAGE_ASPECT_DEPTH_BIT set.",
4827 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004828 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004829 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004830 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004831 skip |= LogError(image, vuid,
4832 "%s: Using format (%s) with aspect flags (%s) but stencil-only image formats must have the "
4833 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4834 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004835 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004836 skip |= LogError(image, vuid,
4837 "%s: Using format (%s) with aspect flags (%s) but stencil-only image formats can have only the "
4838 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4839 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004840 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004841 } else if (FormatIsMultiplane(format)) {
4842 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4843 if (3 == FormatPlaneCount(format)) {
4844 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4845 }
4846 if ((aspect_mask & valid_flags) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004847 skip |= LogError(image, vuid,
4848 "%s: Using format (%s) with aspect flags (%s) but multi-plane image formats may have only "
4849 "VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs set, where n = [0, 1, 2].",
4850 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Dave Houlton501b15b2018-03-30 15:07:41 -06004851 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004852 }
4853 return skip;
4854}
4855
ziga-lunarg04e94b32021-10-03 01:42:37 +02004856bool CoreChecks::ValidateImageAcquired(IMAGE_STATE const &image_state, const char *func_name) const {
4857 bool skip = false;
4858
4859 if (image_state.create_from_swapchain) {
4860 if (!image_state.bind_swapchain->images[image_state.swapchain_image_index].acquired) {
4861 skip |= LogError(image_state.Handle(), kVUID_Core_NonAcquiredSwapchainImageUsed,
4862 "%s: Image %s is a presentable image, but it is currently not acquired from swapchain.", func_name,
4863 report_data->FormatHandle(image_state.Handle()).c_str());
4864 }
4865 }
4866 return skip;
4867}
4868
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004869bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4870 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004871 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
Jeremy Gebben5573a8c2021-06-04 08:55:10 -06004872 const SubresourceRangeErrorCodes &errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004873 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004874
4875 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004876 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004877 skip |= LogError(image, errorCodes.base_mip_err,
4878 "%s: %s.baseMipLevel (= %" PRIu32
4879 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4880 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004881 }
Petr Kraus4d718682017-05-18 03:38:41 +02004882
Petr Krausffa94af2017-08-08 21:46:02 +02004883 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4884 if (subresourceRange.levelCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004885 skip |=
4886 LogError(image, "VUID-VkImageSubresourceRange-levelCount-01720", "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004887 } else {
4888 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004889
Petr Krausffa94af2017-08-08 21:46:02 +02004890 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004891 skip |= LogError(image, errorCodes.mip_count_err,
4892 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4893 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
4894 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
4895 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004896 }
Petr Kraus4d718682017-05-18 03:38:41 +02004897 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004898 }
Petr Kraus4d718682017-05-18 03:38:41 +02004899
4900 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004901 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004902 skip |= LogError(image, errorCodes.base_layer_err,
4903 "%s: %s.baseArrayLayer (= %" PRIu32
4904 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4905 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004906 }
Petr Kraus4d718682017-05-18 03:38:41 +02004907
Petr Krausffa94af2017-08-08 21:46:02 +02004908 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4909 if (subresourceRange.layerCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004910 skip |=
4911 LogError(image, "VUID-VkImageSubresourceRange-layerCount-01721", "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004912 } else {
4913 const uint64_t necessary_layer_count =
4914 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004915
Petr Krausffa94af2017-08-08 21:46:02 +02004916 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004917 skip |= LogError(image, errorCodes.layer_count_err,
4918 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4919 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
4920 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
4921 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004922 }
Petr Kraus4d718682017-05-18 03:38:41 +02004923 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004924 }
Petr Kraus4d718682017-05-18 03:38:41 +02004925
ziga-lunargb4e90752021-08-02 13:58:29 +02004926 if (subresourceRange.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
4927 if (subresourceRange.aspectMask &
4928 (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT)) {
4929 skip |= LogError(image, "VUID-VkImageSubresourceRange-aspectMask-01670",
4930 "%s: aspectMask includes both VK_IMAGE_ASPECT_COLOR_BIT and one of VK_IMAGE_ASPECT_PLANE_0_BIT, "
4931 "VK_IMAGE_ASPECT_PLANE_1_BIT, or VK_IMAGE_ASPECT_PLANE_2_BIT.",
4932 cmd_name);
4933 }
4934 }
4935
Mark Lobodzinski602de982017-02-09 11:01:33 -07004936 return skip;
4937}
4938
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004939bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004940 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004941 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004942 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
Mike Schuchardt2df08912020-12-15 16:28:09 -08004943 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004944 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 +02004945
David McFarland2853f2f2020-11-30 15:50:39 -04004946 uint32_t image_layer_count;
4947
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004948 if (is_3_d_to_2_d_map) {
David McFarland2853f2f2020-11-30 15:50:39 -04004949 const auto layers = LayersFromRange(subresourceRange);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06004950 const auto extent = image_state->GetSubresourceExtent(layers);
David McFarland2853f2f2020-11-30 15:50:39 -04004951 image_layer_count = extent.depth;
4952 } else {
4953 image_layer_count = image_state->createInfo.arrayLayers;
4954 }
4955
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004956 const auto image_layer_count_var_name = is_3_d_to_2_d_map ? "extent.depth" : "arrayLayers";
Petr Krausffa94af2017-08-08 21:46:02 +02004957
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004958 SubresourceRangeErrorCodes subresource_range_error_codes = {};
4959 subresource_range_error_codes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4960 subresource_range_error_codes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
4961 subresource_range_error_codes.base_layer_err =
4962 is_khr_maintenance1
4963 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-image-02724" : "VUID-VkImageViewCreateInfo-image-01482")
4964 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4965 subresource_range_error_codes.layer_count_err = is_khr_maintenance1
4966 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
4967 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4968 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004969
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004970 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004971 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004972 image_state->image(), subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02004973}
4974
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004975bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004976 const VkImageSubresourceRange &subresourceRange,
4977 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004978 SubresourceRangeErrorCodes subresource_range_error_codes = {};
4979 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4980 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4981 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4982 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004983
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004984 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004985 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image(),
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004986 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02004987}
4988
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004989bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004990 const VkImageSubresourceRange &subresourceRange,
4991 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004992 SubresourceRangeErrorCodes subresource_range_error_codes = {};
4993 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4994 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4995 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4996 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004997
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004998 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004999 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image(),
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005000 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02005001}
5002
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005003bool CoreChecks::ValidateImageBarrierSubresourceRange(const Location &loc, const IMAGE_STATE *image_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005004 const VkImageSubresourceRange &subresourceRange) const {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005005 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005006 loc.StringFunc().c_str(), loc.StringField().c_str(), "arrayLayers", image_state->image(),
Jeremy Gebbenbb845612021-02-18 18:16:05 -07005007 sync_vuid_maps::GetSubResourceVUIDs(loc));
Petr Krausffa94af2017-08-08 21:46:02 +02005008}
5009
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005010namespace barrier_queue_families {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005011using sync_vuid_maps::GetBarrierQueueVUID;
5012using sync_vuid_maps::kQueueErrorSummary;
5013using sync_vuid_maps::QueueError;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005014
5015class ValidatorState {
5016 public:
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005017 ValidatorState(const ValidationStateTracker *device_data, LogObjectList &&obj, const core_error::Location &location,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005018 const VulkanTypedHandle &barrier_handle, const VkSharingMode sharing_mode)
5019 : device_data_(device_data),
John Zulaufbea70432021-02-23 07:03:12 -07005020 objects_(std::move(obj)),
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005021 loc_(location),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005022 barrier_handle_(barrier_handle),
5023 sharing_mode_(sharing_mode),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005024 limit_(static_cast<uint32_t>(device_data->physical_device_state->queue_family_properties.size())),
5025 mem_ext_(IsExtEnabled(device_data->device_extensions.vk_khr_external_memory)) {}
5026
5027 // Log the messages using boilerplate from object state, and Vu specific information from the template arg
5028 // 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 -07005029 bool LogMsg(QueueError vu_index, uint32_t family, const char *param_name) const {
5030 const std::string val_code = GetBarrierQueueVUID(loc_, vu_index);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005031 const char *annotation = GetFamilyAnnotation(family);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005032 return device_data_->LogError(objects_, val_code, "%s Barrier using %s %s created with sharingMode %s, has %s %u%s. %s",
5033 loc_.Message().c_str(), GetTypeString(),
5034 device_data_->report_data->FormatHandle(barrier_handle_).c_str(), GetModeString(), param_name,
5035 family, annotation, kQueueErrorSummary.at(vu_index).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005036 }
5037
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005038 bool LogMsg(QueueError vu_index, uint32_t src_family, uint32_t dst_family) const {
5039 const std::string val_code = GetBarrierQueueVUID(loc_, vu_index);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005040 const char *src_annotation = GetFamilyAnnotation(src_family);
5041 const char *dst_annotation = GetFamilyAnnotation(dst_family);
5042 return device_data_->LogError(
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005043 objects_, val_code,
5044 "%s Barrier using %s %s created with sharingMode %s, has srcQueueFamilyIndex %u%s and dstQueueFamilyIndex %u%s. %s",
5045 loc_.Message().c_str(), GetTypeString(), device_data_->report_data->FormatHandle(barrier_handle_).c_str(),
5046 GetModeString(), src_family, src_annotation, dst_family, dst_annotation, kQueueErrorSummary.at(vu_index).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005047 }
5048
5049 // This abstract Vu can only be tested at submit time, thus we need a callback from the closure containing the needed
5050 // data. Note that the mem_barrier is copied to the closure as the lambda lifespan exceed the guarantees of validity for
5051 // application input.
5052 static bool ValidateAtQueueSubmit(const QUEUE_STATE *queue_state, const ValidationStateTracker *device_data,
5053 uint32_t src_family, uint32_t dst_family, const ValidatorState &val) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005054 auto error_code = QueueError::kSubmitQueueMustMatchSrcOrDst;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005055 uint32_t queue_family = queue_state->queueFamilyIndex;
5056 if ((src_family != queue_family) && (dst_family != queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005057 const std::string val_code = GetBarrierQueueVUID(val.loc_, error_code);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005058 const char *src_annotation = val.GetFamilyAnnotation(src_family);
5059 const char *dst_annotation = val.GetFamilyAnnotation(dst_family);
5060 return device_data->LogError(
Jeremy Gebben63f3cb02021-09-07 15:16:32 -06005061 queue_state->Handle(), val_code,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005062 "%s Barrier submitted to queue with family index %u, using %s %s created with sharingMode %s, has "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005063 "srcQueueFamilyIndex %u%s and dstQueueFamilyIndex %u%s. %s",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005064 val.loc_.Message().c_str(), queue_family, val.GetTypeString(),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005065 device_data->report_data->FormatHandle(val.barrier_handle_).c_str(), val.GetModeString(), src_family,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005066 src_annotation, dst_family, dst_annotation, kQueueErrorSummary.at(error_code).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005067 }
5068 return false;
5069 }
5070 // Logical helpers for semantic clarity
5071 inline bool KhrExternalMem() const { return mem_ext_; }
5072 inline bool IsValid(uint32_t queue_family) const { return (queue_family < limit_); }
5073 inline bool IsValidOrSpecial(uint32_t queue_family) const {
5074 return IsValid(queue_family) || (mem_ext_ && QueueFamilyIsExternal(queue_family));
5075 }
5076
5077 // Helpers for LogMsg
5078 const char *GetModeString() const { return string_VkSharingMode(sharing_mode_); }
5079
5080 // Descriptive text for the various types of queue family index
5081 const char *GetFamilyAnnotation(uint32_t family) const {
5082 const char *external = " (VK_QUEUE_FAMILY_EXTERNAL)";
5083 const char *foreign = " (VK_QUEUE_FAMILY_FOREIGN_EXT)";
5084 const char *ignored = " (VK_QUEUE_FAMILY_IGNORED)";
5085 const char *valid = " (VALID)";
5086 const char *invalid = " (INVALID)";
5087 switch (family) {
5088 case VK_QUEUE_FAMILY_EXTERNAL:
5089 return external;
5090 case VK_QUEUE_FAMILY_FOREIGN_EXT:
5091 return foreign;
5092 case VK_QUEUE_FAMILY_IGNORED:
5093 return ignored;
5094 default:
5095 if (IsValid(family)) {
5096 return valid;
5097 }
5098 return invalid;
5099 };
5100 }
5101 const char *GetTypeString() const { return object_string[barrier_handle_.type]; }
5102 VkSharingMode GetSharingMode() const { return sharing_mode_; }
5103
5104 protected:
5105 const ValidationStateTracker *device_data_;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005106 const LogObjectList objects_;
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005107 const core_error::Location loc_;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005108 const VulkanTypedHandle barrier_handle_;
5109 const VkSharingMode sharing_mode_;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005110 const uint32_t limit_;
5111 const bool mem_ext_;
5112};
5113
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005114bool Validate(const CoreChecks *device_data, const CMD_BUFFER_STATE *cb_state, const ValidatorState &val,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005115 const uint32_t src_queue_family, const uint32_t dst_queue_family) {
5116 bool skip = false;
5117
5118 const bool mode_concurrent = val.GetSharingMode() == VK_SHARING_MODE_CONCURRENT;
5119 const bool src_ignored = QueueFamilyIsIgnored(src_queue_family);
5120 const bool dst_ignored = QueueFamilyIsIgnored(dst_queue_family);
5121 if (val.KhrExternalMem()) {
5122 if (mode_concurrent) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005123 bool sync2 = device_data->enabled_features.synchronization2_features.synchronization2 != 0;
5124 // this requirement is removed by VK_KHR_synchronization2
5125 if (!(src_ignored || dst_ignored) && !sync2) {
5126 skip |= val.LogMsg(QueueError::kSrcOrDstMustBeIgnore, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005127 }
5128 if ((src_ignored && !(dst_ignored || QueueFamilyIsExternal(dst_queue_family))) ||
5129 (dst_ignored && !(src_ignored || QueueFamilyIsExternal(src_queue_family)))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005130 skip |= val.LogMsg(QueueError::kSpecialOrIgnoreOnly, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005131 }
5132 } else {
5133 // VK_SHARING_MODE_EXCLUSIVE
5134 if (src_queue_family != dst_queue_family) {
5135 if (!val.IsValidOrSpecial(dst_queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005136 skip |= val.LogMsg(QueueError::kSrcAndDstValidOrSpecial, dst_queue_family, "dstQueueFamilyIndex");
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005137 }
5138 if (!val.IsValidOrSpecial(src_queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005139 skip |= val.LogMsg(QueueError::kSrcAndDstValidOrSpecial, src_queue_family, "srcQueueFamilyIndex");
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005140 }
5141 }
5142 }
5143 } else {
5144 // No memory extension
5145 if (mode_concurrent) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005146 bool sync2 = device_data->enabled_features.synchronization2_features.synchronization2 != 0;
5147 // this requirement is removed by VK_KHR_synchronization2
5148 if ((!src_ignored || !dst_ignored) && !sync2) {
5149 skip |= val.LogMsg(QueueError::kSrcAndDestMustBeIgnore, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005150 }
5151 } else {
5152 // VK_SHARING_MODE_EXCLUSIVE
5153 if ((src_queue_family != dst_queue_family) && !(val.IsValid(src_queue_family) && val.IsValid(dst_queue_family))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005154 skip |= val.LogMsg(QueueError::kSrcAndDstBothValid, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005155 }
5156 }
5157 }
5158 return skip;
5159}
5160} // namespace barrier_queue_families
5161
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005162bool CoreChecks::ValidateConcurrentBarrierAtSubmit(const Location &loc, const ValidationStateTracker *state_data,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005163 const QUEUE_STATE *queue_state, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005164 const VulkanTypedHandle &typed_handle, uint32_t src_queue_family,
5165 uint32_t dst_queue_family) {
5166 using barrier_queue_families::ValidatorState;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005167 ValidatorState val(state_data, LogObjectList(cb_state->commandBuffer()), loc, typed_handle, VK_SHARING_MODE_CONCURRENT);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005168 return ValidatorState::ValidateAtQueueSubmit(queue_state, state_data, src_queue_family, dst_queue_family, val);
5169}
5170
5171// Type specific wrapper for image barriers
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005172template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005173bool CoreChecks::ValidateBarrierQueueFamilies(const Location &loc, const CMD_BUFFER_STATE *cb_state, const ImgBarrier &barrier,
5174 const IMAGE_STATE *state_data) const {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005175 // State data is required
5176 if (!state_data) {
5177 return false;
5178 }
5179
5180 // Create the validator state from the image state
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005181 barrier_queue_families::ValidatorState val(this, LogObjectList(cb_state->commandBuffer()), loc,
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06005182 state_data->Handle(), state_data->createInfo.sharingMode);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005183 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
5184 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005185 return barrier_queue_families::Validate(this, cb_state, val, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005186}
5187
5188// Type specific wrapper for buffer barriers
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005189template <typename BufBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005190bool CoreChecks::ValidateBarrierQueueFamilies(const Location &loc, const CMD_BUFFER_STATE *cb_state, const BufBarrier &barrier,
5191 const BUFFER_STATE *state_data) const {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005192 // State data is required
5193 if (!state_data) {
5194 return false;
5195 }
5196
5197 // Create the validator state from the buffer state
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005198 barrier_queue_families::ValidatorState val(this, LogObjectList(cb_state->commandBuffer()), loc,
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06005199 state_data->Handle(), state_data->createInfo.sharingMode);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005200 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
5201 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005202 return barrier_queue_families::Validate(this, cb_state, val, src_queue_family, dst_queue_family);
5203}
5204
5205template <typename Barrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005206bool CoreChecks::ValidateBufferBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005207 const Barrier &mem_barrier) const {
5208 using sync_vuid_maps::BufferError;
5209 using sync_vuid_maps::GetBufferBarrierVUID;
5210
5211 bool skip = false;
5212
5213 skip |= ValidateQFOTransferBarrierUniqueness(loc, cb_state, mem_barrier, cb_state->qfo_transfer_buffer_barriers);
5214
5215 // Validate buffer barrier queue family indices
5216 auto buffer_state = GetBufferState(mem_barrier.buffer);
5217 if (buffer_state) {
5218 auto buf_loc = loc.dot(Field::buffer);
5219 const auto &mem_vuid = GetBufferBarrierVUID(buf_loc, BufferError::kNoMemory);
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005220 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, loc.StringFunc().c_str(), mem_vuid.c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005221
5222 skip |= ValidateBarrierQueueFamilies(buf_loc, cb_state, mem_barrier, buffer_state);
5223
5224 auto buffer_size = buffer_state->createInfo.size;
5225 if (mem_barrier.offset >= buffer_size) {
5226 auto offset_loc = loc.dot(Field::offset);
5227 const auto &vuid = GetBufferBarrierVUID(offset_loc, BufferError::kOffsetTooBig);
5228
5229 skip |= LogError(objects, vuid, "%s %s has offset 0x%" PRIx64 " which is not less than total size 0x%" PRIx64 ".",
5230 offset_loc.Message().c_str(), report_data->FormatHandle(mem_barrier.buffer).c_str(),
5231 HandleToUint64(mem_barrier.offset), HandleToUint64(buffer_size));
5232 } else if (mem_barrier.size != VK_WHOLE_SIZE && (mem_barrier.offset + mem_barrier.size > buffer_size)) {
5233 auto size_loc = loc.dot(Field::size);
5234 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kSizeOutOfRange);
5235 skip |= LogError(objects, vuid,
5236 "%s %s has offset 0x%" PRIx64 " and size 0x%" PRIx64 " whose sum is greater than total size 0x%" PRIx64
5237 ".",
5238 size_loc.Message().c_str(), report_data->FormatHandle(mem_barrier.buffer).c_str(),
5239 HandleToUint64(mem_barrier.offset), HandleToUint64(mem_barrier.size), HandleToUint64(buffer_size));
5240 }
5241 if (mem_barrier.size == 0) {
5242 auto size_loc = loc.dot(Field::size);
5243 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kSizeZero);
5244 skip |= LogError(objects, vuid, "%s %s has a size of 0.", loc.Message().c_str(),
5245 report_data->FormatHandle(mem_barrier.buffer).c_str());
5246 }
5247 }
5248 return skip;
5249}
5250
5251template <typename Barrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005252bool CoreChecks::ValidateImageBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005253 const Barrier &mem_barrier) const {
5254 bool skip = false;
5255
5256 skip |= ValidateQFOTransferBarrierUniqueness(loc, cb_state, mem_barrier, cb_state->qfo_transfer_image_barriers);
5257
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005258 bool is_ilt = true;
5259 if (enabled_features.synchronization2_features.synchronization2) {
5260 is_ilt = mem_barrier.oldLayout != mem_barrier.newLayout;
5261 }
5262
5263 if (is_ilt) {
5264 if (mem_barrier.newLayout == VK_IMAGE_LAYOUT_UNDEFINED || mem_barrier.newLayout == VK_IMAGE_LAYOUT_PREINITIALIZED) {
5265 auto layout_loc = loc.dot(Field::newLayout);
5266 const auto &vuid = sync_vuid_maps::GetImageBarrierVUID(loc, sync_vuid_maps::ImageError::kBadLayout);
5267 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005268 LogError(cb_state->commandBuffer(), vuid, "%s Image Layout cannot be transitioned to UNDEFINED or PREINITIALIZED.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005269 layout_loc.Message().c_str());
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005270 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005271 }
5272
5273 auto image_data = GetImageState(mem_barrier.image);
5274 if (image_data) {
5275 auto image_loc = loc.dot(Field::image);
5276
John Zulaufbea70432021-02-23 07:03:12 -07005277 skip |= ValidateMemoryIsBoundToImage(image_data, loc);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005278
5279 skip |= ValidateBarrierQueueFamilies(image_loc, cb_state, mem_barrier, image_data);
5280
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005281 skip |= ValidateImageAspectMask(image_data->image(), image_data->createInfo.format, mem_barrier.subresourceRange.aspectMask,
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005282 loc.StringFunc().c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005283
5284 skip |= ValidateImageBarrierSubresourceRange(loc.dot(Field::subresourceRange), image_data, mem_barrier.subresourceRange);
ziga-lunarg04e94b32021-10-03 01:42:37 +02005285 skip |= ValidateImageAcquired(*image_data, loc.StringFunc().c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005286 }
5287 return skip;
5288}
5289
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005290bool CoreChecks::ValidateBarriers(const Location &outer_loc, const CMD_BUFFER_STATE *cb_state, VkPipelineStageFlags src_stage_mask,
5291 VkPipelineStageFlags dst_stage_mask, uint32_t memBarrierCount,
5292 const VkMemoryBarrier *pMemBarriers, uint32_t bufferBarrierCount,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005293 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
5294 const VkImageMemoryBarrier *pImageMemBarriers) const {
5295 bool skip = false;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005296 LogObjectList objects(cb_state->commandBuffer());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005297
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005298 for (uint32_t i = 0; i < memBarrierCount; ++i) {
5299 const auto &mem_barrier = pMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005300 auto loc = outer_loc.dot(Struct::VkMemoryBarrier, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005301 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005302 }
5303 for (uint32_t i = 0; i < imageMemBarrierCount; ++i) {
5304 const auto &mem_barrier = pImageMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005305 auto loc = outer_loc.dot(Struct::VkImageMemoryBarrier, Field::pImageMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005306 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005307 skip |= ValidateImageBarrier(objects, loc, cb_state, mem_barrier);
5308 }
5309 {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005310 Location loc(outer_loc.function, Struct::VkImageMemoryBarrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005311 skip |= ValidateBarriersToImages(loc, cb_state, imageMemBarrierCount, pImageMemBarriers);
5312 }
5313 for (uint32_t i = 0; i < bufferBarrierCount; ++i) {
5314 const auto &mem_barrier = pBufferMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005315 auto loc = outer_loc.dot(Struct::VkBufferMemoryBarrier, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005316 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005317 skip |= ValidateBufferBarrier(objects, loc, cb_state, mem_barrier);
5318 }
5319 return skip;
5320}
5321
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005322bool CoreChecks::ValidateDependencyInfo(const LogObjectList &objects, const Location &outer_loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbenefead332021-06-18 08:22:44 -06005323 const VkDependencyInfoKHR *dep_info) const {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005324 bool skip = false;
5325
5326 if (cb_state->activeRenderPass) {
5327 skip |= ValidateRenderPassPipelineBarriers(outer_loc, cb_state, dep_info);
5328 if (skip) return true; // Early return to avoid redundant errors from below calls
5329 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005330 for (uint32_t i = 0; i < dep_info->memoryBarrierCount; ++i) {
5331 const auto &mem_barrier = dep_info->pMemoryBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005332 auto loc = outer_loc.dot(Struct::VkMemoryBarrier2KHR, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005333 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005334 }
5335 for (uint32_t i = 0; i < dep_info->imageMemoryBarrierCount; ++i) {
5336 const auto &mem_barrier = dep_info->pImageMemoryBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005337 auto loc = outer_loc.dot(Struct::VkImageMemoryBarrier2KHR, Field::pImageMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005338 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005339 skip |= ValidateImageBarrier(objects, loc, cb_state, mem_barrier);
5340 }
5341 {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005342 Location loc(outer_loc.function, Struct::VkImageMemoryBarrier2KHR);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005343 skip |= ValidateBarriersToImages(loc, cb_state, dep_info->imageMemoryBarrierCount, dep_info->pImageMemoryBarriers);
5344 }
5345
5346 for (uint32_t i = 0; i < dep_info->bufferMemoryBarrierCount; ++i) {
5347 const auto &mem_barrier = dep_info->pBufferMemoryBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005348 auto loc = outer_loc.dot(Struct::VkBufferMemoryBarrier2KHR, Field::pBufferMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005349 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005350 skip |= ValidateBufferBarrier(objects, loc, cb_state, mem_barrier);
5351 }
5352
5353 return skip;
5354}
5355
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005356// template to check all original barrier structures
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005357template <typename Barrier>
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005358bool CoreChecks::ValidateMemoryBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
5359 const Barrier &barrier, VkPipelineStageFlags src_stage_mask,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005360 VkPipelineStageFlags dst_stage_mask) const {
5361 bool skip = false;
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005362 assert(cb_state);
5363 auto queue_flags = cb_state->GetQueueFlags();
5364
5365 if (!cb_state->IsAcquireOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005366 skip |= ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), queue_flags, barrier.srcAccessMask, src_stage_mask);
5367 }
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005368 if (!cb_state->IsReleaseOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005369 skip |= ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), queue_flags, barrier.dstAccessMask, dst_stage_mask);
5370 }
5371 return skip;
5372}
5373
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005374// template to check all synchronization2 barrier structures
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005375template <typename Barrier>
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005376bool CoreChecks::ValidateMemoryBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
5377 const Barrier &barrier) const {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005378 bool skip = false;
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005379 assert(cb_state);
5380 auto queue_flags = cb_state->GetQueueFlags();
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005381
Jeremy Gebbenefead332021-06-18 08:22:44 -06005382 skip |= ValidatePipelineStage(objects, loc.dot(Field::srcStageMask), queue_flags, barrier.srcStageMask);
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005383 if (!cb_state->IsAcquireOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005384 skip |=
5385 ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), queue_flags, barrier.srcAccessMask, barrier.srcStageMask);
5386 }
Jeremy Gebbenefead332021-06-18 08:22:44 -06005387
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005388 skip |= ValidatePipelineStage(objects, loc.dot(Field::dstStageMask), queue_flags, barrier.dstStageMask);
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005389 if (!cb_state->IsReleaseOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005390 skip |=
5391 ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), queue_flags, barrier.dstAccessMask, barrier.dstStageMask);
5392 }
5393 return skip;
5394}
5395
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005396// VkSubpassDependency validation happens when vkCreateRenderPass() is called.
5397// Dependencies between subpasses can only use pipeline stages compatible with VK_QUEUE_GRAPHICS_BIT,
5398// for external subpasses we don't have a yet command buffer so we have to assume all of them are valid.
5399static inline VkQueueFlags SubpassToQueueFlags(uint32_t subpass) {
5400 return subpass == VK_SUBPASS_EXTERNAL ? sync_utils::kAllQueueTypes : static_cast<VkQueueFlags>(VK_QUEUE_GRAPHICS_BIT);
5401}
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005402
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005403bool CoreChecks::ValidateSubpassDependency(const LogObjectList &objects, const Location &in_loc,
5404 const VkSubpassDependency2 &dependency) const {
5405 bool skip = false;
5406 Location loc = in_loc;
5407 VkMemoryBarrier2KHR converted_barrier;
5408 const auto *mem_barrier = LvlFindInChain<VkMemoryBarrier2KHR>(dependency.pNext);
5409
5410 if (mem_barrier && enabled_features.synchronization2_features.synchronization2) {
5411 if (dependency.srcAccessMask != 0) {
5412 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-srcAccessMask",
5413 "%s is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5414 loc.dot(Field::srcAccessMask).Message().c_str());
5415 }
5416 if (dependency.dstAccessMask != 0) {
5417 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-dstAccessMask",
5418 "%s dstAccessMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5419 loc.dot(Field::dstAccessMask).Message().c_str());
5420 }
5421 if (dependency.srcStageMask != 0) {
5422 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-srcStageMask",
5423 "%s srcStageMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5424 loc.dot(Field::srcStageMask).Message().c_str());
5425 }
5426 if (dependency.dstStageMask != 0) {
5427 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-dstStageMask",
5428 "%s dstStageMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5429 loc.dot(Field::dstStageMask).Message().c_str());
5430 }
5431 loc = in_loc.dot(Field::pNext);
5432 converted_barrier = *mem_barrier;
5433 } else {
5434 if (mem_barrier) {
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005435 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-pNext",
5436 "%s a VkMemoryBarrier2KHR is present in pNext but synchronization2 is not enabled.",
5437 loc.Message().c_str());
5438 }
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005439 // use the subpass dependency flags, upconverted into wider synchronization2 fields.
5440 converted_barrier.srcStageMask = dependency.srcStageMask;
5441 converted_barrier.dstStageMask = dependency.dstStageMask;
5442 converted_barrier.srcAccessMask = dependency.srcAccessMask;
5443 converted_barrier.dstAccessMask = dependency.dstAccessMask;
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005444 }
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005445 auto src_queue_flags = SubpassToQueueFlags(dependency.srcSubpass);
5446 skip |= ValidatePipelineStage(objects, loc.dot(Field::srcStageMask), src_queue_flags, converted_barrier.srcStageMask);
5447 skip |= ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), src_queue_flags, converted_barrier.srcAccessMask,
5448 converted_barrier.srcStageMask);
5449
5450 auto dst_queue_flags = SubpassToQueueFlags(dependency.dstSubpass);
5451 skip |= ValidatePipelineStage(objects, loc.dot(Field::dstStageMask), dst_queue_flags, converted_barrier.dstStageMask);
5452 skip |= ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), dst_queue_flags, converted_barrier.dstAccessMask,
5453 converted_barrier.dstStageMask);
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005454 return skip;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005455}
5456
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005457bool CoreChecks::ValidateImageViewFormatFeatures(const IMAGE_STATE *image_state, const VkFormat view_format,
5458 const VkImageUsageFlags image_usage) const {
5459 // Pass in image_usage here instead of extracting it from image_state in case there's a chained VkImageViewUsageCreateInfo
5460 bool skip = false;
5461
5462 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
5463 const VkImageTiling image_tiling = image_state->createInfo.tiling;
5464
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06005465 if (image_state->HasAHBFormat()) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005466 // AHB image view and image share same feature sets
5467 tiling_features = image_state->format_features;
5468 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5469 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
sfricke-samsung45996a42021-09-16 13:45:27 -07005470 assert(IsExtEnabled(device_extensions.vk_ext_image_drm_format_modifier));
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005471 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = {VK_STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_PROPERTIES_EXT,
5472 nullptr};
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005473 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image_state->image(), &drm_format_properties);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005474
5475 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
5476 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
5477 nullptr};
5478 format_properties_2.pNext = (void *)&drm_properties_list;
5479 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
5480
nyorain38a9d232021-03-06 13:06:12 +01005481 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
5482 drm_properties.resize(drm_properties_list.drmFormatModifierCount);
5483 drm_properties_list.pDrmFormatModifierProperties = drm_properties.data();
5484
5485 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
5486
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005487 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
5488 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_properties.drmFormatModifier) !=
5489 0) {
5490 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
5491 }
5492 }
5493 } else {
5494 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
5495 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
5496 : format_properties.optimalTilingFeatures;
5497 }
5498
5499 if (tiling_features == 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005500 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-None-02273",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005501 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
5502 "physical device.",
5503 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5504 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005505 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02274",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005506 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5507 "VK_IMAGE_USAGE_SAMPLED_BIT.",
5508 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5509 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005510 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02275",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005511 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5512 "VK_IMAGE_USAGE_STORAGE_BIT.",
5513 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5514 } 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 -06005515 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02276",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005516 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5517 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
5518 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5519 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
5520 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005521 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02277",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005522 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5523 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5524 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5525 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
5526 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005527 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02652",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005528 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5529 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5530 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Tobias Hector6663c9b2020-11-05 10:18:02 +00005531 } else if ((image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) &&
5532 !(tiling_features & VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR)) {
5533 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005534 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-04550",
Tobias Hector6663c9b2020-11-05 10:18:02 +00005535 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5536 "VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR.",
5537 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5538 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005539 }
5540
5541 return skip;
5542}
5543
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005544bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005545 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005546 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005547 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005548 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005549 skip |=
5550 ValidateImageUsageFlags(image_state,
5551 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
5552 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
sfricke-samsungbb971942020-09-10 22:11:56 -07005553 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV |
5554 VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
5555 false, "VUID-VkImageViewCreateInfo-image-04441", "vkCreateImageView()",
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005556 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
sfricke-samsungbb971942020-09-10 22:11:56 -07005557 "TRANSIENT_ATTACHMENT|SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005558 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005559 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005560 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02005561 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005562 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005563 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005564
5565 VkImageCreateFlags image_flags = image_state->createInfo.flags;
5566 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005567 VkImageUsageFlags image_usage = image_state->createInfo.usage;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005568 VkFormat view_format = pCreateInfo->format;
5569 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06005570 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005571 VkImageViewType view_type = pCreateInfo->viewType;
sfricke-samsung20a8a372021-07-14 06:12:17 -07005572 uint32_t layer_count = pCreateInfo->subresourceRange.layerCount;
Mark Lobodzinski602de982017-02-09 11:01:33 -07005573
Dave Houltonbd2e2622018-04-10 16:41:14 -06005574 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005575 auto chained_ivuci_struct = LvlFindInChain<VkImageViewUsageCreateInfo>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06005576 if (chained_ivuci_struct) {
sfricke-samsung45996a42021-09-16 13:45:27 -07005577 if (IsExtEnabled(device_extensions.vk_khr_maintenance2)) {
5578 if (!IsExtEnabled(device_extensions.vk_ext_separate_stencil_usage)) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05005579 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005580 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
5581 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
5582 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05005583 }
5584 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005585 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05005586 if (image_stencil_struct == nullptr) {
5587 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005588 skip |= LogError(
5589 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005590 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
5591 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
5592 "any bits that were not set in VkImageCreateInfo::usage used to create image");
5593 }
5594 } else {
5595 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
5596 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
5597 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005598 skip |= LogError(
5599 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005600 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5601 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5602 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
5603 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
5604 }
5605 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
5606 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005607 skip |= LogError(
5608 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005609 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5610 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5611 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
5612 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
5613 }
5614 }
5615 }
5616 }
5617
Dave Houltonbd2e2622018-04-10 16:41:14 -06005618 image_usage = chained_ivuci_struct->usage;
5619 }
5620
sfricke-samsungf60b6c82021-04-05 22:59:20 -07005621 // If image used VkImageFormatListCreateInfo need to make sure a format from list is used
5622 const auto format_list_info = LvlFindInChain<VkImageFormatListCreateInfo>(image_state->createInfo.pNext);
5623 if (format_list_info && (format_list_info->viewFormatCount > 0)) {
5624 bool foundFormat = false;
5625 for (uint32_t i = 0; i < format_list_info->viewFormatCount; i++) {
5626 if (format_list_info->pViewFormats[i] == view_format) {
5627 foundFormat = true;
5628 break;
5629 }
5630 }
5631 if (foundFormat == false) {
5632 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-01585",
5633 "vkCreateImageView(): image was created with a VkImageFormatListCreateInfo in pNext of "
5634 "vkImageCreateInfo, but none of the formats match the VkImageViewCreateInfo::format (%s).",
5635 string_VkFormat(view_format));
5636 }
5637 }
5638
Dave Houlton6f5f20a2018-05-04 12:37:44 -06005639 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
5640 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005641 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01005642 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06005643 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01005644 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06005645 std::stringstream ss;
5646 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01005647 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06005648 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005649 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005650 }
5651 } else {
Mike Schuchardt2df08912020-12-15 16:28:09 -08005652 if (!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005653 // 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 -07005654 const VkFormatCompatibilityClass imageClass = FormatCompatibilityClass(image_format);
5655 const VkFormatCompatibilityClass viewClass = FormatCompatibilityClass(view_format);
5656 // Need to only check if one is NONE_BIT to handle edge case both are NONE_BIT
5657 if ((imageClass != viewClass) || (imageClass == VK_FORMAT_COMPATIBILITY_CLASS_NONE_BIT)) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005658 const char *error_vuid;
sfricke-samsung45996a42021-09-16 13:45:27 -07005659 if ((!IsExtEnabled(device_extensions.vk_khr_maintenance2)) &&
5660 (!IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion))) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005661 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
sfricke-samsung45996a42021-09-16 13:45:27 -07005662 } else if ((IsExtEnabled(device_extensions.vk_khr_maintenance2)) &&
5663 (!IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion))) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005664 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
sfricke-samsung45996a42021-09-16 13:45:27 -07005665 } else if ((!IsExtEnabled(device_extensions.vk_khr_maintenance2)) &&
5666 (IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion))) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005667 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
5668 } else {
5669 // both enabled
5670 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
5671 }
Dave Houltonc7988072018-04-16 11:46:56 -06005672 std::stringstream ss;
5673 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06005674 << " is not in the same format compatibility class as "
5675 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06005676 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
5677 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005678 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005679 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06005680 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005681 }
5682 } else {
5683 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07005684 // Unless it is a multi-planar color bit aspect
5685 if ((image_format != view_format) &&
5686 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
sfricke-samsung45996a42021-09-16 13:45:27 -07005687 const char *vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
5688 ? "VUID-VkImageViewCreateInfo-image-01762"
5689 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07005690 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06005691 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07005692 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07005693 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07005694 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005695 }
5696 }
5697
ziga-lunargebb32de2021-08-29 21:24:30 +02005698 if (image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT && view_type != VK_IMAGE_VIEW_TYPE_2D &&
5699 view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5700 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04972",
5701 "vkCreateImageView(): image was created with sample count %s, but pCreateInfo->viewType is %s.",
5702 string_VkSampleCountFlagBits(image_state->createInfo.samples), string_VkImageViewType(view_type));
5703 }
5704
Mark Lobodzinski602de982017-02-09 11:01:33 -07005705 // Validate correct image aspect bits for desired formats and format consistency
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005706 skip |= ValidateImageAspectMask(image_state->image(), image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06005707
sfricke-samsung20a8a372021-07-14 06:12:17 -07005708 // Valdiate Image/ImageView type compatibility #resources-image-views-compatibility
Jeremy Kniager846ab732017-07-10 13:12:04 -06005709 switch (image_type) {
5710 case VK_IMAGE_TYPE_1D:
5711 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005712 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5713 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5714 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005715 }
5716 break;
5717 case VK_IMAGE_TYPE_2D:
5718 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5719 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
5720 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005721 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
5722 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5723 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005724 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005725 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5726 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5727 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005728 }
5729 }
5730 break;
5731 case VK_IMAGE_TYPE_3D:
sfricke-samsung45996a42021-09-16 13:45:27 -07005732 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06005733 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
5734 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08005735 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005736 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005737 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
sfricke-samsungd9b3e122021-07-15 22:50:00 -07005738 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type "
5739 "%s since the image doesn't have VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT flag set.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005740 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005741 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
5742 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005743 skip |= LogError(
sfricke-samsungd9b3e122021-07-15 22:50:00 -07005744 pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04971",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005745 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
5746 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
5747 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
5748 string_VkImageViewType(view_type), string_VkImageType(image_type));
sfricke-samsungd9b3e122021-07-15 22:50:00 -07005749 } else if (pCreateInfo->subresourceRange.levelCount != 1) {
5750 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04970",
5751 "vkCreateImageView(): pCreateInfo->viewType %s is with image type %s must have a "
5752 "levelCount of 1 but it is %u.",
5753 string_VkImageViewType(view_type), string_VkImageType(image_type),
5754 pCreateInfo->subresourceRange.levelCount);
Jeremy Kniager846ab732017-07-10 13:12:04 -06005755 }
5756 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005757 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5758 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5759 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005760 }
5761 }
5762 } else {
5763 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
sfricke-samsungd9b3e122021-07-15 22:50:00 -07005764 // Help point to VK_KHR_maintenance1
5765 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
5766 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5767 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
5768 "without VK_KHR_maintenance1 enabled which was promoted in Vulkan 1.0.",
5769 string_VkImageViewType(view_type), string_VkImageType(image_type));
5770 } else {
5771 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5772 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5773 string_VkImageViewType(view_type), string_VkImageType(image_type));
5774 }
Jeremy Kniager846ab732017-07-10 13:12:04 -06005775 }
5776 }
5777 break;
5778 default:
5779 break;
5780 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005781
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005782 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
sfricke-samsung45996a42021-09-16 13:45:27 -07005783 if (IsExtEnabled(device_extensions.vk_android_external_memory_android_hardware_buffer)) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005784 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005785 }
5786
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005787 skip |= ValidateImageViewFormatFeatures(image_state, view_format, image_usage);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005788
sfricke-samsung828e59d2021-08-22 23:20:49 -07005789 if (enabled_features.shading_rate_image_features.shadingRateImage) {
Tobias Hector6663c9b2020-11-05 10:18:02 +00005790 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
5791 if (view_format != VK_FORMAT_R8_UINT) {
5792 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
5793 "vkCreateImageView() If image was created with usage containing "
5794 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
5795 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05005796 }
Tobias Hector6663c9b2020-11-05 10:18:02 +00005797 }
5798
sfricke-samsung828e59d2021-08-22 23:20:49 -07005799 if (enabled_features.shading_rate_image_features.shadingRateImage ||
Tobias Hector6663c9b2020-11-05 10:18:02 +00005800 enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
5801 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) {
5802 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5803 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
5804 "vkCreateImageView() If image was created with usage containing "
5805 "VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR, viewType must be "
5806 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
5807 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05005808 }
5809 }
Jeff Bolz99e3f632020-03-24 22:59:22 -05005810
Tobias Hector6663c9b2020-11-05 10:18:02 +00005811 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate &&
5812 !phys_dev_ext_props.fragment_shading_rate_props.layeredShadingRateAttachments &&
sfricke-samsung20a8a372021-07-14 06:12:17 -07005813 image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR && layer_count != 1) {
Tobias Hector6663c9b2020-11-05 10:18:02 +00005814 skip |= LogError(device, "VUID-VkImageViewCreateInfo-usage-04551",
5815 "vkCreateImageView(): subresourceRange.layerCount is %u for a shading rate attachment image view.",
sfricke-samsung20a8a372021-07-14 06:12:17 -07005816 layer_count);
Tobias Hector6663c9b2020-11-05 10:18:02 +00005817 }
5818
sfricke-samsung20a8a372021-07-14 06:12:17 -07005819 if (layer_count == VK_REMAINING_ARRAY_LAYERS) {
5820 const uint32_t remaining_layers = image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer;
5821 if (view_type == VK_IMAGE_VIEW_TYPE_CUBE && remaining_layers != 6) {
Jeff Bolz99e3f632020-03-24 22:59:22 -05005822 skip |= LogError(device, "VUID-VkImageViewCreateInfo-viewType-02962",
5823 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be 6",
sfricke-samsung20a8a372021-07-14 06:12:17 -07005824 remaining_layers);
Jeff Bolz99e3f632020-03-24 22:59:22 -05005825 }
sfricke-samsung20a8a372021-07-14 06:12:17 -07005826 if (view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY && ((remaining_layers) % 6) != 0) {
Jeff Bolz99e3f632020-03-24 22:59:22 -05005827 skip |= LogError(
5828 device, "VUID-VkImageViewCreateInfo-viewType-02963",
5829 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be a multiple of 6",
sfricke-samsung20a8a372021-07-14 06:12:17 -07005830 remaining_layers);
5831 }
5832 if ((remaining_layers != 1) && ((view_type == VK_IMAGE_VIEW_TYPE_1D) || (view_type == VK_IMAGE_VIEW_TYPE_2D) ||
5833 (view_type == VK_IMAGE_VIEW_TYPE_3D))) {
5834 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-imageViewType-04974",
5835 "vkCreateImageView(): Using pCreateInfo->viewType %s and the subresourceRange.layerCount "
5836 "VK_REMAINING_ARRAY_LAYERS=(%d) and must 1 (try looking into VK_IMAGE_VIEW_TYPE_*_ARRAY).",
5837 string_VkImageViewType(view_type), remaining_layers);
5838 }
5839 } else {
5840 if ((layer_count != 1) && ((view_type == VK_IMAGE_VIEW_TYPE_1D) || (view_type == VK_IMAGE_VIEW_TYPE_2D) ||
5841 (view_type == VK_IMAGE_VIEW_TYPE_3D))) {
5842 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-imageViewType-04973",
5843 "vkCreateImageView(): Using pCreateInfo->viewType %s and the subresourceRange.layerCount is %d "
5844 "and must 1 (try looking into VK_IMAGE_VIEW_TYPE_*_ARRAY).",
5845 string_VkImageViewType(view_type), layer_count);
Jeff Bolz99e3f632020-03-24 22:59:22 -05005846 }
5847 }
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005848
5849 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5850 if (pCreateInfo->subresourceRange.levelCount != 1) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005851 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02571",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005852 "vkCreateImageView(): If image was created with usage containing "
5853 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, subresourceRange.levelCount (%d) must: be 1",
5854 pCreateInfo->subresourceRange.levelCount);
5855 }
5856 }
5857 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5858 if (!enabled_features.fragment_density_map_features.fragmentDensityMapDynamic) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005859 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-02572",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005860 "vkCreateImageView(): If the fragmentDensityMapDynamic feature is not enabled, "
5861 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5862 }
5863 } else {
5864 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5865 if (image_flags & (VK_IMAGE_CREATE_PROTECTED_BIT | VK_IMAGE_CREATE_SPARSE_BINDING_BIT |
5866 VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT)) {
Shannon McPherson8d0d1f92020-07-06 11:58:21 -06005867 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-04116",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005868 "vkCreateImageView(): If image was created with usage containing "
5869 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT flags must not contain any of "
5870 "VK_IMAGE_CREATE_PROTECTED_BIT, VK_IMAGE_CREATE_SPARSE_BINDING_BIT, "
5871 "VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or VK_IMAGE_CREATE_SPARSE_ALIASED_BIT");
5872 }
5873 }
5874 }
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005875
ziga-lunarg966ac0e2021-07-18 11:51:44 +02005876 if (image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
5877 if (pCreateInfo->subresourceRange.levelCount != 1) {
5878 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01584",
5879 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit, "
5880 "but subresourcesRange.levelCount (%" PRIu32 ") is not 1.",
5881 pCreateInfo->subresourceRange.levelCount);
5882 }
5883 if (pCreateInfo->subresourceRange.layerCount != 1) {
5884 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01584",
5885 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit, "
5886 "but subresourcesRange.layerCount (%" PRIu32 ") is not 1.",
5887 pCreateInfo->subresourceRange.layerCount);
5888 }
5889 }
5890
Nathaniel Cesario42d5b282021-08-17 12:47:24 -06005891 if (image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT && !FormatIsCompressed(view_format) &&
ziga-lunargc290c7f2021-07-31 22:01:46 +02005892 pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_3D) {
5893 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04739",
5894 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit and "
5895 "non-compressed format (%s), but pCreateInfo->viewType is VK_IMAGE_VIEW_TYPE_3D.",
5896 string_VkFormat(image_format));
5897 }
5898
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005899 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT) {
5900 if (!enabled_features.fragment_density_map2_features.fragmentDensityMapDeferred) {
5901 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03567",
5902 "vkCreateImageView(): If the fragmentDensityMapDeferred feature is not enabled, "
5903 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT");
5904 }
5905 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5906 skip |=
5907 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03568",
5908 "vkCreateImageView(): If flags contains VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT, "
5909 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5910 }
5911 }
sfricke-samsung45996a42021-09-16 13:45:27 -07005912 if (IsExtEnabled(device_extensions.vk_ext_fragment_density_map2)) {
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005913 if ((image_flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) && (image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) &&
sfricke-samsung20a8a372021-07-14 06:12:17 -07005914 (layer_count > phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers)) {
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005915 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-03569",
5916 "vkCreateImageView(): If image was created with flags containing "
5917 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT and usage containing VK_IMAGE_USAGE_SAMPLED_BIT "
5918 "subresourceRange.layerCount (%d) must: be less than or equal to maxSubsampledArrayLayers (%d)",
sfricke-samsung20a8a372021-07-14 06:12:17 -07005919 layer_count, phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers);
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005920 }
5921 }
5922
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005923 auto astc_decode_mode = LvlFindInChain<VkImageViewASTCDecodeModeEXT>(pCreateInfo->pNext);
sfricke-samsung45996a42021-09-16 13:45:27 -07005924 if (IsExtEnabled(device_extensions.vk_ext_astc_decode_mode) && (astc_decode_mode != nullptr)) {
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005925 if ((enabled_features.astc_decode_features.decodeModeSharedExponent == VK_FALSE) &&
5926 (astc_decode_mode->decodeMode == VK_FORMAT_E5B9G9R9_UFLOAT_PACK32)) {
5927 skip |= LogError(device, "VUID-VkImageViewASTCDecodeModeEXT-decodeMode-02231",
5928 "vkCreateImageView(): decodeModeSharedExponent is not enabled but "
5929 "VkImageViewASTCDecodeModeEXT::decodeMode is VK_FORMAT_E5B9G9R9_UFLOAT_PACK32.");
5930 }
5931 }
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005932
sfricke-samsung45996a42021-09-16 13:45:27 -07005933 if (IsExtEnabled(device_extensions.vk_khr_portability_subset)) {
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005934 // If swizzling is disabled, make sure it isn't used
Nathaniel Cesario17d057e2021-06-21 22:58:45 -06005935 // NOTE: as of spec version 1.2.183, VUID 04465 states: "all elements of components _must_ be
5936 // VK_COMPONENT_SWIZZLE_IDENTITY."
5937 // However, issue https://github.com/KhronosGroup/Vulkan-Portability/issues/27 points out that the identity can
5938 // also be defined via R, G, B, A enums in the correct order.
5939 // Spec change is at https://gitlab.khronos.org/vulkan/vulkan/-/merge_requests/4600
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005940 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatSwizzle) &&
Nathaniel Cesario17d057e2021-06-21 22:58:45 -06005941 !IsIdentitySwizzle(pCreateInfo->components)) {
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005942 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatSwizzle-04465",
5943 "vkCreateImageView (portability error): swizzle is disabled for this device.");
5944 }
5945
5946 // Ensure ImageView's format has the same number of bits and components as Image's format if format reinterpretation is
5947 // disabled
5948 // TODO (ncesario): This is not correct for some cases (e.g., VK_FORMAT_B10G11R11_UFLOAT_PACK32 and
5949 // VK_FORMAT_E5B9G9R9_UFLOAT_PACK32), but requires additional information that should probably be generated from the
5950 // spec. See Github issue #2361.
5951 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatReinterpretation) &&
5952 ((FormatElementSize(pCreateInfo->format, VK_IMAGE_ASPECT_COLOR_BIT) !=
5953 FormatElementSize(image_state->createInfo.format, VK_IMAGE_ASPECT_COLOR_BIT)) ||
sfricke-samsunged028b02021-09-06 23:14:51 -07005954 (FormatComponentCount(pCreateInfo->format) != FormatComponentCount(image_state->createInfo.format)))) {
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07005955 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatReinterpretation-04466",
5956 "vkCreateImageView (portability error): ImageView format must have"
5957 " the same number of components and bits per component as the Image's format");
5958 }
5959 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005960 }
5961 return skip;
5962}
5963
Jeff Leger178b1e52020-10-05 12:22:23 -04005964template <typename RegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005965bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
Jeff Leger178b1e52020-10-05 12:22:23 -04005966 uint32_t regionCount, const RegionType *pRegions, CopyCommandVersion version) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005967 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04005968 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5969 const char *func_name = is_2khr ? "vkCmdCopyBuffer2KHR()" : "vkCmdCopyBuffer()";
5970 const char *vuid;
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005971
5972 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
5973 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
5974 VkDeviceSize src_min = UINT64_MAX;
5975 VkDeviceSize src_max = 0;
5976 VkDeviceSize dst_min = UINT64_MAX;
5977 VkDeviceSize dst_max = 0;
5978
5979 for (uint32_t i = 0; i < regionCount; i++) {
5980 src_min = std::min(src_min, pRegions[i].srcOffset);
5981 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
5982 dst_min = std::min(dst_min, pRegions[i].dstOffset);
5983 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
5984
5985 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
5986 if (pRegions[i].srcOffset >= src_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005987 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-srcOffset-00113" : "VUID-vkCmdCopyBuffer-srcOffset-00113";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005988 skip |= LogError(src_buffer_state->buffer(), vuid,
ziga-lunargd6b58ce2021-10-16 01:22:56 +02005989 "%s: pRegions[%" PRIu32 "].srcOffset (%" PRIuLEAST64
5990 ") is greater than size of srcBuffer (%" PRIuLEAST64 ").",
5991 func_name, i, pRegions[i].srcOffset, src_buffer_size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005992 }
5993
5994 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
5995 if (pRegions[i].dstOffset >= dst_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005996 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-dstOffset-00114" : "VUID-vkCmdCopyBuffer-dstOffset-00114";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005997 skip |= LogError(dst_buffer_state->buffer(), vuid,
ziga-lunargd6b58ce2021-10-16 01:22:56 +02005998 "%s: pRegions[%" PRIu32 "].dstOffset (%" PRIuLEAST64
5999 ") is greater than size of dstBuffer (%" PRIuLEAST64 ").",
6000 func_name, i, pRegions[i].dstOffset, dst_buffer_size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006001 }
6002
6003 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
6004 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006005 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00115" : "VUID-vkCmdCopyBuffer-size-00115";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006006 skip |= LogError(src_buffer_state->buffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006007 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the source buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006008 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04006009 func_name, i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006010 }
6011
6012 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
6013 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006014 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00116" : "VUID-vkCmdCopyBuffer-size-00116";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006015 skip |= LogError(dst_buffer_state->buffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006016 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the destination buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006017 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04006018 func_name, i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006019 }
6020 }
6021
6022 // 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 -06006023 if (src_buffer_state->buffer() == dst_buffer_state->buffer()) {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006024 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006025 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-pRegions-00117" : "VUID-vkCmdCopyBuffer-pRegions-00117";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006026 skip |= LogError(src_buffer_state->buffer(), vuid, "%s: Detected overlap between source and dest regions in memory.",
Jeff Leger178b1e52020-10-05 12:22:23 -04006027 func_name);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006028 }
6029 }
6030
6031 return skip;
6032}
6033
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006034bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006035 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06006036 const auto cb_node = GetCBState(commandBuffer);
6037 const auto src_buffer_state = GetBufferState(srcBuffer);
6038 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006039
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006040 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07006041 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
6042 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006043 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06006044 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006045 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
6046 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06006047 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006048 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
6049 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
sfricke-samsung85584a72021-09-30 21:43:38 -07006050 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER);
Jeff Leger178b1e52020-10-05 12:22:23 -04006051 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, regionCount, pRegions, COPY_COMMAND_VERSION_1);
sfricke-samsung022fa252020-07-24 03:26:16 -07006052 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01822");
6053 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01823");
6054 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01824");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006055 return skip;
6056}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07006057
Jeff Leger178b1e52020-10-05 12:22:23 -04006058bool CoreChecks::PreCallValidateCmdCopyBuffer2KHR(VkCommandBuffer commandBuffer,
6059 const VkCopyBufferInfo2KHR *pCopyBufferInfos) const {
6060 const auto cb_node = GetCBState(commandBuffer);
6061 const auto src_buffer_state = GetBufferState(pCopyBufferInfos->srcBuffer);
6062 const auto dst_buffer_state = GetBufferState(pCopyBufferInfos->dstBuffer);
6063
6064 bool skip = false;
6065 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-VkCopyBufferInfo2KHR-srcBuffer-00119");
6066 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-VkCopyBufferInfo2KHR-dstBuffer-00121");
6067 // Validate that SRC & DST buffers have correct usage flags set
6068 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
6069 "VUID-VkCopyBufferInfo2KHR-srcBuffer-00118", "vkCmdCopyBuffer2KHR()",
6070 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
6071 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
6072 "VUID-VkCopyBufferInfo2KHR-dstBuffer-00120", "vkCmdCopyBuffer2KHR()",
6073 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
sfricke-samsung85584a72021-09-30 21:43:38 -07006074 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER2KHR);
Jeff Leger178b1e52020-10-05 12:22:23 -04006075 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, pCopyBufferInfos->regionCount,
6076 pCopyBufferInfos->pRegions, COPY_COMMAND_VERSION_2);
6077 skip |=
6078 ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01822");
6079 skip |=
6080 ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01823");
6081 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer2KHR()",
6082 "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01824");
6083 return skip;
6084}
6085
Jeff Bolz46c0ea02019-10-09 13:06:29 -05006086bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006087 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07006088 auto buffer_state = GetBufferState(buffer);
sfricke-samsung9c7d8552020-08-16 22:12:21 -07006089 if (buffer_state) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06006090 if (buffer_state->InUse()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006091 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
6092 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006093 }
6094 }
6095 return skip;
6096}
6097
Jeff Bolz5c801d12019-10-09 10:38:45 -05006098bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
6099 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05006100 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07006101
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006102 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07006103 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07006104 skip |=
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06006105 ValidateObjectNotInUse(image_view_state, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006106 }
6107 return skip;
6108}
6109
Jeff Bolz5c801d12019-10-09 10:38:45 -05006110bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07006111 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07006112
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006113 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07006114 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07006115 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006116 }
6117 return skip;
6118}
6119
Nathaniel Cesario42ac6ca2021-06-15 17:23:05 -06006120void CoreChecks::PreCallRecordDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
6121 const auto buffer_state = Get<BUFFER_STATE>(buffer);
6122 if (buffer_state) {
6123 auto itr = buffer_address_map_.find(buffer_state->deviceAddress);
6124 if (itr != buffer_address_map_.end()) {
6125 buffer_address_map_.erase(itr);
6126 }
6127 }
6128 StateTracker::PreCallRecordDestroyBuffer(device, buffer, pAllocator);
6129}
6130
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006131bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006132 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07006133 auto buffer_view_state = GetBufferViewState(bufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006134 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07006135 if (buffer_view_state) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06006136 skip |= ValidateObjectNotInUse(buffer_view_state, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06006137 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006138 }
6139 return skip;
6140}
6141
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006142bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006143 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06006144 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07006145 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006146 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07006147 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
sfricke-samsung85584a72021-09-30 21:43:38 -07006148 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006149 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006150 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
6151 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006152
sfricke-samsung022fa252020-07-24 03:26:16 -07006153 skip |= ValidateProtectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01811");
6154 skip |= ValidateUnprotectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01812");
6155
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006156 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006157 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
6158 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
6159 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
6160 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006161 }
6162
6163 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006164 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
6165 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
6166 ") minus dstOffset (0x%" PRIxLEAST64 ").",
6167 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006168 }
6169
sfricke-samsung45996a42021-09-16 13:45:27 -07006170 if (!IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
ziga-lunarg3c5c84e2021-08-04 15:18:56 +02006171 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
6172 "VUID-vkCmdFillBuffer-commandBuffer-00030");
6173 }
6174
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006175 return skip;
6176}
6177
Jeff Leger178b1e52020-10-05 12:22:23 -04006178template <typename BufferImageCopyRegionType>
sfricke-samsungd0659242020-08-18 22:38:43 -07006179bool CoreChecks::ValidateBufferImageCopyData(const CMD_BUFFER_STATE *cb_node, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04006180 const BufferImageCopyRegionType *pRegions, const IMAGE_STATE *image_state,
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006181 const char *function, CopyCommandVersion version, bool image_to_buffer) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006182 bool skip = false;
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07006183 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
6184 const char *vuid;
Jeff Leger178b1e52020-10-05 12:22:23 -04006185
sfricke-samsung125d2b42020-05-28 06:32:43 -07006186 assert(image_state != nullptr);
6187 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006188
6189 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006190 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006191 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
6192 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006193 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00199", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006194 "%s: pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
6195 "and 1, respectively.",
6196 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006197 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006198 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006199
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006200 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
6201 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006202 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00201", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006203 "%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 -07006204 "must be 0 and 1, respectively.",
6205 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006206 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006207 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006208
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006209 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
6210 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006211 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00213", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006212 "%s: pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006213 "For 3D images these must be 0 and 1, respectively.",
6214 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006215 }
6216 }
6217
6218 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07006219 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
sfricke-samsung73e755c2021-09-30 08:34:57 -07006220 const uint32_t element_size =
6221 FormatIsDepthOrStencil(image_format) ? 0 : FormatElementSize(image_format, region_aspect_mask);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006222 const VkDeviceSize bufferOffset = pRegions[i].bufferOffset;
Locke497739c2019-03-08 11:50:47 -07006223
sfricke-samsung8feecc12021-01-23 03:28:38 -08006224 if (FormatIsDepthOrStencil(image_format)) {
6225 if (SafeModulo(bufferOffset, 4) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006226 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("04053", image_to_buffer, is_2khr),
sfricke-samsung8feecc12021-01-23 03:28:38 -08006227 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6228 " must be a multiple 4 if using a depth/stencil format (%s).",
6229 function, i, bufferOffset, string_VkFormat(image_format));
6230 }
6231 } else {
6232 // If not depth/stencil and not multi-plane
6233 if (!FormatIsMultiplane(image_format) && (SafeModulo(bufferOffset, element_size) != 0)) {
sfricke-samsung45996a42021-09-16 13:45:27 -07006234 vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
sfricke-samsung8feecc12021-01-23 03:28:38 -08006235 ? GetBufferImageCopyCommandVUID("01558", image_to_buffer, is_2khr)
6236 : GetBufferImageCopyCommandVUID("00193", image_to_buffer, is_2khr);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006237 skip |= LogError(image_state->image(), vuid,
sfricke-samsung8feecc12021-01-23 03:28:38 -08006238 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6239 " must be a multiple of this format's texel size (%" PRIu32 ").",
6240 function, i, bufferOffset, element_size);
6241 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006242 }
6243
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006244 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
6245 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006246 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferRowLength-00195" : "VUID-VkBufferImageCopy-bufferRowLength-00195";
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06006247 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006248 LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006249 "%s: pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006250 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006251 }
6252
6253 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
6254 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006255 vuid =
6256 (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferImageHeight-00196" : "VUID-VkBufferImageCopy-bufferImageHeight-00196";
Jeff Leger178b1e52020-10-05 12:22:23 -04006257 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006258 LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006259 "%s: pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
6260 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006261 }
6262
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006263 // Calculate adjusted image extent, accounting for multiplane image factors
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06006264 VkExtent3D adjusted_image_extent = image_state->GetSubresourceExtent(pRegions[i].imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006265 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006266 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 -06006267 ((pRegions[i].imageOffset.x + static_cast<int32_t>(pRegions[i].imageExtent.width)) >
6268 static_cast<int32_t>(adjusted_image_extent.width))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006269 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00197", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006270 "%s: Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006271 "zero or <= image subresource width (%d).",
6272 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006273 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006274 }
6275
6276 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006277 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 -06006278 ((pRegions[i].imageOffset.y + static_cast<int32_t>(pRegions[i].imageExtent.height)) >
6279 static_cast<int32_t>(adjusted_image_extent.height))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006280 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00198", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006281 "%s: Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006282 "zero or <= image subresource height (%d).",
6283 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006284 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006285 }
6286
6287 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006288 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 -06006289 ((pRegions[i].imageOffset.z + static_cast<int32_t>(pRegions[i].imageExtent.depth)) >
6290 static_cast<int32_t>(adjusted_image_extent.depth))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006291 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00200", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006292 "%s: Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006293 "zero or <= image subresource depth (%d).",
6294 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006295 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006296 }
6297
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006298 // subresource aspectMask must have exactly 1 bit set
6299 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
sfricke-samsung125d2b42020-05-28 06:32:43 -07006300 std::bitset<num_bits> aspect_mask_bits(region_aspect_mask);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006301 if (aspect_mask_bits.count() != 1) {
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07006302 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-aspectMask-00212" : "VUID-VkBufferImageCopy-aspectMask-00212";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006303 skip |= LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006304 "%s: aspectMasks for imageSubresource in pRegion[%d] must have only a single bit set.", function, i);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006305 }
6306
6307 // image subresource aspect bit must match format
sfricke-samsung125d2b42020-05-28 06:32:43 -07006308 if (!VerifyAspectsPresent(region_aspect_mask, image_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006309 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006310 LogError(image_state->image(), GetBufferImageCopyCommandVUID("00211", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006311 "%s: pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
6312 function, i, region_aspect_mask, image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006313 }
6314
6315 // Checks that apply only to compressed images
sfricke-samsung125d2b42020-05-28 06:32:43 -07006316 if (FormatIsCompressed(image_format) || FormatIsSinglePlane_422(image_format)) {
6317 auto block_size = FormatTexelBlockExtent(image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006318
6319 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06006320 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006321 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006322 LogError(image_state->image(), GetBufferImageCopyCommandVUID("00203", image_to_buffer, is_2khr),
Petr Krausb0d5e592021-05-21 23:37:11 +02006323 "%s: pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04006324 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006325 }
6326
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006327 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06006328 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006329 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006330 image_state->image(), GetBufferImageCopyCommandVUID("00204", image_to_buffer, is_2khr),
Petr Krausb0d5e592021-05-21 23:37:11 +02006331 "%s: pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06006332 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006333 }
6334
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006335 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06006336 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
6337 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
6338 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006339 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00205", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006340 "%s: pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
Petr Krausb0d5e592021-05-21 23:37:11 +02006341 "width & height (%d, %d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006342 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
6343 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006344 }
6345
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006346 // bufferOffset must be a multiple of block size (linear bytes)
sfricke-samsung73e755c2021-09-30 08:34:57 -07006347 if (SafeModulo(bufferOffset, element_size) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006348 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00206", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006349 "%s: pRegion[%d] bufferOffset (0x%" PRIxLEAST64
Petr Krausb0d5e592021-05-21 23:37:11 +02006350 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ").",
sfricke-samsung73e755c2021-09-30 08:34:57 -07006351 function, i, bufferOffset, element_size);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006352 }
Dave Houlton67e9b532017-03-02 17:00:10 -07006353
6354 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06006355 VkExtent3D mip_extent = image_state->GetSubresourceExtent(pRegions[i].imageSubresource);
Dave Houlton1d2022c2017-03-29 11:43:58 -06006356 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006357 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006358 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00207", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006359 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Petr Krausb0d5e592021-05-21 23:37:11 +02006360 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006361 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
6362 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07006363 }
6364
6365 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06006366 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006367 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006368 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00208", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006369 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Petr Krausb0d5e592021-05-21 23:37:11 +02006370 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006371 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
6372 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07006373 }
6374
6375 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06006376 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07006377 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006378 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00209", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006379 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Petr Krausb0d5e592021-05-21 23:37:11 +02006380 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006381 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
6382 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07006383 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006384 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08006385
6386 // Checks that apply only to multi-planar format images
sfricke-samsung125d2b42020-05-28 06:32:43 -07006387 if (FormatIsMultiplane(image_format)) {
sfricke-samsung552d5e12020-01-07 22:00:20 -08006388 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
sfricke-samsung125d2b42020-05-28 06:32:43 -07006389 if ((FormatPlaneCount(image_format) < 3) && (region_aspect_mask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006390 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006391 "%s: pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006392 "format has three planes.",
6393 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08006394 }
6395
6396 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
sfricke-samsung125d2b42020-05-28 06:32:43 -07006397 if (0 ==
6398 (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 -06006399 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006400 "%s: pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006401 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
6402 function, i);
sfricke-samsung125d2b42020-05-28 06:32:43 -07006403 } else {
6404 // Know aspect mask is valid
6405 const VkFormat compatible_format = FindMultiplaneCompatibleFormat(image_format, region_aspect_mask);
6406 const uint32_t compatible_size = FormatElementSize(compatible_format);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006407 if (SafeModulo(bufferOffset, compatible_size) != 0) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006408 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006409 image_state->image(), GetBufferImageCopyCommandVUID("01559", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04006410 "%s: pRegion[%d]->bufferOffset is 0x%" PRIxLEAST64
sfricke-samsung125d2b42020-05-28 06:32:43 -07006411 " 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 -08006412 function, i, bufferOffset, element_size, GetPlaneIndex(region_aspect_mask),
sfricke-samsung125d2b42020-05-28 06:32:43 -07006413 string_VkFormat(compatible_format));
6414 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08006415 }
6416 }
sfricke-samsung8feecc12021-01-23 03:28:38 -08006417
6418 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
6419 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool.get();
6420 assert(command_pool != nullptr);
6421 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
6422 const VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[queue_family_index].queueFlags;
6423 if (((queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT)) == 0) && (SafeModulo(bufferOffset, 4) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006424 LogObjectList objlist(cb_node->commandBuffer());
6425 objlist.add(command_pool->commandPool());
6426 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("04052", image_to_buffer, is_2khr),
sfricke-samsung8feecc12021-01-23 03:28:38 -08006427 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6428 " must be a multiple 4 because the command buffer %s was allocated from the command pool %s "
6429 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT or "
6430 "VK_QUEUE_COMPUTE_BIT flag.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006431 function, i, bufferOffset, report_data->FormatHandle(cb_node->commandBuffer()).c_str(),
6432 report_data->FormatHandle(command_pool->commandPool()).c_str(), queue_family_index);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006433 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006434 }
6435
6436 return skip;
6437}
6438
Jeff Leger178b1e52020-10-05 12:22:23 -04006439template <typename BufferImageCopyRegionType>
6440bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount,
6441 const BufferImageCopyRegionType *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006442 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006443 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006444
6445 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006446 VkExtent3D extent = pRegions[i].imageExtent;
6447 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006448
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006449 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
6450 {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006451 skip |= LogWarning(image_state->image(), kVUID_Core_Image_ZeroAreaSubregion,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006452 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
6453 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006454 }
6455
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06006456 VkExtent3D image_extent = image_state->GetSubresourceExtent(pRegions[i].imageSubresource);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006457
6458 // 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 -06006459 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07006460 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006461 if (image_extent.width % block_extent.width) {
6462 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
6463 }
6464 if (image_extent.height % block_extent.height) {
6465 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
6466 }
6467 if (image_extent.depth % block_extent.depth) {
6468 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
6469 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006470 }
6471
Dave Houltonfc1a4052017-04-27 14:32:45 -06006472 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Petr Krausb0d5e592021-05-21 23:37:11 +02006473 skip |= LogError(image_state->image(), msg_code, "%s: pRegion[%d] exceeds image bounds.", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006474 }
6475 }
6476
6477 return skip;
6478}
6479
Jeff Leger178b1e52020-10-05 12:22:23 -04006480template <typename BufferImageCopyRegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006481bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04006482 const BufferImageCopyRegionType *pRegions, const char *func_name,
6483 const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006484 bool skip = false;
6485
sfricke-samsung11d15ba2021-09-30 09:19:56 -07006486 const VkDeviceSize buffer_size = buff_state->createInfo.size;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006487
6488 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung11d15ba2021-09-30 09:19:56 -07006489 const VkDeviceSize buffer_copy_size = GetBufferSizeFromCopyImage(pRegions[i], image_state->createInfo.format);
6490 // This blocks against invalid VkBufferCopyImage that already have been caught elsewhere
6491 if (buffer_copy_size != 0) {
6492 const VkDeviceSize max_buffer_copy = buffer_copy_size + pRegions[i].bufferOffset;
6493 if (buffer_size < max_buffer_copy) {
6494 skip |= LogError(device, msg_code,
6495 "%s: pRegion[%" PRIu32 "] is trying to copy %" PRIu64 " bytes plus %" PRIu64
6496 " offset to/from the VkBuffer (%s) which exceeds the VkBuffer total size of %" PRIu64 " bytes.",
6497 func_name, i, buffer_copy_size, pRegions[i].bufferOffset,
6498 report_data->FormatHandle(buff_state->buffer()).c_str(), buffer_size);
6499 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006500 }
6501 }
6502
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006503 return skip;
6504}
6505
Jeff Leger178b1e52020-10-05 12:22:23 -04006506template <typename BufferImageCopyRegionType>
6507bool CoreChecks::ValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6508 VkBuffer dstBuffer, uint32_t regionCount, const BufferImageCopyRegionType *pRegions,
6509 CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06006510 const auto cb_node = GetCBState(commandBuffer);
6511 const auto src_image_state = GetImageState(srcImage);
6512 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006513
Jeff Leger178b1e52020-10-05 12:22:23 -04006514 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
Jeff Leger178b1e52020-10-05 12:22:23 -04006515 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGETOBUFFER2KHR : CMD_COPYIMAGETOBUFFER;
sfricke-samsung85584a72021-09-30 21:43:38 -07006516 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04006517 const char *vuid;
6518
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006519 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, src_image_state, func_name, version, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006520
6521 // Validate command buffer state
sfricke-samsung85584a72021-09-30 21:43:38 -07006522 skip |= ValidateCmd(cb_node, cmd_type);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006523
6524 // Command pool must support graphics, compute, or transfer operations
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07006525 const auto pool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006526
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07006527 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07006528
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006529 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006530 vuid =
6531 is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool";
6532 skip |= LogError(cb_node->createInfo.commandPool, vuid,
6533 "Cannot call %s on a command buffer allocated from a pool without graphics, compute, "
6534 "or transfer capabilities.",
6535 func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006536 }
Mike Schuchardt7b152fa2021-08-03 16:30:27 -07006537 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00182" : "VUID-vkCmdCopyImageToBuffer-pRegions-06220";
Jeff Leger178b1e52020-10-05 12:22:23 -04006538 skip |= ValidateImageBounds(src_image_state, regionCount, pRegions, func_name, vuid);
6539 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00183" : "VUID-vkCmdCopyImageToBuffer-pRegions-00183";
6540 skip |= ValidateBufferBounds(src_image_state, dst_buffer_state, regionCount, pRegions, func_name, vuid);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006541
Jeff Leger178b1e52020-10-05 12:22:23 -04006542 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00188" : "VUID-vkCmdCopyImageToBuffer-srcImage-00188";
6543 const char *location = is_2khr ? "vkCmdCopyImageToBuffer2KHR(): srcImage" : "vkCmdCopyImageToBuffer(): srcImage";
6544 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
6545
6546 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00187" : "VUID-vkCmdCopyImageToBuffer-srcImage-00187";
6547 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
6548 vuid = is_2khr ? "vkCmdCopyImageToBuffer-dstBuffer2KHR-00192" : "vkCmdCopyImageToBuffer dstBuffer-00192";
6549 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, func_name, vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006550
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006551 // Validate that SRC image & DST buffer have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04006552 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00186" : "VUID-vkCmdCopyImageToBuffer-srcImage-00186";
6553 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006554 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006555 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-dstBuffer-00191" : "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191";
6556 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006557 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006558 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01831" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01831";
6559 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
6560 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01832" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01832";
6561 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
6562 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01833" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01833";
6563 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006564
6565 // Validation for VK_EXT_fragment_density_map
6566 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006567 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-02544" : "VUID-vkCmdCopyImageToBuffer-srcImage-02544";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006568 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006569 "%s: srcImage must not have been created with flags containing "
6570 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
6571 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006572 }
6573
sfricke-samsung45996a42021-09-16 13:45:27 -07006574 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006575 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-01998" : "VUID-vkCmdCopyImageToBuffer-srcImage-01998";
6576 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04006577 }
Tobin Ehlisc8266452017-04-07 12:20:30 -06006578 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04006579
sfricke-samsung45996a42021-09-16 13:45:27 -07006580 const char *src_invalid_layout_vuid =
6581 (src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
6582 ? (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-01397"
6583 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397")
6584 : (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00190"
6585 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190");
Jeff Leger178b1e52020-10-05 12:22:23 -04006586
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006587 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006588 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
6589 vuid =
6590 is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00189" : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07006591 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04006592 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, src_invalid_layout_vuid, vuid, &hit_error);
6593 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-01794" : "VUID-vkCmdCopyImageToBuffer-imageOffset-01794";
6594 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, src_image_state, &pRegions[i], i, func_name, vuid);
6595 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01703"
6596 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703";
6597 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
6598 "imageSubresource", vuid);
6599 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01704"
6600 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006601 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04006602 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006603 }
6604 return skip;
6605}
6606
Jeff Leger178b1e52020-10-05 12:22:23 -04006607bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6608 VkBuffer dstBuffer, uint32_t regionCount,
6609 const VkBufferImageCopy *pRegions) const {
6610 return ValidateCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions,
6611 COPY_COMMAND_VERSION_1);
6612}
6613
6614bool CoreChecks::PreCallValidateCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
6615 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) const {
6616 return ValidateCmdCopyImageToBuffer(commandBuffer, pCopyImageToBufferInfo->srcImage, pCopyImageToBufferInfo->srcImageLayout,
6617 pCopyImageToBufferInfo->dstBuffer, pCopyImageToBufferInfo->regionCount,
6618 pCopyImageToBufferInfo->pRegions, COPY_COMMAND_VERSION_2);
6619}
6620
John Zulauf1686f232019-07-09 16:27:11 -06006621void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6622 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
6623 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
6624
6625 auto cb_node = GetCBState(commandBuffer);
6626 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06006627 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006628 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06006629 cb_node->SetImageInitialLayout(*src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06006630 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006631}
6632
Jeff Leger178b1e52020-10-05 12:22:23 -04006633void CoreChecks::PreCallRecordCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
6634 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) {
6635 StateTracker::PreCallRecordCmdCopyImageToBuffer2KHR(commandBuffer, pCopyImageToBufferInfo);
6636
6637 auto cb_node = GetCBState(commandBuffer);
6638 auto src_image_state = GetImageState(pCopyImageToBufferInfo->srcImage);
6639 // Make sure that all image slices record referenced layout
6640 for (uint32_t i = 0; i < pCopyImageToBufferInfo->regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06006641 cb_node->SetImageInitialLayout(*src_image_state, pCopyImageToBufferInfo->pRegions[i].imageSubresource,
6642 pCopyImageToBufferInfo->srcImageLayout);
Jeff Leger178b1e52020-10-05 12:22:23 -04006643 }
6644}
6645
6646template <typename RegionType>
6647bool CoreChecks::ValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6648 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
6649 CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06006650 const auto cb_node = GetCBState(commandBuffer);
6651 const auto src_buffer_state = GetBufferState(srcBuffer);
6652 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006653
Jeff Leger178b1e52020-10-05 12:22:23 -04006654 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
Jeff Leger178b1e52020-10-05 12:22:23 -04006655 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYBUFFERTOIMAGE2KHR : CMD_COPYBUFFERTOIMAGE;
sfricke-samsung85584a72021-09-30 21:43:38 -07006656 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04006657 const char *vuid;
6658
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07006659 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, dst_image_state, func_name, version, false);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006660
6661 // Validate command buffer state
sfricke-samsung85584a72021-09-30 21:43:38 -07006662 skip |= ValidateCmd(cb_node, cmd_type);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006663
Mike Schuchardt7b152fa2021-08-03 16:30:27 -07006664 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00172" : "VUID-vkCmdCopyBufferToImage-pRegions-06217";
Jeff Leger178b1e52020-10-05 12:22:23 -04006665 skip |= ValidateImageBounds(dst_image_state, regionCount, pRegions, func_name, vuid);
6666 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00171" : "VUID-vkCmdCopyBufferToImage-pRegions-00171";
6667 skip |= ValidateBufferBounds(dst_image_state, src_buffer_state, regionCount, pRegions, func_name, vuid);
6668
6669 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00179" : "VUID-vkCmdCopyBufferToImage-dstImage-00179";
6670 const char *location = is_2khr ? "vkCmdCopyBufferToImage2KHR(): dstImage" : "vkCmdCopyBufferToImage(): dstImage";
6671 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
6672 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00176" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00176";
6673 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, func_name, vuid);
6674 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00178" : "VUID-vkCmdCopyBufferToImage-dstImage-00178";
6675 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
6676 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00174" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00174";
6677 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006678 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006679 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00177" : "VUID-vkCmdCopyBufferToImage-dstImage-00177";
6680 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006681 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04006682 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01828" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01828";
6683 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, func_name, vuid);
6684 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01829" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01829";
6685 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
6686 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage-commandBuffer-01830" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01830";
6687 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006688
6689 // Validation for VK_EXT_fragment_density_map
6690 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006691 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-02543" : "VUID-vkCmdCopyBufferToImage-dstImage-02543";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006692 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006693 "%s: dstImage must not have been created with flags containing "
6694 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
6695 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006696 }
6697
sfricke-samsung45996a42021-09-16 13:45:27 -07006698 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006699 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-01997" : "VUID-vkCmdCopyBufferToImage-dstImage-01997";
6700 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04006701 }
Tobin Ehlisc8266452017-04-07 12:20:30 -06006702 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04006703
sfricke-samsung45996a42021-09-16 13:45:27 -07006704 const char *dst_invalid_layout_vuid =
6705 (dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
6706 ? (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-01396"
6707 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396")
6708 : (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00181"
6709 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181");
Jeff Leger178b1e52020-10-05 12:22:23 -04006710
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006711 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006712 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
6713 vuid =
6714 is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00180" : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07006715 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04006716 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, dst_invalid_layout_vuid, vuid, &hit_error);
6717 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-01793" : "VUID-vkCmdCopyBufferToImage-imageOffset-01793";
6718 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, dst_image_state, &pRegions[i], i, func_name, vuid);
6719 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01701"
6720 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01701";
6721 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
6722 "imageSubresource", vuid);
6723 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01702"
6724 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01702";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07006725 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04006726 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
sfricke-samsungea4fd142020-10-17 23:51:59 -07006727
6728 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
6729 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool.get();
6730 assert(command_pool != nullptr);
6731 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
6732 const VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[queue_family_index].queueFlags;
6733 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
6734 if (((queue_flags & VK_QUEUE_GRAPHICS_BIT) == 0) &&
6735 ((region_aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006736 LogObjectList objlist(cb_node->commandBuffer());
6737 objlist.add(command_pool->commandPool());
sfricke-samsungea4fd142020-10-17 23:51:59 -07006738 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-commandBuffer-04477"
6739 : "VUID-vkCmdCopyBufferToImage-commandBuffer-04477";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006740 skip |= LogError(dst_image_state->image(), vuid,
sfricke-samsungea4fd142020-10-17 23:51:59 -07006741 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies VK_IMAGE_ASPECT_DEPTH_BIT or "
6742 "VK_IMAGE_ASPECT_STENCIL_BIT but the command buffer %s was allocated from the command pool %s "
6743 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT flag.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006744 func_name, i, region_aspect_mask, report_data->FormatHandle(cb_node->commandBuffer()).c_str(),
6745 report_data->FormatHandle(command_pool->commandPool()).c_str(), queue_family_index);
sfricke-samsungea4fd142020-10-17 23:51:59 -07006746 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006747 }
6748 return skip;
6749}
6750
Jeff Leger178b1e52020-10-05 12:22:23 -04006751bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6752 VkImageLayout dstImageLayout, uint32_t regionCount,
6753 const VkBufferImageCopy *pRegions) const {
6754 return ValidateCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions,
6755 COPY_COMMAND_VERSION_1);
6756}
6757
6758bool CoreChecks::PreCallValidateCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
6759 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo) const {
6760 return ValidateCmdCopyBufferToImage(commandBuffer, pCopyBufferToImageInfo->srcBuffer, pCopyBufferToImageInfo->dstImage,
6761 pCopyBufferToImageInfo->dstImageLayout, pCopyBufferToImageInfo->regionCount,
6762 pCopyBufferToImageInfo->pRegions, COPY_COMMAND_VERSION_2);
6763}
6764
John Zulauf1686f232019-07-09 16:27:11 -06006765void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6766 VkImageLayout dstImageLayout, uint32_t regionCount,
6767 const VkBufferImageCopy *pRegions) {
6768 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
6769
6770 auto cb_node = GetCBState(commandBuffer);
6771 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06006772 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006773 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06006774 cb_node->SetImageInitialLayout(*dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06006775 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006776}
Mike Weiblen672b58b2017-02-21 14:32:53 -07006777
Jeff Leger178b1e52020-10-05 12:22:23 -04006778void CoreChecks::PreCallRecordCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
6779 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo2KHR) {
6780 StateTracker::PreCallRecordCmdCopyBufferToImage2KHR(commandBuffer, pCopyBufferToImageInfo2KHR);
6781
6782 auto cb_node = GetCBState(commandBuffer);
6783 auto dst_image_state = GetImageState(pCopyBufferToImageInfo2KHR->dstImage);
6784 // Make sure that all image slices are record referenced layout
6785 for (uint32_t i = 0; i < pCopyBufferToImageInfo2KHR->regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06006786 cb_node->SetImageInitialLayout(*dst_image_state, pCopyBufferToImageInfo2KHR->pRegions[i].imageSubresource,
6787 pCopyBufferToImageInfo2KHR->dstImageLayout);
Jeff Leger178b1e52020-10-05 12:22:23 -04006788 }
6789}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006790bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006791 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07006792 bool skip = false;
6793 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
6794
Dave Houlton1d960ff2018-01-19 12:17:05 -07006795 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07006796 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
6797 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
6798 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006799 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
6800 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006801 }
6802
John Zulaufa26d3c82019-08-14 16:09:08 -06006803 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006804 if (!image_entry) {
6805 return skip;
6806 }
6807
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006808 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
sfricke-samsung45996a42021-09-16 13:45:27 -07006809 if (IsExtEnabled(device_extensions.vk_ext_image_drm_format_modifier)) {
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006810 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
6811 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006812 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
6813 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
6814 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006815 }
6816 } else {
6817 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006818 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
6819 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06006820 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07006821 }
6822
Dave Houlton1d960ff2018-01-19 12:17:05 -07006823 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07006824 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006825 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
6826 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
6827 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006828 }
6829
Dave Houlton1d960ff2018-01-19 12:17:05 -07006830 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07006831 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006832 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
6833 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
6834 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006835 }
6836
Dave Houlton1d960ff2018-01-19 12:17:05 -07006837 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07006838 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006839 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
6840 if (FormatIsMultiplane(img_format)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08006841 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006842 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
6843 if (FormatPlaneCount(img_format) > 2u) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08006844 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006845 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
6846 }
6847 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006848 skip |= LogError(image, vuid,
6849 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
6850 ") must be a single-plane specifier flag.",
6851 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006852 }
6853 } else if (FormatIsColor(img_format)) {
6854 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
ziga-lunargcc568bc2021-09-05 13:45:45 +02006855 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04461",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006856 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
6857 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006858 }
6859 } else if (FormatIsDepthOrStencil(img_format)) {
Nathaniel Cesario8c80f352021-07-15 15:06:48 -06006860 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006861 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07006862 }
ziga-lunarg4ecbd5b2021-07-15 20:48:30 +02006863 if (!FormatIsDepthAndStencil(img_format) && !FormatIsDepthOnly(img_format)) {
6864 if (sub_aspect & VK_IMAGE_ASPECT_DEPTH_BIT) {
6865 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04464",
6866 "vkGetImageSubresourceLayout(): Image format (%s) does not contain a depth component, "
6867 "but VkImageSubresource.aspectMask contains VK_IMAGE_ASPECT_DEPTH_BIT.",
6868 string_VkFormat(img_format));
6869 }
6870 } else {
6871 if ((sub_aspect & VK_IMAGE_ASPECT_DEPTH_BIT) == 0) {
6872 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04462",
6873 "vkGetImageSubresourceLayout(): Image format (%s) contains a depth component, "
6874 "but VkImageSubresource.aspectMask does not contain VK_IMAGE_ASPECT_DEPTH_BIT.",
6875 string_VkFormat(img_format));
6876 }
6877 }
6878 if (!FormatIsDepthAndStencil(img_format) && !FormatIsStencilOnly(img_format)) {
6879 if (sub_aspect & VK_IMAGE_ASPECT_STENCIL_BIT) {
6880 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04464",
6881 "vkGetImageSubresourceLayout(): Image format (%s) does not contain a stencil component, "
6882 "but VkImageSubresource.aspectMask contains VK_IMAGE_ASPECT_STENCIL_BIT.",
6883 string_VkFormat(img_format));
6884 }
6885 } else {
6886 if ((sub_aspect & VK_IMAGE_ASPECT_STENCIL_BIT) == 0) {
6887 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04463",
6888 "vkGetImageSubresourceLayout(): Image format (%s) contains a stencil component, "
6889 "but VkImageSubresource.aspectMask does not contain VK_IMAGE_ASPECT_STENCIL_BIT.",
6890 string_VkFormat(img_format));
6891 }
6892 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006893 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
6894 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
6895 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
6896 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006897 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
6898 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
6899 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006900 }
6901 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006902
sfricke-samsung45996a42021-09-16 13:45:27 -07006903 if (IsExtEnabled(device_extensions.vk_android_external_memory_android_hardware_buffer)) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07006904 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006905 }
6906
Mike Weiblen672b58b2017-02-21 14:32:53 -07006907 return skip;
6908}
sfricke-samsung022fa252020-07-24 03:26:16 -07006909
6910// Validates the image is allowed to be protected
6911bool CoreChecks::ValidateProtectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006912 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006913 bool skip = false;
6914 if ((cb_state->unprotected == true) && (image_state->unprotected == false)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006915 LogObjectList objlist(cb_state->commandBuffer());
6916 objlist.add(image_state->image());
locke-lunarg351c9d82020-10-23 14:43:21 -06006917 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 -06006918 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
6919 report_data->FormatHandle(image_state->image()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006920 }
6921 return skip;
6922}
6923
6924// Validates the image is allowed to be unprotected
6925bool CoreChecks::ValidateUnprotectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006926 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006927 bool skip = false;
6928 if ((cb_state->unprotected == false) && (image_state->unprotected == true)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006929 LogObjectList objlist(cb_state->commandBuffer());
6930 objlist.add(image_state->image());
locke-lunarg351c9d82020-10-23 14:43:21 -06006931 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 -06006932 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
6933 report_data->FormatHandle(image_state->image()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006934 }
6935 return skip;
6936}
6937
6938// Validates the buffer is allowed to be protected
6939bool CoreChecks::ValidateProtectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006940 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006941 bool skip = false;
6942 if ((cb_state->unprotected == true) && (buffer_state->unprotected == false)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006943 LogObjectList objlist(cb_state->commandBuffer());
6944 objlist.add(buffer_state->buffer());
locke-lunarg351c9d82020-10-23 14:43:21 -06006945 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 -06006946 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
6947 report_data->FormatHandle(buffer_state->buffer()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006948 }
6949 return skip;
6950}
6951
6952// Validates the buffer is allowed to be unprotected
6953bool CoreChecks::ValidateUnprotectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006954 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006955 bool skip = false;
6956 if ((cb_state->unprotected == false) && (buffer_state->unprotected == true)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006957 LogObjectList objlist(cb_state->commandBuffer());
6958 objlist.add(buffer_state->buffer());
locke-lunarg351c9d82020-10-23 14:43:21 -06006959 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 -06006960 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
6961 report_data->FormatHandle(buffer_state->buffer()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006962 }
6963 return skip;
6964}