blob: 68f4d1ac7a73aba034293b95e974e2d01c20459d [file] [log] [blame]
Jeremy Gebben65975ed2021-10-29 11:16:10 -06001/* Copyright (c) 2015-2022 The Khronos Group Inc.
2 * Copyright (c) 2015-2022 Valve Corporation
3 * Copyright (c) 2015-2022 LunarG, Inc.
4 * Copyright (C) 2015-2022 Google Inc.
Aaron Hagan1656b2b2021-12-21 11:52:41 -05005 * Modifications Copyright (C) 2020-2022 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
Tony Barbour845d29b2021-11-09 11:43:14 -070054 "VUID-VkCopyBufferToImageInfo2-bufferOffset-00193", // copy2 & !image_to_buffer
Tony-LunarGaf3632a2021-11-10 15:51:57 -070055 "VUID-VkCopyImageToBufferInfo2-bufferOffset-00193", // copy2 & image_to_buffer
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070056 }},
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",
Tony Barbour845d29b2021-11-09 11:43:14 -070060 "VUID-VkCopyBufferToImageInfo2-bufferOffset-01558",
Tony-LunarGaf3632a2021-11-10 15:51:57 -070061 "VUID-VkCopyImageToBufferInfo2-bufferOffset-01558",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070062 }},
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",
Tony Barbour845d29b2021-11-09 11:43:14 -070066 "VUID-VkCopyBufferToImageInfo2-bufferOffset-01559",
Tony-LunarGaf3632a2021-11-10 15:51:57 -070067 "VUID-VkCopyImageToBufferInfo2-bufferOffset-01559",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070068 }},
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",
Tony Barbour845d29b2021-11-09 11:43:14 -070072 "VUID-VkCopyBufferToImageInfo2-pRegions-06223",
Tony-LunarGaf3632a2021-11-10 15:51:57 -070073 "VUID-VkCopyImageToBufferInfo2-imageOffset-00197",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070074 }},
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",
Tony Barbour845d29b2021-11-09 11:43:14 -070078 "VUID-VkCopyBufferToImageInfo2-pRegions-06224",
Tony-LunarGaf3632a2021-11-10 15:51:57 -070079 "VUID-VkCopyImageToBufferInfo2-imageOffset-00198",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070080 }},
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",
Tony Barbour845d29b2021-11-09 11:43:14 -070084 "VUID-VkCopyBufferToImageInfo2-srcImage-00199",
Tony-LunarGaf3632a2021-11-10 15:51:57 -070085 "VUID-VkCopyImageToBufferInfo2-srcImage-00199",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070086 }},
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",
Tony Barbour845d29b2021-11-09 11:43:14 -070090 "VUID-VkCopyBufferToImageInfo2-imageOffset-00200",
Tony-LunarGaf3632a2021-11-10 15:51:57 -070091 "VUID-VkCopyImageToBufferInfo2-imageOffset-00200",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070092 }},
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",
Tony Barbour845d29b2021-11-09 11:43:14 -070096 "VUID-VkCopyBufferToImageInfo2-srcImage-00201",
Tony-LunarGaf3632a2021-11-10 15:51:57 -070097 "VUID-VkCopyImageToBufferInfo2-srcImage-00201",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070098 }},
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",
Tony Barbour845d29b2021-11-09 11:43:14 -0700102 "VUID-VkCopyBufferToImageInfo2-bufferRowLength-00203",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700103 "VUID-VkCopyImageToBufferInfo2-bufferRowLength-00203",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700104 }},
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",
Tony Barbour845d29b2021-11-09 11:43:14 -0700108 "VUID-VkCopyBufferToImageInfo2-bufferImageHeight-00204",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700109 "VUID-VkCopyImageToBufferInfo2-bufferImageHeight-00204",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700110 }},
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",
Tony Barbour845d29b2021-11-09 11:43:14 -0700114 "VUID-VkCopyBufferToImageInfo2-imageOffset-00205",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700115 "VUID-VkCopyImageToBufferInfo2-imageOffset-00205",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700116 }},
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",
Tony Barbour845d29b2021-11-09 11:43:14 -0700120 "VUID-VkCopyBufferToImageInfo2-bufferOffset-00206",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700121 "VUID-VkCopyImageToBufferInfo2-bufferOffset-00206",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700122 }},
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",
Tony Barbour845d29b2021-11-09 11:43:14 -0700126 "VUID-VkCopyBufferToImageInfo2-imageExtent-00207",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700127 "VUID-VkCopyImageToBufferInfo2-imageExtent-00207",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700128 }},
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",
Tony Barbour845d29b2021-11-09 11:43:14 -0700132 "VUID-VkCopyBufferToImageInfo2-imageExtent-00208",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700133 "VUID-VkCopyImageToBufferInfo2-imageExtent-00208",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700134 }},
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",
Tony Barbour845d29b2021-11-09 11:43:14 -0700138 "VUID-VkCopyBufferToImageInfo2-imageExtent-00209",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700139 "VUID-VkCopyImageToBufferInfo2-imageExtent-00209",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700140 }},
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",
Tony Barbour845d29b2021-11-09 11:43:14 -0700144 "VUID-VkCopyBufferToImageInfo2-aspectMask-00211",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700145 "VUID-VkCopyImageToBufferInfo2-aspectMask-00211",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700146 }},
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",
Tony Barbour845d29b2021-11-09 11:43:14 -0700150 "VUID-VkCopyBufferToImageInfo2-aspectMask-01560",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700151 "VUID-VkCopyImageToBufferInfo2-aspectMask-01560",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700152 }},
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",
Tony Barbour845d29b2021-11-09 11:43:14 -0700156 "VUID-VkCopyBufferToImageInfo2-baseArrayLayer-00213",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700157 "VUID-VkCopyImageToBufferInfo2-baseArrayLayer-00213",
sfricke-samsung8feecc12021-01-23 03:28:38 -0800158 }},
159 {"04052", {
160 "VUID-vkCmdCopyBufferToImage-commandBuffer-04052",
161 "VUID-vkCmdCopyImageToBuffer-commandBuffer-04052",
Tony Barbour845d29b2021-11-09 11:43:14 -0700162 "VUID-VkCopyBufferToImageInfo2-commandBuffer-04052",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700163 "VUID-VkCopyImageToBufferInfo2-commandBuffer-04052",
sfricke-samsung8feecc12021-01-23 03:28:38 -0800164 }},
165 {"04053", {
166 "VUID-vkCmdCopyBufferToImage-srcImage-04053",
167 "VUID-vkCmdCopyImageToBuffer-srcImage-04053",
Tony Barbour845d29b2021-11-09 11:43:14 -0700168 "VUID-VkCopyBufferToImageInfo2-srcImage-04053",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700169 "VUID-VkCopyImageToBufferInfo2-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 Gebben4a8881f2022-01-10 17:04:30 -0700337 const auto *layout_range_map = image_state.layout_range_map.get();
John Zulauf2076e812020-01-08 14:55:54 -0700338 if (!layout_range_map) return false;
Jeremy Gebben4a8881f2022-01-10 17:04:30 -0700339
340 auto guard = layout_range_map->ReadLock();
locke-lunargf155ccf2020-02-18 11:34:15 -0700341 // TODO: FindLayouts function should mutate into a ValidatePresentableLayout with the loop wrapping the LogError
342 // from the caller. You can then use decode to add the subresource of the range::begin to the error message.
343
John Zulauf2076e812020-01-08 14:55:54 -0700344 // TODO: what is this test and what is it supposed to do?! -- the logic doesn't match the comment below?!
345
346 // 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 -0700347 if (layout_range_map->size() >= (image_state.createInfo.arrayLayers * image_state.createInfo.mipLevels + 1)) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700348 return false;
349 }
locke-lunargcba7d5f2019-12-30 16:59:11 -0700350
John Zulauf79f06582021-02-27 18:38:39 -0700351 for (const auto &entry : *layout_range_map) {
John Zulauf2076e812020-01-08 14:55:54 -0700352 layouts.push_back(entry.second);
Tony Barbourdf013b92017-01-25 12:53:48 -0700353 }
354 return true;
355}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700356
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700357bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600358 const IMAGE_VIEW_STATE &image_view_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700359 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600360 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100361 bool skip = false;
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600362 const auto &image_view = image_view_state.Handle();
363 const auto *image_state = image_view_state.image_state.get();
364 const auto &image = image_state->Handle();
Tobias Hectorbbb12282018-10-22 15:17:59 +0100365 const char *vuid;
366 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700367 const char *function_name = use_rp2 ? "vkCmdBeginRenderPass2()" : "vkCmdBeginRenderPass()";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100368
369 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600370 LogObjectList objlist(image);
371 objlist.add(renderpass);
372 objlist.add(framebuffer);
373 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700374 skip |=
sfricke-samsung4389faa2022-03-23 01:19:42 -0500375 LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700376 "%s: RenderPass %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
377 function_name, report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
378 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100379 return skip;
380 }
381
382 auto image_usage = image_state->createInfo.usage;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700383 const auto stencil_usage_info = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Ricardo Garcia3f5984c2020-04-09 10:56:34 +0200384 if (stencil_usage_info) {
385 image_usage |= stencil_usage_info->stencilUsage;
386 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100387
388 // Check for layouts that mismatch image usages in the framebuffer
389 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800390 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600391 LogObjectList objlist(image);
392 objlist.add(renderpass);
393 objlist.add(framebuffer);
394 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700395 skip |= LogError(objlist, vuid,
396 "%s: Layout/usage mismatch for attachment %u in %s"
397 " - the %s is %s but the image attached to %s via %s"
398 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
399 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
400 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
401 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100402 }
403
404 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
405 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800406 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600407 LogObjectList objlist(image);
408 objlist.add(renderpass);
409 objlist.add(framebuffer);
410 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700411 skip |= LogError(objlist, vuid,
412 "%s: Layout/usage mismatch for attachment %u in %s"
413 " - the %s is %s but the image attached to %s via %s"
414 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
415 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
416 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
417 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100418 }
419
420 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800421 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600422 LogObjectList objlist(image);
423 objlist.add(renderpass);
424 objlist.add(framebuffer);
425 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700426 skip |= LogError(objlist, vuid,
427 "%s: Layout/usage mismatch for attachment %u in %s"
428 " - the %s is %s but the image attached to %s via %s"
429 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
430 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
431 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
432 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100433 }
434
435 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800436 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600437 LogObjectList objlist(image);
438 objlist.add(renderpass);
439 objlist.add(framebuffer);
440 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700441 skip |= LogError(objlist, vuid,
442 "%s: Layout/usage mismatch for attachment %u in %s"
443 " - the %s is %s but the image attached to %s via %s"
444 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
445 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
446 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
447 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100448 }
449
sfricke-samsung45996a42021-09-16 13:45:27 -0700450 if (IsExtEnabled(device_extensions.vk_khr_maintenance2)) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100451 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
452 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
453 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
454 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
455 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800456 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600457 LogObjectList objlist(image);
458 objlist.add(renderpass);
459 objlist.add(framebuffer);
460 objlist.add(image_view);
461 skip |= LogError(objlist, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700462 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700463 " - the %s is %s but the image attached to %s via %s"
464 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700465 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700466 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
467 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100468 }
469 } else {
470 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
471 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
472 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
473 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600474 LogObjectList objlist(image);
475 objlist.add(renderpass);
476 objlist.add(framebuffer);
477 objlist.add(image_view);
478 skip |= LogError(objlist, "VUID-vkCmdBeginRenderPass-initialLayout-00896",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700479 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700480 " - the %s is %s but the image attached to %s via %s"
481 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700482 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700483 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
484 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100485 }
486 }
487 return skip;
488}
489
John Zulauf17a01bb2019-08-09 16:41:19 -0600490bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700491 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600492 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600493 bool skip = false;
Jeremy Gebbenf4449392022-01-28 10:09:10 -0700494 auto render_pass_state = Get<RENDER_PASS_STATE>(pRenderPassBegin->renderPass);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600495 const auto *render_pass_info = render_pass_state->createInfo.ptr();
496 auto render_pass = render_pass_state->renderPass();
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700497 auto const &framebuffer_info = framebuffer_state->createInfo;
498 const VkImageView *attachments = framebuffer_info.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100499
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600500 auto framebuffer = framebuffer_state->framebuffer();
Tobias Hectorbbb12282018-10-22 15:17:59 +0100501
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700502 if (render_pass_info->attachmentCount != framebuffer_info.attachmentCount) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600503 skip |= LogError(pCB->commandBuffer(), kVUID_Core_DrawState_InvalidRenderpass,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700504 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700505 }
John Zulauf8e308292018-09-21 11:34:37 -0600506
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700507 const auto *attachment_info = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext);
Mike Schuchardt2df08912020-12-15 16:28:09 -0800508 if (((framebuffer_info.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) != 0) && attachment_info != nullptr) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700509 attachments = attachment_info->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100510 }
511
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600512 if (attachments == nullptr) {
513 return skip;
514 }
515 const auto *const_p_cb = static_cast<const CMD_BUFFER_STATE *>(pCB);
516 for (uint32_t i = 0; i < render_pass_info->attachmentCount && i < framebuffer_info.attachmentCount; ++i) {
517 auto image_view = attachments[i];
518 auto view_state = Get<IMAGE_VIEW_STATE>(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100519
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600520 if (!view_state) {
521 LogObjectList objlist(pRenderPassBegin->renderPass);
522 objlist.add(framebuffer_state->framebuffer());
523 objlist.add(image_view);
524 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
525 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
526 report_data->FormatHandle(framebuffer_state->framebuffer()).c_str(), i,
527 report_data->FormatHandle(image_view).c_str());
528 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100529 }
530
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600531 const VkImage image = view_state->create_info.image;
532 const auto *image_state = view_state->image_state.get();
Tobias Hectorbbb12282018-10-22 15:17:59 +0100533
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600534 if (!image_state) {
535 LogObjectList objlist(pRenderPassBegin->renderPass);
536 objlist.add(framebuffer_state->framebuffer());
537 objlist.add(image_view);
538 objlist.add(image);
539 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
540 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
541 report_data->FormatHandle(framebuffer_state->framebuffer()).c_str(), i,
542 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
543 continue;
544 }
545 auto attachment_initial_layout = render_pass_info->pAttachments[i].initialLayout;
546 auto final_layout = render_pass_info->pAttachments[i].finalLayout;
547
548 // Default to expecting stencil in the same layout.
549 auto attachment_stencil_initial_layout = attachment_initial_layout;
550
551 // If a separate layout is specified, look for that.
552 const auto *attachment_description_stencil_layout =
553 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(render_pass_info->pAttachments[i].pNext);
554 if (attachment_description_stencil_layout) {
555 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
556 }
557
558 const ImageSubresourceLayoutMap *subresource_map = nullptr;
559 bool has_queried_map = false;
560 bool subres_skip = false;
561
562 for (uint32_t aspect_index = 0; aspect_index < 32; aspect_index++) {
563 VkImageAspectFlags test_aspect = 1u << aspect_index;
564 if ((view_state->normalized_subresource_range.aspectMask & test_aspect) == 0) {
565 continue;
566 }
567
568 // Allow for differing depth and stencil layouts
569 VkImageLayout check_layout = attachment_initial_layout;
570 if (test_aspect == VK_IMAGE_ASPECT_STENCIL_BIT) {
571 check_layout = attachment_stencil_initial_layout;
572 }
573
574 // If no layout information for image yet, will be checked at QueueSubmit time
575 if (check_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
576 continue;
577 }
578 if (!has_queried_map) {
579 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to
580 // something in common with the non-const version.) The lookup is expensive, so cache it.
581 subresource_map = const_p_cb->GetImageSubresourceLayoutMap(*image_state);
582 has_queried_map = true;
583 }
584
585 if (!subresource_map) {
586 continue;
587 }
588 auto normalized_range = view_state->normalized_subresource_range;
589 normalized_range.aspectMask = test_aspect;
590 auto pos = subresource_map->Find(normalized_range);
591 LayoutUseCheckAndMessage layout_check(subresource_map, test_aspect);
592
593 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to the
594 // next "constant value" range
595 for (; !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
596 const VkImageSubresource &subres = pos->subresource;
597
598 if (!layout_check.Check(subres, check_layout, pos->current_layout, pos->initial_layout)) {
599 subres_skip |= LogError(
600 device, kVUID_Core_DrawState_InvalidRenderpass,
601 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
602 "and the %s layout of the attachment is %s. The layouts must match, or the render "
603 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
604 i, string_VkImageLayout(check_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
605 }
606 }
607 }
608
609 skip |= subres_skip;
610
611 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, *view_state, framebuffer,
612 render_pass, i, "initial layout");
613
614 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, *view_state, framebuffer, render_pass, i,
615 "final layout");
616 }
617
618 for (uint32_t j = 0; j < render_pass_info->subpassCount; ++j) {
619 auto &subpass = render_pass_info->pSubpasses[j];
620 for (uint32_t k = 0; k < render_pass_info->pSubpasses[j].inputAttachmentCount; ++k) {
621 auto &attachment_ref = subpass.pInputAttachments[k];
622 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
623 auto image_view = attachments[attachment_ref.attachment];
624 auto view_state = Get<IMAGE_VIEW_STATE>(image_view);
625
626 if (view_state) {
627 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, *view_state,
628 framebuffer, render_pass, attachment_ref.attachment,
629 "input attachment layout");
630 }
631 }
632 }
633
634 for (uint32_t k = 0; k < render_pass_info->pSubpasses[j].colorAttachmentCount; ++k) {
635 auto &attachment_ref = subpass.pColorAttachments[k];
636 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
637 auto image_view = attachments[attachment_ref.attachment];
638 auto view_state = Get<IMAGE_VIEW_STATE>(image_view);
639
640 if (view_state) {
641 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, *view_state,
642 framebuffer, render_pass, attachment_ref.attachment,
643 "color attachment layout");
644 if (subpass.pResolveAttachments) {
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600645 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, *view_state,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700646 framebuffer, render_pass, attachment_ref.attachment,
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600647 "resolve attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100648 }
649 }
650 }
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600651 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100652
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600653 if (render_pass_info->pSubpasses[j].pDepthStencilAttachment) {
654 auto &attachment_ref = *subpass.pDepthStencilAttachment;
655 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
656 auto image_view = attachments[attachment_ref.attachment];
657 auto view_state = Get<IMAGE_VIEW_STATE>(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100658
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600659 if (view_state) {
660 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, *view_state,
661 framebuffer, render_pass, attachment_ref.attachment,
662 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100663 }
664 }
665 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700666 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600667 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700668}
669
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600670void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700671 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700672 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -0600673 IMAGE_VIEW_STATE *image_view = pCB->GetActiveAttachmentImageViewState(ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600674 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700675 VkImageLayout stencil_layout = kInvalidLayout;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700676 const auto *attachment_reference_stencil_layout = LvlFindInChain<VkAttachmentReferenceStencilLayout>(ref.pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700677 if (attachment_reference_stencil_layout) {
678 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
679 }
680
Jeremy Gebben1ec89332021-08-05 13:51:49 -0600681 pCB->SetImageViewLayout(*image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600682 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700683 }
684}
685
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600686void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
687 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700688 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700689
690 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700691 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700692 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700693 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700694 }
695 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700696 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700697 }
698 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700699 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700700 }
701 }
702}
703
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700704// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
705// 1. Transition into initialLayout state
706// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600707void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700708 FRAMEBUFFER_STATE *framebuffer_state) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700709 // First record expected initialLayout as a potential initial layout usage.
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700710 auto const rpci = render_pass_state->createInfo.ptr();
711 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -0600712 auto *view_state = cb_state->GetActiveAttachmentImageViewState(i);
John Zulauf8e308292018-09-21 11:34:37 -0600713 if (view_state) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700714 IMAGE_STATE *image_state = view_state->image_state.get();
715 const auto initial_layout = rpci->pAttachments[i].initialLayout;
Piers Daniell4fde9b72019-11-27 16:19:46 -0700716 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700717 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(rpci->pAttachments[i].pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700718 if (attachment_description_stencil_layout) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700719 const auto stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
720 VkImageSubresourceRange sub_range = view_state->normalized_subresource_range;
721 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
Jeremy Gebben1ec89332021-08-05 13:51:49 -0600722 cb_state->SetImageInitialLayout(*image_state, sub_range, initial_layout);
John Zulauf81dd1f12021-01-26 16:49:16 -0700723 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
Jeremy Gebben1ec89332021-08-05 13:51:49 -0600724 cb_state->SetImageInitialLayout(*image_state, sub_range, stencil_initial_layout);
John Zulauf81dd1f12021-01-26 16:49:16 -0700725 } else {
Jeremy Gebben1ec89332021-08-05 13:51:49 -0600726 cb_state->SetImageInitialLayout(*image_state, view_state->normalized_subresource_range, initial_layout);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700727 }
John Zulauf8e308292018-09-21 11:34:37 -0600728 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700729 }
730 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700731 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700732}
733
Dave Houlton10b39482017-03-16 13:18:15 -0600734bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600735 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600736 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600737 }
738 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600739 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600740 }
741 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600742 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600743 }
Mike Schuchardt2df08912020-12-15 16:28:09 -0800744 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 -0700745 if (FormatPlaneCount(format) == 1) return false;
746 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600747 return true;
748}
749
sfricke-samsung10b35ce2021-09-29 08:50:20 -0700750// There is a table in the Vulkan spec to list all formats that implicitly require YCbCr conversion,
751// but some features/extensions can explicitly turn that restriction off
752// The implicit check is done in format utils, while feature checks are done here in CoreChecks
753bool CoreChecks::FormatRequiresYcbcrConversionExplicitly(const VkFormat format) const {
754 if (format == VK_FORMAT_R10X6G10X6B10X6A10X6_UNORM_4PACK16 &&
755 enabled_features.rgba10x6_formats_features.formatRgba10x6WithoutYCbCrSampler) {
756 return false;
757 }
758 return FormatRequiresYcbcrConversion(format);
759}
760
Mike Weiblen62d08a32017-03-07 22:18:27 -0700761// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -0700762bool CoreChecks::ValidateBarrierLayoutToImageUsage(const Location &loc, VkImage image, VkImageLayout layout,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700763 VkImageUsageFlags usage_flags) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700764 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700765 bool is_error = false;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700766 switch (layout) {
767 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700768 is_error = ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700769 break;
770 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700771 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700772 break;
773 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700774 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700775 break;
776 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700777 is_error = ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700778 break;
779 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700780 is_error = ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700781 break;
782 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700783 is_error = ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700784 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600785 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700786 is_error = ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0);
Jeff Bolz9af91c52018-09-01 21:53:57 -0500787 break;
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700788 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700789 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700790 break;
791 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700792 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700793 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700794 default:
795 // Other VkImageLayout values do not have VUs defined in this context.
796 break;
797 }
798
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700799 if (is_error) {
800 const auto &vuid = sync_vuid_maps::GetBadImageLayoutVUID(loc, layout);
801
802 skip |=
803 LogError(image, vuid, "%s Image barrier Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".",
804 loc.Message().c_str(), string_VkImageLayout(layout), report_data->FormatHandle(image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700805 }
806 return skip;
807}
808
809// Verify image barriers are compatible with the images they reference.
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700810template <typename ImageBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -0700811bool CoreChecks::ValidateBarriersToImages(const Location &outer_loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700812 uint32_t imageMemoryBarrierCount, const ImageBarrier *pImageMemoryBarriers) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700813 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700814 using sync_vuid_maps::GetImageBarrierVUID;
815 using sync_vuid_maps::ImageError;
Petr Krausad0096a2019-08-09 18:35:04 +0200816
John Zulauf463c51e2018-05-31 13:29:20 -0600817 // Scoreboard for duplicate layout transition barriers within the list
818 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
ziga-lunarg189ae5d2021-10-19 13:09:58 +0200819 const CommandBufferImageLayoutMap &current_map = cb_state->GetImageSubresourceLayoutMap();
820 CommandBufferImageLayoutMap layout_updates;
John Zulauf463c51e2018-05-31 13:29:20 -0600821
Mike Weiblen62d08a32017-03-07 22:18:27 -0700822 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700823 auto loc = outer_loc.dot(Field::pImageMemoryBarriers, i);
Petr Krausad0096a2019-08-09 18:35:04 +0200824 const auto &img_barrier = pImageMemoryBarriers[i];
Mike Weiblen62d08a32017-03-07 22:18:27 -0700825
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600826 auto image_state = Get<IMAGE_STATE>(img_barrier.image);
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600827 if (!image_state) {
828 continue;
829 }
830 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
831 skip |= ValidateBarrierLayoutToImageUsage(loc.dot(Field::oldLayout), img_barrier.image, img_barrier.oldLayout, usage_flags);
832 skip |= ValidateBarrierLayoutToImageUsage(loc.dot(Field::newLayout), img_barrier.image, img_barrier.newLayout, usage_flags);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600833
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600834 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
835 if (image_state->layout_locked) {
836 // TODO: Add unique id for error when available
837 skip |= LogError(
838 img_barrier.image, "VUID-Undefined",
839 "%s Attempting to transition shared presentable %s"
840 " from layout %s to layout %s, but image has already been presented and cannot have its layout transitioned.",
841 loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
842 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(img_barrier.newLayout));
843 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600844
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600845 const VkImageCreateInfo &image_create_info = image_state->createInfo;
846 const VkFormat image_format = image_create_info.format;
847 const VkImageAspectFlags aspect_mask = img_barrier.subresourceRange.aspectMask;
848 // For a Depth/Stencil image both aspects MUST be set
849 auto image_loc = loc.dot(Field::image);
850 if (FormatIsDepthAndStencil(image_format)) {
851 if (enabled_features.core12.separateDepthStencilLayouts) {
852 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
853 auto vuid = GetImageBarrierVUID(loc, ImageError::kNotDepthOrStencilAspect);
sfricke-samsung79b00482020-04-01 21:15:50 -0700854 skip |= LogError(img_barrier.image, vuid,
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600855 "%s references %s of format %s that must have either the depth or stencil "
856 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
857 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
858 string_VkFormat(image_format), aspect_mask);
859 }
860 } else {
861 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
862 if ((aspect_mask & ds_mask) != (ds_mask)) {
863 auto error = IsExtEnabled(device_extensions.vk_khr_separate_depth_stencil_layouts)
864 ? ImageError::kNotSeparateDepthAndStencilAspect
865 : ImageError::kNotDepthAndStencilAspect;
866 auto vuid = GetImageBarrierVUID(image_loc, error);
867 skip |= LogError(img_barrier.image, vuid,
868 "%s references %s of format %s that must have the depth and stencil "
869 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700870 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700871 string_VkFormat(image_format), aspect_mask);
872 }
873 }
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600874 }
sfricke-samsung79b00482020-04-01 21:15:50 -0700875
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600876 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
877 // TODO: Set memory invalid which is in mem_tracker currently
878 } else if (!QueueFamilyIsExternal(img_barrier.srcQueueFamilyIndex)) {
879 auto &write_subresource_map = layout_updates[image_state.get()];
880 bool new_write = false;
881 if (!write_subresource_map) {
882 write_subresource_map = std::make_shared<ImageSubresourceLayoutMap>(*image_state);
883 new_write = true;
884 }
885 const auto &current_subresource_map = current_map.find(image_state.get());
886 const auto &read_subresource_map = (new_write && current_subresource_map != current_map.end())
887 ? (*current_subresource_map).second
888 : write_subresource_map;
889
890 bool subres_skip = false;
891 // Validate aspects in isolation.
892 // This is required when handling separate depth-stencil layouts.
893 for (uint32_t aspect_index = 0; aspect_index < 32; aspect_index++) {
894 VkImageAspectFlags test_aspect = 1u << aspect_index;
895 if ((img_barrier.subresourceRange.aspectMask & test_aspect) == 0) {
896 continue;
897 }
898
899 LayoutUseCheckAndMessage layout_check(read_subresource_map.get(), test_aspect);
900 auto normalized_isr = image_state->NormalizeSubresourceRange(img_barrier.subresourceRange);
901 normalized_isr.aspectMask = test_aspect;
902 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
903 // the next "constant value" range
904 for (auto pos = read_subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip;
905 pos.IncrementInterval()) {
906 const auto &value = *pos;
907 auto old_layout = NormalizeSynchronization2Layout(test_aspect, img_barrier.oldLayout);
908 if (!layout_check.Check(value.subresource, old_layout, value.current_layout, value.initial_layout)) {
909 const auto &vuid = GetImageBarrierVUID(loc, ImageError::kConflictingLayout);
910 subres_skip = LogError(cb_state->commandBuffer(), vuid,
911 "%s %s cannot transition the layout of aspect=%d level=%d layer=%d from %s when the "
912 "%s layout is %s.",
913 loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
914 value.subresource.aspectMask, value.subresource.mipLevel,
915 value.subresource.arrayLayer, string_VkImageLayout(img_barrier.oldLayout),
916 layout_check.message, string_VkImageLayout(layout_check.layout));
917 }
918 }
919 write_subresource_map->SetSubresourceRangeLayout(*cb_state, normalized_isr, img_barrier.newLayout);
920 }
921 skip |= subres_skip;
922 }
923
924 // checks color format and (single-plane or non-disjoint)
925 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
926 if ((FormatIsColor(image_format) == true) &&
927 ((FormatIsMultiplane(image_format) == false) || (image_state->disjoint == false))) {
928 if (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT) {
929 auto error = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion) ? ImageError::kNotColorAspect
930 : ImageError::kNotColorAspectYcbcr;
931 const auto &vuid = GetImageBarrierVUID(loc, error);
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700932 skip |= LogError(img_barrier.image, vuid,
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600933 "%s references %s of format %s that must be only VK_IMAGE_ASPECT_COLOR_BIT, "
934 "but its aspectMask is 0x%" PRIx32 ".",
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700935 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700936 string_VkFormat(image_format), aspect_mask);
937 }
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600938 }
sfricke-samsung79b00482020-04-01 21:15:50 -0700939
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600940 VkImageAspectFlags valid_disjoint_mask =
941 VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT | VK_IMAGE_ASPECT_COLOR_BIT;
942 if ((FormatIsMultiplane(image_format) == true) && (image_state->disjoint == true) &&
943 ((aspect_mask & valid_disjoint_mask) == 0)) {
944 const auto &vuid = GetImageBarrierVUID(image_loc, ImageError::kBadMultiplanarAspect);
945 skip |= LogError(img_barrier.image, vuid,
946 "%s references %s of format %s has aspectMask (0x%" PRIx32
947 ") but needs to include either an VK_IMAGE_ASPECT_PLANE_*_BIT or VK_IMAGE_ASPECT_COLOR_BIT.",
948 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
949 string_VkFormat(image_format), aspect_mask);
950 }
951
952 if ((FormatPlaneCount(image_format) == 2) && ((aspect_mask & VK_IMAGE_ASPECT_PLANE_2_BIT) != 0)) {
953 const auto &vuid = GetImageBarrierVUID(image_loc, ImageError::kBadPlaneCount);
954 skip |= LogError(img_barrier.image, vuid,
955 "%s references %s of format %s has only two planes but included "
956 "VK_IMAGE_ASPECT_PLANE_2_BIT in its aspectMask (0x%" PRIx32 ").",
957 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
958 string_VkFormat(image_format), aspect_mask);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700959 }
960 }
961 return skip;
962}
963
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700964template <typename Barrier, typename TransferBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -0700965bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const Location &loc, const CMD_BUFFER_STATE *cb_state, const Barrier &barrier,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700966 const QFOTransferBarrierSets<TransferBarrier> &barrier_sets) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600967 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700968 const char *handle_name = TransferBarrier::HandleName();
John Zulauf6b4aae82018-05-09 13:03:36 -0600969 const char *transfer_type = nullptr;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700970 if (!IsTransferOp(barrier)) {
971 return skip;
972 }
973 const TransferBarrier *barrier_record = nullptr;
Jeremy Gebben7ba56152021-06-18 10:40:10 -0600974 if (cb_state->IsReleaseOp(barrier) && !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700975 const auto found = barrier_sets.release.find(barrier);
976 if (found != barrier_sets.release.cend()) {
977 barrier_record = &(*found);
978 transfer_type = "releasing";
John Zulauf6b4aae82018-05-09 13:03:36 -0600979 }
Jeremy Gebben7ba56152021-06-18 10:40:10 -0600980 } else if (cb_state->IsAcquireOp(barrier) && !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700981 const auto found = barrier_sets.acquire.find(barrier);
982 if (found != barrier_sets.acquire.cend()) {
983 barrier_record = &(*found);
984 transfer_type = "acquiring";
John Zulauf6b4aae82018-05-09 13:03:36 -0600985 }
986 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700987 if (barrier_record != nullptr) {
988 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600989 LogWarning(cb_state->commandBuffer(), TransferBarrier::ErrMsgDuplicateQFOInCB(),
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700990 "%s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
991 " duplicates existing barrier recorded in this command buffer.",
992 loc.Message().c_str(), transfer_type, handle_name, report_data->FormatHandle(barrier_record->handle).c_str(),
993 barrier_record->srcQueueFamilyIndex, barrier_record->dstQueueFamilyIndex);
994 }
John Zulauf6b4aae82018-05-09 13:03:36 -0600995 return skip;
996}
997
John Zulaufa4472282019-08-22 14:44:34 -0600998VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
999 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1000}
1001
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001002VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier2KHR &barrier) {
1003 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1004}
1005
Jeremy Gebben9f537102021-10-05 16:37:12 -06001006std::shared_ptr<const IMAGE_STATE> BarrierHandleState(const ValidationStateTracker &device_state,
1007 const VkImageMemoryBarrier &barrier) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001008 return device_state.Get<IMAGE_STATE>(barrier.image);
John Zulaufa4472282019-08-22 14:44:34 -06001009}
1010
Jeremy Gebben9f537102021-10-05 16:37:12 -06001011std::shared_ptr<const IMAGE_STATE> BarrierHandleState(const ValidationStateTracker &device_state,
1012 const VkImageMemoryBarrier2KHR &barrier) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001013 return device_state.Get<IMAGE_STATE>(barrier.image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001014}
1015
John Zulaufa4472282019-08-22 14:44:34 -06001016VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
1017 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1018}
1019
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001020VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier2KHR &barrier) {
1021 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1022}
1023
Jeremy Gebben9f537102021-10-05 16:37:12 -06001024const std::shared_ptr<const BUFFER_STATE> BarrierHandleState(const ValidationStateTracker &device_state,
1025 const VkBufferMemoryBarrier &barrier) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001026 return device_state.Get<BUFFER_STATE>(barrier.buffer);
John Zulaufa4472282019-08-22 14:44:34 -06001027}
1028
Jeremy Gebben9f537102021-10-05 16:37:12 -06001029std::shared_ptr<const BUFFER_STATE> BarrierHandleState(const ValidationStateTracker &device_state,
1030 const VkBufferMemoryBarrier2KHR &barrier) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001031 return device_state.Get<BUFFER_STATE>(barrier.buffer);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001032}
John Zulaufa4472282019-08-22 14:44:34 -06001033
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001034template <typename Barrier, typename TransferBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001035void CoreChecks::RecordBarrierValidationInfo(const Location &loc, CMD_BUFFER_STATE *cb_state, const Barrier &barrier,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001036 QFOTransferBarrierSets<TransferBarrier> &barrier_sets) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001037 if (IsTransferOp(barrier)) {
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001038 if (cb_state->IsReleaseOp(barrier) && !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001039 barrier_sets.release.emplace(barrier);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001040 } else if (cb_state->IsAcquireOp(barrier) && !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001041 barrier_sets.acquire.emplace(barrier);
John Zulaufa4472282019-08-22 14:44:34 -06001042 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001043 }
John Zulaufa4472282019-08-22 14:44:34 -06001044
David Zhao Akeleyd76df472021-05-15 17:25:59 -07001045 // 7.7.4: If the values of srcQueueFamilyIndex and dstQueueFamilyIndex are equal, no ownership transfer is performed, and the
1046 // barrier operates as if they were both set to VK_QUEUE_FAMILY_IGNORED.
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001047 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
1048 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
David Zhao Akeleyd76df472021-05-15 17:25:59 -07001049 const bool is_ownership_transfer = src_queue_family != dst_queue_family;
1050
1051 if (is_ownership_transfer) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001052 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
1053 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
1054 auto handle_state = BarrierHandleState(*this, barrier);
1055 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
1056 if (!mode_concurrent) {
1057 const auto typed_handle = BarrierTypedHandle(barrier);
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001058 core_error::LocationCapture loc_capture(loc);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001059 cb_state->queue_submit_functions.emplace_back(
Jeremy Gebbene5361dd2021-11-18 14:23:56 -07001060 [loc_capture, typed_handle, src_queue_family, dst_queue_family](
1061 const ValidationStateTracker &device_data, const QUEUE_STATE &queue_state, const CMD_BUFFER_STATE &cb_state) {
John Zulaufb4438f02021-02-20 20:22:16 -07001062 return ValidateConcurrentBarrierAtSubmit(loc_capture.Get(), device_data, queue_state, cb_state, typed_handle,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001063 src_queue_family, dst_queue_family);
1064 });
John Zulauf6b4aae82018-05-09 13:03:36 -06001065 }
1066 }
1067}
1068
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001069// Verify image barrier image state and that the image is consistent with FB image
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001070template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001071bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001072 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1073 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001074 const ImgBarrier &img_barrier, const CMD_BUFFER_STATE *primary_cb_state) const {
1075 using sync_vuid_maps::GetImageBarrierVUID;
1076 using sync_vuid_maps::ImageError;
1077
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001078 bool skip = false;
1079 const auto *fb_state = framebuffer;
1080 assert(fb_state);
1081 const auto img_bar_image = img_barrier.image;
1082 bool image_match = false;
1083 bool sub_image_found = false; // Do we find a corresponding subpass description
1084 VkImageLayout sub_image_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1085 uint32_t attach_index = 0;
1086 // Verify that a framebuffer image matches barrier image
1087 const auto attachment_count = fb_state->createInfo.attachmentCount;
1088 for (uint32_t attachment = 0; attachment < attachment_count; ++attachment) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06001089 auto view_state = primary_cb_state ? primary_cb_state->GetActiveAttachmentImageViewState(attachment) : cb_state->GetActiveAttachmentImageViewState(attachment);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001090 if (view_state && (img_bar_image == view_state->create_info.image)) {
1091 image_match = true;
1092 attach_index = attachment;
1093 break;
1094 }
1095 }
1096 if (image_match) { // Make sure subpass is referring to matching attachment
1097 if (sub_desc.pDepthStencilAttachment && sub_desc.pDepthStencilAttachment->attachment == attach_index) {
1098 sub_image_layout = sub_desc.pDepthStencilAttachment->layout;
1099 sub_image_found = true;
1100 }
sfricke-samsung45996a42021-09-16 13:45:27 -07001101 if (!sub_image_found && IsExtEnabled(device_extensions.vk_khr_depth_stencil_resolve)) {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001102 const auto *resolve = LvlFindInChain<VkSubpassDescriptionDepthStencilResolve>(sub_desc.pNext);
1103 if (resolve && resolve->pDepthStencilResolveAttachment &&
1104 resolve->pDepthStencilResolveAttachment->attachment == attach_index) {
1105 sub_image_layout = resolve->pDepthStencilResolveAttachment->layout;
1106 sub_image_found = true;
1107 }
1108 }
1109 if (!sub_image_found) {
1110 for (uint32_t j = 0; j < sub_desc.colorAttachmentCount; ++j) {
1111 if (sub_desc.pColorAttachments && sub_desc.pColorAttachments[j].attachment == attach_index) {
1112 sub_image_layout = sub_desc.pColorAttachments[j].layout;
1113 sub_image_found = true;
1114 break;
1115 }
1116 if (!sub_image_found && sub_desc.pResolveAttachments &&
1117 sub_desc.pResolveAttachments[j].attachment == attach_index) {
1118 sub_image_layout = sub_desc.pResolveAttachments[j].layout;
1119 sub_image_found = true;
1120 break;
1121 }
1122 }
1123 }
1124 if (!sub_image_found) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001125 auto img_loc = loc.dot(Field::image);
1126 const auto &vuid = GetImageBarrierVUID(img_loc, ImageError::kRenderPassMismatch);
1127 skip |=
1128 LogError(rp_handle, vuid,
1129 "%s Barrier for %s is not referenced by the VkSubpassDescription for active subpass (%d) of current %s.",
1130 img_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(), active_subpass,
1131 report_data->FormatHandle(rp_handle).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001132 }
1133 } else { // !image_match
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001134 auto img_loc = loc.dot(Field::image);
1135 const auto &vuid = GetImageBarrierVUID(img_loc, ImageError::kRenderPassMismatch);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001136 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 -07001137 img_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001138 report_data->FormatHandle(fb_state->framebuffer()).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001139 }
1140 if (img_barrier.oldLayout != img_barrier.newLayout) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001141 auto layout_loc = loc.dot(Field::oldLayout);
1142 const auto &vuid = GetImageBarrierVUID(layout_loc, ImageError::kRenderPassLayoutChange);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001143 skip |= LogError(cb_state->commandBuffer(), vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001144 "%s As the Image Barrier for %s is being executed within a render pass instance, oldLayout must "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001145 "equal newLayout yet they are %s and %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001146 layout_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001147 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(img_barrier.newLayout));
1148 } else {
1149 if (sub_image_found && sub_image_layout != img_barrier.oldLayout) {
1150 LogObjectList objlist(rp_handle);
1151 objlist.add(img_bar_image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001152 auto layout_loc = loc.dot(Field::oldLayout);
1153 const auto &vuid = GetImageBarrierVUID(layout_loc, ImageError::kRenderPassLayoutChange);
1154 skip |= LogError(objlist, vuid,
1155 "%s Barrier for %s is referenced by the VkSubpassDescription for active "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001156 "subpass (%d) of current %s as having layout %s, but image barrier has layout %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001157 layout_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(), active_subpass,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001158 report_data->FormatHandle(rp_handle).c_str(), string_VkImageLayout(sub_image_layout),
1159 string_VkImageLayout(img_barrier.oldLayout));
1160 }
1161 }
1162 return skip;
1163}
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001164// explictly instantiate so these can be used in core_validation.cpp
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001165template bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001166 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1167 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
1168 const VkImageMemoryBarrier &img_barrier,
1169 const CMD_BUFFER_STATE *primary_cb_state) const;
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001170template bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001171 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1172 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
1173 const VkImageMemoryBarrier2KHR &img_barrier,
1174 const CMD_BUFFER_STATE *primary_cb_state) const;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001175
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001176template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001177void CoreChecks::EnqueueSubmitTimeValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001178 const ImgBarrier &barrier) {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001179 // Secondary CBs can have null framebuffer so queue up validation in that case 'til FB is known
1180 if ((cb_state->activeRenderPass) && (VK_NULL_HANDLE == cb_state->activeFramebuffer) &&
1181 (VK_COMMAND_BUFFER_LEVEL_SECONDARY == cb_state->createInfo.level)) {
1182 const auto active_subpass = cb_state->activeSubpass;
1183 const auto rp_state = cb_state->activeRenderPass;
1184 const auto &sub_desc = rp_state->createInfo.pSubpasses[active_subpass];
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001185 // Secondary CB case w/o FB specified delay validation
1186 auto *this_ptr = this; // Required for older compilers with c++20 compatibility
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001187 core_error::LocationCapture loc_capture(loc);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001188 const auto render_pass = rp_state->renderPass();
John Zulaufb4438f02021-02-20 20:22:16 -07001189 cb_state->cmd_execute_commands_functions.emplace_back(
Jeremy Gebben057f9d52021-11-05 14:12:31 -06001190 [this_ptr, loc_capture, active_subpass, sub_desc, render_pass, barrier](
1191 const CMD_BUFFER_STATE &secondary_cb, const CMD_BUFFER_STATE *primary_cb, const FRAMEBUFFER_STATE *fb) {
1192 return this_ptr->ValidateImageBarrierAttachment(loc_capture.Get(), &secondary_cb, fb, active_subpass, sub_desc,
John Zulaufb4438f02021-02-20 20:22:16 -07001193 render_pass, barrier, primary_cb);
1194 });
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001195 }
1196}
1197
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001198void CoreChecks::RecordBarriers(Func func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001199 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1200 const VkImageMemoryBarrier *pImageMemBarriers) {
1201 for (uint32_t i = 0; i < bufferBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001202 Location loc(func_name, Struct::VkBufferMemoryBarrier, Field::pBufferMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001203 RecordBarrierValidationInfo(loc, cb_state, pBufferMemBarriers[i], cb_state->qfo_transfer_buffer_barriers);
1204 }
1205 for (uint32_t i = 0; i < imageMemBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001206 Location loc(func_name, Struct::VkImageMemoryBarrier, Field::pImageMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001207 const auto &img_barrier = pImageMemBarriers[i];
1208 RecordBarrierValidationInfo(loc, cb_state, img_barrier, cb_state->qfo_transfer_image_barriers);
1209 EnqueueSubmitTimeValidateImageBarrierAttachment(loc, cb_state, img_barrier);
1210 }
1211}
1212
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001213void CoreChecks::RecordBarriers(Func func_name, CMD_BUFFER_STATE *cb_state, const VkDependencyInfoKHR &dep_info) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001214 for (uint32_t i = 0; i < dep_info.bufferMemoryBarrierCount; i++) {
Tony-LunarG279601c2021-11-16 10:50:51 -07001215 Location loc(func_name, Struct::VkBufferMemoryBarrier2, Field::pBufferMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001216 RecordBarrierValidationInfo(loc, cb_state, dep_info.pBufferMemoryBarriers[i], cb_state->qfo_transfer_buffer_barriers);
1217 }
1218 for (uint32_t i = 0; i < dep_info.imageMemoryBarrierCount; i++) {
Tony-LunarG279601c2021-11-16 10:50:51 -07001219 Location loc(func_name, Struct::VkImageMemoryBarrier2, Field::pImageMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001220 const auto &img_barrier = dep_info.pImageMemoryBarriers[i];
1221 RecordBarrierValidationInfo(loc, cb_state, img_barrier, cb_state->qfo_transfer_image_barriers);
1222 EnqueueSubmitTimeValidateImageBarrierAttachment(loc, cb_state, img_barrier);
1223 }
1224}
1225
1226template <typename TransferBarrier, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001227bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001228 const char *operation, const TransferBarrier &barrier,
1229 Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001230 // Record to the scoreboard or report that we have a duplication
1231 bool skip = false;
Jeremy Gebbencbf22862021-03-03 12:01:22 -07001232 auto inserted = scoreboard->emplace(barrier, cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001233 if (!inserted.second && inserted.first->second != cb_state) {
1234 // 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 -06001235 LogObjectList objlist(cb_state->commandBuffer());
Mark Lobodzinskiea561582020-03-16 18:13:56 -06001236 objlist.add(barrier.handle);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001237 objlist.add(inserted.first->second->commandBuffer());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001238 skip = LogWarning(objlist, TransferBarrier::ErrMsgDuplicateQFOInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001239 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1240 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001241 "vkQueueSubmit()", TransferBarrier::BarrierName(), operation, TransferBarrier::HandleName(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001242 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001243 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer()).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001244 }
1245 return skip;
1246}
1247
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001248template <typename TransferBarrier>
1249bool CoreChecks::ValidateQueuedQFOTransferBarriers(
1250 const CMD_BUFFER_STATE *cb_state, QFOTransferCBScoreboards<TransferBarrier> *scoreboards,
1251 const GlobalQFOTransferBarrierMap<TransferBarrier> &global_release_barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001252 bool skip = false;
Jeremy Gebben159b3cc2021-06-03 09:09:03 -06001253 const auto &cb_barriers = cb_state->GetQFOBarrierSets(TransferBarrier());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001254 const char *barrier_name = TransferBarrier::BarrierName();
1255 const char *handle_name = TransferBarrier::HandleName();
John Zulauf6b4aae82018-05-09 13:03:36 -06001256 // No release should have an extant duplicate (WARNING)
1257 for (const auto &release : cb_barriers.release) {
1258 // Check the global pending release barriers
1259 const auto set_it = global_release_barriers.find(release.handle);
1260 if (set_it != global_release_barriers.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001261 const QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001262 const auto found = set_for_handle.find(release);
1263 if (found != set_for_handle.cend()) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001264 skip |= LogWarning(cb_state->commandBuffer(), TransferBarrier::ErrMsgDuplicateQFOSubmitted(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001265 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1266 " to dstQueueFamilyIndex %" PRIu32
1267 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1268 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1269 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001270 }
1271 }
1272 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1273 }
1274 // Each acquire must have a matching release (ERROR)
1275 for (const auto &acquire : cb_barriers.acquire) {
1276 const auto set_it = global_release_barriers.find(acquire.handle);
1277 bool matching_release_found = false;
1278 if (set_it != global_release_barriers.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001279 const QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001280 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1281 }
1282 if (!matching_release_found) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001283 skip |= LogError(cb_state->commandBuffer(), TransferBarrier::ErrMsgMissingQFOReleaseInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001284 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1285 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1286 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1287 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001288 }
1289 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1290 }
1291 return skip;
1292}
1293
John Zulauf3b04ebd2019-07-18 14:08:11 -06001294bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001295 QFOTransferCBScoreboards<QFOImageTransferBarrier> *qfo_image_scoreboards,
1296 QFOTransferCBScoreboards<QFOBufferTransferBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001297 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001298 skip |=
1299 ValidateQueuedQFOTransferBarriers<QFOImageTransferBarrier>(cb_state, qfo_image_scoreboards, qfo_release_image_barrier_map);
1300 skip |= ValidateQueuedQFOTransferBarriers<QFOBufferTransferBarrier>(cb_state, qfo_buffer_scoreboards,
1301 qfo_release_buffer_barrier_map);
John Zulauf6b4aae82018-05-09 13:03:36 -06001302 return skip;
1303}
1304
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001305template <typename TransferBarrier>
1306void RecordQueuedQFOTransferBarriers(QFOTransferBarrierSets<TransferBarrier> &cb_barriers,
1307 GlobalQFOTransferBarrierMap<TransferBarrier> &global_release_barriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001308 // Add release barriers from this submit to the global map
1309 for (const auto &release : cb_barriers.release) {
1310 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
Jeremy Gebben51499ca2022-01-11 08:36:13 -07001311 // NOTE: vl_concurrent_ordered_map::find() makes a thread safe copy of the result, so we must
1312 // copy back after updating.
1313 auto iter = global_release_barriers.find(release.handle);
1314 iter->second.insert(release);
1315 global_release_barriers.insert_or_assign(release.handle, iter->second);
John Zulauf6b4aae82018-05-09 13:03:36 -06001316 }
1317
1318 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1319 for (const auto &acquire : cb_barriers.acquire) {
1320 // NOTE: We're not using [] because we don't want to create entries for missing releases
1321 auto set_it = global_release_barriers.find(acquire.handle);
1322 if (set_it != global_release_barriers.end()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001323 QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001324 set_for_handle.erase(acquire);
1325 if (set_for_handle.size() == 0) { // Clean up empty sets
Jeremy Gebben51499ca2022-01-11 08:36:13 -07001326 global_release_barriers.erase(acquire.handle);
1327 } else {
1328 // NOTE: vl_concurrent_ordered_map::find() makes a thread safe copy of the result, so we must
1329 // copy back after updating.
1330 global_release_barriers.insert_or_assign(acquire.handle, set_for_handle);
John Zulauf6b4aae82018-05-09 13:03:36 -06001331 }
1332 }
1333 }
1334}
1335
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001336void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001337 RecordQueuedQFOTransferBarriers<QFOImageTransferBarrier>(cb_state->qfo_transfer_image_barriers, qfo_release_image_barrier_map);
1338 RecordQueuedQFOTransferBarriers<QFOBufferTransferBarrier>(cb_state->qfo_transfer_buffer_barriers,
1339 qfo_release_buffer_barrier_map);
John Zulauf6b4aae82018-05-09 13:03:36 -06001340}
1341
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001342template <typename ImgBarrier>
1343void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count, const ImgBarrier *barriers) {
1344 // For ownership transfers, the barrier is specified twice; as a release
1345 // operation on the yielding queue family, and as an acquire operation
1346 // on the acquiring queue family. This barrier may also include a layout
1347 // transition, which occurs 'between' the two operations. For validation
1348 // purposes it doesn't seem important which side performs the layout
1349 // transition, but it must not be performed twice. We'll arbitrarily
1350 // choose to perform it as part of the acquire operation.
1351 //
1352 // However, we still need to record initial layout for the "initial layout" validation
1353 for (uint32_t i = 0; i < barrier_count; i++) {
1354 const auto &mem_barrier = barriers[i];
Jeremy Gebbenefead332021-06-18 08:22:44 -06001355 const bool is_release_op = cb_state->IsReleaseOp(mem_barrier);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001356 auto image_state = Get<IMAGE_STATE>(mem_barrier.image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001357 if (image_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06001358 RecordTransitionImageLayout(cb_state, image_state.get(), mem_barrier, is_release_op);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001359 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001360 }
1361}
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001362// explictly instantiate this template so it can be used in core_validation.cpp
1363template void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1364 const VkImageMemoryBarrier *barrier);
1365template void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1366 const VkImageMemoryBarrier2KHR *barrier);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001367
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001368VkImageLayout NormalizeSynchronization2Layout(const VkImageAspectFlags aspect_mask, VkImageLayout layout);
1369
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001370template <typename ImgBarrier>
unknown86bcb3a2019-07-11 13:05:36 -06001371void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001372 const ImgBarrier &mem_barrier, bool is_release_op) {
Tony-LunarG273f32f2021-09-28 08:56:30 -06001373 if (enabled_features.core13.synchronization2) {
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001374 if (mem_barrier.oldLayout == mem_barrier.newLayout) {
1375 return;
1376 }
1377 }
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06001378 auto normalized_isr = image_state->NormalizeSubresourceRange(mem_barrier.subresourceRange);
unknown86bcb3a2019-07-11 13:05:36 -06001379
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001380 VkImageLayout initial_layout = NormalizeSynchronization2Layout(mem_barrier.subresourceRange.aspectMask, mem_barrier.oldLayout);
1381 VkImageLayout new_layout = NormalizeSynchronization2Layout(mem_barrier.subresourceRange.aspectMask, mem_barrier.newLayout);
Michael Spang8af7c102020-05-03 20:50:09 -04001382
1383 // Layout transitions in external instance are not tracked, so don't validate initial layout.
John Zulaufcea64cb2020-06-10 17:17:27 -06001384 if (QueueFamilyIsExternal(mem_barrier.srcQueueFamilyIndex)) {
Michael Spang8af7c102020-05-03 20:50:09 -04001385 initial_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1386 }
1387
John Zulauf2be3fe02019-12-30 09:48:02 -07001388 if (is_release_op) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06001389 cb_state->SetImageInitialLayout(*image_state, normalized_isr, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001390 } else {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06001391 cb_state->SetImageLayout(*image_state, normalized_isr, new_layout, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001392 }
unknown86bcb3a2019-07-11 13:05:36 -06001393}
1394
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001395bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1396 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1397 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1398 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06001399 if (disabled[image_layout_validation]) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001400 assert(cb_node);
1401 assert(image_state);
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001402 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001403
Jeremy Gebben6335df62021-11-01 10:50:13 -06001404 const auto *subresource_map = cb_node->GetImageSubresourceLayoutMap(*image_state);
John Zulauff660ad62019-03-23 07:16:05 -06001405 if (subresource_map) {
1406 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001407 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
Tony Barbour55688172020-09-23 15:19:50 -07001408 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
1409 // the next "constant value" range
1410 for (auto pos = subresource_map->Find(range); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07001411 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001412 *error = true;
Jeremy Gebben6335df62021-11-01 10:50:13 -06001413 subres_skip |=
1414 LogError(cb_node->commandBuffer(), layout_mismatch_msg_code,
1415 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1416 "%s layout %s.",
1417 caller, report_data->FormatHandle(image_state->Handle()).c_str(), pos->subresource.arrayLayer,
1418 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1419 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001420 }
John Zulauf5e617452019-11-19 14:44:16 -07001421 }
John Zulauff660ad62019-03-23 07:16:05 -06001422 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001423 }
John Zulauff660ad62019-03-23 07:16:05 -06001424
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001425 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1426 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1427 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001428 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1429 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001430 skip |= LogPerformanceWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001431 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
Jeremy Gebben6335df62021-11-01 10:50:13 -06001432 report_data->FormatHandle(image_state->Handle()).c_str(),
1433 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001434 }
sfricke-samsung45996a42021-09-16 13:45:27 -07001435 } else if (IsExtEnabled(device_extensions.vk_khr_shared_presentable_image)) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001436 if (image_state->shared_presentable) {
1437 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001438 skip |=
1439 LogError(device, layout_invalid_msg_code,
1440 "%s: Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1441 caller, string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001442 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001443 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001444 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001445 *error = true;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001446 skip |= LogError(cb_node->commandBuffer(), layout_invalid_msg_code,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001447 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
Jeremy Gebben6335df62021-11-01 10:50:13 -06001448 report_data->FormatHandle(image_state->Handle()).c_str(), string_VkImageLayout(explicit_layout),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001449 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001450 }
1451 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001452 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001453}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001454bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001455 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1456 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001457 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001458 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1459 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1460}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001461
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001462void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001463 FRAMEBUFFER_STATE *framebuffer_state) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001464 auto render_pass = Get<RENDER_PASS_STATE>(pRenderPassBegin->renderPass);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001465 if (!render_pass) return;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001466
Mike Schuchardt2df08912020-12-15 16:28:09 -08001467 const VkRenderPassCreateInfo2 *render_pass_info = render_pass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001468 if (framebuffer_state) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001469 for (uint32_t i = 0; i < render_pass_info->attachmentCount; ++i) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06001470 auto *view_state = pCB->GetActiveAttachmentImageViewState(i);
John Zulauf8e308292018-09-21 11:34:37 -06001471 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001472 VkImageLayout stencil_layout = kInvalidLayout;
1473 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001474 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(render_pass_info->pAttachments[i].pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -07001475 if (attachment_description_stencil_layout) {
1476 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1477 }
Jeremy Gebben1ec89332021-08-05 13:51:49 -06001478 pCB->SetImageViewLayout(*view_state, render_pass_info->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001479 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001480 }
1481 }
1482}
Dave Houltone19e20d2018-02-02 16:32:41 -07001483
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001484#ifdef VK_USE_PLATFORM_ANDROID_KHR
1485// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1486// This could also move into a seperate core_validation_android.cpp file... ?
1487
1488//
1489// AHB-specific validation within non-AHB APIs
1490//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001491bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001492 bool skip = false;
1493
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001494 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(create_info->pNext);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001495 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001496 if (0 != ext_fmt_android->externalFormat) {
1497 if (VK_FORMAT_UNDEFINED != create_info->format) {
1498 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001499 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1500 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1501 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001502 }
1503
1504 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001505 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1506 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1507 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001508 }
1509
1510 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001511 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1512 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06001513 "non-zero externalFormat, but usage includes bits (0x%" PRIx32 ") other than VK_IMAGE_USAGE_SAMPLED_BIT.",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001514 create_info->usage);
Dave Houltond9611312018-11-19 17:03:36 -07001515 }
1516
1517 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001518 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1519 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1520 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001521 }
1522 }
1523
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001524 if ((0 != ext_fmt_android->externalFormat) &&
1525 (ahb_ext_formats_map.find(ext_fmt_android->externalFormat) == ahb_ext_formats_map.end())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001526 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001527 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat (%" PRIu64
1528 ") which has "
1529 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().",
1530 ext_fmt_android->externalFormat);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001531 }
1532 }
1533
Dave Houltond9611312018-11-19 17:03:36 -07001534 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001535 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001536 skip |=
1537 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1538 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1539 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001540 }
1541 }
1542
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001543 const VkExternalMemoryImageCreateInfo *emici = LvlFindInChain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001544 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1545 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001546 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001547 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1548 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1549 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1550 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001551 }
1552
1553 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001554 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1555 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1556 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1557 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1558 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001559 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001560 }
1561
1562 return skip;
1563}
1564
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001565bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001566 bool skip = false;
Jeremy Gebbenf4449392022-01-28 10:09:10 -07001567 auto image_state = Get<IMAGE_STATE>(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001568
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06001569 if (image_state->HasAHBFormat()) {
Dave Houltond9611312018-11-19 17:03:36 -07001570 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001571 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1572 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001573 "format member is %s and must be VK_FORMAT_UNDEFINED.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001574 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001575 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001576
Dave Houltond9611312018-11-19 17:03:36 -07001577 // Chain must include a compatible ycbcr conversion
1578 bool conv_found = false;
1579 uint64_t external_format = 0;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001580 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = LvlFindInChain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001581 if (ycbcr_conv_info != nullptr) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001582 auto ycbcr_state = Get<SAMPLER_YCBCR_CONVERSION_STATE>(ycbcr_conv_info->conversion);
Jeremy Gebbenf4fb2a02021-07-08 09:57:46 -06001583 if (ycbcr_state) {
Dave Houltond9611312018-11-19 17:03:36 -07001584 conv_found = true;
Jeremy Gebbenf4fb2a02021-07-08 09:57:46 -06001585 external_format = ycbcr_state->external_format;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001586 }
Dave Houltond9611312018-11-19 17:03:36 -07001587 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001588 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001589 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001590 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1591 "an externalFormat (%" PRIu64
1592 ") but needs a chained VkSamplerYcbcrConversionInfo struct with a VkSamplerYcbcrConversion created "
1593 "with the same external format.",
1594 image_state->ahb_format);
Dave Houltond9611312018-11-19 17:03:36 -07001595 }
1596
1597 // Errors in create_info swizzles
sfricke-samsungbd0e8052020-06-06 01:36:39 -07001598 if (IsIdentitySwizzle(create_info->components) == false) {
1599 skip |= LogError(
1600 create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1601 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1602 "includes one or more non-identity component swizzles, r swizzle = %s, g swizzle = %s, b swizzle = %s, a swizzle "
1603 "= %s.",
1604 string_VkComponentSwizzle(create_info->components.r), string_VkComponentSwizzle(create_info->components.g),
1605 string_VkComponentSwizzle(create_info->components.b), string_VkComponentSwizzle(create_info->components.a));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001606 }
1607 }
Dave Houltond9611312018-11-19 17:03:36 -07001608
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001609 return skip;
1610}
1611
John Zulaufa26d3c82019-08-14 16:09:08 -06001612bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001613 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001614
Jeremy Gebbenf4449392022-01-28 10:09:10 -07001615 auto image_state = Get<IMAGE_STATE>(image);
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001616 if (image_state != nullptr) {
Aitor Camacho3294edd2022-05-16 22:34:19 +02001617 if (image_state->IsExternalAHB() && (0 == image_state->GetBoundMemoryStates().size())) {
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001618 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1619 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1620 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1621 "bound to memory.");
1622 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001623 }
1624 return skip;
1625}
1626
1627#else
1628
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001629bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001630 return false;
1631}
1632
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001633bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001634
John Zulaufa26d3c82019-08-14 16:09:08 -06001635bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001636
1637#endif // VK_USE_PLATFORM_ANDROID_KHR
1638
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001639bool CoreChecks::ValidateImageFormatFeatures(const VkImageCreateInfo *pCreateInfo) const {
1640 bool skip = false;
1641
1642 // validates based on imageCreateFormatFeatures from vkspec.html#resources-image-creation-limits
Lionel Landwerlin21719f62021-12-09 11:40:09 +02001643 VkFormatFeatureFlags2KHR tiling_features = 0;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001644 const VkImageTiling image_tiling = pCreateInfo->tiling;
1645 const VkFormat image_format = pCreateInfo->format;
1646
1647 if (image_format == VK_FORMAT_UNDEFINED) {
1648 // VU 01975 states format can't be undefined unless an android externalFormat
1649#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001650 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001651 if ((image_tiling == VK_IMAGE_TILING_OPTIMAL) && (ext_fmt_android != nullptr) && (0 != ext_fmt_android->externalFormat)) {
1652 auto it = ahb_ext_formats_map.find(ext_fmt_android->externalFormat);
1653 if (it != ahb_ext_formats_map.end()) {
1654 tiling_features = it->second;
1655 }
1656 }
1657#endif
1658 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
Lionel Landwerlin1da35792021-12-14 16:54:13 +02001659 layer_data::unordered_set<uint64_t> drm_format_modifiers;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001660 const VkImageDrmFormatModifierExplicitCreateInfoEXT *drm_explicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001661 LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001662 const VkImageDrmFormatModifierListCreateInfoEXT *drm_implicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001663 LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001664
1665 if (drm_explicit != nullptr) {
Lionel Landwerlin1da35792021-12-14 16:54:13 +02001666 drm_format_modifiers.insert(drm_explicit->drmFormatModifier);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001667 } else {
1668 // VUID 02261 makes sure its only explict or implict in parameter checking
1669 assert(drm_implicit != nullptr);
1670 for (uint32_t i = 0; i < drm_implicit->drmFormatModifierCount; i++) {
Lionel Landwerlin1da35792021-12-14 16:54:13 +02001671 drm_format_modifiers.insert(drm_implicit->pDrmFormatModifiers[i]);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001672 }
1673 }
1674
Lionel Landwerlin1da35792021-12-14 16:54:13 +02001675 auto fmt_drm_props = LvlInitStruct<VkDrmFormatModifierPropertiesListEXT>();
1676 auto fmt_props_2 = LvlInitStruct<VkFormatProperties2>(&fmt_drm_props);
1677 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &fmt_props_2);
Lionel Landwerlin09351a72020-06-22 18:15:59 +03001678 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
Lionel Landwerlin1da35792021-12-14 16:54:13 +02001679 drm_properties.resize(fmt_drm_props.drmFormatModifierCount);
1680 fmt_drm_props.pDrmFormatModifierProperties = drm_properties.data();
1681 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &fmt_props_2);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001682
Lionel Landwerlin1da35792021-12-14 16:54:13 +02001683 for (uint32_t i = 0; i < fmt_drm_props.drmFormatModifierCount; i++) {
1684 if (drm_format_modifiers.find(fmt_drm_props.pDrmFormatModifierProperties[i].drmFormatModifier) !=
1685 drm_format_modifiers.end()) {
1686 tiling_features |= fmt_drm_props.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001687 }
1688 }
1689 } else {
Lionel Landwerlin21719f62021-12-09 11:40:09 +02001690 VkFormatProperties3KHR format_properties = GetPDFormatProperties(image_format);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001691 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
1692 : format_properties.optimalTilingFeatures;
1693 }
1694
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001695 // Lack of disjoint format feature support while using the flag
1696 if (FormatIsMultiplane(image_format) && ((pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT) != 0) &&
Lionel Landwerlin21719f62021-12-09 11:40:09 +02001697 ((tiling_features & VK_FORMAT_FEATURE_2_DISJOINT_BIT_KHR) == 0)) {
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001698 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateFormatFeatures-02260",
1699 "vkCreateImage(): can't use VK_IMAGE_CREATE_DISJOINT_BIT because %s doesn't support "
1700 "VK_FORMAT_FEATURE_DISJOINT_BIT based on imageCreateFormatFeatures.",
1701 string_VkFormat(pCreateInfo->format));
1702 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001703
1704 return skip;
1705}
1706
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001707bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001708 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001709 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001710
sfricke-samsung45996a42021-09-16 13:45:27 -07001711 if (IsExtEnabled(device_extensions.vk_android_external_memory_android_hardware_buffer)) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001712 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001713 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1714 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001715 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1716 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001717 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001718 }
1719
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001720 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1721 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001722 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1723 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1724 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001725 }
Dave Houlton130c0212018-01-29 13:39:56 -07001726 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001727
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001728 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001729 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1730 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1731 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001732 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001733 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width (%u) exceeds "
1734 "device maxFramebufferWidth (%u).",
1735 pCreateInfo->extent.width, device_limits->maxFramebufferWidth);
Dave Houlton130c0212018-01-29 13:39:56 -07001736 }
1737
1738 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001739 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001740 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height (%u) exceeds "
1741 "device maxFramebufferHeight (%u).",
1742 pCreateInfo->extent.height, device_limits->maxFramebufferHeight);
Dave Houlton130c0212018-01-29 13:39:56 -07001743 }
1744
ziga-lunarg44cba6e2021-07-13 17:58:06 +02001745 VkImageCreateFlags sparseFlags =
1746 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
1747 if ((pCreateInfo->flags & sparseFlags) && (pCreateInfo->usage & VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT)) {
1748 skip |= LogError(
1749 device, "VUID-VkImageCreateInfo-None-01925",
1750 "vkCreateImage(): images using sparse memory cannot have VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT set");
1751 }
1752
Agarwal, Arpit78509112022-02-17 15:29:05 -07001753 if (!enabled_features.fragment_density_map_offset_features.fragmentDensityMapOffset) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001754 uint32_t ceiling_width = static_cast<uint32_t>(ceil(
1755 static_cast<float>(device_limits->maxFramebufferWidth) /
1756 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001757 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1758 skip |=
Agarwal, Arpit78509112022-02-17 15:29:05 -07001759 LogError(device, "VUID-VkImageCreateInfo-fragmentDensityMapOffset-06514",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001760 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1761 "ceiling of device "
1762 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1763 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1764 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001765 }
1766
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001767 uint32_t ceiling_height = static_cast<uint32_t>(ceil(
1768 static_cast<float>(device_limits->maxFramebufferHeight) /
1769 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001770 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1771 skip |=
Agarwal, Arpit78509112022-02-17 15:29:05 -07001772 LogError(device, "VUID-VkImageCreateInfo-fragmentDensityMapOffset-06515",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001773 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1774 "ceiling of device "
1775 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1776 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1777 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001778 }
1779 }
1780
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001781 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001782 VkResult result = VK_SUCCESS;
1783 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1784 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1785 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1786 &format_limits);
1787 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001788 auto modifier_list = LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1789 auto explicit_modifier = LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001790 if (modifier_list) {
1791 for (uint32_t i = 0; i < modifier_list->drmFormatModifierCount; i++) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001792 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001793 drm_format_modifier.drmFormatModifier = modifier_list->pDrmFormatModifiers[i];
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001794 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001795 image_format_info.type = pCreateInfo->imageType;
1796 image_format_info.format = pCreateInfo->format;
1797 image_format_info.tiling = pCreateInfo->tiling;
1798 image_format_info.usage = pCreateInfo->usage;
1799 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001800 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001801
1802 result =
1803 DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1804 format_limits = image_format_properties.imageFormatProperties;
1805
1806 /* The application gives a list of modifier and the driver
1807 * selects one. If one is wrong, stop there.
1808 */
1809 if (result != VK_SUCCESS) break;
1810 }
1811 } else if (explicit_modifier) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001812 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001813 drm_format_modifier.drmFormatModifier = explicit_modifier->drmFormatModifier;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001814 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001815 image_format_info.type = pCreateInfo->imageType;
1816 image_format_info.format = pCreateInfo->format;
1817 image_format_info.tiling = pCreateInfo->tiling;
1818 image_format_info.usage = pCreateInfo->usage;
1819 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001820 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001821
1822 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1823 format_limits = image_format_properties.imageFormatProperties;
1824 }
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001825 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001826
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001827 // 1. vkGetPhysicalDeviceImageFormatProperties[2] only success code is VK_SUCCESS
1828 // 2. If call returns an error, then "imageCreateImageFormatPropertiesList" is defined to be the empty list
1829 // 3. All values in 02251 are undefined if "imageCreateImageFormatPropertiesList" is empty.
1830 if (result != VK_SUCCESS) {
1831 // External memory will always have a "imageCreateImageFormatPropertiesList" so skip
Lockee87f87c2019-04-23 17:53:10 -06001832#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001833 if (!LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext)) {
Lockee87f87c2019-04-23 17:53:10 -06001834#endif // VK_USE_PLATFORM_ANDROID_KHR
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001835 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateMaxMipLevels-02251",
Spencer Frickec46fc6d2020-04-16 06:23:05 -07001836 "vkCreateImage(): Format %s is not supported for this combination of parameters and "
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001837 "VkGetPhysicalDeviceImageFormatProperties returned back %s.",
1838 string_VkFormat(pCreateInfo->format), string_VkResult(result));
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001839#ifdef VK_USE_PLATFORM_ANDROID_KHR
1840 }
1841#endif // VK_USE_PLATFORM_ANDROID_KHR
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001842 } else {
1843 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1844 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001845 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1846 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1847 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001848 }
Dave Houlton130c0212018-01-29 13:39:56 -07001849
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001850 uint64_t texel_count = static_cast<uint64_t>(pCreateInfo->extent.width) *
1851 static_cast<uint64_t>(pCreateInfo->extent.height) *
1852 static_cast<uint64_t>(pCreateInfo->extent.depth) * static_cast<uint64_t>(pCreateInfo->arrayLayers) *
1853 static_cast<uint64_t>(pCreateInfo->samples);
Dave Houlton130c0212018-01-29 13:39:56 -07001854
sfricke-samsung2e827212021-09-28 07:52:08 -07001855 // Depth/Stencil formats size can't be accurately calculated
1856 if (!FormatIsDepthAndStencil(pCreateInfo->format)) {
1857 uint64_t total_size =
1858 static_cast<uint64_t>(std::ceil(FormatTexelSize(pCreateInfo->format) * static_cast<double>(texel_count)));
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001859
sfricke-samsung2e827212021-09-28 07:52:08 -07001860 // Round up to imageGranularity boundary
1861 VkDeviceSize image_granularity = phys_dev_props.limits.bufferImageGranularity;
1862 uint64_t ig_mask = image_granularity - 1;
1863 total_size = (total_size + ig_mask) & ~ig_mask;
1864
1865 if (total_size > format_limits.maxResourceSize) {
1866 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
1867 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1868 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1869 total_size, format_limits.maxResourceSize);
1870 }
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001871 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001872
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001873 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001874 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
1875 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1876 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001877 }
1878
1879 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001880 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
1881 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
1882 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001883 }
sfricke-samsung612f3622020-06-20 20:42:46 -07001884
1885 if (pCreateInfo->extent.width > format_limits.maxExtent.width) {
1886 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02252",
1887 "vkCreateImage(): extent.width %u exceeds allowable maximum image extent width %u.",
1888 pCreateInfo->extent.width, format_limits.maxExtent.width);
1889 }
1890
1891 if (pCreateInfo->extent.height > format_limits.maxExtent.height) {
1892 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02253",
1893 "vkCreateImage(): extent.height %u exceeds allowable maximum image extent height %u.",
1894 pCreateInfo->extent.height, format_limits.maxExtent.height);
1895 }
1896
1897 if (pCreateInfo->extent.depth > format_limits.maxExtent.depth) {
1898 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02254",
1899 "vkCreateImage(): extent.depth %u exceeds allowable maximum image extent depth %u.",
1900 pCreateInfo->extent.depth, format_limits.maxExtent.depth);
1901 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001902 }
1903
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001904 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsung10b35ce2021-09-29 08:50:20 -07001905 if (FormatRequiresYcbcrConversionExplicitly(pCreateInfo->format)) {
sfricke-samsungcead0802020-01-30 22:20:10 -08001906 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
sfricke-samsung45996a42021-09-16 13:45:27 -07001907 const char *error_vuid = IsExtEnabled(device_extensions.vk_ext_ycbcr_image_arrays)
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07001908 ? "VUID-VkImageCreateInfo-format-06414"
1909 : "VUID-VkImageCreateInfo-format-06413";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001910 skip |= LogError(device, error_vuid,
1911 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
1912 "YCbCr Conversion format, arrayLayers must be 1",
1913 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001914 }
1915
1916 if (pCreateInfo->mipLevels != 1) {
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07001917 skip |= LogError(device, "VUID-VkImageCreateInfo-format-06410",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001918 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
tmerilehtica733542022-04-13 14:00:29 +03001919 pCreateInfo->mipLevels);
sfricke-samsungcead0802020-01-30 22:20:10 -08001920 }
1921
1922 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001923 skip |= LogError(
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07001924 device, "VUID-VkImageCreateInfo-format-06411",
sfricke-samsungcead0802020-01-30 22:20:10 -08001925 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
1926 string_VkSampleCountFlagBits(pCreateInfo->samples));
1927 }
1928
1929 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001930 skip |= LogError(
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07001931 device, "VUID-VkImageCreateInfo-format-06412",
sfricke-samsungcead0802020-01-30 22:20:10 -08001932 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
1933 string_VkImageType(pCreateInfo->imageType));
1934 }
1935 }
1936
sfricke-samsung45996a42021-09-16 13:45:27 -07001937 if (IsExtEnabled(device_extensions.vk_khr_maintenance2)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001938 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
sfricke-samsung08796682021-09-13 07:47:20 -07001939 if (!FormatIsCompressed(pCreateInfo->format)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001940 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01572",
1941 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
sfricke-samsung08796682021-09-13 07:47:20 -07001942 "format must be a compressed image format, but is %s",
Spencer Fricke48db59b2020-03-23 10:31:46 -07001943 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001944 }
1945 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001946 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01573",
1947 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1948 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001949 }
1950 }
1951 }
1952
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001953 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
sfricke-samsung45996a42021-09-16 13:45:27 -07001954 const char *vuid = IsExtEnabled(device_extensions.vk_khr_get_physical_device_properties2)
1955 ? "VUID-VkImageCreateInfo-sharingMode-01420"
1956 : "VUID-VkImageCreateInfo-sharingMode-01392";
Mark Lobodzinski314b9162020-07-16 15:33:08 -06001957 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
ziga-lunarge2e283d2021-08-01 09:55:04 +02001958 "vkCreateImage", "pCreateInfo->pQueueFamilyIndices", vuid);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001959 }
1960
unknown2c877272019-07-11 12:56:50 -06001961 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
1962 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
1963 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001964 LogError(device, "VUID-VkImageCreateInfo-format-01577",
1965 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
1966 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06001967 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001968
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001969 const auto swapchain_create_info = LvlFindInChain<VkImageSwapchainCreateInfoKHR>(pCreateInfo->pNext);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07001970 if (swapchain_create_info != nullptr) {
1971 if (swapchain_create_info->swapchain != VK_NULL_HANDLE) {
Jeremy Gebbenf4449392022-01-28 10:09:10 -07001972 auto swapchain_state = Get<SWAPCHAIN_NODE>(swapchain_create_info->swapchain);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07001973 const VkSwapchainCreateFlagsKHR swapchain_flags = swapchain_state->createInfo.flags;
1974
1975 // Validate rest of Swapchain Image create check that require swapchain state
1976 const char *vuid = "VUID-VkImageSwapchainCreateInfoKHR-swapchain-00995";
1977 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR) != 0) &&
1978 ((pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) == 0)) {
1979 skip |= LogError(
1980 device, vuid,
1981 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR flag so "
1982 "all swapchain images must have the VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT flag set.");
1983 }
1984 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR) != 0) &&
1985 ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) == 0)) {
1986 skip |= LogError(device, vuid,
1987 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR flag so all "
1988 "swapchain images must have the VK_IMAGE_CREATE_PROTECTED_BIT flag set.");
1989 }
Mike Schuchardt2df08912020-12-15 16:28:09 -08001990 const VkImageCreateFlags mutable_flags = (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT | VK_IMAGE_CREATE_EXTENDED_USAGE_BIT);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07001991 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR) != 0) &&
1992 ((pCreateInfo->flags & mutable_flags) != mutable_flags)) {
1993 skip |= LogError(device, vuid,
1994 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR flag so "
1995 "all swapchain images must have the VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT and "
Mike Schuchardt2df08912020-12-15 16:28:09 -08001996 "VK_IMAGE_CREATE_EXTENDED_USAGE_BIT flags both set.");
sfricke-samsungddaf72b2020-06-23 21:39:28 -07001997 }
1998 }
1999 }
2000
sfricke-samsungedce77a2020-07-03 22:35:13 -07002001 if ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) != 0) {
2002 if (enabled_features.core11.protectedMemory == VK_FALSE) {
2003 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01890",
2004 "vkCreateImage(): the protectedMemory device feature is disabled: Images cannot be created with the "
2005 "VK_IMAGE_CREATE_PROTECTED_BIT set.");
2006 }
2007 const VkImageCreateFlags invalid_flags =
2008 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
2009 if ((pCreateInfo->flags & invalid_flags) != 0) {
2010 skip |= LogError(device, "VUID-VkImageCreateInfo-None-01891",
2011 "vkCreateImage(): VK_IMAGE_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at same "
2012 "time (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | "
2013 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT).");
2014 }
2015 }
2016
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002017 skip |= ValidateImageFormatFeatures(pCreateInfo);
2018
Nathaniel Cesarioc02c2512020-11-13 12:04:24 -07002019 // Check compatibility with VK_KHR_portability_subset
sfricke-samsung45996a42021-09-16 13:45:27 -07002020 if (IsExtEnabled(device_extensions.vk_khr_portability_subset)) {
Nathaniel Cesarioc02c2512020-11-13 12:04:24 -07002021 if (VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT & pCreateInfo->flags &&
2022 VK_FALSE == enabled_features.portability_subset_features.imageView2DOn3DImage) {
2023 skip |= LogError(device, "VUID-VkImageCreateInfo-imageView2DOn3DImage-04459",
2024 "vkCreateImage (portability error): VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT is not supported.");
2025 }
2026 if ((VK_SAMPLE_COUNT_1_BIT != pCreateInfo->samples) && (1 != pCreateInfo->arrayLayers) &&
2027 (VK_FALSE == enabled_features.portability_subset_features.multisampleArrayImage)) {
2028 skip |=
2029 LogError(device, "VUID-VkImageCreateInfo-multisampleArrayImage-04460",
2030 "vkCreateImage (portability error): Cannot create an image with samples/texel > 1 && arrayLayers != 1");
2031 }
2032 }
2033
ziga-lunarg63f8d7a2021-07-20 22:10:31 +02002034 const auto external_memory_create_info_nv = LvlFindInChain<VkExternalMemoryImageCreateInfoNV>(pCreateInfo->pNext);
ziga-lunarg62aa24f2021-10-09 11:58:30 +02002035 const auto external_memory_create_info = LvlFindInChain<VkExternalMemoryImageCreateInfo>(pCreateInfo->pNext);
2036 if (external_memory_create_info_nv != nullptr && external_memory_create_info != nullptr) {
2037 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-00988",
2038 "vkCreateImage(): VkImageCreateInfo struct has both VkExternalMemoryImageCreateInfoNV and "
2039 "VkExternalMemoryImageCreateInfo chained structs.");
2040 }
2041 if (external_memory_create_info) {
2042 if (external_memory_create_info->handleTypes != 0 && pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_UNDEFINED) {
2043 skip |= LogError(
2044 device, "VUID-VkImageCreateInfo-pNext-01443",
2045 "vkCreateImage: VkImageCreateInfo pNext chain includes VkExternalMemoryImageCreateInfo with handleTypes %" PRIu32
2046 " but pCreateInfo->initialLayout is %s.",
2047 external_memory_create_info->handleTypes, string_VkImageLayout(pCreateInfo->initialLayout));
2048 }
2049 } else if (external_memory_create_info_nv) {
2050 if (external_memory_create_info_nv->handleTypes != 0 && pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_UNDEFINED) {
2051 skip |= LogError(
2052 device, "VUID-VkImageCreateInfo-pNext-01443",
2053 "vkCreateImage: VkImageCreateInfo pNext chain includes VkExternalMemoryImageCreateInfoNV with handleTypes %" PRIu32
2054 " but pCreateInfo->initialLayout is %s.",
2055 external_memory_create_info_nv->handleTypes, string_VkImageLayout(pCreateInfo->initialLayout));
ziga-lunarg63f8d7a2021-07-20 22:10:31 +02002056 }
2057 }
2058
ziga-lunarg374fd9a2021-07-18 10:32:52 +02002059 if (device_group_create_info.physicalDeviceCount == 1) {
2060 if (pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) {
2061 skip |= LogError(device, "VUID-VkImageCreateInfo-physicalDeviceCount-01421",
2062 "vkCreateImage: Device was created with VkDeviceGroupDeviceCreateInfo::physicalDeviceCount 1, but "
2063 "flags contain VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT bit.");
2064 }
2065 }
2066
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002067 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002068}
2069
John Zulauf7eeb6f72019-06-17 11:56:36 -06002070void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
2071 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
2072 if (VK_SUCCESS != result) return;
2073
2074 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
Jeremy Gebben4a8881f2022-01-10 17:04:30 -07002075 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) != 0) {
2076 // non-sparse images set up their layout maps when memory is bound
2077 auto image_state = Get<IMAGE_STATE>(*pImage);
2078 image_state->SetInitialLayoutMap();
2079 }
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07002080}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002081
Jeff Bolz5c801d12019-10-09 10:38:45 -05002082bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeremy Gebbenf4449392022-01-28 10:09:10 -07002083 auto image_state = Get<IMAGE_STATE>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002084 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07002085 if (image_state) {
Jeremy Gebben82e11d52021-07-26 09:19:37 -06002086 if (image_state->IsSwapchainImage()) {
sfricke-samsung73452522021-06-17 08:44:46 -07002087 skip |= LogError(device, "VUID-vkDestroyImage-image-04882",
sfricke-samsung9056cc12021-04-18 22:51:00 -07002088 "vkDestroyImage(): %s is a presentable image and it is controlled by the implementation and is "
2089 "destroyed with vkDestroySwapchainKHR.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002090 report_data->FormatHandle(image_state->image()).c_str());
sfricke-samsung9056cc12021-04-18 22:51:00 -07002091 }
Jeremy Gebben9f537102021-10-05 16:37:12 -06002092 skip |= ValidateObjectNotInUse(image_state.get(), "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002093 }
2094 return skip;
2095}
2096
John Zulauf7eeb6f72019-06-17 11:56:36 -06002097void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
2098 // Clean up validation specific data
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002099 auto image_state = Get<IMAGE_STATE>(image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07002100 qfo_release_image_barrier_map.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06002101 // Clean up generic image state
2102 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002103}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002104
sfricke-samsungcd924d92020-05-20 23:51:17 -07002105bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range,
2106 const char *param_name) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002107 bool skip = false;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002108 const VkImage image = image_state->image();
sfricke-samsungcd924d92020-05-20 23:51:17 -07002109 const VkFormat format = image_state->createInfo.format;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002110
2111 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002112 skip |= LogError(image, "VUID-vkCmdClearColorImage-aspectMask-02498",
2113 "vkCmdClearColorImage(): %s.aspectMasks must only be set to VK_IMAGE_ASPECT_COLOR_BIT.", param_name);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002114 }
2115
sfricke-samsungcd924d92020-05-20 23:51:17 -07002116 if (FormatIsDepthOrStencil(format)) {
2117 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2118 "vkCmdClearColorImage(): %s called with image %s which has a depth/stencil format (%s).", param_name,
2119 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
2120 } else if (FormatIsCompressed(format)) {
2121 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2122 "vkCmdClearColorImage(): %s called with image %s which has a compressed format (%s).", param_name,
2123 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002124 }
2125
2126 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002127 skip |=
2128 LogError(image, "VUID-vkCmdClearColorImage-image-00002",
2129 "vkCmdClearColorImage() %s called with image %s which was created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.",
2130 param_name, report_data->FormatHandle(image).c_str());
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002131 }
2132 return skip;
2133}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002134
John Zulauf07288512019-07-05 11:09:50 -06002135bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
2136 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
2137 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002138 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002139 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2140 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002141 skip |= LogError(image_state->image(), "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002142 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2143 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002144 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002145
2146 } else {
2147 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
sfricke-samsung45996a42021-09-16 13:45:27 -07002148 if (!IsExtEnabled(device_extensions.vk_khr_shared_presentable_image)) {
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002149 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002150 skip |= LogError(image_state->image(), "VUID-vkCmdClearColorImage-imageLayout-00005",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002151 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2152 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002153 }
2154 } else {
2155 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
2156 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002157 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002158 image_state->image(), "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002159 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
2160 func_name, string_VkImageLayout(dest_image_layout));
2161 }
2162 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002163 }
2164
John Zulauff660ad62019-03-23 07:16:05 -06002165 // Cast to const to prevent creation at validate time.
Jeremy Gebben6335df62021-11-01 10:50:13 -06002166 const auto *subresource_map = cb_node->GetImageSubresourceLayoutMap(*image_state);
John Zulauff660ad62019-03-23 07:16:05 -06002167 if (subresource_map) {
2168 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06002169 LayoutUseCheckAndMessage layout_check(subresource_map);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002170 auto normalized_isr = image_state->NormalizeSubresourceRange(range);
Tony Barbour55688172020-09-23 15:19:50 -07002171 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
2172 // the next "constant value" range
2173 for (auto pos = subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07002174 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06002175 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
2176 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2177 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
2178 } else {
2179 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002180 }
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002181 subres_skip |= LogError(cb_node->commandBuffer(), error_code,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002182 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
2183 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
2184 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002185 }
John Zulauf5e617452019-11-19 14:44:16 -07002186 }
John Zulauff660ad62019-03-23 07:16:05 -06002187 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002188 }
2189
2190 return skip;
2191}
2192
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002193bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2194 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002195 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002196 bool skip = false;
2197 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07002198 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07002199 auto image_state = Get<IMAGE_STATE>(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002200 if (cb_node && image_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06002201 skip |= ValidateMemoryIsBoundToImage(image_state.get(), "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
2202 skip |= ValidateCmd(cb_node.get(), CMD_CLEARCOLORIMAGE);
sfricke-samsung45996a42021-09-16 13:45:27 -07002203 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Lionel Landwerlin21719f62021-12-09 11:40:09 +02002204 skip |= ValidateImageFormatFeatureFlags(image_state.get(), VK_FORMAT_FEATURE_2_TRANSFER_DST_BIT_KHR,
2205 "vkCmdClearColorImage", "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04002206 }
Jeremy Gebben9f537102021-10-05 16:37:12 -06002207 skip |= ValidateProtectedImage(cb_node.get(), image_state.get(), "vkCmdClearColorImage()",
2208 "VUID-vkCmdClearColorImage-commandBuffer-01805");
2209 skip |= ValidateUnprotectedImage(cb_node.get(), image_state.get(), "vkCmdClearColorImage()",
sfricke-samsung022fa252020-07-24 03:26:16 -07002210 "VUID-vkCmdClearColorImage-commandBuffer-01806");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002211 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002212 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Jeremy Gebben9f537102021-10-05 16:37:12 -06002213 skip |= ValidateCmdClearColorSubresourceRange(image_state.get(), pRanges[i], param_name.c_str());
2214 skip |= ValidateImageAttributes(image_state.get(), pRanges[i], param_name.c_str());
2215 skip |= VerifyClearImageLayout(cb_node.get(), image_state.get(), pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002216 }
sfricke-samsunge775d492020-02-28 09:02:25 -08002217 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsung10b35ce2021-09-29 08:50:20 -07002218 if (FormatRequiresYcbcrConversionExplicitly(image_state->createInfo.format)) {
sfricke-samsunge775d492020-02-28 09:02:25 -08002219 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
2220 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
2221 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
2222 string_VkFormat(image_state->createInfo.format));
2223 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002224 }
2225 return skip;
2226}
2227
John Zulaufeabb4462019-07-05 14:13:03 -06002228void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2229 const VkClearColorValue *pColor, uint32_t rangeCount,
2230 const VkImageSubresourceRange *pRanges) {
2231 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
2232
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07002233 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002234 auto image_state = Get<IMAGE_STATE>(image);
John Zulaufeabb4462019-07-05 14:13:03 -06002235 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002236 for (uint32_t i = 0; i < rangeCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06002237 cb_node->SetImageInitialLayout(image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002238 }
2239 }
2240}
2241
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002242bool CoreChecks::ValidateClearDepthStencilValue(VkCommandBuffer commandBuffer, VkClearDepthStencilValue clearValue,
2243 const char *apiName) const {
2244 bool skip = false;
2245
2246 // 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 -07002247 if (!IsExtEnabled(device_extensions.vk_ext_depth_range_unrestricted)) {
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002248 if (!(clearValue.depth >= 0.0) || !(clearValue.depth <= 1.0)) {
2249 // Also VUID-VkClearDepthStencilValue-depth-00022
2250 skip |= LogError(commandBuffer, "VUID-VkClearDepthStencilValue-depth-02506",
2251 "%s: VK_EXT_depth_range_unrestricted extension is not enabled and VkClearDepthStencilValue::depth "
2252 "(=%f) is not within the [0.0, 1.0] range.",
2253 apiName, clearValue.depth);
2254 }
2255 }
2256
2257 return skip;
2258}
2259
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002260bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2261 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002262 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002263 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002264
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002265 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07002266 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07002267 auto image_state = Get<IMAGE_STATE>(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002268 if (cb_node && image_state) {
sfricke-samsung30e325a2020-07-25 12:56:13 -07002269 const VkFormat image_format = image_state->createInfo.format;
Jeremy Gebben9f537102021-10-05 16:37:12 -06002270 skip |= ValidateMemoryIsBoundToImage(image_state.get(), "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002271 "VUID-vkCmdClearDepthStencilImage-image-00010");
Jeremy Gebben9f537102021-10-05 16:37:12 -06002272 skip |= ValidateCmd(cb_node.get(), CMD_CLEARDEPTHSTENCILIMAGE);
sfricke-samsung45996a42021-09-16 13:45:27 -07002273 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Lionel Landwerlin21719f62021-12-09 11:40:09 +02002274 skip |= ValidateImageFormatFeatureFlags(image_state.get(), VK_FORMAT_FEATURE_2_TRANSFER_DST_BIT_KHR,
Jeremy Gebben9f537102021-10-05 16:37:12 -06002275 "vkCmdClearDepthStencilImage", "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04002276 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002277 skip |= ValidateClearDepthStencilValue(commandBuffer, *pDepthStencil, "vkCmdClearDepthStencilImage()");
Jeremy Gebben9f537102021-10-05 16:37:12 -06002278 skip |= ValidateProtectedImage(cb_node.get(), image_state.get(), "vkCmdClearDepthStencilImage()",
sfricke-samsung022fa252020-07-24 03:26:16 -07002279 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01807");
Jeremy Gebben9f537102021-10-05 16:37:12 -06002280 skip |= ValidateUnprotectedImage(cb_node.get(), image_state.get(), "vkCmdClearDepthStencilImage()",
sfricke-samsung022fa252020-07-24 03:26:16 -07002281 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01808");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002282
2283 bool any_include_aspect_depth_bit = false;
2284 bool any_include_aspect_stencil_bit = false;
2285
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002286 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002287 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Jeremy Gebben9f537102021-10-05 16:37:12 -06002288 skip |= ValidateCmdClearDepthSubresourceRange(image_state.get(), pRanges[i], param_name.c_str());
2289 skip |=
2290 VerifyClearImageLayout(cb_node.get(), image_state.get(), pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002291 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06002292 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
2293 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002294 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-aspectMask-02824",
2295 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask can only be VK_IMAGE_ASPECT_DEPTH_BIT "
2296 "and/or VK_IMAGE_ASPECT_STENCIL_BIT.",
2297 i);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002298 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002299 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
2300 any_include_aspect_depth_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002301 if (FormatHasDepth(image_format) == false) {
2302 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02826",
2303 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_DEPTH_BIT but %s "
2304 "doesn't have a depth component.",
2305 i, string_VkFormat(image_format));
2306 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002307 }
2308 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
2309 any_include_aspect_stencil_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002310 if (FormatHasStencil(image_format) == false) {
2311 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02825",
2312 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_STENCIL_BIT but "
2313 "%s doesn't have a stencil component.",
2314 i, string_VkFormat(image_format));
2315 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002316 }
2317 }
2318 if (any_include_aspect_stencil_bit) {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07002319 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05002320 if (image_stencil_struct != nullptr) {
2321 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
2322 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002323 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
2324 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
2325 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
2326 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002327 }
2328 } else {
2329 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002330 skip |= LogError(
2331 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05002332 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
2333 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
2334 "in VkImageCreateInfo::usage used to create image");
2335 }
2336 }
2337 }
2338 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002339 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
2340 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
2341 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002342 }
sfricke-samsung30e325a2020-07-25 12:56:13 -07002343 if (image_state && !FormatIsDepthOrStencil(image_format)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002344 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014",
2345 "vkCmdClearDepthStencilImage(): called with image %s which doesn't have a depth/stencil format (%s).",
sfricke-samsung30e325a2020-07-25 12:56:13 -07002346 report_data->FormatHandle(image).c_str(), string_VkFormat(image_format));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002347 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002348 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002349 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009",
2350 "vkCmdClearDepthStencilImage(): called with image %s which was not created with the "
2351 "VK_IMAGE_USAGE_TRANSFER_DST_BIT set.",
2352 report_data->FormatHandle(image).c_str());
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002353 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002354 }
2355 return skip;
2356}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002357
John Zulaufeabb4462019-07-05 14:13:03 -06002358void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2359 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
2360 const VkImageSubresourceRange *pRanges) {
2361 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07002362
2363 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002364 auto image_state = Get<IMAGE_STATE>(image);
John Zulaufeabb4462019-07-05 14:13:03 -06002365 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002366 for (uint32_t i = 0; i < rangeCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06002367 cb_node->SetImageInitialLayout(image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002368 }
2369 }
2370}
2371
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002372// Returns true if [x, xoffset] and [y, yoffset] overlap
2373static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
2374 bool result = false;
2375 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
2376 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
2377
2378 if (intersection_max > intersection_min) {
2379 result = true;
2380 }
2381 return result;
2382}
2383
Jeff Leger178b1e52020-10-05 12:22:23 -04002384// Returns true if source area of first vkImageCopy/vkImageCopy2KHR region intersects dest area of second region
Dave Houltonc991cc92018-03-06 11:08:51 -07002385// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
Jeff Leger178b1e52020-10-05 12:22:23 -04002386template <typename RegionType>
sfricke-samsung71f04e32022-03-16 01:21:21 -05002387static bool RegionIntersects(const RegionType *region0, const RegionType *region1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002388 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07002389
Dave Houltonc991cc92018-03-06 11:08:51 -07002390 // Separate planes within a multiplane image cannot intersect
sfricke-samsung71f04e32022-03-16 01:21:21 -05002391 if (is_multiplane && (region0->srcSubresource.aspectMask != region1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07002392 return result;
2393 }
2394
sfricke-samsung71f04e32022-03-16 01:21:21 -05002395 if ((region0->srcSubresource.mipLevel == region1->dstSubresource.mipLevel) &&
2396 (RangesIntersect(region0->srcSubresource.baseArrayLayer, region0->srcSubresource.layerCount,
2397 region1->dstSubresource.baseArrayLayer, region1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002398 result = true;
2399 switch (type) {
2400 case VK_IMAGE_TYPE_3D:
sfricke-samsung71f04e32022-03-16 01:21:21 -05002401 result &= RangesIntersect(region0->srcOffset.z, region0->extent.depth, region1->dstOffset.z, region1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002402 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002403 case VK_IMAGE_TYPE_2D:
sfricke-samsung71f04e32022-03-16 01:21:21 -05002404 result &=
2405 RangesIntersect(region0->srcOffset.y, region0->extent.height, region1->dstOffset.y, region1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002406 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002407 case VK_IMAGE_TYPE_1D:
sfricke-samsung71f04e32022-03-16 01:21:21 -05002408 result &= RangesIntersect(region0->srcOffset.x, region0->extent.width, region1->dstOffset.x, region1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002409 break;
2410 default:
2411 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2412 assert(false);
2413 }
2414 }
2415 return result;
2416}
2417
aitor-lunarg607fe732022-03-31 22:00:08 +02002418template <typename RegionType>
2419static bool RegionIntersectsBlit(const RegionType *region0, const RegionType *region1, VkImageType type, bool is_multiplane) {
2420 bool result = false;
2421
2422 // Separate planes within a multiplane image cannot intersect
2423 if (is_multiplane && (region0->srcSubresource.aspectMask != region1->dstSubresource.aspectMask)) {
2424 return result;
2425 }
2426
2427 if ((region0->srcSubresource.mipLevel == region1->dstSubresource.mipLevel) &&
2428 (RangesIntersect(region0->srcSubresource.baseArrayLayer, region0->srcSubresource.layerCount,
2429 region1->dstSubresource.baseArrayLayer, region1->dstSubresource.layerCount))) {
2430 result = true;
2431 switch (type) {
2432 case VK_IMAGE_TYPE_3D:
2433 result &= RangesIntersect(region0->srcOffsets[0].z, region0->srcOffsets[1].z - region0->srcOffsets[0].z,
2434 region1->dstOffsets[0].z, region1->dstOffsets[1].z - region1->dstOffsets[0].z);
2435 // fall through
2436 case VK_IMAGE_TYPE_2D:
2437 result &= RangesIntersect(region0->srcOffsets[0].y, region0->srcOffsets[1].y - region0->srcOffsets[0].y,
2438 region1->dstOffsets[0].y, region1->dstOffsets[1].y - region1->dstOffsets[0].y);
2439 // fall through
2440 case VK_IMAGE_TYPE_1D:
2441 result &= RangesIntersect(region0->srcOffsets[0].x, region0->srcOffsets[1].x - region0->srcOffsets[0].x,
2442 region1->dstOffsets[0].x, region1->dstOffsets[1].x - region1->dstOffsets[0].x);
2443 break;
2444 default:
2445 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2446 assert(false);
2447 }
2448 }
2449 return result;
2450}
2451
Dave Houltonfc1a4052017-04-27 14:32:45 -06002452// Returns non-zero if offset and extent exceed image extents
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002453static const uint32_t kXBit = 1;
2454static const uint32_t kYBit = 2;
2455static const uint32_t kZBit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002456static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002457 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002458 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002459 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2460 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002461 result |= kZBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002462 }
2463 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2464 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002465 result |= kYBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002466 }
2467 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2468 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002469 result |= kXBit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002470 }
2471 return result;
2472}
2473
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002474// Test if two VkExtent3D structs are equivalent
2475static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2476 bool result = true;
2477 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2478 (extent->depth != other_extent->depth)) {
2479 result = false;
2480 }
2481 return result;
2482}
2483
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002484// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002485static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002486 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2487}
2488
2489// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002490VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002491 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2492 VkExtent3D granularity = {0, 0, 0};
Jeremy Gebbencd7fa282021-10-27 10:25:32 -06002493 const auto pool = cb_node->command_pool;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002494 if (pool) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002495 granularity = physical_device_state->queue_family_properties[pool->queueFamilyIndex].minImageTransferGranularity;
sfricke-samsung01da6312021-10-20 07:51:32 -07002496 if (FormatIsBlockedImage(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002497 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002498 granularity.width *= block_size.width;
2499 granularity.height *= block_size.height;
2500 }
2501 }
2502 return granularity;
2503}
2504
2505// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2506static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2507 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002508 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2509 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002510 valid = false;
2511 }
2512 return valid;
2513}
2514
2515// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002516bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002517 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002518 bool skip = false;
2519 VkExtent3D offset_extent = {};
2520 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2521 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2522 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002523 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002524 // 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 -07002525 if (IsExtentAllZeroes(&offset_extent) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002526 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002527 "%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 "
2528 "image transfer granularity is (w=0, h=0, d=0).",
2529 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002530 }
2531 } else {
2532 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2533 // integer multiples of the image transfer granularity.
2534 if (IsExtentAligned(&offset_extent, granularity) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002535 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002536 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2537 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2538 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2539 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002540 }
2541 }
2542 return skip;
2543}
2544
2545// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002546bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002547 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002548 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002549 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002550 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002551 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2552 // subresource extent.
2553 if (IsExtentEqual(extent, subresource_extent) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002554 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002555 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2556 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2557 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2558 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002559 }
2560 } else {
2561 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2562 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2563 // subresource extent dimensions.
2564 VkExtent3D offset_extent_sum = {};
2565 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2566 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2567 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002568 bool x_ok = true;
2569 bool y_ok = true;
2570 bool z_ok = true;
2571 switch (image_type) {
2572 case VK_IMAGE_TYPE_3D:
2573 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2574 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002575 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002576 case VK_IMAGE_TYPE_2D:
2577 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2578 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002579 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002580 case VK_IMAGE_TYPE_1D:
2581 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2582 (subresource_extent->width == offset_extent_sum.width));
2583 break;
2584 default:
2585 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2586 assert(false);
2587 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002588 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002589 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002590 LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002591 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2592 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2593 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2594 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2595 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2596 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002597 }
2598 }
2599 return skip;
2600}
2601
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002602bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002603 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002604 bool skip = false;
2605 if (mip_level >= img->createInfo.mipLevels) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002606 skip |= LogError(cb_node->commandBuffer(), vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2607 function, i, member, mip_level, report_data->FormatHandle(img->image()).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002608 }
2609 return skip;
2610}
2611
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002612bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002613 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002614 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002615 bool skip = false;
2616 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2617 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002618 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002619 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2620 "%u, but provided %s has %u array layers.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002621 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image()).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002622 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002623 }
2624 return skip;
2625}
2626
Tony Barbour845d29b2021-11-09 11:43:14 -07002627// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy/VkBufferImageCopy2 structure
sfricke-samsung71f04e32022-03-16 01:21:21 -05002628template <typename RegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002629bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
sfricke-samsung71f04e32022-03-16 01:21:21 -05002630 const RegionType *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002631 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002632 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002633 VkExtent3D granularity = GetScaledItg(cb_node, img);
2634 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002635 VkExtent3D subresource_extent = img->GetSubresourceExtent(region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002636 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002637 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002638 return skip;
2639}
2640
Jeff Leger178b1e52020-10-05 12:22:23 -04002641// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy/VkImageCopy2KHR structure
2642template <typename RegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002643bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002644 const IMAGE_STATE *dst_img, const RegionType *region,
2645 const uint32_t i, const char *function,
Tony-LunarGb61514a2021-11-02 12:36:51 -06002646 CMD_TYPE cmd_type) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002647 bool skip = false;
Tony-LunarGb61514a2021-11-02 12:36:51 -06002648 const bool is_2 = (cmd_type == CMD_COPYIMAGE2KHR || cmd_type == CMD_COPYIMAGE2);
Jeff Leger178b1e52020-10-05 12:22:23 -04002649 const char *vuid;
2650
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002651 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002652 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
Tony-LunarGb61514a2021-11-02 12:36:51 -06002653 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
Jeff Leger178b1e52020-10-05 12:22:23 -04002654 skip |= CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", vuid);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002655 VkExtent3D subresource_extent = src_img->GetSubresourceExtent(region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002656 const VkExtent3D extent = region->extent;
Tony-LunarGb61514a2021-11-02 12:36:51 -06002657 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002658 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04002659 i, function, "extent", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002660
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002661 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002662 granularity = GetScaledItg(cb_node, dst_img);
Tony-LunarGb61514a2021-11-02 12:36:51 -06002663 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
Jeff Leger178b1e52020-10-05 12:22:23 -04002664 skip |= CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", vuid);
Dave Houltonee281a52017-12-08 13:51:02 -07002665 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002666 const VkExtent3D dest_effective_extent =
2667 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002668 subresource_extent = dst_img->GetSubresourceExtent(region->dstSubresource);
Tony-LunarGb61514a2021-11-02 12:36:51 -06002669 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002670 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Jeff Leger178b1e52020-10-05 12:22:23 -04002671 dst_img->createInfo.imageType, i, function, "extent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002672 return skip;
2673}
2674
Jeff Leger178b1e52020-10-05 12:22:23 -04002675// Validate contents of a VkImageCopy or VkImageCopy2KHR struct
sfricke-samsung71f04e32022-03-16 01:21:21 -05002676template <typename RegionType>
2677bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const RegionType *pRegions, const IMAGE_STATE *src_state,
2678 const IMAGE_STATE *dst_state, CMD_TYPE cmd_type) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002679 bool skip = false;
Tony-LunarGb61514a2021-11-02 12:36:51 -06002680 const bool is_2 = (cmd_type == CMD_COPYIMAGE2KHR || cmd_type == CMD_COPYIMAGE2);
2681 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04002682 const char *vuid;
Dave Houlton6f9059e2017-05-02 17:15:13 -06002683
2684 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05002685 const RegionType region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002686
2687 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002688 const VkExtent3D src_copy_extent = region.extent;
2689 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002690 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2691
Dave Houlton6f9059e2017-05-02 17:15:13 -06002692 bool slice_override = false;
2693 uint32_t depth_slices = 0;
2694
2695 // Special case for copying between a 1D/2D array and a 3D image
2696 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2697 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002698 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002699 slice_override = (depth_slices != 1);
2700 } 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 -07002701 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002702 slice_override = (depth_slices != 1);
2703 }
2704
2705 // Do all checks on source image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002706 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002707 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002708 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-00146" : "VUID-vkCmdCopyImage-srcImage-00146";
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.y is %d and extent.height is %d. For 1D images these must "
2711 "be 0 and 1, respectively.",
2712 func_name, i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002713 }
2714 }
2715
Dave Houlton533be9f2018-03-26 17:08:30 -06002716 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002717 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01785" : "VUID-vkCmdCopyImage-srcImage-01785";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002718 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002719 "%s: pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002720 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002721 func_name, i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002722 }
2723
Dave Houlton533be9f2018-03-26 17:08:30 -06002724 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002725 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01787" : "VUID-vkCmdCopyImage-srcImage-01787";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002726 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 -04002727 func_name, i, region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002728 }
2729
sfricke-samsung01da6312021-10-20 07:51:32 -07002730 // Source checks that apply only to "blocked images"
2731 if (FormatIsBlockedImage(src_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002732 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002733 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002734 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2735 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2736 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002737 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01727" : "VUID-vkCmdCopyImage-srcImage-01727";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002738 skip |= LogError(src_state->image(), vuid,
sfricke-samsung01da6312021-10-20 07:51:32 -07002739 "%s: pRegion[%d] srcOffset (%d, %d) must be multiples of the blocked image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002740 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002741 func_name, i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002742 }
2743
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002744 const VkExtent3D mip_extent = src_state->GetSubresourceExtent(region.srcSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07002745 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2746 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002747 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01728" : "VUID-vkCmdCopyImage-srcImage-01728";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002748 skip |= LogError(src_state->image(), vuid,
sfricke-samsung01da6312021-10-20 07:51:32 -07002749 "%s: pRegion[%d] extent width (%d) must be a multiple of the blocked texture block "
Jeff Leger178b1e52020-10-05 12:22:23 -04002750 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2751 func_name, i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002752 }
2753
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002754 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002755 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2756 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002757 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01729" : "VUID-vkCmdCopyImage-srcImage-01729";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002758 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002759 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2760 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2761 func_name, i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002762 }
2763
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002764 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002765 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2766 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002767 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01730" : "VUID-vkCmdCopyImage-srcImage-01730";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002768 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002769 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2770 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2771 func_name, i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002772 }
2773 } // Compressed
2774
2775 // Do all checks on dest image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002776 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002777 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002778 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-00152" : "VUID-vkCmdCopyImage-dstImage-00152";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002779 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002780 "%s: pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002781 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002782 func_name, i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002783 }
2784 }
2785
Dave Houlton533be9f2018-03-26 17:08:30 -06002786 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002787 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01786" : "VUID-vkCmdCopyImage-dstImage-01786";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002788 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002789 "%s: pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2790 "and 1, respectively.",
2791 func_name, i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002792 }
2793
Dave Houlton533be9f2018-03-26 17:08:30 -06002794 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002795 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01788" : "VUID-vkCmdCopyImage-dstImage-01788";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002796 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 -04002797 func_name, i, region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002798 }
2799
sfricke-samsung30b094c2020-05-30 11:42:11 -07002800 // Handle difference between Maintenance 1
sfricke-samsung45996a42021-09-16 13:45:27 -07002801 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002802 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2803 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002804 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-04443" : "VUID-vkCmdCopyImage-srcImage-04443";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002805 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002806 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2807 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2808 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002809 }
2810 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002811 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002812 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002813 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-04444" : "VUID-vkCmdCopyImage-dstImage-04444";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002814 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002815 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2816 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2817 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002818 }
2819 }
2820 } else { // Pre maint 1
2821 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002822 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002823 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002824 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002825 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and "
sfricke-samsung30b094c2020-05-30 11:42:11 -07002826 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2827 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002828 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002829 }
Dave Houltonee281a52017-12-08 13:51:02 -07002830 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002831 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002832 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002833 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002834 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2835 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002836 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002837 }
2838 }
2839 }
2840
sfricke-samsung01da6312021-10-20 07:51:32 -07002841 // Dest checks that apply only to "blocked images"
2842 if (FormatIsBlockedImage(dst_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002843 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002844
2845 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002846 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2847 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2848 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002849 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01731" : "VUID-vkCmdCopyImage-dstImage-01731";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002850 skip |= LogError(dst_state->image(), vuid,
sfricke-samsung01da6312021-10-20 07:51:32 -07002851 "%s: pRegion[%d] dstOffset (%d, %d) must be multiples of the blocked image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002852 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002853 func_name, i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002854 }
2855
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002856 const VkExtent3D mip_extent = dst_state->GetSubresourceExtent(region.dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07002857 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2858 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002859 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01732" : "VUID-vkCmdCopyImage-dstImage-01732";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002860 skip |= LogError(dst_state->image(), vuid,
sfricke-samsung01da6312021-10-20 07:51:32 -07002861 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the blocked texture "
Jeff Leger178b1e52020-10-05 12:22:23 -04002862 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2863 func_name, i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002864 }
2865
Dave Houltonee281a52017-12-08 13:51:02 -07002866 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2867 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2868 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002869 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01733" : "VUID-vkCmdCopyImage-dstImage-01733";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002870 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002871 "%s: pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002872 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2873 "height (%d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002874 func_name, i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002875 }
2876
Dave Houltonee281a52017-12-08 13:51:02 -07002877 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2878 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2879 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002880 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01734" : "VUID-vkCmdCopyImage-dstImage-01734";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002881 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002882 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2883 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2884 func_name, i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002885 }
2886 } // Compressed
2887 }
2888 return skip;
2889}
2890
Jeff Leger178b1e52020-10-05 12:22:23 -04002891template <typename RegionType>
2892bool CoreChecks::ValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2893 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Tony-LunarGb61514a2021-11-02 12:36:51 -06002894 const RegionType *pRegions, CMD_TYPE cmd_type) const {
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07002895 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07002896 auto src_image_state = Get<IMAGE_STATE>(srcImage);
2897 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
sfricke-samsungdce5f692020-03-07 13:59:31 -08002898 const VkFormat src_format = src_image_state->createInfo.format;
2899 const VkFormat dst_format = dst_image_state->createInfo.format;
Tony-LunarGb61514a2021-11-02 12:36:51 -06002900 const bool is_2 = (cmd_type == CMD_COPYIMAGE2KHR || cmd_type == CMD_COPYIMAGE2);;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002901 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002902
sfricke-samsung85584a72021-09-30 21:43:38 -07002903 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04002904 const char *vuid;
Tony-LunarGb61514a2021-11-02 12:36:51 -06002905 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state.get(), dst_image_state.get(), cmd_type);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002906
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002907 VkCommandBuffer command_buffer = cb_node->commandBuffer();
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002908
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002909 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002910 const RegionType region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002911
2912 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2913 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08002914 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07002915
Dave Houlton6f9059e2017-05-02 17:15:13 -06002916 bool slice_override = false;
2917 uint32_t depth_slices = 0;
2918
2919 // Special case for copying between a 1D/2D array and a 3D image
2920 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2921 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2922 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002923 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002924 slice_override = (depth_slices != 1);
2925 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2926 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002927 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002928 slice_override = (depth_slices != 1);
2929 }
2930
Jeremy Gebben9f537102021-10-05 16:37:12 -06002931 skip |= ValidateImageSubresourceLayers(cb_node.get(), &region.srcSubresource, func_name, "srcSubresource", i);
2932 skip |= ValidateImageSubresourceLayers(cb_node.get(), &region.dstSubresource, func_name, "dstSubresource", i);
Tony-LunarGb61514a2021-11-02 12:36:51 -06002933 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcSubresource-01696" : "VUID-vkCmdCopyImage-srcSubresource-01696";
2934 skip |=
2935 ValidateImageMipLevel(cb_node.get(), src_image_state.get(), region.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
2936 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstSubresource-01697" : "VUID-vkCmdCopyImage-dstSubresource-01697";
2937 skip |=
2938 ValidateImageMipLevel(cb_node.get(), dst_image_state.get(), region.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
2939 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcSubresource-01698" : "VUID-vkCmdCopyImage-srcSubresource-01698";
Jeremy Gebben9f537102021-10-05 16:37:12 -06002940 skip |= ValidateImageArrayLayerRange(cb_node.get(), src_image_state.get(), region.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002941 region.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
Tony-LunarGb61514a2021-11-02 12:36:51 -06002942 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstSubresource-01699" : "VUID-vkCmdCopyImage-dstSubresource-01699";
Jeremy Gebben9f537102021-10-05 16:37:12 -06002943 skip |= ValidateImageArrayLayerRange(cb_node.get(), dst_image_state.get(), region.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002944 region.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002945
sfricke-samsung45996a42021-09-16 13:45:27 -07002946 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002947 // No chance of mismatch if we're overriding depth slice count
2948 if (!slice_override) {
2949 // The number of depth slices in srcSubresource and dstSubresource must match
2950 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2951 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002952 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2953 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002954 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002955 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2956 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002957 if (src_slices != dst_slices) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002958 vuid = is_2 ? "VUID-VkImageCopy2-extent-00140" : "VUID-VkImageCopy-extent-00140";
Jeff Leger178b1e52020-10-05 12:22:23 -04002959 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002960 "%s: number of depth slices in source (%u) and destination (%u) subresources for pRegions[%u] "
2961 "do not match.",
2962 func_name, src_slices, dst_slices, i);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002963 }
2964 }
2965 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002966 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002967 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002968 vuid = is_2 ? "VUID-VkImageCopy2-layerCount-00138" : "VUID-VkImageCopy-layerCount-00138";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002969 skip |=
2970 LogError(command_buffer, vuid,
2971 "%s: number of layers in source (%u) and destination (%u) subresources for pRegions[%u] do not match",
2972 func_name, region.srcSubresource.layerCount, region.dstSubresource.layerCount, i);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002973 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002974 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002975
Dave Houltonc991cc92018-03-06 11:08:51 -07002976 // Do multiplane-specific checks, if extension enabled
sfricke-samsung45996a42021-09-16 13:45:27 -07002977 if (IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)) {
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002978 if ((!FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format))) {
2979 // If neither image is multi-plane the aspectMask member of src and dst must match
2980 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002981 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01551" : "VUID-vkCmdCopyImage-srcImage-01551";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002982 skip |= LogError(command_buffer, vuid,
2983 "%s: Copy between non-multiplane images with differing aspectMasks in pRegions[%u] with "
2984 "source (0x%x) destination (0x%x).",
2985 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
2986 }
2987 } else {
2988 // Source image multiplane checks
2989 uint32_t planes = FormatPlaneCount(src_format);
2990 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2991 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002992 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01552" : "VUID-vkCmdCopyImage-srcImage-01552";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002993 skip |= LogError(command_buffer, vuid,
2994 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
2995 i, aspect);
2996 }
2997 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
2998 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002999 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01553" : "VUID-vkCmdCopyImage-srcImage-01553";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003000 skip |= LogError(command_buffer, vuid,
3001 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
3002 i, aspect);
3003 }
3004 // Single-plane to multi-plane
3005 if ((!FormatIsMultiplane(src_format)) && (FormatIsMultiplane(dst_format)) &&
3006 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003007 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01557" : "VUID-vkCmdCopyImage-dstImage-01557";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003008 skip |= LogError(command_buffer, vuid,
3009 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
3010 func_name, i, aspect);
3011 }
Dave Houltonc991cc92018-03-06 11:08:51 -07003012
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003013 // Dest image multiplane checks
3014 planes = FormatPlaneCount(dst_format);
3015 aspect = region.dstSubresource.aspectMask;
3016 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003017 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01554" : "VUID-vkCmdCopyImage-dstImage-01554";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003018 skip |= LogError(command_buffer, vuid,
3019 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
3020 i, aspect);
3021 }
3022 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
3023 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003024 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01555" : "VUID-vkCmdCopyImage-dstImage-01555";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003025 skip |= LogError(command_buffer, vuid,
3026 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
3027 i, aspect);
3028 }
3029 // Multi-plane to single-plane
3030 if ((FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format)) &&
3031 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003032 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01556" : "VUID-vkCmdCopyImage-srcImage-01556";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003033 skip |= LogError(command_buffer, vuid,
3034 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
3035 func_name, i, aspect);
3036 }
3037 }
3038 } else {
3039 // !vk_khr_sampler_ycbcr_conversion
Dave Houltonf5217612018-02-02 16:18:52 -07003040 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
3041 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003042 vuid = is_2 ? "VUID-VkImageCopy2-aspectMask-00137" : "VUID-VkImageCopy-aspectMask-00137";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003043 skip |= LogError(
3044 command_buffer, vuid,
3045 "%s: Copy between images with differing aspectMasks in pRegions[%u] with source (0x%x) destination (0x%x).",
3046 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
Dave Houltonf5217612018-02-02 16:18:52 -07003047 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003048 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003049
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003050 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08003051 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003052 vuid = is_2 ? "VUID-VkCopyImageInfo2-aspectMask-00142" : "VUID-vkCmdCopyImage-aspectMask-00142";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003053 skip |=
3054 LogError(command_buffer, vuid,
3055 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) cannot specify aspects not present in source image.",
3056 func_name, i, region.srcSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003057 }
3058
3059 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08003060 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003061 vuid = is_2 ? "VUID-VkCopyImageInfo2-aspectMask-00143" : "VUID-vkCmdCopyImage-aspectMask-00143";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003062 skip |= LogError(
3063 command_buffer, vuid,
3064 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) cannot specify aspects not present in destination image.",
3065 func_name, i, region.dstSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003066 }
3067
sfricke-samsung5f11b0e2022-03-22 14:12:15 -05003068 // Make sure not a empty region
3069 if (src_copy_extent.width == 0) {
3070 vuid = is_2 ? "VUID-VkImageCopy2-extent-06668" : "VUID-VkImageCopy-extent-06668";
3071 skip |=
3072 LogError(command_buffer, vuid,
3073 "%s: pRegion[%" PRIu32 "] extent.width must not be zero as empty copies are not allowed.", func_name, i);
3074 }
3075 if (src_copy_extent.height == 0) {
3076 vuid = is_2 ? "VUID-VkImageCopy2-extent-06669" : "VUID-VkImageCopy-extent-06669";
3077 skip |=
3078 LogError(command_buffer, vuid,
3079 "%s: pRegion[%" PRIu32 "] extent.height must not be zero as empty copies are not allowed.", func_name, i);
3080 }
3081 if (src_copy_extent.depth == 0) {
3082 vuid = is_2 ? "VUID-VkImageCopy2-extent-06670" : "VUID-VkImageCopy-extent-06670";
3083 skip |=
3084 LogError(command_buffer, vuid,
3085 "%s: pRegion[%" PRIu32 "] extent.depth must not be zero as empty copies are not allowed.", func_name, i);
3086 }
3087
Dave Houltonfc1a4052017-04-27 14:32:45 -06003088 // Each dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003089 VkExtent3D subresource_extent = src_image_state->GetSubresourceExtent(region.srcSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07003090 if (slice_override) src_copy_extent.depth = depth_slices;
3091 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003092 if (extent_check & kXBit) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003093 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcOffset-00144" : "VUID-vkCmdCopyImage-srcOffset-00144";
Jeff Leger178b1e52020-10-05 12:22:23 -04003094 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003095 "%s: Source image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003096 "width [%1d].",
3097 func_name, i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003098 }
3099
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003100 if (extent_check & kYBit) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003101 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcOffset-00145" : "VUID-vkCmdCopyImage-srcOffset-00145";
Jeff Leger178b1e52020-10-05 12:22:23 -04003102 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003103 "%s: Source image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003104 "height [%1d].",
3105 func_name, i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003106 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003107 if (extent_check & kZBit) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003108 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcOffset-00147" : "VUID-vkCmdCopyImage-srcOffset-00147";
Jeff Leger178b1e52020-10-05 12:22:23 -04003109 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003110 "%s: Source image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003111 "depth [%1d].",
3112 func_name, i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003113 }
3114
Dave Houltonee281a52017-12-08 13:51:02 -07003115 // Adjust dest extent if necessary
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003116 subresource_extent = dst_image_state->GetSubresourceExtent(region.dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07003117 if (slice_override) dst_copy_extent.depth = depth_slices;
3118
3119 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003120 if (extent_check & kXBit) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003121 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstOffset-00150" : "VUID-vkCmdCopyImage-dstOffset-00150";
Jeff Leger178b1e52020-10-05 12:22:23 -04003122 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003123 "%s: Dest image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003124 "width [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003125 func_name, i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003126 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003127 if (extent_check & kYBit) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003128 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstOffset-00151" : "VUID-vkCmdCopyImage-dstOffset-00151";
Jeff Leger178b1e52020-10-05 12:22:23 -04003129 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003130 "%s): Dest image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003131 "height [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003132 func_name, i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003133 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003134 if (extent_check & kZBit) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003135 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstOffset-00153" : "VUID-vkCmdCopyImage-dstOffset-00153";
Jeff Leger178b1e52020-10-05 12:22:23 -04003136 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003137 "%s: Dest image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003138 "depth [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003139 func_name, i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003140 }
3141
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003142 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
3143 // must not overlap in memory
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003144 if (src_image_state->image() == dst_image_state->image()) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003145 for (uint32_t j = 0; j < regionCount; j++) {
3146 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
sfricke-samsungdce5f692020-03-07 13:59:31 -08003147 FormatIsMultiplane(src_format))) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003148 vuid = is_2 ? "VUID-VkCopyImageInfo2-pRegions-00124" : "VUID-vkCmdCopyImage-pRegions-00124";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003149 skip |= LogError(command_buffer, vuid, "%s: pRegion[%u] src overlaps with pRegions[%u].", func_name, i, j);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003150 }
3151 }
3152 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08003153
3154 // 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 -07003155 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
sfricke-samsung48172ca2020-02-13 23:38:11 -08003156 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3157 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3158 (src_copy_extent.depth != 1)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003159 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01790" : "VUID-vkCmdCopyImage-srcImage-01790";
Jeff Leger178b1e52020-10-05 12:22:23 -04003160 skip |= LogError(command_buffer, vuid,
3161 "%s: pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1",
3162 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003163 }
3164 } else {
3165 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
3166 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3167 (src_copy_extent.depth != 1)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003168 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01789" : "VUID-vkCmdCopyImage-srcImage-01789";
Jeff Leger178b1e52020-10-05 12:22:23 -04003169 skip |= LogError(command_buffer, vuid,
3170 "%s: pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1",
3171 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003172 }
3173 }
3174
3175 // Check if 2D with 3D and depth not equal to 2D layerCount
3176 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3177 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
3178 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003179 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01791" : "VUID-vkCmdCopyImage-srcImage-01791";
Jeff Leger178b1e52020-10-05 12:22:23 -04003180 skip |= LogError(command_buffer, vuid,
3181 "%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 -08003182 "srcSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003183 func_name, i, src_copy_extent.depth, region.srcSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003184 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
3185 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
3186 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003187 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01792" : "VUID-vkCmdCopyImage-dstImage-01792";
Jeff Leger178b1e52020-10-05 12:22:23 -04003188 skip |= LogError(command_buffer, vuid,
3189 "%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 -08003190 "dstSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003191 func_name, i, src_copy_extent.depth, region.dstSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003192 }
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003193
3194 // Check for multi-plane format compatiblity
3195 if (FormatIsMultiplane(src_format) || FormatIsMultiplane(dst_format)) {
sfricke-samsung73e755c2021-09-30 08:34:57 -07003196 const VkFormat src_plane_format = FormatIsMultiplane(src_format)
3197 ? FindMultiplaneCompatibleFormat(src_format, region.srcSubresource.aspectMask)
3198 : src_format;
3199 const VkFormat dst_plane_format = FormatIsMultiplane(dst_format)
3200 ? FindMultiplaneCompatibleFormat(dst_format, region.dstSubresource.aspectMask)
3201 : dst_format;
3202 const size_t src_format_size = FormatElementSize(src_plane_format);
3203 const size_t dst_format_size = FormatElementSize(dst_plane_format);
3204
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003205 // If size is still zero, then format is invalid and will be caught in another VU
3206 if ((src_format_size != dst_format_size) && (src_format_size != 0) && (dst_format_size != 0)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003207 vuid = is_2 ? "VUID-VkCopyImageInfo2-None-01549" : "VUID-vkCmdCopyImage-None-01549";
Jeff Leger178b1e52020-10-05 12:22:23 -04003208 skip |= LogError(command_buffer, vuid,
3209 "%s: pRegions[%u] called with non-compatible image formats. "
3210 "The src format %s with aspectMask %s is not compatible with dst format %s aspectMask %s.",
3211 func_name, i, string_VkFormat(src_format),
3212 string_VkImageAspectFlags(region.srcSubresource.aspectMask).c_str(), string_VkFormat(dst_format),
3213 string_VkImageAspectFlags(region.dstSubresource.aspectMask).c_str());
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003214 }
3215 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003216 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003217
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003218 // The formats of non-multiplane src_image and dst_image must be compatible. Formats are considered compatible if their texel
3219 // size in bytes is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT
3220 // because because both texels are 4 bytes in size.
3221 if (!FormatIsMultiplane(src_format) && !FormatIsMultiplane(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003222 const char *compatible_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003223 IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
Tony-LunarGb61514a2021-11-02 12:36:51 -06003224 ? (is_2 ? "VUID-VkCopyImageInfo2-srcImage-01548" : "VUID-vkCmdCopyImage-srcImage-01548")
3225 : (is_2 ? "VUID-VkCopyImageInfo2-srcImage-00135" : "VUID-vkCmdCopyImage-srcImage-00135");
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003226 // Depth/stencil formats must match exactly.
3227 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3228 if (src_format != dst_format) {
3229 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003230 "%s: Depth/stencil formats must match exactly for src (%s) and dst (%s).", func_name,
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003231 string_VkFormat(src_format), string_VkFormat(dst_format));
3232 }
3233 } else {
Jeff Leger178b1e52020-10-05 12:22:23 -04003234 if (FormatElementSize(src_format) != FormatElementSize(dst_format)) {
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003235 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003236 "%s: Unmatched image format sizes. "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06003237 "The src format %s has size of %" PRIu32 " and dst format %s has size of %" PRIu32 ".",
Jeff Leger178b1e52020-10-05 12:22:23 -04003238 func_name, string_VkFormat(src_format), FormatElementSize(src_format), string_VkFormat(dst_format),
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003239 FormatElementSize(dst_format));
3240 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003241 }
3242 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003243
Dave Houlton33c22b72017-02-28 13:16:02 -07003244 // Source and dest image sample counts must match
3245 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003246 std::stringstream ss;
3247 ss << func_name << " called on image pair with non-identical sample counts.";
Tony-LunarGb61514a2021-11-02 12:36:51 -06003248 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-00136" : "VUID-vkCmdCopyImage-srcImage-00136";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003249 skip |=
3250 LogError(command_buffer, vuid, "%s: The src image sample count (%s) dose not match the dst image sample count (%s).",
3251 func_name, string_VkSampleCountFlagBits(src_image_state->createInfo.samples),
3252 string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Dave Houlton33c22b72017-02-28 13:16:02 -07003253 }
3254
sfricke-samsung45996a42021-09-16 13:45:27 -07003255 vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
Tony-LunarGb61514a2021-11-02 12:36:51 -06003256 ? (is_2 ? "VUID-VkCopyImageInfo2-srcImage-01546" : "VUID-vkCmdCopyImage-srcImage-01546")
3257 : (is_2 ? "VUID-VkCopyImageInfo2-srcImage-00127" : "VUID-vkCmdCopyImage-srcImage-00127");
Jeremy Gebben9f537102021-10-05 16:37:12 -06003258 skip |= ValidateMemoryIsBoundToImage(src_image_state.get(), func_name, vuid);
sfricke-samsung45996a42021-09-16 13:45:27 -07003259 vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
Tony-LunarGb61514a2021-11-02 12:36:51 -06003260 ? (is_2 ? "VUID-VkCopyImageInfo2-dstImage-01547" : "VUID-vkCmdCopyImage-dstImage-01547")
3261 : (is_2 ? "VUID-VkCopyImageInfo2-dstImage-00132" : "VUID-vkCmdCopyImage-dstImage-00132");
Jeremy Gebben9f537102021-10-05 16:37:12 -06003262 skip |= ValidateMemoryIsBoundToImage(dst_image_state.get(), func_name, vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003263 // Validate that SRC & DST images have correct usage flags set
Tony-LunarGb61514a2021-11-02 12:36:51 -06003264 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-00126" : "VUID-vkCmdCopyImage-srcImage-00126";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003265 skip |= ValidateImageUsageFlags(src_image_state.get(), VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04003266 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tony-LunarGb61514a2021-11-02 12:36:51 -06003267 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-00131" : "VUID-vkCmdCopyImage-dstImage-00131";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003268 skip |= ValidateImageUsageFlags(dst_image_state.get(), VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04003269 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Tony-LunarGb61514a2021-11-02 12:36:51 -06003270 vuid = is_2 ? "VUID-vkCmdCopyImage2-commandBuffer-01825" : "VUID-vkCmdCopyImage-commandBuffer-01825";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003271 skip |= ValidateProtectedImage(cb_node.get(), src_image_state.get(), func_name, vuid);
Tony-LunarGb61514a2021-11-02 12:36:51 -06003272 vuid = is_2 ? "VUID-vkCmdCopyImage2-commandBuffer-01826" : "VUID-vkCmdCopyImage-commandBuffer-01826";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003273 skip |= ValidateProtectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
Tony-LunarGb61514a2021-11-02 12:36:51 -06003274 vuid = is_2 ? "VUID-vkCmdCopyImage2-commandBuffer-01827" : "VUID-vkCmdCopyImage-commandBuffer-01827";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003275 skip |= ValidateUnprotectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003276
3277 // Validation for VK_EXT_fragment_density_map
3278 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003279 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
Jeff Leger178b1e52020-10-05 12:22:23 -04003280 skip |=
3281 LogError(command_buffer, vuid,
3282 "%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 +02003283 }
3284 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003285 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
Jeff Leger178b1e52020-10-05 12:22:23 -04003286 skip |=
3287 LogError(command_buffer, vuid,
3288 "%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 +02003289 }
3290
sfricke-samsung45996a42021-09-16 13:45:27 -07003291 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003292 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01995" : "VUID-vkCmdCopyImage-srcImage-01995";
3293 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(), VK_FORMAT_FEATURE_2_TRANSFER_SRC_BIT, func_name, vuid);
3294 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01996" : "VUID-vkCmdCopyImage-dstImage-01996";
3295 skip |= ValidateImageFormatFeatureFlags(dst_image_state.get(), VK_FORMAT_FEATURE_2_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003296 }
Jeremy Gebben9f537102021-10-05 16:37:12 -06003297 skip |= ValidateCmd(cb_node.get(), cmd_type);
Tobin Ehlisc8266452017-04-07 12:20:30 -06003298 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04003299
3300 const char *invalid_src_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003301 (src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Tony-LunarGb61514a2021-11-02 12:36:51 -06003302 ? (is_2 ? "VUID-VkCopyImageInfo2-srcImageLayout-01917" : "VUID-vkCmdCopyImage-srcImageLayout-01917")
3303 : (is_2 ? "VUID-VkCopyImageInfo2-srcImageLayout-00129" : "VUID-vkCmdCopyImage-srcImageLayout-00129");
Jeff Leger178b1e52020-10-05 12:22:23 -04003304 const char *invalid_dst_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003305 (dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Tony-LunarGb61514a2021-11-02 12:36:51 -06003306 ? (is_2 ? "VUID-VkCopyImageInfo2-dstImageLayout-01395" : "VUID-vkCmdCopyImage-dstImageLayout-01395")
3307 : (is_2 ? "VUID-VkCopyImageInfo2-dstImageLayout-00134" : "VUID-vkCmdCopyImage-dstImageLayout-00134");
Jeff Leger178b1e52020-10-05 12:22:23 -04003308
aitor-lunargd0d85e12022-01-28 16:56:49 +01003309 bool same_image = (src_image_state == dst_image_state);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003310 for (uint32_t i = 0; i < regionCount; ++i) {
aitor-lunargd0d85e12022-01-28 16:56:49 +01003311 // When performing copy from and to same subresource, VK_IMAGE_LAYOUT_GENERAL is the only option
sfricke-samsung71f04e32022-03-16 01:21:21 -05003312 const RegionType region = pRegions[i];
3313 const auto &src_sub = region.srcSubresource;
3314 const auto &dst_sub = region.dstSubresource;
aitor-lunargd0d85e12022-01-28 16:56:49 +01003315 bool same_subresource =
3316 (same_image && (src_sub.mipLevel == dst_sub.mipLevel) && (src_sub.baseArrayLayer == dst_sub.baseArrayLayer));
3317 VkImageLayout source_optimal = (same_subresource ? VK_IMAGE_LAYOUT_GENERAL : VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL);
3318 VkImageLayout destination_optimal = (same_subresource ? VK_IMAGE_LAYOUT_GENERAL : VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL);
Tony-LunarGb61514a2021-11-02 12:36:51 -06003319 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImageLayout-00128" : "VUID-vkCmdCopyImage-srcImageLayout-00128";
sfricke-samsung71f04e32022-03-16 01:21:21 -05003320 skip |= VerifyImageLayout(cb_node.get(), src_image_state.get(), region.srcSubresource, srcImageLayout, source_optimal,
aitor-lunargd0d85e12022-01-28 16:56:49 +01003321 func_name, invalid_src_layout_vuid, vuid, &hit_error);
Tony-LunarGb61514a2021-11-02 12:36:51 -06003322 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImageLayout-00133" : "VUID-vkCmdCopyImage-dstImageLayout-00133";
sfricke-samsung71f04e32022-03-16 01:21:21 -05003323 skip |= VerifyImageLayout(cb_node.get(), dst_image_state.get(), region.dstSubresource, dstImageLayout, destination_optimal,
3324 func_name, invalid_dst_layout_vuid, vuid, &hit_error);
Jeremy Gebben9f537102021-10-05 16:37:12 -06003325 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node.get(), src_image_state.get(), dst_image_state.get(),
sfricke-samsung71f04e32022-03-16 01:21:21 -05003326 &region, i, func_name, cmd_type);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003327 }
3328
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003329 return skip;
3330}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003331
Jeff Leger178b1e52020-10-05 12:22:23 -04003332bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3333 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3334 const VkImageCopy *pRegions) const {
3335 return ValidateCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
Tony-LunarGb61514a2021-11-02 12:36:51 -06003336 CMD_COPYIMAGE);
Jeff Leger178b1e52020-10-05 12:22:23 -04003337}
3338
3339bool CoreChecks::PreCallValidateCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) const {
3340 return ValidateCmdCopyImage(commandBuffer, pCopyImageInfo->srcImage, pCopyImageInfo->srcImageLayout, pCopyImageInfo->dstImage,
3341 pCopyImageInfo->dstImageLayout, pCopyImageInfo->regionCount, pCopyImageInfo->pRegions,
Tony-LunarGb61514a2021-11-02 12:36:51 -06003342 CMD_COPYIMAGE2KHR);
3343}
3344
3345bool CoreChecks::PreCallValidateCmdCopyImage2(VkCommandBuffer commandBuffer, const VkCopyImageInfo2 *pCopyImageInfo) const {
3346 return ValidateCmdCopyImage(commandBuffer, pCopyImageInfo->srcImage, pCopyImageInfo->srcImageLayout, pCopyImageInfo->dstImage,
3347 pCopyImageInfo->dstImageLayout, pCopyImageInfo->regionCount, pCopyImageInfo->pRegions,
3348 CMD_COPYIMAGE2);
Jeff Leger178b1e52020-10-05 12:22:23 -04003349}
3350
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003351void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3352 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3353 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003354 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3355 pRegions);
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07003356 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003357 auto src_image_state = Get<IMAGE_STATE>(srcImage);
3358 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003359
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003360 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003361 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06003362 cb_node->SetImageInitialLayout(*src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3363 cb_node->SetImageInitialLayout(*dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003364 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003365}
3366
sfricke-samsungd750f812022-02-04 10:23:34 -08003367void CoreChecks::RecordCmdCopyImage2(VkCommandBuffer commandBuffer, const VkCopyImageInfo2 *pCopyImageInfo) {
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07003368 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003369 auto src_image_state = Get<IMAGE_STATE>(pCopyImageInfo->srcImage);
3370 auto dst_image_state = Get<IMAGE_STATE>(pCopyImageInfo->dstImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04003371
3372 // Make sure that all image slices are updated to correct layout
3373 for (uint32_t i = 0; i < pCopyImageInfo->regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06003374 cb_node->SetImageInitialLayout(*src_image_state, pCopyImageInfo->pRegions[i].srcSubresource,
3375 pCopyImageInfo->srcImageLayout);
3376 cb_node->SetImageInitialLayout(*dst_image_state, pCopyImageInfo->pRegions[i].dstSubresource,
3377 pCopyImageInfo->dstImageLayout);
Jeff Leger178b1e52020-10-05 12:22:23 -04003378 }
3379}
3380
Tony-LunarGb61514a2021-11-02 12:36:51 -06003381void CoreChecks::PreCallRecordCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) {
3382 StateTracker::PreCallRecordCmdCopyImage2KHR(commandBuffer, pCopyImageInfo);
3383 RecordCmdCopyImage2(commandBuffer, pCopyImageInfo);
3384}
3385
3386void CoreChecks::PreCallRecordCmdCopyImage2(VkCommandBuffer commandBuffer, const VkCopyImageInfo2 *pCopyImageInfo) {
3387 StateTracker::PreCallRecordCmdCopyImage2(commandBuffer, pCopyImageInfo);
3388 RecordCmdCopyImage2(commandBuffer, pCopyImageInfo);
3389}
3390
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003391// Returns true if sub_rect is entirely contained within rect
3392static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
3393 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 -07003394 (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 -07003395 return false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003396 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003397 return true;
3398}
3399
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003400bool CoreChecks::ValidateClearAttachmentExtent(const CMD_BUFFER_STATE &cb_node, uint32_t attachment_index,
amhagana448ea52021-11-02 14:09:14 -04003401 const IMAGE_VIEW_STATE* image_view_state,
3402 const VkRect2D &render_area, uint32_t rect_count, const VkClearRect *clear_rects) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07003403 bool skip = false;
John Zulauf3a548ef2019-02-01 16:14:07 -07003404
3405 for (uint32_t j = 0; j < rect_count; j++) {
3406 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003407 skip |= LogError(cb_node.Handle(), "VUID-vkCmdClearAttachments-pRects-00016",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003408 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
3409 "the current render pass instance.",
3410 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07003411 }
3412
3413 if (image_view_state) {
3414 // The layers specified by a given element of pRects must be contained within every attachment that
3415 // pAttachments refers to
ziga-lunargff6485c2021-10-08 18:18:32 +02003416 const uint32_t attachment_layer_count = image_view_state->GetAttachmentLayerCount();
John Zulauf3a548ef2019-02-01 16:14:07 -07003417 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
3418 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003419 skip |= LogError(cb_node.Handle(), "VUID-vkCmdClearAttachments-pRects-00017",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003420 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
3421 "of pAttachment[%d].",
3422 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07003423 }
3424 }
3425 }
3426 return skip;
3427}
3428
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003429bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3430 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003431 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003432 bool skip = false;
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07003433 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Petr Kraus2dffb382019-08-10 02:52:12 +02003434 if (!cb_node) return skip;
3435
Jeremy Gebben9f537102021-10-05 16:37:12 -06003436 skip |= ValidateCmd(cb_node.get(), CMD_CLEARATTACHMENTS);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003437
3438 // Validate that attachment is in reference list of active subpass
3439 if (cb_node->activeRenderPass) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08003440 const VkRenderPassCreateInfo2 *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07003441 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Mike Schuchardt2df08912020-12-15 16:28:09 -08003442 const VkSubpassDescription2 *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
locke-lunargaecf2152020-05-12 17:15:41 -06003443 const auto *framebuffer = cb_node->activeFramebuffer.get();
Aaron Hagan1656b2b2021-12-21 11:52:41 -05003444 const auto &render_area = (cb_node->activeRenderPass->use_dynamic_rendering) ?
3445 cb_node->activeRenderPass->dynamic_rendering_begin_rendering_info.renderArea :
3446 cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003447
John Zulauf3a548ef2019-02-01 16:14:07 -07003448 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3449 auto clear_desc = &pAttachments[attachment_index];
3450 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003451 const VkImageAspectFlags aspect_mask = clear_desc->aspectMask;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003452
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003453 if (aspect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
3454 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020",
3455 "vkCmdClearAttachments() pAttachments[%u] mask contains VK_IMAGE_ASPECT_METADATA_BIT",
3456 attachment_index);
3457 } else if (aspect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
3458 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
3459 skip |=
3460 LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-02246",
3461 "vkCmdClearAttachments() pAttachments[%u] mask contains a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit",
3462 attachment_index);
3463 } else if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07003464 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
Aaron Haganc6bafff2021-11-29 23:30:07 -05003465 if (subpass_desc) {
amhagana448ea52021-11-02 14:09:14 -04003466 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
3467 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3468 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
3469 skip |= LogError(
3470 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3471 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
3472 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
3473 attachment_index, clear_desc->colorAttachment,
3474 report_data->FormatHandle(cb_node->activeRenderPass->renderPass()).c_str(), cb_node->activeSubpass,
3475 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07003476
amhagana448ea52021-11-02 14:09:14 -04003477 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
3478 }
3479 } else {
3480 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3481 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
3482 " subpass %u. colorAttachmentCount=%u",
3483 attachment_index, clear_desc->colorAttachment,
3484 report_data->FormatHandle(cb_node->activeRenderPass->renderPass()).c_str(),
3485 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
John Zulauff2582972019-02-09 14:53:30 -07003486 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003487 }
John Zulauff2582972019-02-09 14:53:30 -07003488 fb_attachment = color_attachment;
3489
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003490 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
3491 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
3492 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019",
3493 "vkCmdClearAttachments() pAttachments[%u] aspectMask must set only VK_IMAGE_ASPECT_COLOR_BIT "
3494 "of a color attachment.",
3495 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003496 }
3497 } else { // Must be depth and/or stencil
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003498 bool subpass_depth = false;
3499 bool subpass_stencil = false;
amhagana448ea52021-11-02 14:09:14 -04003500 if (subpass_desc) {
3501 if (subpass_desc->pDepthStencilAttachment &&
3502 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3503 auto index = subpass_desc->pDepthStencilAttachment->attachment;
3504 subpass_depth = FormatHasDepth(renderpass_create_info->pAttachments[index].format);
3505 subpass_stencil = FormatHasStencil(renderpass_create_info->pAttachments[index].format);
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003506 }
amhagana448ea52021-11-02 14:09:14 -04003507 if (!subpass_desc->pDepthStencilAttachment ||
3508 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3509 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) && !subpass_depth) {
3510 skip |= LogError(
3511 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02502",
3512 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_DEPTH_BIT but there is no "
3513 "depth attachment in subpass",
3514 attachment_index);
3515 }
3516 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) && !subpass_stencil) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003517 skip |= LogError(
3518 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02503",
3519 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_STENCIL_BIT but there is no "
amhagana448ea52021-11-02 14:09:14 -04003520 "stencil attachment in subpass",
3521 attachment_index);
3522 }
3523 } else {
3524 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003525 }
amhagana448ea52021-11-02 14:09:14 -04003526 if (subpass_depth) {
3527 skip |= ValidateClearDepthStencilValue(commandBuffer, clear_desc->clearValue.depthStencil,
3528 "vkCmdClearAttachments()");
3529 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08003530 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003531 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003532 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
amhagana448ea52021-11-02 14:09:14 -04003533 const IMAGE_VIEW_STATE* image_view_state = nullptr;
3534 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
3535 image_view_state = cb_node->GetActiveAttachmentImageViewState(fb_attachment);
3536 }
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003537 skip |= ValidateClearAttachmentExtent(*cb_node, attachment_index, image_view_state, render_area,
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003538 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06003539 }
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003540
3541 // Once the framebuffer attachment is found, can get the image view state
3542 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) &&
3543 (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003544 const auto *image_view_state = cb_node->GetActiveAttachmentImageViewState(fb_attachment);
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003545 if (image_view_state != nullptr) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06003546 skip |= ValidateProtectedImage(cb_node.get(), image_view_state->image_state.get(), "vkCmdClearAttachments()",
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003547 "VUID-vkCmdClearAttachments-commandBuffer-02504");
Jeremy Gebben9f537102021-10-05 16:37:12 -06003548 skip |= ValidateUnprotectedImage(cb_node.get(), image_view_state->image_state.get(), "vkCmdClearAttachments()",
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003549 "VUID-vkCmdClearAttachments-commandBuffer-02505");
3550 }
3551 }
ziga-lunargfa335aa2021-08-05 16:59:39 +02003552
amhagana448ea52021-11-02 14:09:14 -04003553 // When a subpass uses a non-zero view mask, multiview functionality is considered to be enabled
3554 if (subpass_desc && (subpass_desc->viewMask > 0)) {
3555 for (uint32_t i = 0; i < rectCount; ++i) {
3556 if (pRects[i].baseArrayLayer != 0 || pRects[i].layerCount != 1) {
3557 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-baseArrayLayer-00018",
3558 "vkCmdClearAttachments(): pRects[%" PRIu32 "] baseArrayLayer is %" PRIu32
3559 " and layerCount is %" PRIu32 ", but the render pass instance uses multiview.",
3560 i, pRects[i].baseArrayLayer, pRects[i].layerCount);
3561 }
ziga-lunargfa335aa2021-08-05 16:59:39 +02003562 }
3563 }
3564 }
John Zulauf441558b2019-08-12 11:47:39 -06003565 }
3566 return skip;
3567}
3568
3569void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3570 const VkClearAttachment *pAttachments, uint32_t rectCount,
3571 const VkClearRect *pRects) {
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07003572 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
John Zulauf441558b2019-08-12 11:47:39 -06003573 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
John Zulauf441558b2019-08-12 11:47:39 -06003574 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
Aaron Haganc6bafff2021-11-29 23:30:07 -05003575 if (cb_node->activeRenderPass->use_dynamic_rendering_inherited) {
3576 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3577 const auto clear_desc = &pAttachments[attachment_index];
3578 auto colorAttachmentCount = cb_node->activeRenderPass->inheritance_rendering_info.colorAttachmentCount;
3579 int image_index = -1;
3580 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3581 (clear_desc->colorAttachment < colorAttachmentCount)) {
3582 image_index = cb_node->GetDynamicColorAttachmentImageIndex(clear_desc->colorAttachment);
3583 }
3584 else if (clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT)) {
3585 image_index = cb_node->GetDynamicDepthAttachmentImageIndex();
3586 }
3587 else if (clear_desc->aspectMask & (VK_IMAGE_ASPECT_STENCIL_BIT)) {
3588 image_index = cb_node->GetDynamicStencilAttachmentImageIndex();
3589 }
amhagana448ea52021-11-02 14:09:14 -04003590
Aaron Haganc6bafff2021-11-29 23:30:07 -05003591 if (image_index != -1) {
3592 if (!clear_rect_copy) {
3593 // We need a copy of the clear rectangles that will persist until the last lambda executes
3594 // but we want to create it as lazily as possible
3595 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
amhagana448ea52021-11-02 14:09:14 -04003596 }
Aaron Haganc6bafff2021-11-29 23:30:07 -05003597 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3598 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
3599 auto val_fn = [this, attachment_index, image_index, rectCount, clear_rect_copy](
3600 const CMD_BUFFER_STATE &secondary, const CMD_BUFFER_STATE *prim_cb,
3601 const FRAMEBUFFER_STATE *fb) {
3602 assert(rectCount == clear_rect_copy->size());
3603 bool skip = false;
3604 const IMAGE_VIEW_STATE* image_view_state = nullptr;
3605 if (image_index != -1) {
3606 image_view_state = (*prim_cb->active_attachments)[image_index];
3607 }
3608 skip = ValidateClearAttachmentExtent(secondary, attachment_index, image_view_state,
3609 prim_cb->activeRenderPass->dynamic_rendering_begin_rendering_info.renderArea,
3610 rectCount, clear_rect_copy->data());
3611 return skip;
3612 };
3613 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003614 }
amhagana448ea52021-11-02 14:09:14 -04003615 }
3616 }
Aaron Haganc6bafff2021-11-29 23:30:07 -05003617 else if (cb_node->activeRenderPass->use_dynamic_rendering == false)
amhagana448ea52021-11-02 14:09:14 -04003618 {
3619 const VkRenderPassCreateInfo2* renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3620 const VkSubpassDescription2* subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
sfricke-samsung21286f82021-11-16 08:21:46 -08003621
amhagana448ea52021-11-02 14:09:14 -04003622 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3623 const auto clear_desc = &pAttachments[attachment_index];
3624 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3625 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3626 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3627 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3628 }
3629 else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3630 subpass_desc->pDepthStencilAttachment) {
3631 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3632 }
3633 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
3634 if (!clear_rect_copy) {
3635 // We need a copy of the clear rectangles that will persist until the last lambda executes
3636 // but we want to create it as lazily as possible
3637 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
3638 }
3639 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3640 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003641 auto val_fn = [this, attachment_index, fb_attachment, rectCount, clear_rect_copy](
3642 const CMD_BUFFER_STATE &secondary, const CMD_BUFFER_STATE *prim_cb,
3643 const FRAMEBUFFER_STATE *fb) {
amhagana448ea52021-11-02 14:09:14 -04003644 assert(rectCount == clear_rect_copy->size());
3645 const auto& render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3646 bool skip = false;
3647 const IMAGE_VIEW_STATE* image_view_state = nullptr;
3648 if (fb && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < fb->createInfo.attachmentCount)) {
3649 image_view_state = prim_cb->GetActiveAttachmentImageViewState(fb_attachment);
3650 }
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003651 skip = ValidateClearAttachmentExtent(secondary, attachment_index, image_view_state, render_area, rectCount,
3652 clear_rect_copy->data());
amhagana448ea52021-11-02 14:09:14 -04003653 return skip;
3654 };
3655 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
3656 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003657 }
3658 }
3659 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003660}
3661
Jeff Leger178b1e52020-10-05 12:22:23 -04003662template <typename RegionType>
3663bool CoreChecks::ValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3664 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Tony-LunarG562fc102021-11-12 13:58:35 -07003665 const RegionType *pRegions, CMD_TYPE cmd_type) const {
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07003666 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07003667 auto src_image_state = Get<IMAGE_STATE>(srcImage);
3668 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Tony-LunarG562fc102021-11-12 13:58:35 -07003669 const bool is_2 = (cmd_type == CMD_RESOLVEIMAGE2KHR || cmd_type == CMD_RESOLVEIMAGE2);
sfricke-samsung85584a72021-09-30 21:43:38 -07003670 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04003671 const char *vuid;
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003672
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003673 bool skip = false;
3674 if (cb_node && src_image_state && dst_image_state) {
Tony-LunarG562fc102021-11-12 13:58:35 -07003675 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-00256" : "VUID-vkCmdResolveImage-srcImage-00256";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003676 skip |= ValidateMemoryIsBoundToImage(src_image_state.get(), func_name, vuid);
Tony-LunarG562fc102021-11-12 13:58:35 -07003677 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-00258" : "VUID-vkCmdResolveImage-dstImage-00258";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003678 skip |= ValidateMemoryIsBoundToImage(dst_image_state.get(), func_name, vuid);
3679 skip |= ValidateCmd(cb_node.get(), cmd_type);
Tony-LunarG562fc102021-11-12 13:58:35 -07003680 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-02003" : "VUID-vkCmdResolveImage-dstImage-02003";
3681 skip |= ValidateImageFormatFeatureFlags(dst_image_state.get(), VK_FORMAT_FEATURE_2_COLOR_ATTACHMENT_BIT, func_name, vuid);
3682 vuid = is_2 ? "VUID-vkCmdResolveImage2-commandBuffer-01837" : "VUID-vkCmdResolveImage-commandBuffer-01837";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003683 skip |= ValidateProtectedImage(cb_node.get(), src_image_state.get(), func_name, vuid);
Tony-LunarG562fc102021-11-12 13:58:35 -07003684 vuid = is_2 ? "VUID-vkCmdResolveImage2-commandBuffer-01838" : "VUID-vkCmdResolveImage-commandBuffer-01838";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003685 skip |= ValidateProtectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
Tony-LunarG562fc102021-11-12 13:58:35 -07003686 vuid = is_2 ? "VUID-vkCmdResolveImage2-commandBuffer-01839" : "VUID-vkCmdResolveImage-commandBuffer-01839";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003687 skip |= ValidateUnprotectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
ziga-lunarg73154fd2022-05-18 14:36:33 +02003688 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-06762" : "VUID-vkCmdResolveImage-srcImage-06762";
3689 skip |= ValidateImageUsageFlags(src_image_state.get(), VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3690 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3691 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-06763" : "VUID-vkCmdResolveImage-srcImage-06763";
3692 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(), VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
3693 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-06764" : "VUID-vkCmdResolveImage-dstImage-06764";
3694 skip |= ValidateImageUsageFlags(dst_image_state.get(), VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3695 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3696 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-06765" : "VUID-vkCmdResolveImage-dstImage-06765";
3697 skip |= ValidateImageFormatFeatureFlags(dst_image_state.get(), VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003698
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003699 // Validation for VK_EXT_fragment_density_map
3700 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony-LunarG562fc102021-11-12 13:58:35 -07003701 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003702 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003703 "%s: srcImage must not have been created with flags containing "
3704 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3705 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003706 }
3707 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony-LunarG562fc102021-11-12 13:58:35 -07003708 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003709 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003710 "%s: dstImage must not have been created with flags containing "
3711 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3712 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003713 }
3714
Cort Stratton7df30962018-05-17 19:45:57 -07003715 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003716 const char *invalid_src_layout_vuid =
Tony-LunarG562fc102021-11-12 13:58:35 -07003717 is_2 ? ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
3718 ? "VUID-VkResolveImageInfo2-srcImageLayout-01400"
3719 : "VUID-VkResolveImageInfo2-srcImageLayout-00261")
sfricke-samsung45996a42021-09-16 13:45:27 -07003720 : ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003721 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3722 : "VUID-vkCmdResolveImage-srcImageLayout-00261");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003723 const char *invalid_dst_layout_vuid =
Tony-LunarG562fc102021-11-12 13:58:35 -07003724 is_2 ? ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
3725 ? "VUID-VkResolveImageInfo2-dstImageLayout-01401"
3726 : "VUID-VkResolveImageInfo2-dstImageLayout-00263")
sfricke-samsung45996a42021-09-16 13:45:27 -07003727 : ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003728 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3729 : "VUID-vkCmdResolveImage-dstImageLayout-00263");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003730 // For each region, the number of layers in the image subresource should not be zero
3731 // For each region, src and dest image aspect must be color only
3732 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003733 const RegionType region = pRegions[i];
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003734 const VkImageSubresourceLayers src_subresource = region.srcSubresource;
3735 const VkImageSubresourceLayers dst_subresource = region.dstSubresource;
Tony-LunarG562fc102021-11-12 13:58:35 -07003736
Jeremy Gebben9f537102021-10-05 16:37:12 -06003737 skip |= ValidateImageSubresourceLayers(cb_node.get(), &src_subresource, func_name, "srcSubresource", i);
3738 skip |= ValidateImageSubresourceLayers(cb_node.get(), &dst_subresource, func_name, "dstSubresource", i);
Tony-LunarG562fc102021-11-12 13:58:35 -07003739 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImageLayout-00260" : "VUID-vkCmdResolveImage-srcImageLayout-00260";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003740 skip |= VerifyImageLayout(cb_node.get(), src_image_state.get(), src_subresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003741 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
Tony-LunarG562fc102021-11-12 13:58:35 -07003742 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImageLayout-00262" : "VUID-vkCmdResolveImage-dstImageLayout-00262";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003743 skip |= VerifyImageLayout(cb_node.get(), dst_image_state.get(), dst_subresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003744 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
Tony-LunarG562fc102021-11-12 13:58:35 -07003745 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcSubresource-01709" : "VUID-vkCmdResolveImage-srcSubresource-01709";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003746 skip |= ValidateImageMipLevel(cb_node.get(), src_image_state.get(), src_subresource.mipLevel, i, func_name,
3747 "srcSubresource", vuid);
Tony-LunarG562fc102021-11-12 13:58:35 -07003748 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstSubresource-01710" : "VUID-vkCmdResolveImage-dstSubresource-01710";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003749 skip |= ValidateImageMipLevel(cb_node.get(), dst_image_state.get(), dst_subresource.mipLevel, i, func_name,
3750 "dstSubresource", vuid);
Tony-LunarG562fc102021-11-12 13:58:35 -07003751 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcSubresource-01711" : "VUID-vkCmdResolveImage-srcSubresource-01711";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003752 skip |= ValidateImageArrayLayerRange(cb_node.get(), src_image_state.get(), src_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003753 src_subresource.layerCount, i, func_name, "srcSubresource", vuid);
Tony-LunarG562fc102021-11-12 13:58:35 -07003754 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstSubresource-01712" : "VUID-vkCmdResolveImage-dstSubresource-01712";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003755 skip |= ValidateImageArrayLayerRange(cb_node.get(), dst_image_state.get(), dst_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003756 dst_subresource.layerCount, i, func_name, "srcSubresource", vuid);
Cort Stratton7df30962018-05-17 19:45:57 -07003757
3758 // layer counts must match
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003759 if (src_subresource.layerCount != dst_subresource.layerCount) {
Tony-LunarG562fc102021-11-12 13:58:35 -07003760 vuid = is_2 ? "VUID-VkImageResolve2-layerCount-00267" : "VUID-VkImageResolve-layerCount-00267";
Jeff Leger178b1e52020-10-05 12:22:23 -04003761 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003762 LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003763 "%s: layerCount in source and destination subresource of pRegions[%u] does not match.", func_name, i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003764 }
Cort Stratton7df30962018-05-17 19:45:57 -07003765 // For each region, src and dest image aspect must be color only
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003766 if ((src_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3767 (dst_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
Tony-LunarG562fc102021-11-12 13:58:35 -07003768 vuid = is_2 ? "VUID-VkImageResolve2-aspectMask-00266" : "VUID-VkImageResolve-aspectMask-00266";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003769 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003770 "%s: src and dest aspectMasks for pRegions[%u] must specify only VK_IMAGE_ASPECT_COLOR_BIT.",
3771 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003772 }
3773
3774 const VkImageType src_image_type = src_image_state->createInfo.imageType;
3775 const VkImageType dst_image_type = dst_image_state->createInfo.imageType;
3776
3777 if ((VK_IMAGE_TYPE_3D == src_image_type) || (VK_IMAGE_TYPE_3D == dst_image_type)) {
Shannon McPherson74b341c2020-09-08 15:43:05 -06003778 if ((0 != src_subresource.baseArrayLayer) || (1 != src_subresource.layerCount)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003779 LogObjectList objlist(cb_node->commandBuffer());
3780 objlist.add(src_image_state->image());
3781 objlist.add(dst_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003782 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-04446" : "VUID-vkCmdResolveImage-srcImage-04446";
Jeff Leger178b1e52020-10-05 12:22:23 -04003783 skip |= LogError(objlist, vuid,
3784 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
Shannon McPherson74b341c2020-09-08 15:43:05 -06003785 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003786 func_name, i);
Shannon McPherson74b341c2020-09-08 15:43:05 -06003787 }
3788 if ((0 != dst_subresource.baseArrayLayer) || (1 != dst_subresource.layerCount)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003789 LogObjectList objlist(cb_node->commandBuffer());
3790 objlist.add(src_image_state->image());
3791 objlist.add(dst_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003792 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-04447" : "VUID-vkCmdResolveImage-srcImage-04447";
Jeff Leger178b1e52020-10-05 12:22:23 -04003793 skip |= LogError(objlist, vuid,
3794 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003795 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003796 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003797 }
3798 }
3799
3800 if (VK_IMAGE_TYPE_1D == src_image_type) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05003801 if ((region.srcOffset.y != 0) || (region.extent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003802 LogObjectList objlist(cb_node->commandBuffer());
3803 objlist.add(src_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003804 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-00271" : "VUID-vkCmdResolveImage-srcImage-00271";
Jeff Leger178b1e52020-10-05 12:22:23 -04003805 skip |= LogError(objlist, vuid,
3806 "%s: srcImage (%s) is 1D but pRegions[%u] srcOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003807 "extent.height (%u) is not 1.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05003808 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.y,
3809 region.extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003810 }
3811 }
3812 if ((VK_IMAGE_TYPE_1D == src_image_type) || (VK_IMAGE_TYPE_2D == src_image_type)) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05003813 if ((region.srcOffset.z != 0) || (region.extent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003814 LogObjectList objlist(cb_node->commandBuffer());
3815 objlist.add(src_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003816 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-00273" : "VUID-vkCmdResolveImage-srcImage-00273";
Jeff Leger178b1e52020-10-05 12:22:23 -04003817 skip |= LogError(objlist, vuid,
3818 "%s: srcImage (%s) is 2D but pRegions[%u] srcOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003819 "extent.depth (%u) is not 1.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05003820 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.z,
3821 region.extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003822 }
3823 }
3824
3825 if (VK_IMAGE_TYPE_1D == dst_image_type) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05003826 if ((region.dstOffset.y != 0) || (region.extent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003827 LogObjectList objlist(cb_node->commandBuffer());
3828 objlist.add(dst_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003829 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-00276" : "VUID-vkCmdResolveImage-dstImage-00276";
Jeff Leger178b1e52020-10-05 12:22:23 -04003830 skip |= LogError(objlist, vuid,
3831 "%s: dstImage (%s) is 1D but pRegions[%u] dstOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003832 "extent.height (%u) is not 1.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05003833 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.dstOffset.y,
3834 region.extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003835 }
3836 }
3837 if ((VK_IMAGE_TYPE_1D == dst_image_type) || (VK_IMAGE_TYPE_2D == dst_image_type)) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05003838 if ((region.dstOffset.z != 0) || (region.extent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003839 LogObjectList objlist(cb_node->commandBuffer());
3840 objlist.add(dst_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003841 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-00278" : "VUID-vkCmdResolveImage-dstImage-00278";
Jeff Leger178b1e52020-10-05 12:22:23 -04003842 skip |= LogError(objlist, vuid,
3843 "%s: dstImage (%s) is 2D but pRegions[%u] dstOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003844 "extent.depth (%u) is not 1.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05003845 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.dstOffset.z,
3846 region.extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003847 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003848 }
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003849
3850 // Each srcImage dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003851 VkExtent3D subresource_extent = src_image_state->GetSubresourceExtent(src_subresource);
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003852 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3853 // developer
3854 if (src_subresource.mipLevel < src_image_state->createInfo.mipLevels) {
3855 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003856 if ((extent_check & kXBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003857 LogObjectList objlist(cb_node->commandBuffer());
3858 objlist.add(src_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003859 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcOffset-00269" : "VUID-vkCmdResolveImage-srcOffset-00269";
Jeff Leger178b1e52020-10-05 12:22:23 -04003860 skip |= LogError(objlist, vuid,
3861 "%s: srcImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003862 "exceeds subResource width [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003863 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003864 region.extent.width, subresource_extent.width);
3865 }
3866
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003867 if ((extent_check & kYBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003868 LogObjectList objlist(cb_node->commandBuffer());
3869 objlist.add(src_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003870 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcOffset-00270" : "VUID-vkCmdResolveImage-srcOffset-00270";
Jeff Leger178b1e52020-10-05 12:22:23 -04003871 skip |= LogError(objlist, vuid,
3872 "%s: srcImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003873 "exceeds subResource height [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003874 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003875 region.extent.height, subresource_extent.height);
3876 }
3877
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003878 if ((extent_check & kZBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003879 LogObjectList objlist(cb_node->commandBuffer());
3880 objlist.add(src_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003881 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcOffset-00272" : "VUID-vkCmdResolveImage-srcOffset-00272";
Jeff Leger178b1e52020-10-05 12:22:23 -04003882 skip |= LogError(objlist, vuid,
3883 "%s: srcImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003884 "exceeds subResource depth [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003885 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003886 region.extent.depth, subresource_extent.depth);
3887 }
3888 }
3889
3890 // Each dstImage dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003891 subresource_extent = dst_image_state->GetSubresourceExtent(dst_subresource);
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003892 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3893 // developer
3894 if (dst_subresource.mipLevel < dst_image_state->createInfo.mipLevels) {
3895 uint32_t extent_check = ExceedsBounds(&(region.dstOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003896 if ((extent_check & kXBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003897 LogObjectList objlist(cb_node->commandBuffer());
3898 objlist.add(dst_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003899 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstOffset-00274" : "VUID-vkCmdResolveImage-dstOffset-00274";
Jeff Leger178b1e52020-10-05 12:22:23 -04003900 skip |= LogError(objlist, vuid,
3901 "%s: dstImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003902 "exceeds subResource width [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003903 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003904 region.extent.width, subresource_extent.width);
3905 }
3906
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003907 if ((extent_check & kYBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003908 LogObjectList objlist(cb_node->commandBuffer());
3909 objlist.add(dst_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003910 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstOffset-00275" : "VUID-vkCmdResolveImage-dstOffset-00275";
Jeff Leger178b1e52020-10-05 12:22:23 -04003911 skip |= LogError(objlist, vuid,
3912 "%s: dstImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003913 "exceeds subResource height [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003914 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003915 region.extent.height, subresource_extent.height);
3916 }
3917
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003918 if ((extent_check & kZBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003919 LogObjectList objlist(cb_node->commandBuffer());
3920 objlist.add(dst_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003921 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstOffset-00277" : "VUID-vkCmdResolveImage-dstOffset-00277";
Jeff Leger178b1e52020-10-05 12:22:23 -04003922 skip |= LogError(objlist, vuid,
3923 "%s: dstImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003924 "exceeds subResource depth [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003925 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003926 region.extent.depth, subresource_extent.depth);
3927 }
3928 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003929 }
3930
3931 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
Tony-LunarG562fc102021-11-12 13:58:35 -07003932 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-01386" : "VUID-vkCmdResolveImage-srcImage-01386";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003933 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 -04003934 func_name, string_VkFormat(src_image_state->createInfo.format),
3935 string_VkFormat(dst_image_state->createInfo.format));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003936 }
3937 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003938 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_MismatchedImageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04003939 "%s: srcImage type (%s) and dstImage type (%s) are not the same.", func_name,
sfricke-samsungc26350e2020-05-30 12:31:31 -07003940 string_VkImageType(src_image_state->createInfo.imageType),
3941 string_VkImageType(dst_image_state->createInfo.imageType));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003942 }
3943 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
Tony-LunarG562fc102021-11-12 13:58:35 -07003944 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-00257" : "VUID-vkCmdResolveImage-srcImage-00257";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003945 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 -07003946 }
3947 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
Tony-LunarG562fc102021-11-12 13:58:35 -07003948 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-00259" : "VUID-vkCmdResolveImage-dstImage-00259";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003949 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 -04003950 func_name, string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003951 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003952 } else {
3953 assert(0);
3954 }
3955 return skip;
3956}
3957
Jeff Leger178b1e52020-10-05 12:22:23 -04003958bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3959 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3960 const VkImageResolve *pRegions) const {
3961 return ValidateCmdResolveImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
Tony-LunarG562fc102021-11-12 13:58:35 -07003962 CMD_RESOLVEIMAGE);
Jeff Leger178b1e52020-10-05 12:22:23 -04003963}
3964
3965bool CoreChecks::PreCallValidateCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
3966 const VkResolveImageInfo2KHR *pResolveImageInfo) const {
3967 return ValidateCmdResolveImage(commandBuffer, pResolveImageInfo->srcImage, pResolveImageInfo->srcImageLayout,
3968 pResolveImageInfo->dstImage, pResolveImageInfo->dstImageLayout, pResolveImageInfo->regionCount,
Tony-LunarG562fc102021-11-12 13:58:35 -07003969 pResolveImageInfo->pRegions, CMD_RESOLVEIMAGE2KHR);
3970}
3971
3972bool CoreChecks::PreCallValidateCmdResolveImage2(VkCommandBuffer commandBuffer,
3973 const VkResolveImageInfo2 *pResolveImageInfo) const {
3974 return ValidateCmdResolveImage(commandBuffer, pResolveImageInfo->srcImage, pResolveImageInfo->srcImageLayout,
3975 pResolveImageInfo->dstImage, pResolveImageInfo->dstImageLayout, pResolveImageInfo->regionCount,
3976 pResolveImageInfo->pRegions, CMD_RESOLVEIMAGE2);
Jeff Leger178b1e52020-10-05 12:22:23 -04003977}
3978
3979template <typename RegionType>
3980bool CoreChecks::ValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3981 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Tony-LunarG542ae912021-11-04 16:06:44 -06003982 const RegionType *pRegions, VkFilter filter, CMD_TYPE cmd_type) const {
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07003983 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07003984 auto src_image_state = Get<IMAGE_STATE>(srcImage);
3985 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Tony-LunarG542ae912021-11-04 16:06:44 -06003986 const bool is_2 = (cmd_type == CMD_BLITIMAGE2KHR || cmd_type == CMD_BLITIMAGE2);
sfricke-samsung85584a72021-09-30 21:43:38 -07003987 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04003988
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003989 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003990 if (cb_node) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06003991 skip |= ValidateCmd(cb_node.get(), cmd_type);
John Zulauf5c2750c2018-01-30 15:04:56 -07003992 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003993 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003994 const char *vuid;
Tony-LunarG542ae912021-11-04 16:06:44 -06003995 std::string loc_head = std::string(func_name);
3996 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00233" : "VUID-vkCmdBlitImage-srcImage-00233";
3997 const char *location1 = is_2 ? loc_head.append("(): pBlitImageInfo->srcImage").c_str() : "vkCmdBlitImage(): srcImage";
3998 skip |= ValidateImageSampleCount(src_image_state.get(), VK_SAMPLE_COUNT_1_BIT, location1, vuid);
3999 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-00234" : "VUID-vkCmdBlitImage-dstImage-00234";
4000 loc_head = std::string(func_name);
4001 const char *location2 = is_2 ? loc_head.append("(): pBlitImageInfo->dstImage").c_str() : "vkCmdBlitImage(): dstImage";
4002 skip |= ValidateImageSampleCount(dst_image_state.get(), VK_SAMPLE_COUNT_1_BIT, location2, vuid);
4003 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00220" : "VUID-vkCmdBlitImage-srcImage-00220";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004004 skip |= ValidateMemoryIsBoundToImage(src_image_state.get(), func_name, vuid);
Tony-LunarG542ae912021-11-04 16:06:44 -06004005 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-00225" : "VUID-vkCmdBlitImage-dstImage-00225";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004006 skip |= ValidateMemoryIsBoundToImage(dst_image_state.get(), func_name, vuid);
Tony-LunarG542ae912021-11-04 16:06:44 -06004007 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00219" : "VUID-vkCmdBlitImage-srcImage-00219";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004008 skip |= ValidateImageUsageFlags(src_image_state.get(), VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04004009 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tony-LunarG542ae912021-11-04 16:06:44 -06004010 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-00224" : "VUID-vkCmdBlitImage-dstImage-00224";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004011 skip |= ValidateImageUsageFlags(dst_image_state.get(), VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04004012 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Jeremy Gebben9f537102021-10-05 16:37:12 -06004013 skip |= ValidateCmd(cb_node.get(), cmd_type);
Tony-LunarG542ae912021-11-04 16:06:44 -06004014 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-01999" : "VUID-vkCmdBlitImage-srcImage-01999";
4015 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(), VK_FORMAT_FEATURE_2_BLIT_SRC_BIT, func_name, vuid);
4016 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-02000" : "VUID-vkCmdBlitImage-dstImage-02000";
4017 skip |= ValidateImageFormatFeatureFlags(dst_image_state.get(), VK_FORMAT_FEATURE_2_BLIT_DST_BIT, func_name, vuid);
4018 vuid = is_2 ? "VUID-vkCmdBlitImage2-commandBuffer-01834" : "VUID-vkCmdBlitImage-commandBuffer-01834";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004019 skip |= ValidateProtectedImage(cb_node.get(), src_image_state.get(), func_name, vuid);
Tony-LunarG542ae912021-11-04 16:06:44 -06004020 vuid = is_2 ? "VUID-vkCmdBlitImage2-commandBuffer-01835" : "VUID-vkCmdBlitImage-commandBuffer-01835";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004021 skip |= ValidateProtectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
Tony-LunarG542ae912021-11-04 16:06:44 -06004022 vuid = is_2 ? "VUID-vkCmdBlitImage2-commandBuffer-01836" : "VUID-vkCmdBlitImage-commandBuffer-01836";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004023 skip |= ValidateUnprotectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
sfricke-samsung022fa252020-07-24 03:26:16 -07004024
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02004025 // Validation for VK_EXT_fragment_density_map
4026 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004027 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004028 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004029 "%s: srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
4030 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02004031 }
4032 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004033 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004034 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004035 "%s: dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
4036 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02004037 }
4038
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06004039 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004040
Dave Houlton33c2d252017-06-09 17:08:32 -06004041 VkFormat src_format = src_image_state->createInfo.format;
4042 VkFormat dst_format = dst_image_state->createInfo.format;
4043 VkImageType src_type = src_image_state->createInfo.imageType;
4044 VkImageType dst_type = dst_image_state->createInfo.imageType;
4045
Cort Stratton186b1a22018-05-01 20:18:06 -04004046 if (VK_FILTER_LINEAR == filter) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004047 vuid = is_2 ? "VUID-VkBlitImageInfo2-filter-02001" : "VUID-vkCmdBlitImage-filter-02001";
4048 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(), VK_FORMAT_FEATURE_2_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Jeremy Gebben9f537102021-10-05 16:37:12 -06004049 func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04004050 } else if (VK_FILTER_CUBIC_IMG == filter) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004051 vuid = is_2 ? "VUID-VkBlitImageInfo2-filter-02002" : "VUID-vkCmdBlitImage-filter-02002";
4052 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(), VK_FORMAT_FEATURE_2_SAMPLED_IMAGE_FILTER_CUBIC_BIT,
Jeff Leger178b1e52020-10-05 12:22:23 -04004053 func_name, vuid);
Dave Houlton33c2d252017-06-09 17:08:32 -06004054 }
4055
sfricke-samsung10b35ce2021-09-29 08:50:20 -07004056 if (FormatRequiresYcbcrConversionExplicitly(src_format)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004057 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-06421" : "VUID-vkCmdBlitImage-srcImage-06421";
Jeff Leger178b1e52020-10-05 12:22:23 -04004058 skip |= LogError(device, vuid,
4059 "%s: srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004060 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04004061 func_name, string_VkFormat(src_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004062 }
4063
sfricke-samsung10b35ce2021-09-29 08:50:20 -07004064 if (FormatRequiresYcbcrConversionExplicitly(dst_format)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004065 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-06422" : "VUID-vkCmdBlitImage-dstImage-06422";
Jeff Leger178b1e52020-10-05 12:22:23 -04004066 skip |= LogError(device, vuid,
4067 "%s: dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004068 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04004069 func_name, string_VkFormat(dst_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004070 }
4071
ziga-lunarg52604a12021-09-09 16:02:05 +02004072 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_2D != src_type)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004073 vuid = is_2 ? "VUID-VkBlitImageInfo2-filter-00237" : "VUID-vkCmdBlitImage-filter-00237";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004074 skip |= LogError(cb_node->commandBuffer(), vuid,
ziga-lunarg52604a12021-09-09 16:02:05 +02004075 "%s: source image type must be VK_IMAGE_TYPE_2D when cubic filtering is specified.", func_name);
Dave Houlton33c2d252017-06-09 17:08:32 -06004076 }
4077
Dave Houlton33c2d252017-06-09 17:08:32 -06004078 // Validate consistency for unsigned formats
sfricke-samsunge3086292021-11-18 23:02:35 -08004079 if (FormatIsUINT(src_format) != FormatIsUINT(dst_format)) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004080 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004081 ss << func_name << ": If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06004082 << "the other one must also have unsigned integer format. "
4083 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Tony-LunarG542ae912021-11-04 16:06:44 -06004084 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00230" : "VUID-vkCmdBlitImage-srcImage-00230";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004085 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004086 }
4087
4088 // Validate consistency for signed formats
sfricke-samsunge3086292021-11-18 23:02:35 -08004089 if (FormatIsSINT(src_format) != FormatIsSINT(dst_format)) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004090 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004091 ss << func_name << ": If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06004092 << "the other one must also have signed integer format. "
4093 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Tony-LunarG542ae912021-11-04 16:06:44 -06004094 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00229" : "VUID-vkCmdBlitImage-srcImage-00229";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004095 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004096 }
4097
4098 // Validate filter for Depth/Stencil formats
4099 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
4100 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004101 ss << func_name << ": If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06004102 << "then filter must be VK_FILTER_NEAREST.";
Tony-LunarG542ae912021-11-04 16:06:44 -06004103 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00232" : "VUID-vkCmdBlitImage-srcImage-00232";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004104 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004105 }
4106
4107 // Validate aspect bits and formats for depth/stencil images
4108 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
4109 if (src_format != dst_format) {
4110 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004111 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 -06004112 << "stencil, the other one must have exactly the same format. "
4113 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
4114 << string_VkFormat(dst_format);
Tony-LunarG542ae912021-11-04 16:06:44 -06004115 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00231" : "VUID-vkCmdBlitImage-srcImage-00231";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004116 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004117 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004118 } // Depth or Stencil
4119
4120 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004121 const char *invalid_src_layout_vuid =
Tony-LunarG542ae912021-11-04 16:06:44 -06004122 is_2 ? ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
4123 ? "VUID-VkBlitImageInfo2-srcImageLayout-01398"
4124 : "VUID-VkBlitImageInfo2-srcImageLayout-00222")
sfricke-samsung45996a42021-09-16 13:45:27 -07004125 : ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04004126 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
4127 : "VUID-vkCmdBlitImage-srcImageLayout-00222");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004128 const char *invalid_dst_layout_vuid =
Tony-LunarG542ae912021-11-04 16:06:44 -06004129 is_2 ? ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
4130 ? "VUID-VkBlitImageInfo2-dstImageLayout-01399"
4131 : "VUID-VkBlitImageInfo2-dstImageLayout-00227")
sfricke-samsung45996a42021-09-16 13:45:27 -07004132 : ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04004133 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
4134 : "VUID-vkCmdBlitImage-dstImageLayout-00227");
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004135 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05004136 const RegionType region = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004137 bool hit_error = false;
Tony-LunarG542ae912021-11-04 16:06:44 -06004138
4139 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImageLayout-00221" : "VUID-vkCmdBlitImage-srcImageLayout-00221";
sfricke-samsung71f04e32022-03-16 01:21:21 -05004140 skip |= VerifyImageLayout(cb_node.get(), src_image_state.get(), region.srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04004141 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
Tony-LunarG542ae912021-11-04 16:06:44 -06004142 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImageLayout-00226" : "VUID-vkCmdBlitImage-dstImageLayout-00226";
sfricke-samsung71f04e32022-03-16 01:21:21 -05004143 skip |= VerifyImageLayout(cb_node.get(), dst_image_state.get(), region.dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04004144 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
sfricke-samsung71f04e32022-03-16 01:21:21 -05004145 skip |= ValidateImageSubresourceLayers(cb_node.get(), &region.srcSubresource, func_name, "srcSubresource", i);
4146 skip |= ValidateImageSubresourceLayers(cb_node.get(), &region.dstSubresource, func_name, "dstSubresource", i);
Tony-LunarG542ae912021-11-04 16:06:44 -06004147 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcSubresource-01705" : "VUID-vkCmdBlitImage-srcSubresource-01705";
sfricke-samsung71f04e32022-03-16 01:21:21 -05004148 skip |= ValidateImageMipLevel(cb_node.get(), src_image_state.get(), region.srcSubresource.mipLevel, i, func_name,
Jeremy Gebben9f537102021-10-05 16:37:12 -06004149 "srcSubresource", vuid);
Tony-LunarG542ae912021-11-04 16:06:44 -06004150 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstSubresource-01706" : "VUID-vkCmdBlitImage-dstSubresource-01706";
sfricke-samsung71f04e32022-03-16 01:21:21 -05004151 skip |= ValidateImageMipLevel(cb_node.get(), dst_image_state.get(), region.dstSubresource.mipLevel, i, func_name,
Jeremy Gebben9f537102021-10-05 16:37:12 -06004152 "dstSubresource", vuid);
Tony-LunarG542ae912021-11-04 16:06:44 -06004153 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcSubresource-01707" : "VUID-vkCmdBlitImage-srcSubresource-01707";
sfricke-samsung71f04e32022-03-16 01:21:21 -05004154 skip |= ValidateImageArrayLayerRange(cb_node.get(), src_image_state.get(), region.srcSubresource.baseArrayLayer,
4155 region.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
Tony-LunarG542ae912021-11-04 16:06:44 -06004156 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstSubresource-01708" : "VUID-vkCmdBlitImage-dstSubresource-01708";
sfricke-samsung71f04e32022-03-16 01:21:21 -05004157 skip |= ValidateImageArrayLayerRange(cb_node.get(), dst_image_state.get(), region.dstSubresource.baseArrayLayer,
4158 region.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004159 // Warn for zero-sized regions
sfricke-samsung71f04e32022-03-16 01:21:21 -05004160 if ((region.srcOffsets[0].x == region.srcOffsets[1].x) || (region.srcOffsets[0].y == region.srcOffsets[1].y) ||
4161 (region.srcOffsets[0].z == region.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004162 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004163 ss << func_name << ": pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004164 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004165 }
sfricke-samsung71f04e32022-03-16 01:21:21 -05004166 if ((region.dstOffsets[0].x == region.dstOffsets[1].x) || (region.dstOffsets[0].y == region.dstOffsets[1].y) ||
4167 (region.dstOffsets[0].z == region.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004168 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004169 ss << func_name << ": pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004170 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004171 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004172
4173 // Check that src/dst layercounts match
sfricke-samsung71f04e32022-03-16 01:21:21 -05004174 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004175 vuid = is_2 ? "VUID-VkImageBlit2-layerCount-00239" : "VUID-VkImageBlit-layerCount-00239";
Jeff Leger178b1e52020-10-05 12:22:23 -04004176 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004177 LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004178 "%s: layerCount in source and destination subresource of pRegions[%d] does not match.", func_name, i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004179 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07004180
sfricke-samsung71f04e32022-03-16 01:21:21 -05004181 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004182 vuid = is_2 ? "VUID-VkImageBlit2-aspectMask-00238" : "VUID-VkImageBlit-aspectMask-00238";
Jeff Leger178b1e52020-10-05 12:22:23 -04004183 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004184 LogError(cb_node->commandBuffer(), vuid, "%s: aspectMask members for pRegion[%d] do not match.", func_name, i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07004185 }
Dave Houlton48989f32017-05-26 15:01:46 -06004186
sfricke-samsung71f04e32022-03-16 01:21:21 -05004187 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004188 vuid = is_2 ? "VUID-VkBlitImageInfo2-aspectMask-00241" : "VUID-vkCmdBlitImage-aspectMask-00241";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004189 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004190 "%s: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004191 "image format %s.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004192 func_name, i, region.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004193 }
4194
sfricke-samsung71f04e32022-03-16 01:21:21 -05004195 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004196 vuid = is_2 ? "VUID-VkBlitImageInfo2-aspectMask-00242" : "VUID-vkCmdBlitImage-aspectMask-00242";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004197 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004198 "%s: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004199 func_name, i, region.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004200 }
4201
Dave Houlton48989f32017-05-26 15:01:46 -06004202 // Validate source image offsets
sfricke-samsung71f04e32022-03-16 01:21:21 -05004203 VkExtent3D src_extent = src_image_state->GetSubresourceExtent(region.srcSubresource);
Dave Houlton33c2d252017-06-09 17:08:32 -06004204 if (VK_IMAGE_TYPE_1D == src_type) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05004205 if ((0 != region.srcOffsets[0].y) || (1 != region.srcOffsets[1].y)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004206 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00245" : "VUID-vkCmdBlitImage-srcImage-00245";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004207 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004208 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
4209 "of (%1d, %1d). These must be (0, 1).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004210 func_name, i, region.srcOffsets[0].y, region.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004211 }
4212 }
4213
Dave Houlton33c2d252017-06-09 17:08:32 -06004214 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05004215 if ((0 != region.srcOffsets[0].z) || (1 != region.srcOffsets[1].z)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004216 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00247" : "VUID-vkCmdBlitImage-srcImage-00247";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004217 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004218 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
4219 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004220 func_name, i, region.srcOffsets[0].z, region.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004221 }
4222 }
4223
Dave Houlton33c2d252017-06-09 17:08:32 -06004224 bool oob = false;
sfricke-samsung71f04e32022-03-16 01:21:21 -05004225 if ((region.srcOffsets[0].x < 0) || (region.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
4226 (region.srcOffsets[1].x < 0) || (region.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004227 oob = true;
Tony-LunarG542ae912021-11-04 16:06:44 -06004228 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcOffset-00243" : "VUID-vkCmdBlitImage-srcOffset-00243";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004229 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004230 "%s: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004231 func_name, i, region.srcOffsets[0].x, region.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004232 }
sfricke-samsung71f04e32022-03-16 01:21:21 -05004233 if ((region.srcOffsets[0].y < 0) || (region.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
4234 (region.srcOffsets[1].y < 0) || (region.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004235 oob = true;
Tony-LunarG542ae912021-11-04 16:06:44 -06004236 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcOffset-00244" : "VUID-vkCmdBlitImage-srcOffset-00244";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004237 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004238 "%s: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004239 func_name, i, region.srcOffsets[0].y, region.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004240 }
sfricke-samsung71f04e32022-03-16 01:21:21 -05004241 if ((region.srcOffsets[0].z < 0) || (region.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
4242 (region.srcOffsets[1].z < 0) || (region.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004243 oob = true;
Tony-LunarG542ae912021-11-04 16:06:44 -06004244 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcOffset-00246" : "VUID-vkCmdBlitImage-srcOffset-00246";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004245 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004246 "%s: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004247 func_name, i, region.srcOffsets[0].z, region.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004248 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004249 if (oob) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004250 vuid = is_2 ? "VUID-VkBlitImageInfo2-pRegions-00215" : "VUID-vkCmdBlitImage-pRegions-00215";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004251 skip |= LogError(cb_node->commandBuffer(), vuid, "%s: region [%d] source image blit region exceeds image dimensions.",
Jeff Leger178b1e52020-10-05 12:22:23 -04004252 func_name, i);
Dave Houlton33c2d252017-06-09 17:08:32 -06004253 }
Dave Houlton48989f32017-05-26 15:01:46 -06004254
4255 // Validate dest image offsets
sfricke-samsung71f04e32022-03-16 01:21:21 -05004256 VkExtent3D dst_extent = dst_image_state->GetSubresourceExtent(region.dstSubresource);
Dave Houlton33c2d252017-06-09 17:08:32 -06004257 if (VK_IMAGE_TYPE_1D == dst_type) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05004258 if ((0 != region.dstOffsets[0].y) || (1 != region.dstOffsets[1].y)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004259 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-00250" : "VUID-vkCmdBlitImage-dstImage-00250";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004260 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004261 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
4262 "(%1d, %1d). These must be (0, 1).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004263 func_name, i, region.dstOffsets[0].y, region.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004264 }
4265 }
4266
Dave Houlton33c2d252017-06-09 17:08:32 -06004267 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05004268 if ((0 != region.dstOffsets[0].z) || (1 != region.dstOffsets[1].z)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004269 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-00252" : "VUID-vkCmdBlitImage-dstImage-00252";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004270 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004271 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004272 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004273 func_name, i, region.dstOffsets[0].z, region.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004274 }
4275 }
4276
Dave Houlton33c2d252017-06-09 17:08:32 -06004277 oob = false;
sfricke-samsung71f04e32022-03-16 01:21:21 -05004278 if ((region.dstOffsets[0].x < 0) || (region.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
4279 (region.dstOffsets[1].x < 0) || (region.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004280 oob = true;
Tony-LunarG542ae912021-11-04 16:06:44 -06004281 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstOffset-00248" : "VUID-vkCmdBlitImage-dstOffset-00248";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004282 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004283 "%s: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004284 func_name, i, region.dstOffsets[0].x, region.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004285 }
sfricke-samsung71f04e32022-03-16 01:21:21 -05004286 if ((region.dstOffsets[0].y < 0) || (region.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
4287 (region.dstOffsets[1].y < 0) || (region.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004288 oob = true;
Tony-LunarG542ae912021-11-04 16:06:44 -06004289 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstOffset-00249" : "VUID-vkCmdBlitImage-dstOffset-00249";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004290 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004291 "%s: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004292 func_name, i, region.dstOffsets[0].y, region.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004293 }
sfricke-samsung71f04e32022-03-16 01:21:21 -05004294 if ((region.dstOffsets[0].z < 0) || (region.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
4295 (region.dstOffsets[1].z < 0) || (region.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004296 oob = true;
Tony-LunarG542ae912021-11-04 16:06:44 -06004297 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstOffset-00251" : "VUID-vkCmdBlitImage-dstOffset-00251";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004298 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004299 "%s: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004300 func_name, i, region.dstOffsets[0].z, region.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004301 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004302 if (oob) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004303 vuid = is_2 ? "VUID-VkBlitImageInfo2-pRegions-00216" : "VUID-vkCmdBlitImage-pRegions-00216";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004304 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004305 "%s: region [%d] destination image blit region exceeds image dimensions.", func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004306 }
4307
Dave Houlton33c2d252017-06-09 17:08:32 -06004308 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05004309 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount) ||
4310 (0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004311 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00240" : "VUID-vkCmdBlitImage-srcImage-00240";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004312 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004313 "%s: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
4314 "layerCount other than 1.",
4315 func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004316 }
4317 }
aitor-lunarg607fe732022-03-31 22:00:08 +02004318
4319 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
4320 // must not overlap in memory
4321 if (srcImage == dstImage) {
4322 for (uint32_t j = 0; j < regionCount; j++) {
4323 if (RegionIntersectsBlit(&region, &pRegions[j], src_image_state->createInfo.imageType,
4324 FormatIsMultiplane(src_format))) {
4325 vuid = is_2 ? "VUID-VkBlitImageInfo2-pRegions-00217" : "VUID-vkCmdBlitImage-pRegions-00217";
4326 skip |= LogError(cb_node->commandBuffer(), vuid,
4327 "%s: pRegion[%" PRIu32 "] src overlaps with pRegions[%" PRIu32 "] dst.", func_name, i, j);
4328 }
4329 }
4330 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004331 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004332 } else {
4333 assert(0);
4334 }
4335 return skip;
4336}
4337
Jeff Leger178b1e52020-10-05 12:22:23 -04004338bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4339 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4340 const VkImageBlit *pRegions, VkFilter filter) const {
4341 return ValidateCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter,
Tony-LunarG542ae912021-11-04 16:06:44 -06004342 CMD_BLITIMAGE);
Jeff Leger178b1e52020-10-05 12:22:23 -04004343}
4344
4345bool CoreChecks::PreCallValidateCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) const {
4346 return ValidateCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4347 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
Tony-LunarG542ae912021-11-04 16:06:44 -06004348 pBlitImageInfo->filter, CMD_BLITIMAGE2KHR);
4349}
4350
4351bool CoreChecks::PreCallValidateCmdBlitImage2(VkCommandBuffer commandBuffer, const VkBlitImageInfo2 *pBlitImageInfo) const {
4352 return ValidateCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4353 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4354 pBlitImageInfo->filter, CMD_BLITIMAGE2);
Jeff Leger178b1e52020-10-05 12:22:23 -04004355}
4356
4357template <typename RegionType>
4358void CoreChecks::RecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
4359 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
4360 VkFilter filter) {
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07004361 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06004362 auto src_image_state = Get<IMAGE_STATE>(srcImage);
4363 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004364
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004365 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004366 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06004367 cb_node->SetImageInitialLayout(*src_image_state, pRegions[i].srcSubresource, srcImageLayout);
4368 cb_node->SetImageInitialLayout(*dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004369 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004370}
4371
Jeff Leger178b1e52020-10-05 12:22:23 -04004372void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4373 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4374 const VkImageBlit *pRegions, VkFilter filter) {
4375 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
4376 pRegions, filter);
4377 RecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter);
4378}
4379
4380void CoreChecks::PreCallRecordCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) {
4381 StateTracker::PreCallRecordCmdBlitImage2KHR(commandBuffer, pBlitImageInfo);
4382 RecordCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4383 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4384 pBlitImageInfo->filter);
4385}
4386
Tony-LunarG542ae912021-11-04 16:06:44 -06004387void CoreChecks::PreCallRecordCmdBlitImage2(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) {
4388 StateTracker::PreCallRecordCmdBlitImage2(commandBuffer, pBlitImageInfo);
4389 RecordCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4390 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4391 pBlitImageInfo->filter);
4392}
4393
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004394GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap &map, const IMAGE_STATE &image_state) {
John Zulauf2076e812020-01-08 14:55:54 -07004395 // This approach allows for a single hash lookup or/create new
Jeremy Gebben6335df62021-11-01 10:50:13 -06004396 auto &layout_map = map[&image_state];
John Zulauf17708d02021-02-22 11:20:58 -07004397 if (!layout_map) {
4398 layout_map.emplace(image_state.subresource_encoder.SubresourceCount());
John Zulauf2076e812020-01-08 14:55:54 -07004399 }
John Zulauf17708d02021-02-22 11:20:58 -07004400 return &layout_map;
John Zulauf2076e812020-01-08 14:55:54 -07004401}
4402
Jeremy Gebben6335df62021-11-01 10:50:13 -06004403const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, const IMAGE_STATE &image_state) {
4404 auto it = map.find(&image_state);
John Zulauf2076e812020-01-08 14:55:54 -07004405 if (it != map.end()) {
John Zulauf17708d02021-02-22 11:20:58 -07004406 return &it->second;
John Zulauf2076e812020-01-08 14:55:54 -07004407 }
4408 return nullptr;
4409}
4410
Jeremy Gebben53631302021-04-13 16:46:37 -06004411// Helper to update the Global or Overlay layout map
4412struct GlobalLayoutUpdater {
4413 bool update(VkImageLayout &dst, const image_layout_map::ImageSubresourceLayoutMap::LayoutEntry &src) const {
4414 if (src.current_layout != image_layout_map::kInvalidLayout && dst != src.current_layout) {
4415 dst = src.current_layout;
4416 return true;
4417 }
4418 return false;
4419 }
4420
4421 layer_data::optional<VkImageLayout> insert(const image_layout_map::ImageSubresourceLayoutMap::LayoutEntry &src) const {
4422 layer_data::optional<VkImageLayout> result;
4423 if (src.current_layout != image_layout_map::kInvalidLayout) {
4424 result.emplace(src.current_layout);
4425 }
4426 return result;
4427 }
4428};
4429
Shannon McPherson449fa9c2018-10-25 11:51:07 -06004430// 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 -07004431bool CoreChecks::ValidateCmdBufImageLayouts(const Location &loc, const CMD_BUFFER_STATE *pCB,
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004432 GlobalImageLayoutMap &overlayLayoutMap) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06004433 if (disabled[image_layout_validation]) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004434 bool skip = false;
John Zulauff660ad62019-03-23 07:16:05 -06004435 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07004436 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06004437 for (const auto &layout_map_entry : pCB->image_layout_map) {
Jeremy Gebben6335df62021-11-01 10:50:13 -06004438 const auto *image_state = layout_map_entry.first;
unknown089cdb82019-07-11 12:58:43 -06004439 const auto &subres_map = layout_map_entry.second;
Jeremy Gebben53631302021-04-13 16:46:37 -06004440 const auto &layout_map = subres_map->GetLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06004441 // Validate the initial_uses for each subresource referenced
Jeremy Gebben53631302021-04-13 16:46:37 -06004442 if (layout_map.empty()) continue;
John Zulauf2076e812020-01-08 14:55:54 -07004443
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004444 auto *overlay_map = GetLayoutRangeMap(overlayLayoutMap, *image_state);
Jeremy Gebben4a8881f2022-01-10 17:04:30 -07004445 const auto *global_map = image_state->layout_range_map.get();
4446 assert(global_map);
4447 auto global_map_guard = global_map->ReadLock();
John Zulauf2076e812020-01-08 14:55:54 -07004448
4449 // Note: don't know if it would matter
4450 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
4451
Jeremy Gebben53631302021-04-13 16:46:37 -06004452 auto pos = layout_map.begin();
4453 const auto end = layout_map.end();
4454 sparse_container::parallel_iterator<const GlobalImageLayoutRangeMap> current_layout(*overlay_map, *global_map,
4455 pos->first.begin);
John Zulauf2076e812020-01-08 14:55:54 -07004456 while (pos != end) {
Jeremy Gebben53631302021-04-13 16:46:37 -06004457 VkImageLayout initial_layout = pos->second.initial_layout;
4458 assert(initial_layout != image_layout_map::kInvalidLayout);
4459 if (initial_layout == image_layout_map::kInvalidLayout) {
4460 continue;
4461 }
4462
John Zulauf2076e812020-01-08 14:55:54 -07004463 VkImageLayout image_layout = kInvalidLayout;
Jeremy Gebben53631302021-04-13 16:46:37 -06004464
John Zulauf2076e812020-01-08 14:55:54 -07004465 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 -07004466 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004467 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07004468 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004469 image_layout = current_layout->pos_B->lower_bound->second;
4470 }
4471 const auto intersected_range = pos->first & current_layout->range;
4472 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
4473 // TODO: Set memory invalid which is in mem_tracker currently
4474 } else if (image_layout != initial_layout) {
Hans-Kristian Arntzen6cb03492021-07-05 16:57:31 +02004475 const auto aspect_mask = image_state->subresource_encoder.Decode(intersected_range.begin).aspectMask;
4476 bool matches = ImageLayoutMatches(aspect_mask, image_layout, initial_layout);
John Zulauf2076e812020-01-08 14:55:54 -07004477 if (!matches) {
John Zulauf2076e812020-01-08 14:55:54 -07004478 // We can report all the errors for the intersected range directly
4479 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
locke-lunarg296a3c92020-03-25 01:04:29 -06004480 const auto subresource = image_state->subresource_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004481 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004482 pCB->commandBuffer(), kVUID_Core_DrawState_InvalidImageLayout,
sfricke-samsung6b447aa2021-07-26 09:42:26 -07004483 "%s command buffer %s expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004484 "to be in layout %s--instead, current layout is %s.",
sfricke-samsung6b447aa2021-07-26 09:42:26 -07004485 loc.Message().c_str(), report_data->FormatHandle(pCB->commandBuffer()).c_str(),
Jeremy Gebben6335df62021-11-01 10:50:13 -06004486 report_data->FormatHandle(image_state->Handle()).c_str(), subresource.aspectMask, subresource.arrayLayer,
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004487 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
John Zulaufb61ed972019-04-09 16:12:35 -06004488 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004489 }
4490 }
John Zulauf2076e812020-01-08 14:55:54 -07004491 if (pos->first.includes(intersected_range.end)) {
4492 current_layout.seek(intersected_range.end);
4493 } else {
4494 ++pos;
4495 if (pos != end) {
4496 current_layout.seek(pos->first.begin);
4497 }
4498 }
John Zulauff660ad62019-03-23 07:16:05 -06004499 }
locke-lunargf155ccf2020-02-18 11:34:15 -07004500 // Update all layout set operations (which will be a subset of the initial_layouts)
Jeremy Gebben53631302021-04-13 16:46:37 -06004501 sparse_container::splice(*overlay_map, subres_map->GetLayoutMap(), GlobalLayoutUpdater());
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004502 }
John Zulauff660ad62019-03-23 07:16:05 -06004503
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004504 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004505}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07004506
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004507void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06004508 for (const auto &layout_map_entry : pCB->image_layout_map) {
Jeremy Gebben6335df62021-11-01 10:50:13 -06004509 const auto *image_state = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07004510 const auto &subres_map = layout_map_entry.second;
Jeremy Gebben4a8881f2022-01-10 17:04:30 -07004511 auto guard = image_state->layout_range_map->WriteLock();
4512 sparse_container::splice(*image_state->layout_range_map, subres_map->GetLayoutMap(), GlobalLayoutUpdater());
Tony Barbourdf013b92017-01-25 12:53:48 -07004513 }
4514}
4515
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004516// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004517// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
4518// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004519bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
4520 const VkImageLayout first_layout, const uint32_t attachment,
Mike Schuchardt2df08912020-12-15 16:28:09 -08004521 const VkAttachmentDescription2 &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004522 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004523 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
4524
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004525 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
sfricke-samsung55f01952020-03-24 08:16:41 -07004526 // for both loadOp and stencilLoaOp rp2 has it in 1 VU while rp1 has it in 2 VU with half behind Maintenance2 extension
4527 // Each is VUID is below in following order: rp2 -> rp1 with Maintenance2 -> rp1 with no extenstion
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004528 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07004529 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4530 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4531 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004532 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004533 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004534 string_VkImageLayout(first_layout));
sfricke-samsung45996a42021-09-16 13:45:27 -07004535 } else if ((use_rp2 == false) && IsExtEnabled(device_extensions.vk_khr_maintenance2) &&
sfricke-samsung55f01952020-03-24 08:16:41 -07004536 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL)) {
4537 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01566",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004538 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004539 string_VkImageLayout(first_layout));
4540 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4541 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004542 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004543 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004544 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004545 }
4546 }
sfricke-samsung55f01952020-03-24 08:16:41 -07004547
4548 // Same as above for loadOp, but for stencilLoadOp
4549 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
4550 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4551 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4552 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL))) {
4553 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02523",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004554 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004555 string_VkImageLayout(first_layout));
sfricke-samsung45996a42021-09-16 13:45:27 -07004556 } else if ((use_rp2 == false) && IsExtEnabled(device_extensions.vk_khr_maintenance2) &&
sfricke-samsung55f01952020-03-24 08:16:41 -07004557 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL)) {
4558 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01567",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004559 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004560 string_VkImageLayout(first_layout));
4561 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4562 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
4563 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-02511",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004564 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004565 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02004566 }
4567 }
4568
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004569 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004570}
4571
Mark Lobodzinski96210742017-02-09 10:33:46 -07004572// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4573// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004574template <typename T1>
4575bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
4576 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
4577 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004578 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004579 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004580 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004581 if (strict) {
4582 correct_usage = ((actual & desired) == desired);
4583 } else {
4584 correct_usage = ((actual & desired) != 0);
4585 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004586
Mark Lobodzinski96210742017-02-09 10:33:46 -07004587 if (!correct_usage) {
sfricke-samsungbb971942020-09-10 22:11:56 -07004588 // All callers should have a valid VUID
4589 assert(msgCode != kVUIDUndefined);
4590 skip =
4591 LogError(object, msgCode, "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4592 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004593 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004594 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004595}
4596
4597// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4598// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004599bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004600 char const *func_name, char const *usage_string) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004601 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image(),
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06004602 image_state->Handle(), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004603}
4604
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004605bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags2KHR desired,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004606 char const *func_name, const char *vuid) const {
Cort Stratton186b1a22018-05-01 20:18:06 -04004607 bool skip = false;
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004608 const VkFormatFeatureFlags2KHR image_format_features = image_state->format_features;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004609 if ((image_format_features & desired) != desired) {
4610 // Same error, but more details if it was an AHB external format
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06004611 if (image_state->HasAHBFormat()) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004612 skip |= LogError(image_state->image(), vuid,
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004613 "In %s, VkFormatFeatureFlags (0x%" PRIxLEAST64 ") does not support required feature %s for the external format "
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004614 "found in VkAndroidHardwareBufferFormatPropertiesANDROID::formatFeatures used by %s.",
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004615 func_name, image_format_features, string_VkFormatFeatureFlags2KHR(desired).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004616 report_data->FormatHandle(image_state->image()).c_str());
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004617 } else {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004618 skip |= LogError(image_state->image(), vuid,
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004619 "In %s, VkFormatFeatureFlags (0x%" PRIxLEAST64 ") does not support required feature %s for format %u used by %s "
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004620 "with tiling %s.",
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004621 func_name, image_format_features, string_VkFormatFeatureFlags2KHR(desired).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004622 image_state->createInfo.format, report_data->FormatHandle(image_state->image()).c_str(),
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004623 string_VkImageTiling(image_state->createInfo.tiling));
Cort Stratton186b1a22018-05-01 20:18:06 -04004624 }
4625 }
4626 return skip;
4627}
4628
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004629bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004630 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004631 bool skip = false;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004632 const VkImageAspectFlags apsect_mask = subresource_layers->aspectMask;
Cort Strattond619a302018-05-17 19:46:32 -07004633 // layerCount must not be zero
4634 if (subresource_layers->layerCount == 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004635 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-layerCount-01700",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004636 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004637 }
4638 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004639 if (apsect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004640 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-00168",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004641 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004642 }
4643 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004644 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 -06004645 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-00167",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004646 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4647 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4648 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004649 }
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004650 // aspectMask must not contain VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT
4651 if (apsect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
4652 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004653 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-02247",
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004654 "In %s, pRegions[%u].%s.aspectMask has a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit set.", func_name, i,
4655 member);
4656 }
Cort Strattond619a302018-05-17 19:46:32 -07004657 return skip;
4658}
4659
Mark Lobodzinski96210742017-02-09 10:33:46 -07004660// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4661// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004662bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004663 char const *func_name, char const *usage_string) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004664 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer(),
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06004665 buffer_state->Handle(), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004666}
4667
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004668bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004669 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004670 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004671
4672 const VkDeviceSize &range = pCreateInfo->range;
4673 if (range != VK_WHOLE_SIZE) {
4674 // Range must be greater than 0
4675 if (range <= 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004676 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00928",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004677 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004678 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4679 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004680 }
4681 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004682 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4683 if (SafeModulo(range, format_size) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004684 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00929",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004685 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004686 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4687 "(%" PRIu32 ").",
4688 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004689 }
4690 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004691 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004692 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00930",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004693 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004694 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4695 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4696 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004697 }
4698 // The sum of range and offset must be less than or equal to the size of buffer
4699 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004700 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-offset-00931",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004701 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004702 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4703 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4704 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004705 }
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004706 } else {
4707 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4708
4709 // Size of buffer - offset, divided by the element size of format must be less than or equal to
4710 // VkPhysicalDeviceLimits::maxTexelBufferElements
4711 if (SafeDivision(buffer_state->createInfo.size - pCreateInfo->offset, format_size) >
4712 device_limits->maxTexelBufferElements) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004713 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-04059",
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004714 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
4715 ") equals VK_WHOLE_SIZE, the buffer's size (%" PRIuLEAST64 ") minus the offset (%" PRIuLEAST64
4716 "), divided by the element size of the format (%" PRIu32
4717 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4718 range, buffer_state->createInfo.size, pCreateInfo->offset, format_size,
4719 device_limits->maxTexelBufferElements);
4720 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004721 }
4722 return skip;
4723}
4724
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004725bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004726 bool skip = false;
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004727 const VkFormatProperties3KHR format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004728 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004729 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_2_UNIFORM_TEXEL_BUFFER_BIT_KHR)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004730 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-00933",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004731 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004732 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format (%s) must "
4733 "be supported for uniform texel buffers",
4734 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004735 }
4736 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004737 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_2_STORAGE_TEXEL_BUFFER_BIT_KHR)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004738 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-00934",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004739 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004740 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format (%s) must "
4741 "be supported for storage texel buffers",
4742 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004743 }
4744 return skip;
4745}
4746
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004747bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004748 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004749 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004750
Dave Houltond8ed0212018-05-16 17:18:24 -06004751 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004752
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004753 auto chained_devaddr_struct = LvlFindInChain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
Jeff Bolz87697532019-01-11 22:54:00 -06004754 if (chained_devaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004755 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz87697532019-01-11 22:54:00 -06004756 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004757 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4758 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004759 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004760 }
4761 }
4762
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004763 auto chained_opaqueaddr_struct = LvlFindInChain<VkBufferOpaqueCaptureAddressCreateInfo>(pCreateInfo->pNext);
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004764 if (chained_opaqueaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004765 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004766 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004767 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
Mike Schuchardt2df08912020-12-15 16:28:09 -08004768 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfo::opaqueCaptureAddress"
4769 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004770 }
4771 }
4772
ziga-lunarg2e2be1e2021-07-18 23:09:15 +02004773 auto dedicated_allocation_buffer = LvlFindInChain<VkDedicatedAllocationBufferCreateInfoNV>(pCreateInfo->pNext);
4774 if (dedicated_allocation_buffer && dedicated_allocation_buffer->dedicatedAllocation == VK_TRUE) {
4775 if (pCreateInfo->flags &
4776 (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT)) {
4777 skip |= LogError(device, "VUID-VkBufferCreateInfo-pNext-01571",
4778 "vkCreateBuffer(): pCreateInfos->flags must not include VK_BUFFER_CREATE_SPARSE_BINDING_BIT, "
4779 "VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT, or VK_BUFFER_CREATE_SPARSE_ALIASED_BIT when "
4780 "VkDedicatedAllocationBufferCreateInfoNV is in pNext chain with dedicatedAllocation VK_TRUE.");
4781 }
4782 }
4783
Mike Schuchardt2df08912020-12-15 16:28:09 -08004784 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz33fc6722020-03-31 12:58:16 -05004785 !enabled_features.core12.bufferDeviceAddressCaptureReplay &&
sfricke-samsung828e59d2021-08-22 23:20:49 -07004786 !enabled_features.buffer_device_address_ext_features.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004787 skip |= LogError(
4788 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004789 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004790 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT set.");
Jeff Bolz87697532019-01-11 22:54:00 -06004791 }
4792
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004793 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
sfricke-samsung45996a42021-09-16 13:45:27 -07004794 const char *vuid = IsExtEnabled(device_extensions.vk_khr_get_physical_device_properties2)
4795 ? "VUID-VkBufferCreateInfo-sharingMode-01419"
4796 : "VUID-VkBufferCreateInfo-sharingMode-01391";
Mark Lobodzinski314b9162020-07-16 15:33:08 -06004797 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
ziga-lunarga0b4f8a2021-07-28 13:23:02 +02004798 "vkCreateBuffer", "pCreateInfo->pQueueFamilyIndices", vuid);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004799 }
4800
sfricke-samsungedce77a2020-07-03 22:35:13 -07004801 if ((pCreateInfo->flags & VK_BUFFER_CREATE_PROTECTED_BIT) != 0) {
4802 if (enabled_features.core11.protectedMemory == VK_FALSE) {
4803 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-01887",
4804 "vkCreateBuffer(): the protectedMemory device feature is disabled: Buffers cannot be created with the "
4805 "VK_BUFFER_CREATE_PROTECTED_BIT set.");
4806 }
4807 const VkBufferCreateFlags invalid_flags =
4808 VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT;
4809 if ((pCreateInfo->flags & invalid_flags) != 0) {
4810 skip |= LogError(device, "VUID-VkBufferCreateInfo-None-01888",
4811 "vkCreateBuffer(): VK_BUFFER_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at "
4812 "same time (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | "
4813 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT).");
4814 }
4815 }
4816
ziga-lunargfe74b8d2022-04-18 17:37:46 +02004817 if ((pCreateInfo->usage & (VK_BUFFER_USAGE_VIDEO_DECODE_SRC_BIT_KHR | VK_BUFFER_USAGE_VIDEO_DECODE_DST_BIT_KHR)) > 0) {
4818 bool has_decode_codec_operation = false;
4819 const auto* video_profiles = LvlFindInChain<VkVideoProfilesKHR>(pCreateInfo->pNext);
4820 if (video_profiles) {
4821 for (uint32_t i = 0; i < video_profiles->profileCount; ++i) {
4822 if (video_profiles->pProfiles[i].videoCodecOperation &
4823 (VK_VIDEO_CODEC_OPERATION_DECODE_H264_BIT_EXT | VK_VIDEO_CODEC_OPERATION_DECODE_H265_BIT_EXT)) {
4824 has_decode_codec_operation = true;
4825 break;
4826 }
4827 }
4828 }
4829 if (!has_decode_codec_operation) {
4830 skip |= LogError(device, "VUID-VkBufferCreateInfo-usage-04813",
4831 "vkCreateBuffer(): pCreateInfo->usage is %s, but pNext chain does not include VkVideoProfilesKHR with "
4832 "a decode codec-operation.",
4833 string_VkBufferUsageFlags(pCreateInfo->usage).c_str());
4834 }
4835 }
4836 if ((pCreateInfo->usage & (VK_BUFFER_USAGE_VIDEO_ENCODE_SRC_BIT_KHR | VK_BUFFER_USAGE_VIDEO_ENCODE_DST_BIT_KHR)) > 0) {
4837 bool has_encode_codec_operation = false;
4838 const auto *video_profiles = LvlFindInChain<VkVideoProfilesKHR>(pCreateInfo->pNext);
4839 if (video_profiles) {
4840 for (uint32_t i = 0; i < video_profiles->profileCount; ++i) {
4841 if (video_profiles->pProfiles[i].videoCodecOperation &
4842 (VK_VIDEO_CODEC_OPERATION_ENCODE_H264_BIT_EXT | VK_VIDEO_CODEC_OPERATION_ENCODE_H265_BIT_EXT)) {
4843 has_encode_codec_operation = true;
4844 break;
4845 }
4846 }
4847 }
4848 if (!has_encode_codec_operation) {
4849 skip |= LogError(device, "VUID-VkBufferCreateInfo-usage-04814",
4850 "vkCreateBuffer(): pCreateInfo->usage is %s, but pNext chain does not include VkVideoProfilesKHR with "
4851 "an encode codec-operation.",
4852 string_VkBufferUsageFlags(pCreateInfo->usage).c_str());
4853 }
4854 }
4855
Mark Lobodzinski96210742017-02-09 10:33:46 -07004856 return skip;
4857}
4858
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004859bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004860 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004861 bool skip = false;
Jeremy Gebbenf4449392022-01-28 10:09:10 -07004862 auto buffer_state = Get<BUFFER_STATE>(pCreateInfo->buffer);
sfricke-samsung2e827212021-09-28 07:52:08 -07004863
4864 if (FormatIsDepthOrStencil(pCreateInfo->format)) {
4865 // Should never hopefully get here, but there are known driver advertising the wrong feature flags
4866 // see https://gitlab.khronos.org/vulkan/vulkan/-/merge_requests/4849
4867 skip |= LogError(device, kVUID_Core_invalidDepthStencilFormat,
4868 "vkCreateBufferView(): format is a depth/stencil format (%s) but depth/stencil formats do not have a "
4869 "defined sizes for alignment, replace with a color format.",
4870 string_VkFormat(pCreateInfo->format));
4871 }
4872
Mark Lobodzinski96210742017-02-09 10:33:46 -07004873 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4874 if (buffer_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06004875 skip |=
4876 ValidateMemoryIsBoundToBuffer(buffer_state.get(), "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004877 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4878 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Jeremy Gebben9f537102021-10-05 16:37:12 -06004879 skip |= ValidateBufferUsageFlags(buffer_state.get(),
Dave Houltond8ed0212018-05-16 17:18:24 -06004880 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4881 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4882 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004883
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004884 // Buffer view offset must be less than the size of buffer
4885 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004886 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-offset-00925",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004887 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004888 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4889 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004890 }
4891
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004892 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004893 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4894 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4895 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
sfricke-samsung45996a42021-09-16 13:45:27 -07004896 const char *vuid = IsExtEnabled(device_extensions.vk_ext_texel_buffer_alignment)
4897 ? "VUID-VkBufferViewCreateInfo-offset-02749"
4898 : "VUID-VkBufferViewCreateInfo-offset-00926";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004899 skip |= LogError(buffer_state->buffer(), vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004900 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004901 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4902 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004903 }
4904
4905 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004906 VkDeviceSize element_size = FormatElementSize(pCreateInfo->format);
4907 if ((element_size % 3) == 0) {
4908 element_size /= 3;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004909 }
4910 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004911 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05004912 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4913 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004914 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004915 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004916 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004917 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004918 buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-02750",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004919 "vkCreateBufferView(): If buffer was created with usage containing "
4920 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004921 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4922 ") must be a multiple of the lesser of "
4923 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4924 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4925 "(%" PRId32
4926 ") is VK_TRUE, the size of a texel of the requested format. "
4927 "If the size of a texel is a multiple of three bytes, then the size of a "
4928 "single component of format is used instead",
4929 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4930 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4931 }
4932 }
4933 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004934 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05004935 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4936 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004937 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004938 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004939 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004940 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004941 buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-02751",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004942 "vkCreateBufferView(): If buffer was created with usage containing "
4943 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004944 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4945 ") must be a multiple of the lesser of "
4946 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4947 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4948 "(%" PRId32
4949 ") is VK_TRUE, the size of a texel of the requested format. "
4950 "If the size of a texel is a multiple of three bytes, then the size of a "
4951 "single component of format is used instead",
4952 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4953 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4954 }
4955 }
4956 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004957
Jeremy Gebben9f537102021-10-05 16:37:12 -06004958 skip |= ValidateBufferViewRange(buffer_state.get(), pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004959
Jeremy Gebben9f537102021-10-05 16:37:12 -06004960 skip |= ValidateBufferViewBuffer(buffer_state.get(), pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004961 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004962 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004963}
4964
Mark Lobodzinski602de982017-02-09 11:01:33 -07004965// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004966bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004967 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004968 bool skip = false;
Jeremy Gebbenf4449392022-01-28 10:09:10 -07004969 auto image_state = Get<IMAGE_STATE>(image);
sfricke-samsung79b00482020-04-01 21:15:50 -07004970 // checks color format and (single-plane or non-disjoint)
4971 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
sfricke-samsung71bc6572020-04-29 15:49:43 -07004972 if ((FormatIsColor(format)) && ((FormatIsMultiplane(format) == false) || (image_state->disjoint == false))) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004973 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004974 skip |= LogError(
4975 image, vuid,
4976 "%s: Using format (%s) with aspect flags (%s) but color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.",
4977 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004978 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004979 skip |= LogError(image, vuid,
4980 "%s: Using format (%s) with aspect flags (%s) but color image formats must have ONLY the "
4981 "VK_IMAGE_ASPECT_COLOR_BIT set.",
4982 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004983 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004984 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004985 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004986 skip |= LogError(image, vuid,
sfricke-samsung7687a482021-01-29 23:19:22 -08004987 "%s: Using format (%s) with aspect flags (%s) but depth/stencil image formats must have at least one "
4988 "of VK_IMAGE_ASPECT_DEPTH_BIT and VK_IMAGE_ASPECT_STENCIL_BIT set.",
4989 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004990 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004991 skip |= LogError(image, vuid,
sfricke-samsung7687a482021-01-29 23:19:22 -08004992 "%s: Using format (%s) with aspect flags (%s) but combination depth/stencil image formats can have "
4993 "only the VK_IMAGE_ASPECT_DEPTH_BIT and VK_IMAGE_ASPECT_STENCIL_BIT set.",
4994 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004995 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004996 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004997 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08004998 skip |= LogError(image, vuid,
4999 "%s: Using format (%s) with aspect flags (%s) but depth-only image formats must have the "
5000 "VK_IMAGE_ASPECT_DEPTH_BIT set.",
5001 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005002 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08005003 skip |= LogError(image, vuid,
5004 "%s: Using format (%s) with aspect flags (%s) but depth-only image formats can have only the "
5005 "VK_IMAGE_ASPECT_DEPTH_BIT set.",
5006 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005007 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06005008 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005009 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08005010 skip |= LogError(image, vuid,
5011 "%s: Using format (%s) with aspect flags (%s) but stencil-only image formats must have the "
5012 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
5013 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005014 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08005015 skip |= LogError(image, vuid,
5016 "%s: Using format (%s) with aspect flags (%s) but stencil-only image formats can have only the "
5017 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
5018 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005019 }
Dave Houlton501b15b2018-03-30 15:07:41 -06005020 } else if (FormatIsMultiplane(format)) {
5021 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
5022 if (3 == FormatPlaneCount(format)) {
5023 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
5024 }
5025 if ((aspect_mask & valid_flags) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08005026 skip |= LogError(image, vuid,
5027 "%s: Using format (%s) with aspect flags (%s) but multi-plane image formats may have only "
5028 "VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs set, where n = [0, 1, 2].",
5029 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Dave Houlton501b15b2018-03-30 15:07:41 -06005030 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005031 }
5032 return skip;
5033}
5034
ziga-lunarg69aa72f2022-03-29 15:24:35 +02005035bool CoreChecks::ValidateImageAcquired(IMAGE_STATE const &image_state, const char *func_name) const {
ziga-lunarg04e94b32021-10-03 01:42:37 +02005036 bool skip = false;
5037
ziga-lunarg04e94b32021-10-03 01:42:37 +02005038 return skip;
5039}
5040
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005041bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
5042 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005043 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
Jeremy Gebben5573a8c2021-06-04 08:55:10 -06005044 const SubresourceRangeErrorCodes &errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005045 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02005046
5047 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02005048 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005049 skip |= LogError(image, errorCodes.base_mip_err,
5050 "%s: %s.baseMipLevel (= %" PRIu32
5051 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
5052 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02005053 }
Petr Kraus4d718682017-05-18 03:38:41 +02005054
Petr Krausffa94af2017-08-08 21:46:02 +02005055 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
5056 if (subresourceRange.levelCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07005057 skip |=
5058 LogError(image, "VUID-VkImageSubresourceRange-levelCount-01720", "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02005059 } else {
5060 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02005061
Petr Krausffa94af2017-08-08 21:46:02 +02005062 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005063 skip |= LogError(image, errorCodes.mip_count_err,
5064 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
5065 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
5066 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
5067 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02005068 }
Petr Kraus4d718682017-05-18 03:38:41 +02005069 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005070 }
Petr Kraus4d718682017-05-18 03:38:41 +02005071
5072 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02005073 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005074 skip |= LogError(image, errorCodes.base_layer_err,
5075 "%s: %s.baseArrayLayer (= %" PRIu32
5076 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
5077 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02005078 }
Petr Kraus4d718682017-05-18 03:38:41 +02005079
Petr Krausffa94af2017-08-08 21:46:02 +02005080 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
5081 if (subresourceRange.layerCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07005082 skip |=
5083 LogError(image, "VUID-VkImageSubresourceRange-layerCount-01721", "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02005084 } else {
5085 const uint64_t necessary_layer_count =
5086 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02005087
Petr Krausffa94af2017-08-08 21:46:02 +02005088 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005089 skip |= LogError(image, errorCodes.layer_count_err,
5090 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
5091 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
5092 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
5093 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02005094 }
Petr Kraus4d718682017-05-18 03:38:41 +02005095 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005096 }
Petr Kraus4d718682017-05-18 03:38:41 +02005097
ziga-lunargb4e90752021-08-02 13:58:29 +02005098 if (subresourceRange.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
5099 if (subresourceRange.aspectMask &
5100 (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT)) {
5101 skip |= LogError(image, "VUID-VkImageSubresourceRange-aspectMask-01670",
5102 "%s: aspectMask includes both VK_IMAGE_ASPECT_COLOR_BIT and one of VK_IMAGE_ASPECT_PLANE_0_BIT, "
5103 "VK_IMAGE_ASPECT_PLANE_1_BIT, or VK_IMAGE_ASPECT_PLANE_2_BIT.",
5104 cmd_name);
5105 }
5106 }
5107
Mark Lobodzinski602de982017-02-09 11:01:33 -07005108 return skip;
5109}
5110
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005111bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005112 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07005113 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Tony-LunarGbe956362022-04-05 13:34:31 -06005114 bool is_2d_compatible = (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT) ? true : false;
5115 if (device_extensions.vk_ext_image_2d_view_of_3d)
5116 is_2d_compatible |= (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_VIEW_COMPATIBLE_BIT_EXT) ? true : false;
5117 bool is_image_slicable =
5118 (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) && is_2d_compatible;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005119 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 +02005120
David McFarland2853f2f2020-11-30 15:50:39 -04005121 uint32_t image_layer_count;
5122
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005123 if (is_3_d_to_2_d_map) {
David McFarland2853f2f2020-11-30 15:50:39 -04005124 const auto layers = LayersFromRange(subresourceRange);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06005125 const auto extent = image_state->GetSubresourceExtent(layers);
David McFarland2853f2f2020-11-30 15:50:39 -04005126 image_layer_count = extent.depth;
5127 } else {
5128 image_layer_count = image_state->createInfo.arrayLayers;
5129 }
5130
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005131 const auto image_layer_count_var_name = is_3_d_to_2_d_map ? "extent.depth" : "arrayLayers";
Petr Krausffa94af2017-08-08 21:46:02 +02005132
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005133 SubresourceRangeErrorCodes subresource_range_error_codes = {};
5134 subresource_range_error_codes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
5135 subresource_range_error_codes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
5136 subresource_range_error_codes.base_layer_err =
5137 is_khr_maintenance1
Tony-LunarGbe956362022-04-05 13:34:31 -06005138 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-image-02724"
5139 : (device_extensions.vk_ext_image_2d_view_of_3d ? "VUID-VkImageViewCreateInfo-image-06724"
5140 : "VUID-VkImageViewCreateInfo-image-01482"))
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005141 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
Tony-LunarGbe956362022-04-05 13:34:31 -06005142 subresource_range_error_codes.layer_count_err =
5143 is_khr_maintenance1
5144 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
5145 : (device_extensions.vk_ext_image_2d_view_of_3d ? "VUID-VkImageViewCreateInfo-subresourceRange-06725"
5146 : "VUID-VkImageViewCreateInfo-subresourceRange-01483"))
5147 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02005148
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005149 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02005150 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005151 image_state->image(), subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02005152}
5153
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005154bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06005155 const VkImageSubresourceRange &subresourceRange,
5156 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005157 SubresourceRangeErrorCodes subresource_range_error_codes = {};
5158 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
5159 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
5160 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
5161 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02005162
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005163 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005164 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image(),
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005165 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02005166}
5167
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005168bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06005169 const VkImageSubresourceRange &subresourceRange,
5170 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005171 SubresourceRangeErrorCodes subresource_range_error_codes = {};
5172 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
5173 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
5174 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
5175 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02005176
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005177 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005178 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image(),
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005179 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02005180}
5181
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005182bool CoreChecks::ValidateImageBarrierSubresourceRange(const Location &loc, const IMAGE_STATE *image_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005183 const VkImageSubresourceRange &subresourceRange) const {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005184 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005185 loc.StringFunc().c_str(), loc.StringField().c_str(), "arrayLayers", image_state->image(),
Jeremy Gebbenbb845612021-02-18 18:16:05 -07005186 sync_vuid_maps::GetSubResourceVUIDs(loc));
Petr Krausffa94af2017-08-08 21:46:02 +02005187}
5188
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005189namespace barrier_queue_families {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005190using sync_vuid_maps::GetBarrierQueueVUID;
5191using sync_vuid_maps::kQueueErrorSummary;
5192using sync_vuid_maps::QueueError;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005193
5194class ValidatorState {
5195 public:
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005196 ValidatorState(const ValidationStateTracker *device_data, LogObjectList &&obj, const core_error::Location &location,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005197 const VulkanTypedHandle &barrier_handle, const VkSharingMode sharing_mode)
5198 : device_data_(device_data),
John Zulaufbea70432021-02-23 07:03:12 -07005199 objects_(std::move(obj)),
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005200 loc_(location),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005201 barrier_handle_(barrier_handle),
5202 sharing_mode_(sharing_mode),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005203 limit_(static_cast<uint32_t>(device_data->physical_device_state->queue_family_properties.size())),
5204 mem_ext_(IsExtEnabled(device_data->device_extensions.vk_khr_external_memory)) {}
5205
5206 // Log the messages using boilerplate from object state, and Vu specific information from the template arg
5207 // 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 -07005208 bool LogMsg(QueueError vu_index, uint32_t family, const char *param_name) const {
5209 const std::string val_code = GetBarrierQueueVUID(loc_, vu_index);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005210 const char *annotation = GetFamilyAnnotation(family);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005211 return device_data_->LogError(objects_, val_code, "%s Barrier using %s %s created with sharingMode %s, has %s %u%s. %s",
5212 loc_.Message().c_str(), GetTypeString(),
5213 device_data_->report_data->FormatHandle(barrier_handle_).c_str(), GetModeString(), param_name,
5214 family, annotation, kQueueErrorSummary.at(vu_index).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005215 }
5216
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005217 bool LogMsg(QueueError vu_index, uint32_t src_family, uint32_t dst_family) const {
5218 const std::string val_code = GetBarrierQueueVUID(loc_, vu_index);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005219 const char *src_annotation = GetFamilyAnnotation(src_family);
5220 const char *dst_annotation = GetFamilyAnnotation(dst_family);
5221 return device_data_->LogError(
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005222 objects_, val_code,
5223 "%s Barrier using %s %s created with sharingMode %s, has srcQueueFamilyIndex %u%s and dstQueueFamilyIndex %u%s. %s",
5224 loc_.Message().c_str(), GetTypeString(), device_data_->report_data->FormatHandle(barrier_handle_).c_str(),
5225 GetModeString(), src_family, src_annotation, dst_family, dst_annotation, kQueueErrorSummary.at(vu_index).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005226 }
5227
5228 // This abstract Vu can only be tested at submit time, thus we need a callback from the closure containing the needed
5229 // data. Note that the mem_barrier is copied to the closure as the lambda lifespan exceed the guarantees of validity for
5230 // application input.
5231 static bool ValidateAtQueueSubmit(const QUEUE_STATE *queue_state, const ValidationStateTracker *device_data,
5232 uint32_t src_family, uint32_t dst_family, const ValidatorState &val) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005233 auto error_code = QueueError::kSubmitQueueMustMatchSrcOrDst;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005234 uint32_t queue_family = queue_state->queueFamilyIndex;
5235 if ((src_family != queue_family) && (dst_family != queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005236 const std::string val_code = GetBarrierQueueVUID(val.loc_, error_code);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005237 const char *src_annotation = val.GetFamilyAnnotation(src_family);
5238 const char *dst_annotation = val.GetFamilyAnnotation(dst_family);
5239 return device_data->LogError(
Jeremy Gebben63f3cb02021-09-07 15:16:32 -06005240 queue_state->Handle(), val_code,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005241 "%s Barrier submitted to queue with family index %u, using %s %s created with sharingMode %s, has "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005242 "srcQueueFamilyIndex %u%s and dstQueueFamilyIndex %u%s. %s",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005243 val.loc_.Message().c_str(), queue_family, val.GetTypeString(),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005244 device_data->report_data->FormatHandle(val.barrier_handle_).c_str(), val.GetModeString(), src_family,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005245 src_annotation, dst_family, dst_annotation, kQueueErrorSummary.at(error_code).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005246 }
5247 return false;
5248 }
5249 // Logical helpers for semantic clarity
5250 inline bool KhrExternalMem() const { return mem_ext_; }
5251 inline bool IsValid(uint32_t queue_family) const { return (queue_family < limit_); }
5252 inline bool IsValidOrSpecial(uint32_t queue_family) const {
5253 return IsValid(queue_family) || (mem_ext_ && QueueFamilyIsExternal(queue_family));
5254 }
5255
5256 // Helpers for LogMsg
5257 const char *GetModeString() const { return string_VkSharingMode(sharing_mode_); }
5258
5259 // Descriptive text for the various types of queue family index
5260 const char *GetFamilyAnnotation(uint32_t family) const {
5261 const char *external = " (VK_QUEUE_FAMILY_EXTERNAL)";
5262 const char *foreign = " (VK_QUEUE_FAMILY_FOREIGN_EXT)";
5263 const char *ignored = " (VK_QUEUE_FAMILY_IGNORED)";
5264 const char *valid = " (VALID)";
5265 const char *invalid = " (INVALID)";
5266 switch (family) {
5267 case VK_QUEUE_FAMILY_EXTERNAL:
5268 return external;
5269 case VK_QUEUE_FAMILY_FOREIGN_EXT:
5270 return foreign;
5271 case VK_QUEUE_FAMILY_IGNORED:
5272 return ignored;
5273 default:
5274 if (IsValid(family)) {
5275 return valid;
5276 }
5277 return invalid;
5278 };
5279 }
5280 const char *GetTypeString() const { return object_string[barrier_handle_.type]; }
5281 VkSharingMode GetSharingMode() const { return sharing_mode_; }
5282
5283 protected:
5284 const ValidationStateTracker *device_data_;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005285 const LogObjectList objects_;
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005286 const core_error::Location loc_;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005287 const VulkanTypedHandle barrier_handle_;
5288 const VkSharingMode sharing_mode_;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005289 const uint32_t limit_;
5290 const bool mem_ext_;
5291};
5292
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005293bool Validate(const CoreChecks *device_data, const CMD_BUFFER_STATE *cb_state, const ValidatorState &val,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005294 const uint32_t src_queue_family, const uint32_t dst_queue_family) {
5295 bool skip = false;
5296
5297 const bool mode_concurrent = val.GetSharingMode() == VK_SHARING_MODE_CONCURRENT;
5298 const bool src_ignored = QueueFamilyIsIgnored(src_queue_family);
5299 const bool dst_ignored = QueueFamilyIsIgnored(dst_queue_family);
5300 if (val.KhrExternalMem()) {
5301 if (mode_concurrent) {
Tony-LunarG273f32f2021-09-28 08:56:30 -06005302 bool sync2 = device_data->enabled_features.core13.synchronization2 != 0;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005303 // this requirement is removed by VK_KHR_synchronization2
5304 if (!(src_ignored || dst_ignored) && !sync2) {
5305 skip |= val.LogMsg(QueueError::kSrcOrDstMustBeIgnore, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005306 }
5307 if ((src_ignored && !(dst_ignored || QueueFamilyIsExternal(dst_queue_family))) ||
5308 (dst_ignored && !(src_ignored || QueueFamilyIsExternal(src_queue_family)))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005309 skip |= val.LogMsg(QueueError::kSpecialOrIgnoreOnly, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005310 }
5311 } else {
5312 // VK_SHARING_MODE_EXCLUSIVE
5313 if (src_queue_family != dst_queue_family) {
5314 if (!val.IsValidOrSpecial(dst_queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005315 skip |= val.LogMsg(QueueError::kSrcAndDstValidOrSpecial, dst_queue_family, "dstQueueFamilyIndex");
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005316 }
5317 if (!val.IsValidOrSpecial(src_queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005318 skip |= val.LogMsg(QueueError::kSrcAndDstValidOrSpecial, src_queue_family, "srcQueueFamilyIndex");
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005319 }
5320 }
5321 }
5322 } else {
5323 // No memory extension
5324 if (mode_concurrent) {
Tony-LunarG273f32f2021-09-28 08:56:30 -06005325 bool sync2 = device_data->enabled_features.core13.synchronization2 != 0;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005326 // this requirement is removed by VK_KHR_synchronization2
5327 if ((!src_ignored || !dst_ignored) && !sync2) {
5328 skip |= val.LogMsg(QueueError::kSrcAndDestMustBeIgnore, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005329 }
5330 } else {
5331 // VK_SHARING_MODE_EXCLUSIVE
5332 if ((src_queue_family != dst_queue_family) && !(val.IsValid(src_queue_family) && val.IsValid(dst_queue_family))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005333 skip |= val.LogMsg(QueueError::kSrcAndDstBothValid, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005334 }
5335 }
5336 }
5337 return skip;
5338}
5339} // namespace barrier_queue_families
5340
Jeremy Gebbene5361dd2021-11-18 14:23:56 -07005341bool CoreChecks::ValidateConcurrentBarrierAtSubmit(const Location &loc, const ValidationStateTracker &state_data,
5342 const QUEUE_STATE &queue_state, const CMD_BUFFER_STATE &cb_state,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005343 const VulkanTypedHandle &typed_handle, uint32_t src_queue_family,
5344 uint32_t dst_queue_family) {
5345 using barrier_queue_families::ValidatorState;
Jeremy Gebbene5361dd2021-11-18 14:23:56 -07005346 ValidatorState val(&state_data, LogObjectList(cb_state.Handle()), loc, typed_handle, VK_SHARING_MODE_CONCURRENT);
5347 return ValidatorState::ValidateAtQueueSubmit(&queue_state, &state_data, src_queue_family, dst_queue_family, val);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005348}
5349
5350// Type specific wrapper for image barriers
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005351template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005352bool CoreChecks::ValidateBarrierQueueFamilies(const Location &loc, const CMD_BUFFER_STATE *cb_state, const ImgBarrier &barrier,
5353 const IMAGE_STATE *state_data) const {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005354 // State data is required
5355 if (!state_data) {
5356 return false;
5357 }
5358
5359 // Create the validator state from the image state
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005360 barrier_queue_families::ValidatorState val(this, LogObjectList(cb_state->commandBuffer()), loc,
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06005361 state_data->Handle(), state_data->createInfo.sharingMode);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005362 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
5363 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005364 return barrier_queue_families::Validate(this, cb_state, val, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005365}
5366
5367// Type specific wrapper for buffer barriers
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005368template <typename BufBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005369bool CoreChecks::ValidateBarrierQueueFamilies(const Location &loc, const CMD_BUFFER_STATE *cb_state, const BufBarrier &barrier,
5370 const BUFFER_STATE *state_data) const {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005371 // State data is required
5372 if (!state_data) {
5373 return false;
5374 }
5375
5376 // Create the validator state from the buffer state
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005377 barrier_queue_families::ValidatorState val(this, LogObjectList(cb_state->commandBuffer()), loc,
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06005378 state_data->Handle(), state_data->createInfo.sharingMode);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005379 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
5380 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005381 return barrier_queue_families::Validate(this, cb_state, val, src_queue_family, dst_queue_family);
5382}
5383
5384template <typename Barrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005385bool CoreChecks::ValidateBufferBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005386 const Barrier &mem_barrier) const {
5387 using sync_vuid_maps::BufferError;
5388 using sync_vuid_maps::GetBufferBarrierVUID;
5389
5390 bool skip = false;
5391
5392 skip |= ValidateQFOTransferBarrierUniqueness(loc, cb_state, mem_barrier, cb_state->qfo_transfer_buffer_barriers);
5393
5394 // Validate buffer barrier queue family indices
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06005395 auto buffer_state = Get<BUFFER_STATE>(mem_barrier.buffer);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005396 if (buffer_state) {
5397 auto buf_loc = loc.dot(Field::buffer);
5398 const auto &mem_vuid = GetBufferBarrierVUID(buf_loc, BufferError::kNoMemory);
Jeremy Gebben9f537102021-10-05 16:37:12 -06005399 skip |= ValidateMemoryIsBoundToBuffer(buffer_state.get(), loc.StringFunc().c_str(), mem_vuid.c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005400
Jeremy Gebben9f537102021-10-05 16:37:12 -06005401 skip |= ValidateBarrierQueueFamilies(buf_loc, cb_state, mem_barrier, buffer_state.get());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005402
5403 auto buffer_size = buffer_state->createInfo.size;
5404 if (mem_barrier.offset >= buffer_size) {
5405 auto offset_loc = loc.dot(Field::offset);
5406 const auto &vuid = GetBufferBarrierVUID(offset_loc, BufferError::kOffsetTooBig);
5407
5408 skip |= LogError(objects, vuid, "%s %s has offset 0x%" PRIx64 " which is not less than total size 0x%" PRIx64 ".",
5409 offset_loc.Message().c_str(), report_data->FormatHandle(mem_barrier.buffer).c_str(),
5410 HandleToUint64(mem_barrier.offset), HandleToUint64(buffer_size));
5411 } else if (mem_barrier.size != VK_WHOLE_SIZE && (mem_barrier.offset + mem_barrier.size > buffer_size)) {
5412 auto size_loc = loc.dot(Field::size);
5413 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kSizeOutOfRange);
5414 skip |= LogError(objects, vuid,
5415 "%s %s has offset 0x%" PRIx64 " and size 0x%" PRIx64 " whose sum is greater than total size 0x%" PRIx64
5416 ".",
5417 size_loc.Message().c_str(), report_data->FormatHandle(mem_barrier.buffer).c_str(),
5418 HandleToUint64(mem_barrier.offset), HandleToUint64(mem_barrier.size), HandleToUint64(buffer_size));
5419 }
5420 if (mem_barrier.size == 0) {
5421 auto size_loc = loc.dot(Field::size);
5422 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kSizeZero);
5423 skip |= LogError(objects, vuid, "%s %s has a size of 0.", loc.Message().c_str(),
5424 report_data->FormatHandle(mem_barrier.buffer).c_str());
5425 }
5426 }
ziga-lunarg8e2506c2022-04-18 20:06:00 +02005427
5428 if (mem_barrier.srcQueueFamilyIndex == VK_QUEUE_FAMILY_EXTERNAL &&
5429 mem_barrier.dstQueueFamilyIndex == VK_QUEUE_FAMILY_EXTERNAL) {
5430 auto size_loc = loc.dot(Field::srcQueueFamilyIndex);
5431 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kQueueFamilyExternal);
5432 skip |= LogError(objects, vuid, "Both srcQueueFamilyIndex and dstQueueFamilyIndex are VK_QUEUE_FAMILY_EXTERNAL.");
5433 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005434 return skip;
5435}
5436
5437template <typename Barrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005438bool CoreChecks::ValidateImageBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005439 const Barrier &mem_barrier) const {
5440 bool skip = false;
5441
5442 skip |= ValidateQFOTransferBarrierUniqueness(loc, cb_state, mem_barrier, cb_state->qfo_transfer_image_barriers);
5443
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005444 bool is_ilt = true;
Tony-LunarG273f32f2021-09-28 08:56:30 -06005445 if (enabled_features.core13.synchronization2) {
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005446 is_ilt = mem_barrier.oldLayout != mem_barrier.newLayout;
5447 }
5448
5449 if (is_ilt) {
5450 if (mem_barrier.newLayout == VK_IMAGE_LAYOUT_UNDEFINED || mem_barrier.newLayout == VK_IMAGE_LAYOUT_PREINITIALIZED) {
5451 auto layout_loc = loc.dot(Field::newLayout);
5452 const auto &vuid = sync_vuid_maps::GetImageBarrierVUID(loc, sync_vuid_maps::ImageError::kBadLayout);
5453 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005454 LogError(cb_state->commandBuffer(), vuid, "%s Image Layout cannot be transitioned to UNDEFINED or PREINITIALIZED.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005455 layout_loc.Message().c_str());
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005456 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005457 }
5458
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06005459 auto image_data = Get<IMAGE_STATE>(mem_barrier.image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005460 if (image_data) {
5461 auto image_loc = loc.dot(Field::image);
5462
Jeremy Gebben9f537102021-10-05 16:37:12 -06005463 skip |= ValidateMemoryIsBoundToImage(image_data.get(), loc);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005464
Jeremy Gebben9f537102021-10-05 16:37:12 -06005465 skip |= ValidateBarrierQueueFamilies(image_loc, cb_state, mem_barrier, image_data.get());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005466
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005467 skip |= ValidateImageAspectMask(image_data->image(), image_data->createInfo.format, mem_barrier.subresourceRange.aspectMask,
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005468 loc.StringFunc().c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005469
Jeremy Gebben9f537102021-10-05 16:37:12 -06005470 skip |=
5471 ValidateImageBarrierSubresourceRange(loc.dot(Field::subresourceRange), image_data.get(), mem_barrier.subresourceRange);
ziga-lunarg69aa72f2022-03-29 15:24:35 +02005472 skip |= ValidateImageAcquired(*image_data, loc.StringFunc().c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005473 }
5474 return skip;
5475}
5476
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005477bool CoreChecks::ValidateBarriers(const Location &outer_loc, const CMD_BUFFER_STATE *cb_state, VkPipelineStageFlags src_stage_mask,
5478 VkPipelineStageFlags dst_stage_mask, uint32_t memBarrierCount,
5479 const VkMemoryBarrier *pMemBarriers, uint32_t bufferBarrierCount,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005480 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
5481 const VkImageMemoryBarrier *pImageMemBarriers) const {
5482 bool skip = false;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005483 LogObjectList objects(cb_state->commandBuffer());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005484
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005485 for (uint32_t i = 0; i < memBarrierCount; ++i) {
5486 const auto &mem_barrier = pMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005487 auto loc = outer_loc.dot(Struct::VkMemoryBarrier, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005488 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005489 }
5490 for (uint32_t i = 0; i < imageMemBarrierCount; ++i) {
5491 const auto &mem_barrier = pImageMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005492 auto loc = outer_loc.dot(Struct::VkImageMemoryBarrier, Field::pImageMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005493 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005494 skip |= ValidateImageBarrier(objects, loc, cb_state, mem_barrier);
5495 }
5496 {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005497 Location loc(outer_loc.function, Struct::VkImageMemoryBarrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005498 skip |= ValidateBarriersToImages(loc, cb_state, imageMemBarrierCount, pImageMemBarriers);
5499 }
5500 for (uint32_t i = 0; i < bufferBarrierCount; ++i) {
5501 const auto &mem_barrier = pBufferMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005502 auto loc = outer_loc.dot(Struct::VkBufferMemoryBarrier, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005503 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005504 skip |= ValidateBufferBarrier(objects, loc, cb_state, mem_barrier);
5505 }
5506 return skip;
5507}
5508
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005509bool CoreChecks::ValidateDependencyInfo(const LogObjectList &objects, const Location &outer_loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbenefead332021-06-18 08:22:44 -06005510 const VkDependencyInfoKHR *dep_info) const {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005511 bool skip = false;
5512
5513 if (cb_state->activeRenderPass) {
5514 skip |= ValidateRenderPassPipelineBarriers(outer_loc, cb_state, dep_info);
5515 if (skip) return true; // Early return to avoid redundant errors from below calls
5516 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005517 for (uint32_t i = 0; i < dep_info->memoryBarrierCount; ++i) {
5518 const auto &mem_barrier = dep_info->pMemoryBarriers[i];
Tony-LunarG279601c2021-11-16 10:50:51 -07005519 auto loc = outer_loc.dot(Struct::VkMemoryBarrier2, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005520 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005521 }
5522 for (uint32_t i = 0; i < dep_info->imageMemoryBarrierCount; ++i) {
5523 const auto &mem_barrier = dep_info->pImageMemoryBarriers[i];
Tony-LunarG279601c2021-11-16 10:50:51 -07005524 auto loc = outer_loc.dot(Struct::VkImageMemoryBarrier2, Field::pImageMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005525 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005526 skip |= ValidateImageBarrier(objects, loc, cb_state, mem_barrier);
5527 }
5528 {
Tony-LunarG279601c2021-11-16 10:50:51 -07005529 Location loc(outer_loc.function, Struct::VkImageMemoryBarrier2);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005530 skip |= ValidateBarriersToImages(loc, cb_state, dep_info->imageMemoryBarrierCount, dep_info->pImageMemoryBarriers);
5531 }
5532
5533 for (uint32_t i = 0; i < dep_info->bufferMemoryBarrierCount; ++i) {
5534 const auto &mem_barrier = dep_info->pBufferMemoryBarriers[i];
Tony-LunarG279601c2021-11-16 10:50:51 -07005535 auto loc = outer_loc.dot(Struct::VkBufferMemoryBarrier2, Field::pBufferMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005536 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005537 skip |= ValidateBufferBarrier(objects, loc, cb_state, mem_barrier);
5538 }
5539
5540 return skip;
5541}
5542
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005543// template to check all original barrier structures
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005544template <typename Barrier>
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005545bool CoreChecks::ValidateMemoryBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
5546 const Barrier &barrier, VkPipelineStageFlags src_stage_mask,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005547 VkPipelineStageFlags dst_stage_mask) const {
5548 bool skip = false;
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005549 assert(cb_state);
5550 auto queue_flags = cb_state->GetQueueFlags();
5551
5552 if (!cb_state->IsAcquireOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005553 skip |= ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), queue_flags, barrier.srcAccessMask, src_stage_mask);
5554 }
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005555 if (!cb_state->IsReleaseOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005556 skip |= ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), queue_flags, barrier.dstAccessMask, dst_stage_mask);
5557 }
5558 return skip;
5559}
5560
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005561// template to check all synchronization2 barrier structures
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005562template <typename Barrier>
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005563bool CoreChecks::ValidateMemoryBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
5564 const Barrier &barrier) const {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005565 bool skip = false;
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005566 assert(cb_state);
5567 auto queue_flags = cb_state->GetQueueFlags();
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005568
Jeremy Gebbenefead332021-06-18 08:22:44 -06005569 skip |= ValidatePipelineStage(objects, loc.dot(Field::srcStageMask), queue_flags, barrier.srcStageMask);
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005570 if (!cb_state->IsAcquireOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005571 skip |=
5572 ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), queue_flags, barrier.srcAccessMask, barrier.srcStageMask);
5573 }
Jeremy Gebbenefead332021-06-18 08:22:44 -06005574
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005575 skip |= ValidatePipelineStage(objects, loc.dot(Field::dstStageMask), queue_flags, barrier.dstStageMask);
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005576 if (!cb_state->IsReleaseOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005577 skip |=
5578 ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), queue_flags, barrier.dstAccessMask, barrier.dstStageMask);
5579 }
5580 return skip;
5581}
5582
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005583// VkSubpassDependency validation happens when vkCreateRenderPass() is called.
5584// Dependencies between subpasses can only use pipeline stages compatible with VK_QUEUE_GRAPHICS_BIT,
5585// for external subpasses we don't have a yet command buffer so we have to assume all of them are valid.
5586static inline VkQueueFlags SubpassToQueueFlags(uint32_t subpass) {
5587 return subpass == VK_SUBPASS_EXTERNAL ? sync_utils::kAllQueueTypes : static_cast<VkQueueFlags>(VK_QUEUE_GRAPHICS_BIT);
5588}
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005589
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005590bool CoreChecks::ValidateSubpassDependency(const LogObjectList &objects, const Location &in_loc,
5591 const VkSubpassDependency2 &dependency) const {
5592 bool skip = false;
5593 Location loc = in_loc;
5594 VkMemoryBarrier2KHR converted_barrier;
5595 const auto *mem_barrier = LvlFindInChain<VkMemoryBarrier2KHR>(dependency.pNext);
5596
Tony-LunarG273f32f2021-09-28 08:56:30 -06005597 if (mem_barrier && enabled_features.core13.synchronization2) {
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005598 if (dependency.srcAccessMask != 0) {
5599 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-srcAccessMask",
5600 "%s is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5601 loc.dot(Field::srcAccessMask).Message().c_str());
5602 }
5603 if (dependency.dstAccessMask != 0) {
5604 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-dstAccessMask",
5605 "%s dstAccessMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5606 loc.dot(Field::dstAccessMask).Message().c_str());
5607 }
5608 if (dependency.srcStageMask != 0) {
5609 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-srcStageMask",
5610 "%s srcStageMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5611 loc.dot(Field::srcStageMask).Message().c_str());
5612 }
5613 if (dependency.dstStageMask != 0) {
5614 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-dstStageMask",
5615 "%s dstStageMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5616 loc.dot(Field::dstStageMask).Message().c_str());
5617 }
5618 loc = in_loc.dot(Field::pNext);
5619 converted_barrier = *mem_barrier;
5620 } else {
5621 if (mem_barrier) {
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005622 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-pNext",
5623 "%s a VkMemoryBarrier2KHR is present in pNext but synchronization2 is not enabled.",
5624 loc.Message().c_str());
5625 }
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005626 // use the subpass dependency flags, upconverted into wider synchronization2 fields.
5627 converted_barrier.srcStageMask = dependency.srcStageMask;
5628 converted_barrier.dstStageMask = dependency.dstStageMask;
5629 converted_barrier.srcAccessMask = dependency.srcAccessMask;
5630 converted_barrier.dstAccessMask = dependency.dstAccessMask;
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005631 }
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005632 auto src_queue_flags = SubpassToQueueFlags(dependency.srcSubpass);
5633 skip |= ValidatePipelineStage(objects, loc.dot(Field::srcStageMask), src_queue_flags, converted_barrier.srcStageMask);
5634 skip |= ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), src_queue_flags, converted_barrier.srcAccessMask,
5635 converted_barrier.srcStageMask);
5636
5637 auto dst_queue_flags = SubpassToQueueFlags(dependency.dstSubpass);
5638 skip |= ValidatePipelineStage(objects, loc.dot(Field::dstStageMask), dst_queue_flags, converted_barrier.dstStageMask);
5639 skip |= ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), dst_queue_flags, converted_barrier.dstAccessMask,
5640 converted_barrier.dstStageMask);
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005641 return skip;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005642}
5643
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005644bool CoreChecks::ValidateImageViewFormatFeatures(const IMAGE_STATE *image_state, const VkFormat view_format,
5645 const VkImageUsageFlags image_usage) const {
5646 // Pass in image_usage here instead of extracting it from image_state in case there's a chained VkImageViewUsageCreateInfo
5647 bool skip = false;
5648
Lionel Landwerlin21719f62021-12-09 11:40:09 +02005649 VkFormatFeatureFlags2KHR tiling_features = 0;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005650 const VkImageTiling image_tiling = image_state->createInfo.tiling;
5651
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06005652 if (image_state->HasAHBFormat()) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005653 // AHB image view and image share same feature sets
5654 tiling_features = image_state->format_features;
5655 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5656 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
sfricke-samsung45996a42021-09-16 13:45:27 -07005657 assert(IsExtEnabled(device_extensions.vk_ext_image_drm_format_modifier));
sjfrickee9b39372022-05-22 13:02:17 +09005658 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = LvlInitStruct<VkImageDrmFormatModifierPropertiesEXT>();
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005659 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image_state->image(), &drm_format_properties);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005660
Lionel Landwerlin1da35792021-12-14 16:54:13 +02005661 auto fmt_drm_props = LvlInitStruct<VkDrmFormatModifierPropertiesListEXT>();
5662 auto fmt_props_2 = LvlInitStruct<VkFormatProperties2>(&fmt_drm_props);
5663 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &fmt_props_2);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005664
nyorain38a9d232021-03-06 13:06:12 +01005665 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
Lionel Landwerlin1da35792021-12-14 16:54:13 +02005666 drm_properties.resize(fmt_drm_props.drmFormatModifierCount);
5667 fmt_drm_props.pDrmFormatModifierProperties = drm_properties.data();
nyorain38a9d232021-03-06 13:06:12 +01005668
Lionel Landwerlin1da35792021-12-14 16:54:13 +02005669 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &fmt_props_2);
nyorain38a9d232021-03-06 13:06:12 +01005670
Lionel Landwerlin1da35792021-12-14 16:54:13 +02005671 for (uint32_t i = 0; i < fmt_drm_props.drmFormatModifierCount; i++) {
5672 if (fmt_drm_props.pDrmFormatModifierProperties[i].drmFormatModifier == drm_format_properties.drmFormatModifier) {
5673 tiling_features = fmt_drm_props.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
5674 break;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005675 }
5676 }
5677 } else {
Lionel Landwerlin21719f62021-12-09 11:40:09 +02005678 VkFormatProperties3KHR format_properties = GetPDFormatProperties(view_format);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005679 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
5680 : format_properties.optimalTilingFeatures;
5681 }
5682
5683 if (tiling_features == 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005684 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-None-02273",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005685 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
5686 "physical device.",
5687 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5688 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005689 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02274",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005690 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5691 "VK_IMAGE_USAGE_SAMPLED_BIT.",
5692 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5693 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005694 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02275",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005695 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5696 "VK_IMAGE_USAGE_STORAGE_BIT.",
5697 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5698 } 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 -06005699 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02276",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005700 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5701 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
5702 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5703 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
5704 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005705 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02277",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005706 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5707 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5708 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5709 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
5710 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005711 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02652",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005712 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5713 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5714 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Tobias Hector6663c9b2020-11-05 10:18:02 +00005715 } else if ((image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) &&
5716 !(tiling_features & VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR)) {
5717 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005718 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-04550",
Tobias Hector6663c9b2020-11-05 10:18:02 +00005719 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5720 "VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR.",
5721 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5722 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005723 }
5724
5725 return skip;
5726}
5727
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005728bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005729 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005730 bool skip = false;
Jeremy Gebbenf4449392022-01-28 10:09:10 -07005731 auto image_state = Get<IMAGE_STATE>(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005732 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005733 skip |=
Jeremy Gebben9f537102021-10-05 16:37:12 -06005734 ValidateImageUsageFlags(image_state.get(),
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005735 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
5736 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
sfricke-samsungbb971942020-09-10 22:11:56 -07005737 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV |
5738 VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
5739 false, "VUID-VkImageViewCreateInfo-image-04441", "vkCreateImageView()",
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005740 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
sfricke-samsungbb971942020-09-10 22:11:56 -07005741 "TRANSIENT_ATTACHMENT|SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005742 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Jeremy Gebben9f537102021-10-05 16:37:12 -06005743 skip |= ValidateMemoryIsBoundToImage(image_state.get(), "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005744 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02005745 skip |= ValidateCreateImageViewSubresourceRange(
Jeremy Gebben9f537102021-10-05 16:37:12 -06005746 image_state.get(),
5747 pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005748 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005749
5750 VkImageCreateFlags image_flags = image_state->createInfo.flags;
5751 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005752 VkImageUsageFlags image_usage = image_state->createInfo.usage;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005753 VkFormat view_format = pCreateInfo->format;
5754 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06005755 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005756 VkImageViewType view_type = pCreateInfo->viewType;
sfricke-samsung20a8a372021-07-14 06:12:17 -07005757 uint32_t layer_count = pCreateInfo->subresourceRange.layerCount;
Mark Lobodzinski602de982017-02-09 11:01:33 -07005758
Dave Houltonbd2e2622018-04-10 16:41:14 -06005759 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005760 auto chained_ivuci_struct = LvlFindInChain<VkImageViewUsageCreateInfo>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06005761 if (chained_ivuci_struct) {
sfricke-samsung45996a42021-09-16 13:45:27 -07005762 if (IsExtEnabled(device_extensions.vk_khr_maintenance2)) {
5763 if (!IsExtEnabled(device_extensions.vk_ext_separate_stencil_usage)) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05005764 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005765 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
5766 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
5767 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05005768 }
5769 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005770 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05005771 if (image_stencil_struct == nullptr) {
5772 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005773 skip |= LogError(
5774 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005775 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
5776 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
5777 "any bits that were not set in VkImageCreateInfo::usage used to create image");
5778 }
5779 } else {
5780 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
5781 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
5782 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005783 skip |= LogError(
5784 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005785 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5786 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5787 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
5788 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
5789 }
5790 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
5791 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005792 skip |= LogError(
5793 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005794 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5795 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5796 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
5797 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
5798 }
5799 }
5800 }
5801 }
5802
Dave Houltonbd2e2622018-04-10 16:41:14 -06005803 image_usage = chained_ivuci_struct->usage;
5804 }
5805
sfricke-samsungf60b6c82021-04-05 22:59:20 -07005806 // If image used VkImageFormatListCreateInfo need to make sure a format from list is used
5807 const auto format_list_info = LvlFindInChain<VkImageFormatListCreateInfo>(image_state->createInfo.pNext);
5808 if (format_list_info && (format_list_info->viewFormatCount > 0)) {
5809 bool foundFormat = false;
5810 for (uint32_t i = 0; i < format_list_info->viewFormatCount; i++) {
5811 if (format_list_info->pViewFormats[i] == view_format) {
5812 foundFormat = true;
5813 break;
5814 }
5815 }
5816 if (foundFormat == false) {
5817 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-01585",
5818 "vkCreateImageView(): image was created with a VkImageFormatListCreateInfo in pNext of "
5819 "vkImageCreateInfo, but none of the formats match the VkImageViewCreateInfo::format (%s).",
5820 string_VkFormat(view_format));
5821 }
5822 }
5823
Dave Houlton6f5f20a2018-05-04 12:37:44 -06005824 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
5825 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005826 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01005827 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06005828 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01005829 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06005830 std::stringstream ss;
5831 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01005832 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06005833 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005834 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005835 }
5836 } else {
Mike Schuchardt2df08912020-12-15 16:28:09 -08005837 if (!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005838 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
sfricke-samsung965e5f82021-11-24 00:17:47 -06005839 auto image_class = FormatCompatibilityClass(image_format);
5840 auto view_class = FormatCompatibilityClass(view_format);
5841 // Need to only check if one is NONE to handle edge case both are NONE
5842 if ((image_class != view_class) || (image_class == FORMAT_COMPATIBILITY_CLASS::NONE)) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005843 const char *error_vuid;
sfricke-samsung45996a42021-09-16 13:45:27 -07005844 if ((!IsExtEnabled(device_extensions.vk_khr_maintenance2)) &&
5845 (!IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion))) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005846 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
sfricke-samsung45996a42021-09-16 13:45:27 -07005847 } else if ((IsExtEnabled(device_extensions.vk_khr_maintenance2)) &&
5848 (!IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion))) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005849 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
sfricke-samsung45996a42021-09-16 13:45:27 -07005850 } else if ((!IsExtEnabled(device_extensions.vk_khr_maintenance2)) &&
5851 (IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion))) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005852 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
5853 } else {
5854 // both enabled
5855 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
5856 }
Dave Houltonc7988072018-04-16 11:46:56 -06005857 std::stringstream ss;
5858 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06005859 << " is not in the same format compatibility class as "
5860 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06005861 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
5862 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005863 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005864 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06005865 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005866 }
5867 } else {
5868 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07005869 // Unless it is a multi-planar color bit aspect
5870 if ((image_format != view_format) &&
5871 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
sfricke-samsung45996a42021-09-16 13:45:27 -07005872 const char *vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
5873 ? "VUID-VkImageViewCreateInfo-image-01762"
5874 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07005875 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06005876 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07005877 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07005878 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07005879 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005880 }
5881 }
5882
ziga-lunargebb32de2021-08-29 21:24:30 +02005883 if (image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT && view_type != VK_IMAGE_VIEW_TYPE_2D &&
5884 view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5885 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04972",
5886 "vkCreateImageView(): image was created with sample count %s, but pCreateInfo->viewType is %s.",
5887 string_VkSampleCountFlagBits(image_state->createInfo.samples), string_VkImageViewType(view_type));
5888 }
5889
Mark Lobodzinski602de982017-02-09 11:01:33 -07005890 // Validate correct image aspect bits for desired formats and format consistency
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005891 skip |= ValidateImageAspectMask(image_state->image(), image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06005892
sfricke-samsung20a8a372021-07-14 06:12:17 -07005893 // Valdiate Image/ImageView type compatibility #resources-image-views-compatibility
Jeremy Kniager846ab732017-07-10 13:12:04 -06005894 switch (image_type) {
5895 case VK_IMAGE_TYPE_1D:
5896 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005897 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5898 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5899 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005900 }
5901 break;
5902 case VK_IMAGE_TYPE_2D:
5903 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5904 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
5905 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005906 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
5907 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5908 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005909 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005910 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5911 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5912 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005913 }
5914 }
5915 break;
5916 case VK_IMAGE_TYPE_3D:
sfricke-samsung45996a42021-09-16 13:45:27 -07005917 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06005918 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
5919 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
Tony-LunarGbe956362022-04-05 13:34:31 -06005920 if (device_extensions.vk_ext_image_2d_view_of_3d) {
5921 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT)) {
5922 if (view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5923 skip |= LogError(
5924 pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-06723",
5925 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type "
5926 "%s since the image doesn't have VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT flag set.",
5927 string_VkImageViewType(view_type), string_VkImageType(image_type));
5928 } else if (view_type == VK_IMAGE_VIEW_TYPE_2D &&
5929 !(image_flags & VK_IMAGE_CREATE_2D_VIEW_COMPATIBLE_BIT_EXT)) {
5930 skip |= LogError(
5931 pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-06728",
5932 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type "
5933 "%s since the image doesn't have VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT or "
5934 "VK_IMAGE_CREATE_2D_VIEW_COMPATIBLE_BIT_EXT flag set.",
5935 string_VkImageViewType(view_type), string_VkImageType(image_type));
5936 }
5937 }
5938 } else if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT) &&
5939 (view_type == VK_IMAGE_VIEW_TYPE_2D)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005940 skip |=
Tony-LunarGbe956362022-04-05 13:34:31 -06005941 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-06727",
5942 "vkCreateImageView(): pCreateInfo->viewType VK_IMAGE_VIEW_TYPE_2D is not compatible "
5943 "with image type "
sfricke-samsungd9b3e122021-07-15 22:50:00 -07005944 "%s since the image doesn't have VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT flag set.",
Tony-LunarGbe956362022-04-05 13:34:31 -06005945 string_VkImageType(image_type));
5946 }
5947 if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
Jeremy Kniager846ab732017-07-10 13:12:04 -06005948 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005949 skip |= LogError(
sfricke-samsungd9b3e122021-07-15 22:50:00 -07005950 pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04971",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005951 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
5952 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
5953 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
5954 string_VkImageViewType(view_type), string_VkImageType(image_type));
sfricke-samsungd9b3e122021-07-15 22:50:00 -07005955 } else if (pCreateInfo->subresourceRange.levelCount != 1) {
5956 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04970",
5957 "vkCreateImageView(): pCreateInfo->viewType %s is with image type %s must have a "
5958 "levelCount of 1 but it is %u.",
5959 string_VkImageViewType(view_type), string_VkImageType(image_type),
5960 pCreateInfo->subresourceRange.levelCount);
Jeremy Kniager846ab732017-07-10 13:12:04 -06005961 }
5962 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005963 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5964 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5965 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005966 }
5967 }
5968 } else {
5969 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
sfricke-samsungd9b3e122021-07-15 22:50:00 -07005970 // Help point to VK_KHR_maintenance1
5971 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
5972 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5973 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
5974 "without VK_KHR_maintenance1 enabled which was promoted in Vulkan 1.0.",
5975 string_VkImageViewType(view_type), string_VkImageType(image_type));
5976 } else {
5977 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5978 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5979 string_VkImageViewType(view_type), string_VkImageType(image_type));
5980 }
Jeremy Kniager846ab732017-07-10 13:12:04 -06005981 }
5982 }
5983 break;
5984 default:
5985 break;
5986 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005987
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005988 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
sfricke-samsung45996a42021-09-16 13:45:27 -07005989 if (IsExtEnabled(device_extensions.vk_android_external_memory_android_hardware_buffer)) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005990 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005991 }
5992
Jeremy Gebben9f537102021-10-05 16:37:12 -06005993 skip |= ValidateImageViewFormatFeatures(image_state.get(), view_format, image_usage);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005994
sfricke-samsung828e59d2021-08-22 23:20:49 -07005995 if (enabled_features.shading_rate_image_features.shadingRateImage) {
Tobias Hector6663c9b2020-11-05 10:18:02 +00005996 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
5997 if (view_format != VK_FORMAT_R8_UINT) {
5998 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
5999 "vkCreateImageView() If image was created with usage containing "
6000 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
6001 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05006002 }
Tobias Hector6663c9b2020-11-05 10:18:02 +00006003 }
6004
sfricke-samsung828e59d2021-08-22 23:20:49 -07006005 if (enabled_features.shading_rate_image_features.shadingRateImage ||
Tobias Hector6663c9b2020-11-05 10:18:02 +00006006 enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
6007 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) {
6008 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
6009 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
6010 "vkCreateImageView() If image was created with usage containing "
6011 "VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR, viewType must be "
6012 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
6013 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05006014 }
6015 }
Jeff Bolz99e3f632020-03-24 22:59:22 -05006016
Tobias Hector6663c9b2020-11-05 10:18:02 +00006017 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate &&
6018 !phys_dev_ext_props.fragment_shading_rate_props.layeredShadingRateAttachments &&
sfricke-samsung20a8a372021-07-14 06:12:17 -07006019 image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR && layer_count != 1) {
Tobias Hector6663c9b2020-11-05 10:18:02 +00006020 skip |= LogError(device, "VUID-VkImageViewCreateInfo-usage-04551",
6021 "vkCreateImageView(): subresourceRange.layerCount is %u for a shading rate attachment image view.",
sfricke-samsung20a8a372021-07-14 06:12:17 -07006022 layer_count);
Tobias Hector6663c9b2020-11-05 10:18:02 +00006023 }
6024
sfricke-samsung20a8a372021-07-14 06:12:17 -07006025 if (layer_count == VK_REMAINING_ARRAY_LAYERS) {
6026 const uint32_t remaining_layers = image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer;
6027 if (view_type == VK_IMAGE_VIEW_TYPE_CUBE && remaining_layers != 6) {
Jeff Bolz99e3f632020-03-24 22:59:22 -05006028 skip |= LogError(device, "VUID-VkImageViewCreateInfo-viewType-02962",
6029 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be 6",
sfricke-samsung20a8a372021-07-14 06:12:17 -07006030 remaining_layers);
Jeff Bolz99e3f632020-03-24 22:59:22 -05006031 }
sfricke-samsung20a8a372021-07-14 06:12:17 -07006032 if (view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY && ((remaining_layers) % 6) != 0) {
Jeff Bolz99e3f632020-03-24 22:59:22 -05006033 skip |= LogError(
6034 device, "VUID-VkImageViewCreateInfo-viewType-02963",
6035 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be a multiple of 6",
sfricke-samsung20a8a372021-07-14 06:12:17 -07006036 remaining_layers);
6037 }
6038 if ((remaining_layers != 1) && ((view_type == VK_IMAGE_VIEW_TYPE_1D) || (view_type == VK_IMAGE_VIEW_TYPE_2D) ||
6039 (view_type == VK_IMAGE_VIEW_TYPE_3D))) {
6040 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-imageViewType-04974",
6041 "vkCreateImageView(): Using pCreateInfo->viewType %s and the subresourceRange.layerCount "
6042 "VK_REMAINING_ARRAY_LAYERS=(%d) and must 1 (try looking into VK_IMAGE_VIEW_TYPE_*_ARRAY).",
6043 string_VkImageViewType(view_type), remaining_layers);
6044 }
6045 } else {
6046 if ((layer_count != 1) && ((view_type == VK_IMAGE_VIEW_TYPE_1D) || (view_type == VK_IMAGE_VIEW_TYPE_2D) ||
6047 (view_type == VK_IMAGE_VIEW_TYPE_3D))) {
6048 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-imageViewType-04973",
ziga-lunargc9d29f72022-05-15 19:55:08 +02006049 "vkCreateImageView(): subresourceRange.layerCount (%" PRIu32
6050 ") must be 1 when using viewType %s (try looking into VK_IMAGE_VIEW_TYPE_*_ARRAY).",
6051 layer_count, string_VkImageViewType(view_type));
Jeff Bolz99e3f632020-03-24 22:59:22 -05006052 }
6053 }
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006054
6055 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
ziga-lunarga77a2832022-05-03 11:12:00 +02006056 const auto normalized_subresource_range = image_state->NormalizeSubresourceRange(pCreateInfo->subresourceRange);
6057 if (normalized_subresource_range.levelCount != 1) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06006058 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02571",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006059 "vkCreateImageView(): If image was created with usage containing "
6060 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, subresourceRange.levelCount (%d) must: be 1",
6061 pCreateInfo->subresourceRange.levelCount);
6062 }
6063 }
6064 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
6065 if (!enabled_features.fragment_density_map_features.fragmentDensityMapDynamic) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06006066 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-02572",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006067 "vkCreateImageView(): If the fragmentDensityMapDynamic feature is not enabled, "
6068 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
6069 }
6070 } else {
6071 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
6072 if (image_flags & (VK_IMAGE_CREATE_PROTECTED_BIT | VK_IMAGE_CREATE_SPARSE_BINDING_BIT |
6073 VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT)) {
Shannon McPherson8d0d1f92020-07-06 11:58:21 -06006074 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-04116",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006075 "vkCreateImageView(): If image was created with usage containing "
6076 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT flags must not contain any of "
6077 "VK_IMAGE_CREATE_PROTECTED_BIT, VK_IMAGE_CREATE_SPARSE_BINDING_BIT, "
6078 "VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or VK_IMAGE_CREATE_SPARSE_ALIASED_BIT");
6079 }
6080 }
6081 }
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07006082
ziga-lunarg966ac0e2021-07-18 11:51:44 +02006083 if (image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
6084 if (pCreateInfo->subresourceRange.levelCount != 1) {
6085 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01584",
6086 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit, "
6087 "but subresourcesRange.levelCount (%" PRIu32 ") is not 1.",
6088 pCreateInfo->subresourceRange.levelCount);
6089 }
6090 if (pCreateInfo->subresourceRange.layerCount != 1) {
6091 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01584",
6092 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit, "
6093 "but subresourcesRange.layerCount (%" PRIu32 ") is not 1.",
6094 pCreateInfo->subresourceRange.layerCount);
6095 }
ziga-lunarg966ac0e2021-07-18 11:51:44 +02006096
sfricke-samsungd750f812022-02-04 10:23:34 -08006097 if (!FormatIsCompressed(view_format) && pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_3D) {
6098 skip |=
6099 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04739",
ziga-lunargc290c7f2021-07-31 22:01:46 +02006100 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit and "
6101 "non-compressed format (%s), but pCreateInfo->viewType is VK_IMAGE_VIEW_TYPE_3D.",
6102 string_VkFormat(image_format));
sfricke-samsungd750f812022-02-04 10:23:34 -08006103 }
6104
6105 const bool class_compatible = FormatCompatibilityClass(view_format) == FormatCompatibilityClass(image_format);
6106 // "uncompressed format that is size-compatible" so if compressed, same as not being compatible
6107 const bool size_compatible =
6108 FormatIsCompressed(view_format) ? false : FormatElementSize(view_format) == FormatElementSize(image_format);
6109 if (!class_compatible && !size_compatible) {
6110 skip |=
6111 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01583",
6112 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit and "
6113 "format (%s), but pCreateInfo->format (%s) are not compatible.",
6114 string_VkFormat(image_format), string_VkFormat(view_format));
6115 }
ziga-lunargc290c7f2021-07-31 22:01:46 +02006116 }
6117
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02006118 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT) {
6119 if (!enabled_features.fragment_density_map2_features.fragmentDensityMapDeferred) {
6120 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03567",
6121 "vkCreateImageView(): If the fragmentDensityMapDeferred feature is not enabled, "
6122 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT");
6123 }
6124 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
6125 skip |=
6126 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03568",
6127 "vkCreateImageView(): If flags contains VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT, "
6128 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
6129 }
6130 }
sfricke-samsung45996a42021-09-16 13:45:27 -07006131 if (IsExtEnabled(device_extensions.vk_ext_fragment_density_map2)) {
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02006132 if ((image_flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) && (image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) &&
sfricke-samsung20a8a372021-07-14 06:12:17 -07006133 (layer_count > phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers)) {
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02006134 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-03569",
6135 "vkCreateImageView(): If image was created with flags containing "
6136 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT and usage containing VK_IMAGE_USAGE_SAMPLED_BIT "
6137 "subresourceRange.layerCount (%d) must: be less than or equal to maxSubsampledArrayLayers (%d)",
sfricke-samsung20a8a372021-07-14 06:12:17 -07006138 layer_count, phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers);
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02006139 }
6140 }
6141
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07006142 auto astc_decode_mode = LvlFindInChain<VkImageViewASTCDecodeModeEXT>(pCreateInfo->pNext);
sfricke-samsung45996a42021-09-16 13:45:27 -07006143 if (IsExtEnabled(device_extensions.vk_ext_astc_decode_mode) && (astc_decode_mode != nullptr)) {
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07006144 if ((enabled_features.astc_decode_features.decodeModeSharedExponent == VK_FALSE) &&
6145 (astc_decode_mode->decodeMode == VK_FORMAT_E5B9G9R9_UFLOAT_PACK32)) {
6146 skip |= LogError(device, "VUID-VkImageViewASTCDecodeModeEXT-decodeMode-02231",
6147 "vkCreateImageView(): decodeModeSharedExponent is not enabled but "
6148 "VkImageViewASTCDecodeModeEXT::decodeMode is VK_FORMAT_E5B9G9R9_UFLOAT_PACK32.");
6149 }
6150 }
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07006151
sfricke-samsung45996a42021-09-16 13:45:27 -07006152 if (IsExtEnabled(device_extensions.vk_khr_portability_subset)) {
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07006153 // If swizzling is disabled, make sure it isn't used
Nathaniel Cesario17d057e2021-06-21 22:58:45 -06006154 // NOTE: as of spec version 1.2.183, VUID 04465 states: "all elements of components _must_ be
6155 // VK_COMPONENT_SWIZZLE_IDENTITY."
6156 // However, issue https://github.com/KhronosGroup/Vulkan-Portability/issues/27 points out that the identity can
6157 // also be defined via R, G, B, A enums in the correct order.
6158 // Spec change is at https://gitlab.khronos.org/vulkan/vulkan/-/merge_requests/4600
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07006159 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatSwizzle) &&
Nathaniel Cesario17d057e2021-06-21 22:58:45 -06006160 !IsIdentitySwizzle(pCreateInfo->components)) {
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07006161 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatSwizzle-04465",
6162 "vkCreateImageView (portability error): swizzle is disabled for this device.");
6163 }
6164
6165 // Ensure ImageView's format has the same number of bits and components as Image's format if format reinterpretation is
6166 // disabled
6167 // TODO (ncesario): This is not correct for some cases (e.g., VK_FORMAT_B10G11R11_UFLOAT_PACK32 and
6168 // VK_FORMAT_E5B9G9R9_UFLOAT_PACK32), but requires additional information that should probably be generated from the
6169 // spec. See Github issue #2361.
6170 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatReinterpretation) &&
6171 ((FormatElementSize(pCreateInfo->format, VK_IMAGE_ASPECT_COLOR_BIT) !=
6172 FormatElementSize(image_state->createInfo.format, VK_IMAGE_ASPECT_COLOR_BIT)) ||
sfricke-samsunged028b02021-09-06 23:14:51 -07006173 (FormatComponentCount(pCreateInfo->format) != FormatComponentCount(image_state->createInfo.format)))) {
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07006174 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatReinterpretation-04466",
6175 "vkCreateImageView (portability error): ImageView format must have"
6176 " the same number of components and bits per component as the Image's format");
6177 }
6178 }
Tony-LunarG69604c42021-11-22 16:00:12 -07006179
6180 auto image_view_min_lod = LvlFindInChain<VkImageViewMinLodCreateInfoEXT>(pCreateInfo->pNext);
6181 if (image_view_min_lod) {
6182 if ((!enabled_features.image_view_min_lod_features.minLod) && (image_view_min_lod->minLod != 0)) {
6183 skip |= LogError(device, "VUID-VkImageViewMinLodCreateInfoEXT-minLod-06455",
6184 "vkCreateImageView(): VkImageViewMinLodCreateInfoEXT::minLod = %f, but the minLod feature is not "
6185 "enabled. If the minLod feature is not enabled, minLod must be 0.0",
6186 image_view_min_lod->minLod);
6187 }
6188 auto max_level = (pCreateInfo->subresourceRange.baseMipLevel + (pCreateInfo->subresourceRange.levelCount - 1));
6189 if (image_view_min_lod->minLod > max_level) {
6190 skip |= LogError(device, "VUID-VkImageViewMinLodCreateInfoEXT-minLod-06456",
6191 "vkCreateImageView(): minLod (%f) must be less or equal to the index of the last mipmap level "
6192 "accessible to the view (%" PRIu32 ")",
6193 image_view_min_lod->minLod, max_level);
6194 }
6195 }
sfricke-samsung0dae8952022-03-03 20:34:23 -06006196
6197 if (FormatRequiresYcbcrConversionExplicitly(view_format)) {
6198 const auto ycbcr_conversion = LvlFindInChain<VkSamplerYcbcrConversionInfo>(pCreateInfo->pNext);
6199 if (!ycbcr_conversion || ycbcr_conversion->conversion == VK_NULL_HANDLE) {
6200 skip |= LogError(
6201 device, "VUID-VkImageViewCreateInfo-format-06415",
6202 "vkCreateImageView(): Format %s requires a VkSamplerYcbcrConversion but one was not passed in the pNext chain.",
6203 string_VkFormat(view_format));
6204 }
6205 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07006206 }
6207 return skip;
6208}
6209
Jeff Leger178b1e52020-10-05 12:22:23 -04006210template <typename RegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006211bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
Tony-LunarGef035472021-11-02 10:23:33 -06006212 uint32_t regionCount, const RegionType *pRegions, CMD_TYPE cmd_type) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006213 bool skip = false;
Tony-LunarGef035472021-11-02 10:23:33 -06006214 const bool is_2 = (cmd_type == CMD_COPYBUFFER2KHR || cmd_type == CMD_COPYBUFFER2);
6215 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04006216 const char *vuid;
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006217
6218 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
6219 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006220
6221 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006222 const RegionType region = pRegions[i];
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006223
6224 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
sfricke-samsung71f04e32022-03-16 01:21:21 -05006225 if (region.srcOffset >= src_buffer_size) {
Tony-LunarGef035472021-11-02 10:23:33 -06006226 vuid = is_2 ? "VUID-VkCopyBufferInfo2-srcOffset-00113" : "VUID-vkCmdCopyBuffer-srcOffset-00113";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006227 skip |= LogError(src_buffer_state->buffer(), vuid,
ziga-lunargd6b58ce2021-10-16 01:22:56 +02006228 "%s: pRegions[%" PRIu32 "].srcOffset (%" PRIuLEAST64
6229 ") is greater than size of srcBuffer (%" PRIuLEAST64 ").",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006230 func_name, i, region.srcOffset, src_buffer_size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006231 }
6232
6233 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
sfricke-samsung71f04e32022-03-16 01:21:21 -05006234 if (region.dstOffset >= dst_buffer_size) {
Tony-LunarGef035472021-11-02 10:23:33 -06006235 vuid = is_2 ? "VUID-VkCopyBufferInfo2-dstOffset-00114" : "VUID-vkCmdCopyBuffer-dstOffset-00114";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006236 skip |= LogError(dst_buffer_state->buffer(), vuid,
ziga-lunargd6b58ce2021-10-16 01:22:56 +02006237 "%s: pRegions[%" PRIu32 "].dstOffset (%" PRIuLEAST64
6238 ") is greater than size of dstBuffer (%" PRIuLEAST64 ").",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006239 func_name, i, region.dstOffset, dst_buffer_size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006240 }
6241
6242 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
sfricke-samsung71f04e32022-03-16 01:21:21 -05006243 if (region.size > (src_buffer_size - region.srcOffset)) {
Tony-LunarGef035472021-11-02 10:23:33 -06006244 vuid = is_2 ? "VUID-VkCopyBufferInfo2-size-00115" : "VUID-vkCmdCopyBuffer-size-00115";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006245 skip |= LogError(src_buffer_state->buffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006246 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the source buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006247 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006248 func_name, i, region.size, src_buffer_size, i, region.srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006249 }
6250
6251 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
sfricke-samsung71f04e32022-03-16 01:21:21 -05006252 if (region.size > (dst_buffer_size - region.dstOffset)) {
Tony-LunarGef035472021-11-02 10:23:33 -06006253 vuid = is_2 ? "VUID-VkCopyBufferInfo2-size-00116" : "VUID-vkCmdCopyBuffer-size-00116";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006254 skip |= LogError(dst_buffer_state->buffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006255 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the destination buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006256 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006257 func_name, i, region.size, dst_buffer_size, i, region.dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006258 }
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006259
aitor-lunargb66a5fa2022-04-20 00:15:31 +02006260 // Perf improvement potential here
ziga-lunargb94ff002022-03-23 23:30:19 +01006261 // The union of the source regions, and the union of the destination regions, must not overlap in memory
aitor-lunarg26fbbc22022-04-22 18:42:08 +02006262 if (src_buffer_state->buffer() == dst_buffer_state->buffer()) {
6263 VkDeviceSize src_min = region.srcOffset;
6264 VkDeviceSize src_max = region.srcOffset + region.size;
6265 for (uint32_t j = 0; j < regionCount; j++) {
6266 VkDeviceSize dst_min = pRegions[j].dstOffset;
6267 VkDeviceSize dst_max = pRegions[j].dstOffset + region.size;
6268 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max)) ||
6269 ((src_min == dst_min && src_max == dst_max))) {
6270 vuid = is_2 ? "VUID-VkCopyBufferInfo2-pRegions-00117" : "VUID-vkCmdCopyBuffer-pRegions-00117";
6271 skip |= LogError(src_buffer_state->buffer(), vuid,
6272 "%s: Detected overlap between source and dest regions in memory.", func_name);
6273 }
ziga-lunargb94ff002022-03-23 23:30:19 +01006274 }
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006275 }
6276 }
6277
ziga-lunargb94ff002022-03-23 23:30:19 +01006278
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006279 return skip;
6280}
sfricke-samsung11813ab2021-10-20 14:53:37 -07006281template <typename RegionType>
6282bool CoreChecks::ValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer, uint32_t regionCount,
Tony-LunarGef035472021-11-02 10:23:33 -06006283 const RegionType *pRegions, CMD_TYPE cmd_type) const {
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07006284 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07006285 auto src_buffer_state = Get<BUFFER_STATE>(srcBuffer);
6286 auto dst_buffer_state = Get<BUFFER_STATE>(dstBuffer);
Tony-LunarGef035472021-11-02 10:23:33 -06006287 const bool is_2 = (cmd_type == CMD_COPYBUFFER2KHR || cmd_type == CMD_COPYBUFFER2);
sfricke-samsung11813ab2021-10-20 14:53:37 -07006288 const char *func_name = CommandTypeString(cmd_type);
6289 const char *vuid;
6290
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006291 bool skip = false;
Tony-LunarGef035472021-11-02 10:23:33 -06006292 vuid = is_2 ? "VUID-VkCopyBufferInfo2-srcBuffer-00119" : "VUID-vkCmdCopyBuffer-srcBuffer-00119";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006293 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state.get(), func_name, vuid);
Tony-LunarGef035472021-11-02 10:23:33 -06006294 vuid = is_2 ? "VUID-VkCopyBufferInfo2-dstBuffer-00121" : "VUID-vkCmdCopyBuffer-dstBuffer-00121";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006295 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state.get(), func_name, vuid);
sfricke-samsung11813ab2021-10-20 14:53:37 -07006296
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006297 // Validate that SRC & DST buffers have correct usage flags set
Tony-LunarGef035472021-11-02 10:23:33 -06006298 vuid = is_2 ? "VUID-VkCopyBufferInfo2-srcBuffer-00118" : "VUID-vkCmdCopyBuffer-srcBuffer-00118";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006299 skip |= ValidateBufferUsageFlags(src_buffer_state.get(), VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
sfricke-samsung11813ab2021-10-20 14:53:37 -07006300 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Tony-LunarGef035472021-11-02 10:23:33 -06006301 vuid = is_2 ? "VUID-VkCopyBufferInfo2-dstBuffer-00120" : "VUID-vkCmdCopyBuffer-dstBuffer-00120";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006302 skip |= ValidateBufferUsageFlags(dst_buffer_state.get(), VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
sfricke-samsung11813ab2021-10-20 14:53:37 -07006303 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
6304
Jeremy Gebben9f537102021-10-05 16:37:12 -06006305 skip |= ValidateCmd(cb_node.get(), cmd_type);
Tony-LunarGef035472021-11-02 10:23:33 -06006306 skip |= ValidateCmdCopyBufferBounds(src_buffer_state.get(), dst_buffer_state.get(), regionCount, pRegions, cmd_type);
sfricke-samsung11813ab2021-10-20 14:53:37 -07006307
Tony-LunarGef035472021-11-02 10:23:33 -06006308 vuid = is_2 ? "VUID-vkCmdCopyBuffer2-commandBuffer-01822" : "VUID-vkCmdCopyBuffer-commandBuffer-01822";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006309 skip |= ValidateProtectedBuffer(cb_node.get(), src_buffer_state.get(), func_name, vuid);
Tony-LunarGef035472021-11-02 10:23:33 -06006310 vuid = is_2 ? "VUID-vkCmdCopyBuffer2-commandBuffer-01823" : "VUID-vkCmdCopyBuffer-commandBuffer-01823";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006311 skip |= ValidateProtectedBuffer(cb_node.get(), dst_buffer_state.get(), func_name, vuid);
Tony-LunarGef035472021-11-02 10:23:33 -06006312 vuid = is_2 ? "VUID-vkCmdCopyBuffer2-commandBuffer-01824" : "VUID-vkCmdCopyBuffer-commandBuffer-01824";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006313 skip |= ValidateUnprotectedBuffer(cb_node.get(), dst_buffer_state.get(), func_name, vuid);
Tony-LunarGef035472021-11-02 10:23:33 -06006314
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006315 return skip;
6316}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07006317
sfricke-samsung11813ab2021-10-20 14:53:37 -07006318bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
6319 uint32_t regionCount, const VkBufferCopy *pRegions) const {
Tony-LunarGef035472021-11-02 10:23:33 -06006320 return ValidateCmdCopyBuffer(commandBuffer, srcBuffer, dstBuffer, regionCount, pRegions, CMD_COPYBUFFER);
sfricke-samsung11813ab2021-10-20 14:53:37 -07006321}
6322
Jeff Leger178b1e52020-10-05 12:22:23 -04006323bool CoreChecks::PreCallValidateCmdCopyBuffer2KHR(VkCommandBuffer commandBuffer,
6324 const VkCopyBufferInfo2KHR *pCopyBufferInfos) const {
sfricke-samsung11813ab2021-10-20 14:53:37 -07006325 return ValidateCmdCopyBuffer(commandBuffer, pCopyBufferInfos->srcBuffer, pCopyBufferInfos->dstBuffer,
Tony-LunarGef035472021-11-02 10:23:33 -06006326 pCopyBufferInfos->regionCount, pCopyBufferInfos->pRegions, CMD_COPYBUFFER2KHR);
6327}
6328
6329bool CoreChecks::PreCallValidateCmdCopyBuffer2(VkCommandBuffer commandBuffer, const VkCopyBufferInfo2 *pCopyBufferInfos) const {
6330 return ValidateCmdCopyBuffer(commandBuffer, pCopyBufferInfos->srcBuffer, pCopyBufferInfos->dstBuffer,
6331 pCopyBufferInfos->regionCount, pCopyBufferInfos->pRegions, CMD_COPYBUFFER2);
Jeff Leger178b1e52020-10-05 12:22:23 -04006332}
6333
Jeff Bolz46c0ea02019-10-09 13:06:29 -05006334bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006335 bool skip = false;
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006336 auto buffer_state = Get<BUFFER_STATE>(buffer);
sfricke-samsung9c7d8552020-08-16 22:12:21 -07006337 if (buffer_state) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06006338 if (buffer_state->InUse()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006339 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
6340 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006341 }
6342 }
6343 return skip;
6344}
6345
Jeff Bolz5c801d12019-10-09 10:38:45 -05006346bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
6347 const VkAllocationCallbacks *pAllocator) const {
Jeremy Gebbenf4449392022-01-28 10:09:10 -07006348 auto image_view_state = Get<IMAGE_VIEW_STATE>(imageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07006349
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006350 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07006351 if (image_view_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06006352 skip |= ValidateObjectNotInUse(image_view_state.get(), "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006353 }
6354 return skip;
6355}
6356
Jeff Bolz5c801d12019-10-09 10:38:45 -05006357bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Jeremy Gebben9f537102021-10-05 16:37:12 -06006358 return ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006359}
6360
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006361bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006362 const VkAllocationCallbacks *pAllocator) const {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006363 auto buffer_view_state = Get<BUFFER_VIEW_STATE>(bufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006364 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07006365 if (buffer_view_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06006366 skip |= ValidateObjectNotInUse(buffer_view_state.get(), "vkDestroyBufferView", "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006367 }
6368 return skip;
6369}
6370
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006371bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006372 VkDeviceSize size, uint32_t data) const {
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07006373 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006374 auto buffer_state = Get<BUFFER_STATE>(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006375 bool skip = false;
Jeremy Gebben9f537102021-10-05 16:37:12 -06006376 skip |= ValidateMemoryIsBoundToBuffer(buffer_state.get(), "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
6377 skip |= ValidateCmd(cb_node.get(), CMD_FILLBUFFER);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006378 // Validate that DST buffer has correct usage flags set
Jeremy Gebben9f537102021-10-05 16:37:12 -06006379 skip |=
6380 ValidateBufferUsageFlags(buffer_state.get(), VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
6381 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006382
Jeremy Gebben9f537102021-10-05 16:37:12 -06006383 skip |=
6384 ValidateProtectedBuffer(cb_node.get(), buffer_state.get(), "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01811");
6385 skip |= ValidateUnprotectedBuffer(cb_node.get(), buffer_state.get(), "vkCmdFillBuffer()",
6386 "VUID-vkCmdFillBuffer-commandBuffer-01812");
sfricke-samsung022fa252020-07-24 03:26:16 -07006387
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006388 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006389 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
6390 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
6391 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
6392 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006393 }
6394
6395 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006396 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
6397 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
6398 ") minus dstOffset (0x%" PRIxLEAST64 ").",
6399 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006400 }
6401
sfricke-samsung45996a42021-09-16 13:45:27 -07006402 if (!IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06006403 skip |= ValidateCmdQueueFlags(cb_node.get(), "vkCmdFillBuffer()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
ziga-lunarg3c5c84e2021-08-04 15:18:56 +02006404 "VUID-vkCmdFillBuffer-commandBuffer-00030");
6405 }
6406
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006407 return skip;
6408}
6409
sfricke-samsung71f04e32022-03-16 01:21:21 -05006410template <typename RegionType>
6411bool CoreChecks::ValidateBufferImageCopyData(const CMD_BUFFER_STATE *cb_node, uint32_t regionCount, const RegionType *pRegions,
6412 const IMAGE_STATE *image_state, const char *function, CMD_TYPE cmd_type,
6413 bool image_to_buffer) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006414 bool skip = false;
Tony Barbour845d29b2021-11-09 11:43:14 -07006415 const bool is_2 = (cmd_type == CMD_COPYBUFFERTOIMAGE2KHR || cmd_type == CMD_COPYBUFFERTOIMAGE2);
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07006416 const char *vuid;
Jeff Leger178b1e52020-10-05 12:22:23 -04006417
sfricke-samsung125d2b42020-05-28 06:32:43 -07006418 assert(image_state != nullptr);
6419 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006420
6421 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006422 const RegionType region = pRegions[i];
6423 const VkImageAspectFlags region_aspect_mask = region.imageSubresource.aspectMask;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006424 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006425 if ((region.imageOffset.y != 0) || (region.imageExtent.height != 1)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006426 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00199", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006427 "%s: pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
6428 "and 1, respectively.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006429 function, i, region.imageOffset.y, region.imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006430 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006431 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006432
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006433 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006434 if ((region.imageOffset.z != 0) || (region.imageExtent.depth != 1)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006435 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00201", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006436 "%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 -07006437 "must be 0 and 1, respectively.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006438 function, i, region.imageOffset.z, region.imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006439 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006440 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006441
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006442 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006443 if ((0 != region.imageSubresource.baseArrayLayer) || (1 != region.imageSubresource.layerCount)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006444 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00213", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006445 "%s: pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006446 "For 3D images these must be 0 and 1, respectively.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006447 function, i, region.imageSubresource.baseArrayLayer, region.imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006448 }
6449 }
6450
6451 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07006452 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
sfricke-samsung73e755c2021-09-30 08:34:57 -07006453 const uint32_t element_size =
6454 FormatIsDepthOrStencil(image_format) ? 0 : FormatElementSize(image_format, region_aspect_mask);
sfricke-samsung71f04e32022-03-16 01:21:21 -05006455 const VkDeviceSize bufferOffset = region.bufferOffset;
Locke497739c2019-03-08 11:50:47 -07006456
sfricke-samsung8feecc12021-01-23 03:28:38 -08006457 if (FormatIsDepthOrStencil(image_format)) {
6458 if (SafeModulo(bufferOffset, 4) != 0) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006459 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("04053", image_to_buffer, is_2),
sfricke-samsung8feecc12021-01-23 03:28:38 -08006460 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6461 " must be a multiple 4 if using a depth/stencil format (%s).",
6462 function, i, bufferOffset, string_VkFormat(image_format));
6463 }
6464 } else {
6465 // If not depth/stencil and not multi-plane
6466 if (!FormatIsMultiplane(image_format) && (SafeModulo(bufferOffset, element_size) != 0)) {
sfricke-samsung45996a42021-09-16 13:45:27 -07006467 vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
Tony Barbour845d29b2021-11-09 11:43:14 -07006468 ? GetBufferImageCopyCommandVUID("01558", image_to_buffer, is_2)
6469 : GetBufferImageCopyCommandVUID("00193", image_to_buffer, is_2);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006470 skip |= LogError(image_state->image(), vuid,
sfricke-samsung8feecc12021-01-23 03:28:38 -08006471 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6472 " must be a multiple of this format's texel size (%" PRIu32 ").",
6473 function, i, bufferOffset, element_size);
6474 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006475 }
6476
sfricke-samsung5f11b0e2022-03-22 14:12:15 -05006477 // Make sure not a empty region
6478 if (region.imageExtent.width == 0) {
6479 vuid = is_2 ? "VUID-VkBufferImageCopy2-imageExtent-06659" : "VUID-VkBufferImageCopy-imageExtent-06659";
6480 LogObjectList objlist(cb_node->commandBuffer());
6481 objlist.add(image_state->image());
6482 skip |=
6483 LogError(objlist, vuid, "%s: pRegion[%" PRIu32 "] extent.width must not be zero as empty copies are not allowed.",
6484 function, i);
6485 }
6486 if (region.imageExtent.height == 0) {
6487 vuid = is_2 ? "VUID-VkBufferImageCopy2-imageExtent-06660" : "VUID-VkBufferImageCopy-imageExtent-06660";
6488 LogObjectList objlist(cb_node->commandBuffer());
6489 objlist.add(image_state->image());
6490 skip |=
6491 LogError(objlist, vuid, "%s: pRegion[%" PRIu32 "] extent.height must not be zero as empty copies are not allowed.",
6492 function, i);
6493 }
6494 if (region.imageExtent.depth == 0) {
6495 vuid = is_2 ? "VUID-VkBufferImageCopy2-imageExtent-06661" : "VUID-VkBufferImageCopy-imageExtent-06661";
6496 LogObjectList objlist(cb_node->commandBuffer());
6497 objlist.add(image_state->image());
6498 skip |=
6499 LogError(objlist, vuid, "%s: pRegion[%" PRIu32 "] extent.depth must not be zero as empty copies are not allowed.",
6500 function, i);
6501 }
6502
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006503 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
sfricke-samsung71f04e32022-03-16 01:21:21 -05006504 if ((region.bufferRowLength != 0) && (region.bufferRowLength < region.imageExtent.width)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006505 vuid = (is_2) ? "VUID-VkBufferImageCopy2-bufferRowLength-00195" : "VUID-VkBufferImageCopy-bufferRowLength-00195";
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06006506 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006507 LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006508 "%s: pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006509 function, i, region.bufferRowLength, region.imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006510 }
6511
6512 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
sfricke-samsung71f04e32022-03-16 01:21:21 -05006513 if ((region.bufferImageHeight != 0) && (region.bufferImageHeight < region.imageExtent.height)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006514 vuid = (is_2) ? "VUID-VkBufferImageCopy2-bufferImageHeight-00196" : "VUID-VkBufferImageCopy-bufferImageHeight-00196";
Jeff Leger178b1e52020-10-05 12:22:23 -04006515 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006516 LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006517 "%s: pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006518 function, i, region.bufferImageHeight, region.imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006519 }
6520
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006521 // Calculate adjusted image extent, accounting for multiplane image factors
sfricke-samsung71f04e32022-03-16 01:21:21 -05006522 VkExtent3D adjusted_image_extent = image_state->GetSubresourceExtent(region.imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006523 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
sfricke-samsung71f04e32022-03-16 01:21:21 -05006524 if ((region.imageOffset.x < 0) || (region.imageOffset.x > static_cast<int32_t>(adjusted_image_extent.width)) ||
6525 ((region.imageOffset.x + static_cast<int32_t>(region.imageExtent.width)) >
Mark Lobodzinski72b1a222020-03-18 11:36:10 -06006526 static_cast<int32_t>(adjusted_image_extent.width))) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006527 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00197", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006528 "%s: Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006529 "zero or <= image subresource width (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006530 function, i, region.imageOffset.x, (region.imageOffset.x + region.imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006531 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006532 }
6533
6534 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
sfricke-samsung71f04e32022-03-16 01:21:21 -05006535 if ((region.imageOffset.y < 0) || (region.imageOffset.y > static_cast<int32_t>(adjusted_image_extent.height)) ||
6536 ((region.imageOffset.y + static_cast<int32_t>(region.imageExtent.height)) >
Mark Lobodzinski72b1a222020-03-18 11:36:10 -06006537 static_cast<int32_t>(adjusted_image_extent.height))) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006538 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00198", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006539 "%s: Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006540 "zero or <= image subresource height (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006541 function, i, region.imageOffset.y, (region.imageOffset.y + region.imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006542 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006543 }
6544
6545 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
sfricke-samsung71f04e32022-03-16 01:21:21 -05006546 if ((region.imageOffset.z < 0) || (region.imageOffset.z > static_cast<int32_t>(adjusted_image_extent.depth)) ||
6547 ((region.imageOffset.z + static_cast<int32_t>(region.imageExtent.depth)) >
Mark Lobodzinski72b1a222020-03-18 11:36:10 -06006548 static_cast<int32_t>(adjusted_image_extent.depth))) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006549 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00200", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006550 "%s: Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006551 "zero or <= image subresource depth (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006552 function, i, region.imageOffset.z, (region.imageOffset.z + region.imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006553 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006554 }
6555
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006556 // subresource aspectMask must have exactly 1 bit set
6557 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
sfricke-samsung125d2b42020-05-28 06:32:43 -07006558 std::bitset<num_bits> aspect_mask_bits(region_aspect_mask);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006559 if (aspect_mask_bits.count() != 1) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006560 vuid = (is_2) ? "VUID-VkBufferImageCopy2-aspectMask-00212" : "VUID-VkBufferImageCopy-aspectMask-00212";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006561 skip |= LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006562 "%s: aspectMasks for imageSubresource in pRegion[%d] must have only a single bit set.", function, i);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006563 }
6564
6565 // image subresource aspect bit must match format
sfricke-samsung125d2b42020-05-28 06:32:43 -07006566 if (!VerifyAspectsPresent(region_aspect_mask, image_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006567 skip |=
Tony Barbour845d29b2021-11-09 11:43:14 -07006568 LogError(image_state->image(), GetBufferImageCopyCommandVUID("00211", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006569 "%s: pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
6570 function, i, region_aspect_mask, image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006571 }
6572
6573 // Checks that apply only to compressed images
sfricke-samsung01da6312021-10-20 07:51:32 -07006574 if (FormatIsBlockedImage(image_format)) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006575 auto block_size = FormatTexelBlockExtent(image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006576
6577 // BufferRowLength must be a multiple of block width
sfricke-samsung71f04e32022-03-16 01:21:21 -05006578 if (SafeModulo(region.bufferRowLength, block_size.width) != 0) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006579 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00203", image_to_buffer, is_2),
sfricke-samsung01da6312021-10-20 07:51:32 -07006580 "%s: pRegion[%d] bufferRowLength (%d) must be a multiple of the blocked image's texel width (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006581 function, i, region.bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006582 }
6583
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006584 // BufferRowHeight must be a multiple of block height
sfricke-samsung71f04e32022-03-16 01:21:21 -05006585 if (SafeModulo(region.bufferImageHeight, block_size.height) != 0) {
sfricke-samsung01da6312021-10-20 07:51:32 -07006586 skip |=
Tony Barbour845d29b2021-11-09 11:43:14 -07006587 LogError(image_state->image(), GetBufferImageCopyCommandVUID("00204", image_to_buffer, is_2),
sfricke-samsung01da6312021-10-20 07:51:32 -07006588 "%s: pRegion[%d] bufferImageHeight (%d) must be a multiple of the blocked image's texel height (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006589 function, i, region.bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006590 }
6591
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006592 // image offsets must be multiples of block dimensions
sfricke-samsung71f04e32022-03-16 01:21:21 -05006593 if ((SafeModulo(region.imageOffset.x, block_size.width) != 0) ||
6594 (SafeModulo(region.imageOffset.y, block_size.height) != 0) ||
6595 (SafeModulo(region.imageOffset.z, block_size.depth) != 0)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006596 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00205", image_to_buffer, is_2),
sfricke-samsung01da6312021-10-20 07:51:32 -07006597 "%s: pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the blocked image's texel "
Petr Krausb0d5e592021-05-21 23:37:11 +02006598 "width & height (%d, %d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006599 function, i, region.imageOffset.x, region.imageOffset.y, block_size.width, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006600 }
6601
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006602 // bufferOffset must be a multiple of block size (linear bytes)
sfricke-samsung73e755c2021-09-30 08:34:57 -07006603 if (SafeModulo(bufferOffset, element_size) != 0) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006604 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00206", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006605 "%s: pRegion[%d] bufferOffset (0x%" PRIxLEAST64
sfricke-samsung01da6312021-10-20 07:51:32 -07006606 ") must be a multiple of the blocked image's texel block size (%" PRIu32 ").",
sfricke-samsung73e755c2021-09-30 08:34:57 -07006607 function, i, bufferOffset, element_size);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006608 }
Dave Houlton67e9b532017-03-02 17:00:10 -07006609
6610 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
sfricke-samsung71f04e32022-03-16 01:21:21 -05006611 VkExtent3D mip_extent = image_state->GetSubresourceExtent(region.imageSubresource);
6612 if ((SafeModulo(region.imageExtent.width, block_size.width) != 0) &&
6613 (region.imageExtent.width + region.imageOffset.x != mip_extent.width)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006614 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00207", image_to_buffer, is_2),
sfricke-samsung01da6312021-10-20 07:51:32 -07006615 "%s: pRegion[%d] extent width (%d) must be a multiple of the blocked texture block width "
Petr Krausb0d5e592021-05-21 23:37:11 +02006616 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006617 function, i, region.imageExtent.width, block_size.width, region.imageOffset.x, mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07006618 }
6619
6620 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
sfricke-samsung71f04e32022-03-16 01:21:21 -05006621 if ((SafeModulo(region.imageExtent.height, block_size.height) != 0) &&
6622 (region.imageExtent.height + region.imageOffset.y != mip_extent.height)) {
6623 skip |=
6624 LogError(image_state->image(), GetBufferImageCopyCommandVUID("00208", image_to_buffer, is_2),
6625 "%s: pRegion[%d] extent height (%d) must be a multiple of the blocked texture block height "
6626 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d).",
6627 function, i, region.imageExtent.height, block_size.height, region.imageOffset.y, mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07006628 }
6629
6630 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
sfricke-samsung71f04e32022-03-16 01:21:21 -05006631 if ((SafeModulo(region.imageExtent.depth, block_size.depth) != 0) &&
6632 (region.imageExtent.depth + region.imageOffset.z != mip_extent.depth)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006633 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00209", image_to_buffer, is_2),
sfricke-samsung01da6312021-10-20 07:51:32 -07006634 "%s: pRegion[%d] extent width (%d) must be a multiple of the blocked texture block depth "
Petr Krausb0d5e592021-05-21 23:37:11 +02006635 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006636 function, i, region.imageExtent.depth, block_size.depth, region.imageOffset.z, mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07006637 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006638 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08006639
6640 // Checks that apply only to multi-planar format images
sfricke-samsung125d2b42020-05-28 06:32:43 -07006641 if (FormatIsMultiplane(image_format)) {
sfricke-samsung552d5e12020-01-07 22:00:20 -08006642 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
sfricke-samsung125d2b42020-05-28 06:32:43 -07006643 if ((FormatPlaneCount(image_format) < 3) && (region_aspect_mask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006644 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006645 "%s: pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006646 "format has three planes.",
6647 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08006648 }
6649
6650 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
sfricke-samsung125d2b42020-05-28 06:32:43 -07006651 if (0 ==
6652 (region_aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT))) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006653 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006654 "%s: pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006655 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
6656 function, i);
sfricke-samsung125d2b42020-05-28 06:32:43 -07006657 } else {
6658 // Know aspect mask is valid
6659 const VkFormat compatible_format = FindMultiplaneCompatibleFormat(image_format, region_aspect_mask);
6660 const uint32_t compatible_size = FormatElementSize(compatible_format);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006661 if (SafeModulo(bufferOffset, compatible_size) != 0) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006662 skip |= LogError(
Tony Barbour845d29b2021-11-09 11:43:14 -07006663 image_state->image(), GetBufferImageCopyCommandVUID("01559", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006664 "%s: pRegion[%d]->bufferOffset is 0x%" PRIxLEAST64
sfricke-samsung125d2b42020-05-28 06:32:43 -07006665 " 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 -08006666 function, i, bufferOffset, element_size, GetPlaneIndex(region_aspect_mask),
sfricke-samsung125d2b42020-05-28 06:32:43 -07006667 string_VkFormat(compatible_format));
6668 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08006669 }
6670 }
sfricke-samsung8feecc12021-01-23 03:28:38 -08006671
6672 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
Jeremy Gebbencd7fa282021-10-27 10:25:32 -06006673 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool;
sfricke-samsung8feecc12021-01-23 03:28:38 -08006674 assert(command_pool != nullptr);
6675 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006676 const VkQueueFlags queue_flags = physical_device_state->queue_family_properties[queue_family_index].queueFlags;
sfricke-samsung8feecc12021-01-23 03:28:38 -08006677 if (((queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT)) == 0) && (SafeModulo(bufferOffset, 4) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006678 LogObjectList objlist(cb_node->commandBuffer());
6679 objlist.add(command_pool->commandPool());
sfricke-samsung4389faa2022-03-23 01:19:42 -05006680 objlist.add(image_state->image());
6681 skip |= LogError(objlist, GetBufferImageCopyCommandVUID("04052", image_to_buffer, is_2),
sfricke-samsung8feecc12021-01-23 03:28:38 -08006682 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6683 " must be a multiple 4 because the command buffer %s was allocated from the command pool %s "
6684 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT or "
6685 "VK_QUEUE_COMPUTE_BIT flag.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006686 function, i, bufferOffset, report_data->FormatHandle(cb_node->commandBuffer()).c_str(),
6687 report_data->FormatHandle(command_pool->commandPool()).c_str(), queue_family_index);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006688 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006689 }
6690
6691 return skip;
6692}
6693
sfricke-samsung71f04e32022-03-16 01:21:21 -05006694template <typename RegionType>
6695bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount, const RegionType *pRegions,
6696 const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006697 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006698 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006699
6700 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006701 const RegionType region = pRegions[i];
6702 VkExtent3D extent = region.imageExtent;
6703 VkOffset3D offset = region.imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006704
sfricke-samsung71f04e32022-03-16 01:21:21 -05006705 VkExtent3D image_extent = image_state->GetSubresourceExtent(region.imageSubresource);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006706
sfricke-samsung01da6312021-10-20 07:51:32 -07006707 // If we're using a blocked image format, valid extent is rounded up to multiple of block size (per
6708 // vkspec.html#_common_operation)
6709 if (FormatIsBlockedImage(image_info->format)) {
Dave Houltona585d132019-01-18 13:05:42 -07006710 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006711 if (image_extent.width % block_extent.width) {
6712 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
6713 }
6714 if (image_extent.height % block_extent.height) {
6715 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
6716 }
6717 if (image_extent.depth % block_extent.depth) {
6718 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
6719 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006720 }
6721
Dave Houltonfc1a4052017-04-27 14:32:45 -06006722 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Petr Krausb0d5e592021-05-21 23:37:11 +02006723 skip |= LogError(image_state->image(), msg_code, "%s: pRegion[%d] exceeds image bounds.", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006724 }
6725 }
6726
6727 return skip;
6728}
6729
sfricke-samsung71f04e32022-03-16 01:21:21 -05006730template <typename RegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006731bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
sfricke-samsung71f04e32022-03-16 01:21:21 -05006732 const RegionType *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006733 bool skip = false;
6734
sfricke-samsung11d15ba2021-09-30 09:19:56 -07006735 const VkDeviceSize buffer_size = buff_state->createInfo.size;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006736
6737 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006738 const RegionType region = pRegions[i];
6739 const VkDeviceSize buffer_copy_size = GetBufferSizeFromCopyImage(region, image_state->createInfo.format);
sfricke-samsung11d15ba2021-09-30 09:19:56 -07006740 // This blocks against invalid VkBufferCopyImage that already have been caught elsewhere
6741 if (buffer_copy_size != 0) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006742 const VkDeviceSize max_buffer_copy = buffer_copy_size + region.bufferOffset;
sfricke-samsung11d15ba2021-09-30 09:19:56 -07006743 if (buffer_size < max_buffer_copy) {
6744 skip |= LogError(device, msg_code,
6745 "%s: pRegion[%" PRIu32 "] is trying to copy %" PRIu64 " bytes plus %" PRIu64
6746 " offset to/from the VkBuffer (%s) which exceeds the VkBuffer total size of %" PRIu64 " bytes.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006747 func_name, i, buffer_copy_size, region.bufferOffset,
sfricke-samsung11d15ba2021-09-30 09:19:56 -07006748 report_data->FormatHandle(buff_state->buffer()).c_str(), buffer_size);
6749 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006750 }
6751 }
6752
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006753 return skip;
6754}
6755
sfricke-samsung71f04e32022-03-16 01:21:21 -05006756template <typename RegionType>
Jeff Leger178b1e52020-10-05 12:22:23 -04006757bool CoreChecks::ValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
sfricke-samsung71f04e32022-03-16 01:21:21 -05006758 VkBuffer dstBuffer, uint32_t regionCount, const RegionType *pRegions,
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006759
6760 CMD_TYPE cmd_type) const {
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07006761 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07006762 auto src_image_state = Get<IMAGE_STATE>(srcImage);
6763 auto dst_buffer_state = Get<BUFFER_STATE>(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006764
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006765 const bool is_2 = (cmd_type == CMD_COPYIMAGETOBUFFER2KHR || cmd_type == CMD_COPYIMAGETOBUFFER2);
sfricke-samsung85584a72021-09-30 21:43:38 -07006766 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04006767 const char *vuid;
6768
Tony Barbour845d29b2021-11-09 11:43:14 -07006769 bool skip = ValidateBufferImageCopyData(cb_node.get(), regionCount, pRegions, src_image_state.get(), func_name, cmd_type, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006770
6771 // Validate command buffer state
Jeremy Gebben9f537102021-10-05 16:37:12 -06006772 skip |= ValidateCmd(cb_node.get(), cmd_type);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006773
6774 // Command pool must support graphics, compute, or transfer operations
Jeremy Gebbencd7fa282021-10-27 10:25:32 -06006775 const auto pool = cb_node->command_pool;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006776
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006777 VkQueueFlags queue_flags = physical_device_state->queue_family_properties[pool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07006778
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006779 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006780 vuid = is_2 ? "VUID-vkCmdCopyImageToBuffer2-commandBuffer-cmdpool" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool";
Jeff Leger178b1e52020-10-05 12:22:23 -04006781 skip |= LogError(cb_node->createInfo.commandPool, vuid,
6782 "Cannot call %s on a command buffer allocated from a pool without graphics, compute, "
6783 "or transfer capabilities.",
6784 func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006785 }
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006786
6787 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-pRegions-00182" : "VUID-vkCmdCopyImageToBuffer-pRegions-06220";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006788 skip |= ValidateImageBounds(src_image_state.get(), regionCount, pRegions, func_name, vuid);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006789 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-pRegions-00183" : "VUID-vkCmdCopyImageToBuffer-pRegions-00183";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006790 skip |= ValidateBufferBounds(src_image_state.get(), dst_buffer_state.get(), regionCount, pRegions, func_name, vuid);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006791
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006792 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImage-00188" : "VUID-vkCmdCopyImageToBuffer-srcImage-00188";
6793 std::string location = func_name;
6794 location.append("() : srcImage");
6795 skip |= ValidateImageSampleCount(src_image_state.get(), VK_SAMPLE_COUNT_1_BIT, location.c_str(), vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04006796
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006797 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImage-00187" : "VUID-vkCmdCopyImageToBuffer-srcImage-00187";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006798 skip |= ValidateMemoryIsBoundToImage(src_image_state.get(), func_name, vuid);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006799 vuid = is_2 ? "vkCmdCopyImageToBuffer-dstBuffer2-00192" : "vkCmdCopyImageToBuffer dstBuffer-00192";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006800 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state.get(), func_name, vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006801
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006802 // Validate that SRC image & DST buffer have correct usage flags set
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006803 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImage-00186" : "VUID-vkCmdCopyImageToBuffer-srcImage-00186";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006804 skip |= ValidateImageUsageFlags(src_image_state.get(), VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006805 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006806 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-dstBuffer-00191" : "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006807 skip |= ValidateBufferUsageFlags(dst_buffer_state.get(), VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006808 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006809 vuid = is_2 ? "VUID-vkCmdCopyImageToBuffer2-commandBuffer-01831" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01831";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006810 skip |= ValidateProtectedImage(cb_node.get(), src_image_state.get(), func_name, vuid);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006811 vuid = is_2 ? "VUID-vkCmdCopyImageToBuffer2-commandBuffer-01832" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01832";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006812 skip |= ValidateProtectedBuffer(cb_node.get(), dst_buffer_state.get(), func_name, vuid);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006813 vuid = is_2 ? "VUID-vkCmdCopyImageToBuffer2-commandBuffer-01833" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01833";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006814 skip |= ValidateUnprotectedBuffer(cb_node.get(), dst_buffer_state.get(), func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006815
6816 // Validation for VK_EXT_fragment_density_map
6817 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006818 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImage-02544" : "VUID-vkCmdCopyImageToBuffer-srcImage-02544";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006819 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006820 "%s: srcImage must not have been created with flags containing "
6821 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
6822 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006823 }
6824
sfricke-samsung45996a42021-09-16 13:45:27 -07006825 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006826 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImage-01998" : "VUID-vkCmdCopyImageToBuffer-srcImage-01998";
6827 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(), VK_FORMAT_FEATURE_2_TRANSFER_SRC_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04006828 }
Tobin Ehlisc8266452017-04-07 12:20:30 -06006829 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04006830
sfricke-samsung45996a42021-09-16 13:45:27 -07006831 const char *src_invalid_layout_vuid =
6832 (src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006833 ? (vuid =
6834 is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImageLayout-01397" : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397")
6835 : (vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImageLayout-00190"
6836 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190");
Jeff Leger178b1e52020-10-05 12:22:23 -04006837
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006838 for (uint32_t i = 0; i < regionCount; ++i) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006839 const RegionType region = pRegions[i];
6840 skip |= ValidateImageSubresourceLayers(cb_node.get(), &region.imageSubresource, func_name, "imageSubresource", i);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006841 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImageLayout-00189" : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189";
sfricke-samsung71f04e32022-03-16 01:21:21 -05006842 skip |= VerifyImageLayout(cb_node.get(), src_image_state.get(), region.imageSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04006843 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, src_invalid_layout_vuid, vuid, &hit_error);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006844 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-imageOffset-01794" : "VUID-vkCmdCopyImageToBuffer-imageOffset-01794";
sfricke-samsung71f04e32022-03-16 01:21:21 -05006845 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node.get(), src_image_state.get(), &region, i, func_name,
6846 vuid);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006847 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-imageSubresource-01703" : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703";
sfricke-samsung71f04e32022-03-16 01:21:21 -05006848 skip |= ValidateImageMipLevel(cb_node.get(), src_image_state.get(), region.imageSubresource.mipLevel, i, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04006849 "imageSubresource", vuid);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006850 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-imageSubresource-01704" : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704";
sfricke-samsung71f04e32022-03-16 01:21:21 -05006851 skip |= ValidateImageArrayLayerRange(cb_node.get(), src_image_state.get(), region.imageSubresource.baseArrayLayer,
6852 region.imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006853 }
6854 return skip;
6855}
6856
Jeff Leger178b1e52020-10-05 12:22:23 -04006857bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6858 VkBuffer dstBuffer, uint32_t regionCount,
6859 const VkBufferImageCopy *pRegions) const {
6860 return ValidateCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions,
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006861 CMD_COPYIMAGETOBUFFER);
Jeff Leger178b1e52020-10-05 12:22:23 -04006862}
6863
6864bool CoreChecks::PreCallValidateCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
6865 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) const {
6866 return ValidateCmdCopyImageToBuffer(commandBuffer, pCopyImageToBufferInfo->srcImage, pCopyImageToBufferInfo->srcImageLayout,
6867 pCopyImageToBufferInfo->dstBuffer, pCopyImageToBufferInfo->regionCount,
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006868 pCopyImageToBufferInfo->pRegions, CMD_COPYIMAGETOBUFFER2KHR);
Jeff Leger178b1e52020-10-05 12:22:23 -04006869}
6870
Tony Barbour845d29b2021-11-09 11:43:14 -07006871bool CoreChecks::PreCallValidateCmdCopyImageToBuffer2(VkCommandBuffer commandBuffer,
6872 const VkCopyImageToBufferInfo2 *pCopyImageToBufferInfo) const {
6873 return ValidateCmdCopyImageToBuffer(commandBuffer, pCopyImageToBufferInfo->srcImage, pCopyImageToBufferInfo->srcImageLayout,
6874 pCopyImageToBufferInfo->dstBuffer, pCopyImageToBufferInfo->regionCount,
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006875 pCopyImageToBufferInfo->pRegions, CMD_COPYIMAGETOBUFFER2);
Tony Barbour845d29b2021-11-09 11:43:14 -07006876}
6877
John Zulauf1686f232019-07-09 16:27:11 -06006878void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6879 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
6880 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
6881
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07006882 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006883 auto src_image_state = Get<IMAGE_STATE>(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06006884 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006885 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06006886 cb_node->SetImageInitialLayout(*src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06006887 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006888}
6889
Jeff Leger178b1e52020-10-05 12:22:23 -04006890void CoreChecks::PreCallRecordCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
6891 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) {
6892 StateTracker::PreCallRecordCmdCopyImageToBuffer2KHR(commandBuffer, pCopyImageToBufferInfo);
6893
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07006894 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006895 auto src_image_state = Get<IMAGE_STATE>(pCopyImageToBufferInfo->srcImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04006896 // Make sure that all image slices record referenced layout
6897 for (uint32_t i = 0; i < pCopyImageToBufferInfo->regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06006898 cb_node->SetImageInitialLayout(*src_image_state, pCopyImageToBufferInfo->pRegions[i].imageSubresource,
6899 pCopyImageToBufferInfo->srcImageLayout);
Jeff Leger178b1e52020-10-05 12:22:23 -04006900 }
6901}
6902
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006903void CoreChecks::PreCallRecordCmdCopyImageToBuffer2(VkCommandBuffer commandBuffer,
6904 const VkCopyImageToBufferInfo2 *pCopyImageToBufferInfo) {
6905 StateTracker::PreCallRecordCmdCopyImageToBuffer2(commandBuffer, pCopyImageToBufferInfo);
6906
6907 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
6908 auto src_image_state = Get<IMAGE_STATE>(pCopyImageToBufferInfo->srcImage);
6909 // Make sure that all image slices record referenced layout
6910 for (uint32_t i = 0; i < pCopyImageToBufferInfo->regionCount; ++i) {
6911 cb_node->SetImageInitialLayout(*src_image_state, pCopyImageToBufferInfo->pRegions[i].imageSubresource,
6912 pCopyImageToBufferInfo->srcImageLayout);
6913 }
6914}
6915
Jeff Leger178b1e52020-10-05 12:22:23 -04006916template <typename RegionType>
6917bool CoreChecks::ValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6918 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
Tony Barbour845d29b2021-11-09 11:43:14 -07006919 CMD_TYPE cmd_type) const {
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07006920 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07006921 auto src_buffer_state = Get<BUFFER_STATE>(srcBuffer);
6922 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006923
Tony Barbour845d29b2021-11-09 11:43:14 -07006924 const bool is_2 = (cmd_type == CMD_COPYBUFFERTOIMAGE2KHR || cmd_type == CMD_COPYBUFFERTOIMAGE2);
sfricke-samsung85584a72021-09-30 21:43:38 -07006925 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04006926 const char *vuid;
6927
Tony Barbour845d29b2021-11-09 11:43:14 -07006928 bool skip =
6929 ValidateBufferImageCopyData(cb_node.get(), regionCount, pRegions, dst_image_state.get(), func_name, cmd_type, false);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006930
6931 // Validate command buffer state
Jeremy Gebben9f537102021-10-05 16:37:12 -06006932 skip |= ValidateCmd(cb_node.get(), cmd_type);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006933
Tony Barbour845d29b2021-11-09 11:43:14 -07006934 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-pRegions-00172" : "VUID-vkCmdCopyBufferToImage-pRegions-06217";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006935 skip |= ValidateImageBounds(dst_image_state.get(), regionCount, pRegions, func_name, vuid);
Tony Barbour845d29b2021-11-09 11:43:14 -07006936 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-pRegions-00171" : "VUID-vkCmdCopyBufferToImage-pRegions-00171";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006937 skip |= ValidateBufferBounds(dst_image_state.get(), src_buffer_state.get(), regionCount, pRegions, func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04006938
Tony Barbour845d29b2021-11-09 11:43:14 -07006939 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImage-00179" : "VUID-vkCmdCopyBufferToImage-dstImage-00179";
6940 std::string location = func_name;
6941 location.append("() : dstImage");
6942 skip |= ValidateImageSampleCount(dst_image_state.get(), VK_SAMPLE_COUNT_1_BIT, location.c_str(), vuid);
6943 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-srcBuffer-00176" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00176";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006944 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state.get(), func_name, vuid);
Tony Barbour845d29b2021-11-09 11:43:14 -07006945 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImage-00178" : "VUID-vkCmdCopyBufferToImage-dstImage-00178";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006946 skip |= ValidateMemoryIsBoundToImage(dst_image_state.get(), func_name, vuid);
Tony Barbour845d29b2021-11-09 11:43:14 -07006947 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-srcBuffer-00174" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00174";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006948 skip |= ValidateBufferUsageFlags(src_buffer_state.get(), VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006949 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Tony Barbour845d29b2021-11-09 11:43:14 -07006950 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImage-00177" : "VUID-vkCmdCopyBufferToImage-dstImage-00177";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006951 skip |= ValidateImageUsageFlags(dst_image_state.get(), VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006952 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Tony Barbour845d29b2021-11-09 11:43:14 -07006953 vuid = is_2 ? "VUID-vkCmdCopyBufferToImage2-commandBuffer-01828" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01828";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006954 skip |= ValidateProtectedBuffer(cb_node.get(), src_buffer_state.get(), func_name, vuid);
Tony Barbour845d29b2021-11-09 11:43:14 -07006955 vuid = is_2 ? "VUID-vkCmdCopyBufferToImage2-commandBuffer-01829" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01829";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006956 skip |= ValidateProtectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
Tony Barbour845d29b2021-11-09 11:43:14 -07006957 vuid = is_2 ? "VUID-vkCmdCopyBufferToImage-commandBuffer-01830" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01830";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006958 skip |= ValidateUnprotectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006959
6960 // Validation for VK_EXT_fragment_density_map
6961 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006962 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImage-02543" : "VUID-vkCmdCopyBufferToImage-dstImage-02543";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006963 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006964 "%s: dstImage must not have been created with flags containing "
6965 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
6966 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006967 }
6968
sfricke-samsung45996a42021-09-16 13:45:27 -07006969 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006970 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImage-01997" : "VUID-vkCmdCopyBufferToImage-dstImage-01997";
6971 skip |= ValidateImageFormatFeatureFlags(dst_image_state.get(), VK_FORMAT_FEATURE_2_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04006972 }
Tobin Ehlisc8266452017-04-07 12:20:30 -06006973 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04006974
sfricke-samsung45996a42021-09-16 13:45:27 -07006975 const char *dst_invalid_layout_vuid =
6976 (dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Tony Barbour845d29b2021-11-09 11:43:14 -07006977 ? (is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImageLayout-01396"
sfricke-samsung45996a42021-09-16 13:45:27 -07006978 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396")
Tony Barbour845d29b2021-11-09 11:43:14 -07006979 : (is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImageLayout-00181"
sfricke-samsung45996a42021-09-16 13:45:27 -07006980 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181");
Jeff Leger178b1e52020-10-05 12:22:23 -04006981
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006982 for (uint32_t i = 0; i < regionCount; ++i) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006983 const RegionType region = pRegions[i];
6984 skip |= ValidateImageSubresourceLayers(cb_node.get(), &region.imageSubresource, func_name, "imageSubresource", i);
Tony Barbour845d29b2021-11-09 11:43:14 -07006985 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImageLayout-00180" : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180";
sfricke-samsung71f04e32022-03-16 01:21:21 -05006986 skip |= VerifyImageLayout(cb_node.get(), dst_image_state.get(), region.imageSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04006987 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, dst_invalid_layout_vuid, vuid, &hit_error);
Tony Barbour845d29b2021-11-09 11:43:14 -07006988 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-imageOffset-01793" : "VUID-vkCmdCopyBufferToImage-imageOffset-01793";
sfricke-samsung71f04e32022-03-16 01:21:21 -05006989 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node.get(), dst_image_state.get(), &region, i, func_name,
6990 vuid);
Tony Barbour845d29b2021-11-09 11:43:14 -07006991 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-imageSubresource-01701" : "VUID-vkCmdCopyBufferToImage-imageSubresource-01701";
sfricke-samsung71f04e32022-03-16 01:21:21 -05006992 skip |= ValidateImageMipLevel(cb_node.get(), dst_image_state.get(), region.imageSubresource.mipLevel, i, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04006993 "imageSubresource", vuid);
Tony Barbour845d29b2021-11-09 11:43:14 -07006994 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-imageSubresource-01702" : "VUID-vkCmdCopyBufferToImage-imageSubresource-01702";
sfricke-samsung71f04e32022-03-16 01:21:21 -05006995 skip |= ValidateImageArrayLayerRange(cb_node.get(), dst_image_state.get(), region.imageSubresource.baseArrayLayer,
6996 region.imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
sfricke-samsungea4fd142020-10-17 23:51:59 -07006997
6998 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
Jeremy Gebbencd7fa282021-10-27 10:25:32 -06006999 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool;
sfricke-samsungea4fd142020-10-17 23:51:59 -07007000 assert(command_pool != nullptr);
7001 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06007002 const VkQueueFlags queue_flags = physical_device_state->queue_family_properties[queue_family_index].queueFlags;
sfricke-samsung71f04e32022-03-16 01:21:21 -05007003 const VkImageAspectFlags region_aspect_mask = region.imageSubresource.aspectMask;
sfricke-samsungea4fd142020-10-17 23:51:59 -07007004 if (((queue_flags & VK_QUEUE_GRAPHICS_BIT) == 0) &&
7005 ((region_aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06007006 LogObjectList objlist(cb_node->commandBuffer());
7007 objlist.add(command_pool->commandPool());
sfricke-samsung4389faa2022-03-23 01:19:42 -05007008 objlist.add(dst_image_state->image());
Tony Barbour845d29b2021-11-09 11:43:14 -07007009 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-commandBuffer-04477"
sfricke-samsungea4fd142020-10-17 23:51:59 -07007010 : "VUID-vkCmdCopyBufferToImage-commandBuffer-04477";
sfricke-samsung4389faa2022-03-23 01:19:42 -05007011 skip |= LogError(objlist, vuid,
sfricke-samsungea4fd142020-10-17 23:51:59 -07007012 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies VK_IMAGE_ASPECT_DEPTH_BIT or "
7013 "VK_IMAGE_ASPECT_STENCIL_BIT but the command buffer %s was allocated from the command pool %s "
7014 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT flag.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06007015 func_name, i, region_aspect_mask, report_data->FormatHandle(cb_node->commandBuffer()).c_str(),
7016 report_data->FormatHandle(command_pool->commandPool()).c_str(), queue_family_index);
sfricke-samsungea4fd142020-10-17 23:51:59 -07007017 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07007018 }
7019 return skip;
7020}
7021
Jeff Leger178b1e52020-10-05 12:22:23 -04007022bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
7023 VkImageLayout dstImageLayout, uint32_t regionCount,
7024 const VkBufferImageCopy *pRegions) const {
7025 return ValidateCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions,
Tony Barbour845d29b2021-11-09 11:43:14 -07007026 CMD_COPYBUFFERTOIMAGE);
Jeff Leger178b1e52020-10-05 12:22:23 -04007027}
7028
7029bool CoreChecks::PreCallValidateCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
7030 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo) const {
7031 return ValidateCmdCopyBufferToImage(commandBuffer, pCopyBufferToImageInfo->srcBuffer, pCopyBufferToImageInfo->dstImage,
7032 pCopyBufferToImageInfo->dstImageLayout, pCopyBufferToImageInfo->regionCount,
Tony Barbour845d29b2021-11-09 11:43:14 -07007033 pCopyBufferToImageInfo->pRegions, CMD_COPYBUFFERTOIMAGE2KHR);
7034}
7035
7036bool CoreChecks::PreCallValidateCmdCopyBufferToImage2(VkCommandBuffer commandBuffer,
7037 const VkCopyBufferToImageInfo2 *pCopyBufferToImageInfo) const {
7038 return ValidateCmdCopyBufferToImage(commandBuffer, pCopyBufferToImageInfo->srcBuffer, pCopyBufferToImageInfo->dstImage,
7039 pCopyBufferToImageInfo->dstImageLayout, pCopyBufferToImageInfo->regionCount,
7040 pCopyBufferToImageInfo->pRegions, CMD_COPYBUFFERTOIMAGE2);
Jeff Leger178b1e52020-10-05 12:22:23 -04007041}
7042
John Zulauf1686f232019-07-09 16:27:11 -06007043void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
7044 VkImageLayout dstImageLayout, uint32_t regionCount,
7045 const VkBufferImageCopy *pRegions) {
7046 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
7047
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07007048 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06007049 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06007050 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07007051 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06007052 cb_node->SetImageInitialLayout(*dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06007053 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07007054}
Mike Weiblen672b58b2017-02-21 14:32:53 -07007055
Jeff Leger178b1e52020-10-05 12:22:23 -04007056void CoreChecks::PreCallRecordCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
7057 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo2KHR) {
7058 StateTracker::PreCallRecordCmdCopyBufferToImage2KHR(commandBuffer, pCopyBufferToImageInfo2KHR);
7059
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07007060 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06007061 auto dst_image_state = Get<IMAGE_STATE>(pCopyBufferToImageInfo2KHR->dstImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04007062 // Make sure that all image slices are record referenced layout
7063 for (uint32_t i = 0; i < pCopyBufferToImageInfo2KHR->regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06007064 cb_node->SetImageInitialLayout(*dst_image_state, pCopyBufferToImageInfo2KHR->pRegions[i].imageSubresource,
7065 pCopyBufferToImageInfo2KHR->dstImageLayout);
Jeff Leger178b1e52020-10-05 12:22:23 -04007066 }
7067}
Tony Barbour845d29b2021-11-09 11:43:14 -07007068
7069void CoreChecks::PreCallRecordCmdCopyBufferToImage2(VkCommandBuffer commandBuffer,
7070 const VkCopyBufferToImageInfo2 *pCopyBufferToImageInfo) {
7071 StateTracker::PreCallRecordCmdCopyBufferToImage2(commandBuffer, pCopyBufferToImageInfo);
7072
7073 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
7074 auto dst_image_state = Get<IMAGE_STATE>(pCopyBufferToImageInfo->dstImage);
7075 // Make sure that all image slices are record referenced layout
7076 for (uint32_t i = 0; i < pCopyBufferToImageInfo->regionCount; ++i) {
7077 cb_node->SetImageInitialLayout(*dst_image_state, pCopyBufferToImageInfo->pRegions[i].imageSubresource,
7078 pCopyBufferToImageInfo->dstImageLayout);
7079 }
7080}
7081
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07007082bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05007083 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07007084 bool skip = false;
7085 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
7086
Dave Houlton1d960ff2018-01-19 12:17:05 -07007087 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07007088 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
7089 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
7090 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07007091 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
7092 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07007093 }
7094
Jeremy Gebbenf4449392022-01-28 10:09:10 -07007095 auto image_entry = Get<IMAGE_STATE>(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07007096 if (!image_entry) {
7097 return skip;
7098 }
7099
Mark Lobodzinski6f358172019-10-02 11:09:12 -06007100 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
sfricke-samsung45996a42021-09-16 13:45:27 -07007101 if (IsExtEnabled(device_extensions.vk_ext_image_drm_format_modifier)) {
Mark Lobodzinski6f358172019-10-02 11:09:12 -06007102 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
7103 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07007104 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
7105 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
7106 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06007107 }
7108 } else {
7109 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07007110 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
7111 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06007112 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07007113 }
7114
Dave Houlton1d960ff2018-01-19 12:17:05 -07007115 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07007116 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07007117 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
7118 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
7119 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07007120 }
7121
Dave Houlton1d960ff2018-01-19 12:17:05 -07007122 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07007123 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07007124 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
7125 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
7126 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07007127 }
7128
Dave Houlton1d960ff2018-01-19 12:17:05 -07007129 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07007130 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06007131 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
7132 if (FormatIsMultiplane(img_format)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08007133 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06007134 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
7135 if (FormatPlaneCount(img_format) > 2u) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08007136 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06007137 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
7138 }
7139 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07007140 skip |= LogError(image, vuid,
7141 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
7142 ") must be a single-plane specifier flag.",
7143 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06007144 }
7145 } else if (FormatIsColor(img_format)) {
7146 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
ziga-lunargcc568bc2021-09-05 13:45:45 +02007147 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04461",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07007148 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
7149 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06007150 }
7151 } else if (FormatIsDepthOrStencil(img_format)) {
Nathaniel Cesario8c80f352021-07-15 15:06:48 -06007152 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06007153 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07007154 }
ziga-lunarg4ecbd5b2021-07-15 20:48:30 +02007155 if (!FormatIsDepthAndStencil(img_format) && !FormatIsDepthOnly(img_format)) {
7156 if (sub_aspect & VK_IMAGE_ASPECT_DEPTH_BIT) {
7157 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04464",
7158 "vkGetImageSubresourceLayout(): Image format (%s) does not contain a depth component, "
7159 "but VkImageSubresource.aspectMask contains VK_IMAGE_ASPECT_DEPTH_BIT.",
7160 string_VkFormat(img_format));
7161 }
7162 } else {
7163 if ((sub_aspect & VK_IMAGE_ASPECT_DEPTH_BIT) == 0) {
7164 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04462",
7165 "vkGetImageSubresourceLayout(): Image format (%s) contains a depth component, "
7166 "but VkImageSubresource.aspectMask does not contain VK_IMAGE_ASPECT_DEPTH_BIT.",
7167 string_VkFormat(img_format));
7168 }
7169 }
7170 if (!FormatIsDepthAndStencil(img_format) && !FormatIsStencilOnly(img_format)) {
7171 if (sub_aspect & VK_IMAGE_ASPECT_STENCIL_BIT) {
7172 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04464",
7173 "vkGetImageSubresourceLayout(): Image format (%s) does not contain a stencil component, "
7174 "but VkImageSubresource.aspectMask contains VK_IMAGE_ASPECT_STENCIL_BIT.",
7175 string_VkFormat(img_format));
7176 }
7177 } else {
7178 if ((sub_aspect & VK_IMAGE_ASPECT_STENCIL_BIT) == 0) {
7179 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04463",
7180 "vkGetImageSubresourceLayout(): Image format (%s) contains a stencil component, "
7181 "but VkImageSubresource.aspectMask does not contain VK_IMAGE_ASPECT_STENCIL_BIT.",
7182 string_VkFormat(img_format));
7183 }
7184 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06007185 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
7186 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
7187 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
Aitor Camacho0e4aad32022-05-20 19:22:02 +02007188 skip |= LogError(
7189 image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
7190 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask (%s) must be VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.",
7191 string_VkImageAspectFlags(sub_aspect).c_str());
7192 } else {
7193 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
7194 assert(IsExtEnabled(device_extensions.vk_ext_image_drm_format_modifier));
7195 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = LvlInitStruct<VkImageDrmFormatModifierPropertiesEXT>();
7196 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image, &drm_format_properties);
7197
7198 auto fmt_drm_props = LvlInitStruct<VkDrmFormatModifierPropertiesListEXT>();
7199 auto fmt_props_2 = LvlInitStruct<VkFormatProperties2>(&fmt_drm_props);
7200 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_entry->createInfo.format, &fmt_props_2);
7201 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties{fmt_drm_props.drmFormatModifierCount};
7202 fmt_drm_props.pDrmFormatModifierProperties = drm_properties.data();
7203 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_entry->createInfo.format, &fmt_props_2);
7204
7205 uint32_t max_plane_count = 0u;
7206
7207 for (auto const &drm_property : drm_properties) {
7208 if (drm_format_properties.drmFormatModifier == drm_property.drmFormatModifier) {
7209 max_plane_count = drm_property.drmFormatModifierPlaneCount;
7210 break;
7211 }
7212 }
7213
7214 VkImageAspectFlagBits allowed_plane_indices[] = {
7215 VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT, VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT,
7216 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT, VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT};
7217
7218 bool is_valid = false;
7219
7220 for (uint32_t i = 0u; i < max_plane_count; ++i) {
7221 if (sub_aspect == allowed_plane_indices[i]) {
7222 is_valid = true;
7223 break;
7224 }
7225 }
7226
7227 if (!is_valid) {
7228 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
7229 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask (%s) must be "
7230 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT, with i being less than the "
7231 "VkDrmFormatModifierPropertiesEXT::drmFormatModifierPlaneCount (%" PRIu32
7232 ") associated with the image's format (%s) and "
7233 "VkImageDrmFormatModifierPropertiesEXT::drmFormatModifier (%" PRIu64 ").",
7234 string_VkImageAspectFlags(sub_aspect).c_str(), max_plane_count,
7235 string_VkFormat(image_entry->createInfo.format), drm_format_properties.drmFormatModifier);
7236 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07007237 }
7238 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06007239
sfricke-samsung45996a42021-09-16 13:45:27 -07007240 if (IsExtEnabled(device_extensions.vk_android_external_memory_android_hardware_buffer)) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07007241 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06007242 }
7243
Mike Weiblen672b58b2017-02-21 14:32:53 -07007244 return skip;
7245}
sfricke-samsung022fa252020-07-24 03:26:16 -07007246
7247// Validates the image is allowed to be protected
7248bool CoreChecks::ValidateProtectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06007249 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07007250 bool skip = false;
sfricke-samsung21286f82021-11-16 08:21:46 -08007251
7252 // if driver supports protectedNoFault the operation is valid, just has undefined values
7253 if ((!phys_dev_props_core11.protectedNoFault) && (cb_state->unprotected == true) && (image_state->unprotected == false)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06007254 LogObjectList objlist(cb_state->commandBuffer());
7255 objlist.add(image_state->image());
locke-lunarg351c9d82020-10-23 14:43:21 -06007256 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 -06007257 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
7258 report_data->FormatHandle(image_state->image()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07007259 }
7260 return skip;
7261}
7262
7263// Validates the image is allowed to be unprotected
7264bool CoreChecks::ValidateUnprotectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06007265 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07007266 bool skip = false;
sfricke-samsung21286f82021-11-16 08:21:46 -08007267
7268 // if driver supports protectedNoFault the operation is valid, just has undefined values
7269 if ((!phys_dev_props_core11.protectedNoFault) && (cb_state->unprotected == false) && (image_state->unprotected == true)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06007270 LogObjectList objlist(cb_state->commandBuffer());
7271 objlist.add(image_state->image());
locke-lunarg351c9d82020-10-23 14:43:21 -06007272 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 -06007273 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
7274 report_data->FormatHandle(image_state->image()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07007275 }
7276 return skip;
7277}
7278
7279// Validates the buffer is allowed to be protected
7280bool CoreChecks::ValidateProtectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06007281 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07007282 bool skip = false;
sfricke-samsung21286f82021-11-16 08:21:46 -08007283
7284 // if driver supports protectedNoFault the operation is valid, just has undefined values
7285 if ((!phys_dev_props_core11.protectedNoFault) && (cb_state->unprotected == true) && (buffer_state->unprotected == false)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06007286 LogObjectList objlist(cb_state->commandBuffer());
7287 objlist.add(buffer_state->buffer());
locke-lunarg351c9d82020-10-23 14:43:21 -06007288 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 -06007289 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
7290 report_data->FormatHandle(buffer_state->buffer()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07007291 }
7292 return skip;
7293}
7294
7295// Validates the buffer is allowed to be unprotected
7296bool CoreChecks::ValidateUnprotectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06007297 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07007298 bool skip = false;
sfricke-samsung21286f82021-11-16 08:21:46 -08007299
7300 // if driver supports protectedNoFault the operation is valid, just has undefined values
7301 if ((!phys_dev_props_core11.protectedNoFault) && (cb_state->unprotected == false) && (buffer_state->unprotected == true)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06007302 LogObjectList objlist(cb_state->commandBuffer());
7303 objlist.add(buffer_state->buffer());
locke-lunarg351c9d82020-10-23 14:43:21 -06007304 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 -06007305 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
7306 report_data->FormatHandle(buffer_state->buffer()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07007307 }
7308 return skip;
7309}