blob: 4d0e8bf6778a144ba71aac7a3c3b97e5c37cc896 [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
Jeremy Gebbencb13f0f2022-07-15 15:48:05 -060047using LayoutRange = image_layout_map::ImageSubresourceLayoutMap::RangeType;
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -060048using LayoutEntry = image_layout_map::ImageSubresourceLayoutMap::LayoutEntry;
49
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070050// All VUID from copy_bufferimage_to_imagebuffer_common.txt
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070051static const char *GetBufferImageCopyCommandVUID(std::string id, bool image_to_buffer, bool copy2) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070052 // clang-format off
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070053 static const std::map<std::string, std::array<const char *, 4>> copy_imagebuffer_vuid = {
54 {"00193", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070055 "VUID-vkCmdCopyBufferToImage-bufferOffset-00193", // !copy2 & !image_to_buffer
56 "VUID-vkCmdCopyImageToBuffer-bufferOffset-00193", // !copy2 & image_to_buffer
Tony Barbour845d29b2021-11-09 11:43:14 -070057 "VUID-VkCopyBufferToImageInfo2-bufferOffset-00193", // copy2 & !image_to_buffer
Tony-LunarGaf3632a2021-11-10 15:51:57 -070058 "VUID-VkCopyImageToBufferInfo2-bufferOffset-00193", // copy2 & image_to_buffer
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070059 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070060 {"01558", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070061 "VUID-vkCmdCopyBufferToImage-bufferOffset-01558",
62 "VUID-vkCmdCopyImageToBuffer-bufferOffset-01558",
Tony Barbour845d29b2021-11-09 11:43:14 -070063 "VUID-VkCopyBufferToImageInfo2-bufferOffset-01558",
Tony-LunarGaf3632a2021-11-10 15:51:57 -070064 "VUID-VkCopyImageToBufferInfo2-bufferOffset-01558",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070065 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070066 {"01559", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070067 "VUID-vkCmdCopyBufferToImage-bufferOffset-01559",
68 "VUID-vkCmdCopyImageToBuffer-bufferOffset-01559",
Tony Barbour845d29b2021-11-09 11:43:14 -070069 "VUID-VkCopyBufferToImageInfo2-bufferOffset-01559",
Tony-LunarGaf3632a2021-11-10 15:51:57 -070070 "VUID-VkCopyImageToBufferInfo2-bufferOffset-01559",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070071 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070072 {"00197", {
Mike Schuchardt7b152fa2021-08-03 16:30:27 -070073 "VUID-vkCmdCopyBufferToImage-pRegions-06218",
74 "VUID-vkCmdCopyImageToBuffer-pRegions-06221",
Tony Barbour845d29b2021-11-09 11:43:14 -070075 "VUID-VkCopyBufferToImageInfo2-pRegions-06223",
Tony-LunarGaf3632a2021-11-10 15:51:57 -070076 "VUID-VkCopyImageToBufferInfo2-imageOffset-00197",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070077 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070078 {"00198", {
Mike Schuchardt7b152fa2021-08-03 16:30:27 -070079 "VUID-vkCmdCopyBufferToImage-pRegions-06219",
80 "VUID-vkCmdCopyImageToBuffer-pRegions-06222",
Tony Barbour845d29b2021-11-09 11:43:14 -070081 "VUID-VkCopyBufferToImageInfo2-pRegions-06224",
Tony-LunarGaf3632a2021-11-10 15:51:57 -070082 "VUID-VkCopyImageToBufferInfo2-imageOffset-00198",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070083 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070084 {"00199", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070085 "VUID-vkCmdCopyBufferToImage-srcImage-00199",
86 "VUID-vkCmdCopyImageToBuffer-srcImage-00199",
Tony Barbour845d29b2021-11-09 11:43:14 -070087 "VUID-VkCopyBufferToImageInfo2-srcImage-00199",
Tony-LunarGaf3632a2021-11-10 15:51:57 -070088 "VUID-VkCopyImageToBufferInfo2-srcImage-00199",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070089 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070090 {"00200", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070091 "VUID-vkCmdCopyBufferToImage-imageOffset-00200",
92 "VUID-vkCmdCopyImageToBuffer-imageOffset-00200",
Tony Barbour845d29b2021-11-09 11:43:14 -070093 "VUID-VkCopyBufferToImageInfo2-imageOffset-00200",
Tony-LunarGaf3632a2021-11-10 15:51:57 -070094 "VUID-VkCopyImageToBufferInfo2-imageOffset-00200",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070095 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070096 {"00201", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070097 "VUID-vkCmdCopyBufferToImage-srcImage-00201",
98 "VUID-vkCmdCopyImageToBuffer-srcImage-00201",
Tony Barbour845d29b2021-11-09 11:43:14 -070099 "VUID-VkCopyBufferToImageInfo2-srcImage-00201",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700100 "VUID-VkCopyImageToBufferInfo2-srcImage-00201",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700101 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700102 {"00203", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700103 "VUID-vkCmdCopyBufferToImage-bufferRowLength-00203",
104 "VUID-vkCmdCopyImageToBuffer-bufferRowLength-00203",
Tony Barbour845d29b2021-11-09 11:43:14 -0700105 "VUID-VkCopyBufferToImageInfo2-bufferRowLength-00203",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700106 "VUID-VkCopyImageToBufferInfo2-bufferRowLength-00203",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700107 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700108 {"00204", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700109 "VUID-vkCmdCopyBufferToImage-bufferImageHeight-00204",
110 "VUID-vkCmdCopyImageToBuffer-bufferImageHeight-00204",
Tony Barbour845d29b2021-11-09 11:43:14 -0700111 "VUID-VkCopyBufferToImageInfo2-bufferImageHeight-00204",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700112 "VUID-VkCopyImageToBufferInfo2-bufferImageHeight-00204",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700113 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700114 {"00205", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700115 "VUID-vkCmdCopyBufferToImage-imageOffset-00205",
116 "VUID-vkCmdCopyImageToBuffer-imageOffset-00205",
Tony Barbour845d29b2021-11-09 11:43:14 -0700117 "VUID-VkCopyBufferToImageInfo2-imageOffset-00205",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700118 "VUID-VkCopyImageToBufferInfo2-imageOffset-00205",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700119 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700120 {"00206", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700121 "VUID-vkCmdCopyBufferToImage-bufferOffset-00206",
122 "VUID-vkCmdCopyImageToBuffer-bufferOffset-00206",
Tony Barbour845d29b2021-11-09 11:43:14 -0700123 "VUID-VkCopyBufferToImageInfo2-bufferOffset-00206",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700124 "VUID-VkCopyImageToBufferInfo2-bufferOffset-00206",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700125 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700126 {"00207", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700127 "VUID-vkCmdCopyBufferToImage-imageExtent-00207",
128 "VUID-vkCmdCopyImageToBuffer-imageExtent-00207",
Tony Barbour845d29b2021-11-09 11:43:14 -0700129 "VUID-VkCopyBufferToImageInfo2-imageExtent-00207",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700130 "VUID-VkCopyImageToBufferInfo2-imageExtent-00207",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700131 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700132 {"00208", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700133 "VUID-vkCmdCopyBufferToImage-imageExtent-00208",
134 "VUID-vkCmdCopyImageToBuffer-imageExtent-00208",
Tony Barbour845d29b2021-11-09 11:43:14 -0700135 "VUID-VkCopyBufferToImageInfo2-imageExtent-00208",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700136 "VUID-VkCopyImageToBufferInfo2-imageExtent-00208",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700137 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700138 {"00209", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700139 "VUID-vkCmdCopyBufferToImage-imageExtent-00209",
140 "VUID-vkCmdCopyImageToBuffer-imageExtent-00209",
Tony Barbour845d29b2021-11-09 11:43:14 -0700141 "VUID-VkCopyBufferToImageInfo2-imageExtent-00209",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700142 "VUID-VkCopyImageToBufferInfo2-imageExtent-00209",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700143 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700144 {"00211", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700145 "VUID-vkCmdCopyBufferToImage-aspectMask-00211",
146 "VUID-vkCmdCopyImageToBuffer-aspectMask-00211",
Tony Barbour845d29b2021-11-09 11:43:14 -0700147 "VUID-VkCopyBufferToImageInfo2-aspectMask-00211",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700148 "VUID-VkCopyImageToBufferInfo2-aspectMask-00211",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700149 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700150 {"01560", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700151 "VUID-vkCmdCopyBufferToImage-aspectMask-01560",
152 "VUID-vkCmdCopyImageToBuffer-aspectMask-01560",
Tony Barbour845d29b2021-11-09 11:43:14 -0700153 "VUID-VkCopyBufferToImageInfo2-aspectMask-01560",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700154 "VUID-VkCopyImageToBufferInfo2-aspectMask-01560",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700155 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700156 {"00213", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700157 "VUID-vkCmdCopyBufferToImage-baseArrayLayer-00213",
158 "VUID-vkCmdCopyImageToBuffer-baseArrayLayer-00213",
Tony Barbour845d29b2021-11-09 11:43:14 -0700159 "VUID-VkCopyBufferToImageInfo2-baseArrayLayer-00213",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700160 "VUID-VkCopyImageToBufferInfo2-baseArrayLayer-00213",
sfricke-samsung8feecc12021-01-23 03:28:38 -0800161 }},
162 {"04052", {
163 "VUID-vkCmdCopyBufferToImage-commandBuffer-04052",
164 "VUID-vkCmdCopyImageToBuffer-commandBuffer-04052",
Tony Barbour845d29b2021-11-09 11:43:14 -0700165 "VUID-VkCopyBufferToImageInfo2-commandBuffer-04052",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700166 "VUID-VkCopyImageToBufferInfo2-commandBuffer-04052",
sfricke-samsung8feecc12021-01-23 03:28:38 -0800167 }},
168 {"04053", {
169 "VUID-vkCmdCopyBufferToImage-srcImage-04053",
170 "VUID-vkCmdCopyImageToBuffer-srcImage-04053",
Tony Barbour845d29b2021-11-09 11:43:14 -0700171 "VUID-VkCopyBufferToImageInfo2-srcImage-04053",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700172 "VUID-VkCopyImageToBufferInfo2-srcImage-04053",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700173 }}
174 };
175 // clang-format on
176
177 uint8_t index = 0;
Artem Bolgar82d08362021-06-03 13:11:13 -0700178 index |= uint8_t((image_to_buffer) ? 0x1 : 0);
179 index |= uint8_t((copy2) ? 0x2 : 0);
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700180 return copy_imagebuffer_vuid.at(id).at(index);
181}
182
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700183static VkImageLayout NormalizeDepthImageLayout(VkImageLayout layout) {
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200184 switch (layout) {
185 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
186 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
187 return VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL;
188
189 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
190 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
191 return VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL;
192
193 default:
194 return layout;
195 }
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700196}
197
198static VkImageLayout NormalizeStencilImageLayout(VkImageLayout layout) {
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200199 switch (layout) {
200 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
201 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
202 return VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL;
203
204 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
205 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
206 return VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL;
207
208 default:
209 return layout;
210 }
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700211}
212
Jeremy Gebben579aaca2021-02-15 13:36:18 -0700213static VkImageLayout NormalizeSynchronization2Layout(const VkImageAspectFlags aspect_mask, VkImageLayout layout) {
214 if (layout == VK_IMAGE_LAYOUT_ATTACHMENT_OPTIMAL_KHR) {
215 if (aspect_mask == VK_IMAGE_ASPECT_COLOR_BIT) {
216 layout = VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL;
217 } else if (aspect_mask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
218 layout = VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL;
219 } else if (aspect_mask == VK_IMAGE_ASPECT_DEPTH_BIT) {
220 layout = VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL;
221 } else if (aspect_mask == VK_IMAGE_ASPECT_STENCIL_BIT) {
222 layout = VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL;
223 }
224 } else if (layout == VK_IMAGE_LAYOUT_READ_ONLY_OPTIMAL_KHR) {
225 if (aspect_mask == VK_IMAGE_ASPECT_COLOR_BIT) {
226 layout = VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL;
227 } else if (aspect_mask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
228 layout = VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL;
229 } else if (aspect_mask == VK_IMAGE_ASPECT_DEPTH_BIT) {
230 layout = VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL;
231 } else if (aspect_mask == VK_IMAGE_ASPECT_STENCIL_BIT) {
232 layout = VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL;
233 }
234 }
235 return layout;
236}
237
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700238static bool ImageLayoutMatches(const VkImageAspectFlags aspect_mask, VkImageLayout a, VkImageLayout b) {
239 bool matches = (a == b);
240 if (!matches) {
John Zulaufbea70432021-02-23 07:03:12 -0700241 a = NormalizeSynchronization2Layout(aspect_mask, a);
242 b = NormalizeSynchronization2Layout(aspect_mask, b);
243 matches = (a == b);
244 if (!matches) {
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200245 // Relaxed rules when referencing *only* the depth or stencil aspects.
246 // When accessing both, normalize layouts for aspects separately.
247 if (aspect_mask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
248 matches = NormalizeDepthImageLayout(a) == NormalizeDepthImageLayout(b) &&
249 NormalizeStencilImageLayout(a) == NormalizeStencilImageLayout(b);
250 } else if (aspect_mask == VK_IMAGE_ASPECT_DEPTH_BIT) {
John Zulaufbea70432021-02-23 07:03:12 -0700251 matches = NormalizeDepthImageLayout(a) == NormalizeDepthImageLayout(b);
252 } else if (aspect_mask == VK_IMAGE_ASPECT_STENCIL_BIT) {
253 matches = NormalizeStencilImageLayout(a) == NormalizeStencilImageLayout(b);
254 }
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700255 }
256 }
257 return matches;
258}
259
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600260// Utility type for checking Image layouts
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700261struct LayoutUseCheckAndMessage {
262 const static VkImageAspectFlags kDepthOrStencil = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600263 const VkImageLayout expected_layout;
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700264 const VkImageAspectFlags aspect_mask;
265 const char *message;
266 VkImageLayout layout;
267
268 LayoutUseCheckAndMessage() = delete;
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600269 LayoutUseCheckAndMessage(VkImageLayout expected, const VkImageAspectFlags aspect_mask_ = 0)
270 : expected_layout{expected}, aspect_mask{aspect_mask_}, message(nullptr), layout(kInvalidLayout) {}
271 bool Check(const LayoutEntry &layout_entry) {
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700272 message = nullptr;
273 layout = kInvalidLayout; // Success status
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600274 if (layout_entry.current_layout != kInvalidLayout) {
275 if (!ImageLayoutMatches(aspect_mask, expected_layout, layout_entry.current_layout)) {
276 message = "previous known";
277 layout = layout_entry.current_layout;
278 }
279 } else if (layout_entry.initial_layout != kInvalidLayout) {
280 if (!ImageLayoutMatches(aspect_mask, expected_layout, layout_entry.initial_layout)) {
281 assert(layout_entry.state); // If we have an initial layout, we better have a state for it
282 if (!((layout_entry.state->aspect_mask & kDepthOrStencil) &&
283 ImageLayoutMatches(layout_entry.state->aspect_mask, expected_layout, layout_entry.initial_layout))) {
284 message = "previously used";
285 layout = layout_entry.initial_layout;
286 }
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700287 }
288 }
289 return layout == kInvalidLayout;
290 }
291};
292
locke-lunarg540b2252020-08-03 13:23:36 -0600293bool IMAGE_VIEW_STATE::OverlapSubresource(const IMAGE_VIEW_STATE &compare_view) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600294 if (image_view() == compare_view.image_view()) {
locke-lunarg540b2252020-08-03 13:23:36 -0600295 return true;
296 }
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600297 if (image_state->image() != compare_view.image_state->image()) {
locke-lunargdc287022020-08-21 12:03:57 -0600298 return false;
299 }
locke-lunarg540b2252020-08-03 13:23:36 -0600300 if (normalized_subresource_range.aspectMask != compare_view.normalized_subresource_range.aspectMask) {
301 return false;
302 }
303
304 // compare if overlap mip level
locke-lunarg540b2252020-08-03 13:23:36 -0600305 if ((normalized_subresource_range.baseMipLevel < compare_view.normalized_subresource_range.baseMipLevel) &&
locke-lunargdc287022020-08-21 12:03:57 -0600306 ((normalized_subresource_range.baseMipLevel + normalized_subresource_range.levelCount) <=
locke-lunarg540b2252020-08-03 13:23:36 -0600307 compare_view.normalized_subresource_range.baseMipLevel)) {
locke-lunargdc287022020-08-21 12:03:57 -0600308 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600309 }
310
311 if ((normalized_subresource_range.baseMipLevel > compare_view.normalized_subresource_range.baseMipLevel) &&
locke-lunargdc287022020-08-21 12:03:57 -0600312 (normalized_subresource_range.baseMipLevel >=
locke-lunarg540b2252020-08-03 13:23:36 -0600313 (compare_view.normalized_subresource_range.baseMipLevel + compare_view.normalized_subresource_range.levelCount))) {
locke-lunargdc287022020-08-21 12:03:57 -0600314 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600315 }
316
317 // compare if overlap array layer
locke-lunarg540b2252020-08-03 13:23:36 -0600318 if ((normalized_subresource_range.baseArrayLayer < compare_view.normalized_subresource_range.baseArrayLayer) &&
locke-lunargdc287022020-08-21 12:03:57 -0600319 ((normalized_subresource_range.baseArrayLayer + normalized_subresource_range.layerCount) <=
locke-lunarg540b2252020-08-03 13:23:36 -0600320 compare_view.normalized_subresource_range.baseArrayLayer)) {
locke-lunargdc287022020-08-21 12:03:57 -0600321 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600322 }
323
324 if ((normalized_subresource_range.baseArrayLayer > compare_view.normalized_subresource_range.baseArrayLayer) &&
locke-lunargdc287022020-08-21 12:03:57 -0600325 (normalized_subresource_range.baseArrayLayer >=
locke-lunarg540b2252020-08-03 13:23:36 -0600326 (compare_view.normalized_subresource_range.baseArrayLayer + compare_view.normalized_subresource_range.layerCount))) {
locke-lunargdc287022020-08-21 12:03:57 -0600327 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600328 }
locke-lunargdc287022020-08-21 12:03:57 -0600329 return true;
locke-lunarg540b2252020-08-03 13:23:36 -0600330}
331
Dave Houltond9611312018-11-19 17:03:36 -0700332uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
333 // uint cast applies floor()
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700334 return 1u + static_cast<uint32_t>(log2(std::max({height, width, depth})));
Dave Houltond9611312018-11-19 17:03:36 -0700335}
336
337uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
338
339uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
340
John Zulauf2d60a452021-03-04 15:12:03 -0700341bool CoreChecks::FindLayouts(const IMAGE_STATE &image_state, std::vector<VkImageLayout> &layouts) const {
Jeremy Gebben4a8881f2022-01-10 17:04:30 -0700342 const auto *layout_range_map = image_state.layout_range_map.get();
John Zulauf2076e812020-01-08 14:55:54 -0700343 if (!layout_range_map) return false;
Jeremy Gebben4a8881f2022-01-10 17:04:30 -0700344
345 auto guard = layout_range_map->ReadLock();
locke-lunargf155ccf2020-02-18 11:34:15 -0700346 // TODO: FindLayouts function should mutate into a ValidatePresentableLayout with the loop wrapping the LogError
347 // from the caller. You can then use decode to add the subresource of the range::begin to the error message.
348
John Zulauf2076e812020-01-08 14:55:54 -0700349 // TODO: what is this test and what is it supposed to do?! -- the logic doesn't match the comment below?!
350
351 // 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 -0700352 if (layout_range_map->size() >= (image_state.createInfo.arrayLayers * image_state.createInfo.mipLevels + 1)) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700353 return false;
354 }
locke-lunargcba7d5f2019-12-30 16:59:11 -0700355
John Zulauf79f06582021-02-27 18:38:39 -0700356 for (const auto &entry : *layout_range_map) {
John Zulauf2076e812020-01-08 14:55:54 -0700357 layouts.push_back(entry.second);
Tony Barbourdf013b92017-01-25 12:53:48 -0700358 }
359 return true;
360}
Tony-LunarG0857f842022-08-23 10:32:16 -0600361bool CoreChecks::ValidateMultipassRenderedToSingleSampledSampleCount(RenderPassCreateVersion rp_version, VkFramebuffer framebuffer,
362 VkRenderPass renderpass, uint32_t subpass, VkImage image,
363 VkImageCreateInfo image_create_info,
364 VkSampleCountFlagBits msrtss_samples,
365 uint32_t attachment_index, bool depth) const {
366 bool skip = false;
367 const char *function_name = (rp_version == RENDER_PASS_VERSION_2) ? "vkCmdBeginRenderPass2()" : "vkCmdBeginRenderPass()";
368 VkImageFormatProperties image_properties = {};
369 const VkResult image_properties_result = DispatchGetPhysicalDeviceImageFormatProperties(
370 physical_device, image_create_info.format, image_create_info.imageType, image_create_info.tiling, image_create_info.usage,
371 image_create_info.flags, &image_properties);
372 if (image_properties_result != VK_SUCCESS) {
373 skip |= LogError(device, "VUID-VkRenderPassAttachmentBeginInfo-pAttachments-07010",
374 "vkGetPhysicalDeviceImageFormatProperties() unexpectedly failed, "
375 "when called for validation with following params: "
376 "format: %s, imageType: %s, "
377 "tiling: %s, usage: %s, "
378 "flags: %s.",
379 string_VkFormat(image_create_info.format), string_VkImageType(image_create_info.imageType),
380 string_VkImageTiling(image_create_info.tiling), string_VkImageUsageFlags(image_create_info.usage).c_str(),
381 string_VkImageCreateFlags(image_create_info.flags).c_str());
382 } else {
383 if (!(image_properties.sampleCounts & msrtss_samples)) {
384 std::stringstream msg;
385 if (depth) {
386 msg << "depth stencil attachment";
387 } else {
388 msg << "attachment " << attachment_index;
389 }
390 skip |=
391 LogError(device, "VUID-VkRenderPassAttachmentBeginInfo-pAttachments-07010",
392 "%s(): Renderpass subpass %" PRIu32
393 " enables "
394 "multisampled-render-to-single-sampled and %s"
395 ", is specified with "
396 "VK_SAMPLE_COUNT_1_BIT samples, but image (%s) created with format %s imageType: %s, "
397 "tiling: %s, usage: %s, "
398 "flags: %s does not support a rasterizationSamples count of %s",
399 function_name, subpass, msg.str().c_str(), report_data->FormatHandle(image).c_str(),
400 string_VkFormat(image_create_info.format), string_VkImageType(image_create_info.imageType),
401 string_VkImageTiling(image_create_info.tiling), string_VkImageUsageFlags(image_create_info.usage).c_str(),
402 string_VkImageCreateFlags(image_create_info.flags).c_str(), string_VkSampleCountFlagBits(msrtss_samples));
403 }
404 }
405 return skip;
406}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700407
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700408bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600409 const IMAGE_VIEW_STATE &image_view_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700410 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600411 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100412 bool skip = false;
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600413 const auto &image_view = image_view_state.Handle();
414 const auto *image_state = image_view_state.image_state.get();
415 const auto &image = image_state->Handle();
Tobias Hectorbbb12282018-10-22 15:17:59 +0100416 const char *vuid;
417 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700418 const char *function_name = use_rp2 ? "vkCmdBeginRenderPass2()" : "vkCmdBeginRenderPass()";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100419
420 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600421 LogObjectList objlist(image);
422 objlist.add(renderpass);
423 objlist.add(framebuffer);
424 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700425 skip |=
sfricke-samsung4389faa2022-03-23 01:19:42 -0500426 LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700427 "%s: RenderPass %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
428 function_name, report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
429 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100430 return skip;
431 }
432
433 auto image_usage = image_state->createInfo.usage;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700434 const auto stencil_usage_info = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Ricardo Garcia3f5984c2020-04-09 10:56:34 +0200435 if (stencil_usage_info) {
436 image_usage |= stencil_usage_info->stencilUsage;
437 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100438
439 // Check for layouts that mismatch image usages in the framebuffer
440 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800441 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600442 LogObjectList objlist(image);
443 objlist.add(renderpass);
444 objlist.add(framebuffer);
445 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700446 skip |= LogError(objlist, vuid,
447 "%s: Layout/usage mismatch for attachment %u in %s"
448 " - the %s is %s but the image attached to %s via %s"
449 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
450 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
451 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
452 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100453 }
454
455 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
456 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800457 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600458 LogObjectList objlist(image);
459 objlist.add(renderpass);
460 objlist.add(framebuffer);
461 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700462 skip |= LogError(objlist, vuid,
463 "%s: Layout/usage mismatch for attachment %u in %s"
464 " - the %s is %s but the image attached to %s via %s"
465 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
466 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
467 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
468 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100469 }
470
471 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800472 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600473 LogObjectList objlist(image);
474 objlist.add(renderpass);
475 objlist.add(framebuffer);
476 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700477 skip |= LogError(objlist, vuid,
478 "%s: Layout/usage mismatch for attachment %u in %s"
479 " - the %s is %s but the image attached to %s via %s"
480 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
481 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
482 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
483 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100484 }
485
486 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800487 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600488 LogObjectList objlist(image);
489 objlist.add(renderpass);
490 objlist.add(framebuffer);
491 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700492 skip |= LogError(objlist, vuid,
493 "%s: Layout/usage mismatch for attachment %u in %s"
494 " - the %s is %s but the image attached to %s via %s"
495 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
496 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
497 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
498 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100499 }
500
Tony-LunarG10f54412022-08-12 11:43:40 -0600501 if (layout == VK_IMAGE_LAYOUT_ATTACHMENT_FEEDBACK_LOOP_OPTIMAL_EXT) {
502 if (((image_usage & (VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) == 0) ||
503 ((image_usage & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0)) {
504 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-07002" : "VUID-vkCmdBeginRenderPass-initialLayout-07000";
505 LogObjectList objlist(image);
506 objlist.add(renderpass);
507 objlist.add(framebuffer);
508 objlist.add(image_view);
509 skip |=
510 LogError(objlist, vuid,
511 "%s: Layout/usage mismatch for attachment %" PRIu32
512 " in %s"
513 " - the %s is %s but the image attached to %s via %s"
514 " was not created with either the VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT or "
515 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT usage bits, and the VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or "
516 "VK_IMAGE_USAGE_SAMPLED_BIT usage bits",
517 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
518 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
519 report_data->FormatHandle(image_view).c_str());
520 }
521 if (!(image_usage & VK_IMAGE_USAGE_ATTACHMENT_FEEDBACK_LOOP_BIT_EXT)) {
522 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-07003" : "VUID-vkCmdBeginRenderPass-initialLayout-07001";
523 LogObjectList objlist(image);
524 objlist.add(renderpass);
525 objlist.add(framebuffer);
526 objlist.add(image_view);
527 skip |= LogError(objlist, vuid,
528 "%s: Layout/usage mismatch for attachment %" PRIu32
529 " in %s"
530 " - the %s is %s but the image attached to %s via %s"
531 " was not created with the VK_IMAGE_USAGE_ATTACHMENT_FEEDBACK_LOOP_BIT_EXT usage bit",
532 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
533 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
534 report_data->FormatHandle(image_view).c_str());
535 }
536 }
537
sfricke-samsung45996a42021-09-16 13:45:27 -0700538 if (IsExtEnabled(device_extensions.vk_khr_maintenance2)) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100539 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
540 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
541 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
542 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
543 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800544 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600545 LogObjectList objlist(image);
546 objlist.add(renderpass);
547 objlist.add(framebuffer);
548 objlist.add(image_view);
549 skip |= LogError(objlist, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700550 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700551 " - the %s is %s but the image attached to %s via %s"
552 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700553 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700554 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
555 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100556 }
557 } else {
558 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
559 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
560 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
561 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600562 LogObjectList objlist(image);
563 objlist.add(renderpass);
564 objlist.add(framebuffer);
565 objlist.add(image_view);
566 skip |= LogError(objlist, "VUID-vkCmdBeginRenderPass-initialLayout-00896",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700567 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700568 " - the %s is %s but the image attached to %s via %s"
569 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700570 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700571 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
572 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100573 }
574 }
575 return skip;
576}
577
John Zulauf17a01bb2019-08-09 16:41:19 -0600578bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700579 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600580 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600581 bool skip = false;
Jeremy Gebbenf4449392022-01-28 10:09:10 -0700582 auto render_pass_state = Get<RENDER_PASS_STATE>(pRenderPassBegin->renderPass);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600583 const auto *render_pass_info = render_pass_state->createInfo.ptr();
584 auto render_pass = render_pass_state->renderPass();
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700585 auto const &framebuffer_info = framebuffer_state->createInfo;
586 const VkImageView *attachments = framebuffer_info.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100587
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600588 auto framebuffer = framebuffer_state->framebuffer();
Tobias Hectorbbb12282018-10-22 15:17:59 +0100589
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700590 if (render_pass_info->attachmentCount != framebuffer_info.attachmentCount) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600591 skip |= LogError(pCB->commandBuffer(), kVUID_Core_DrawState_InvalidRenderpass,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700592 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700593 }
John Zulauf8e308292018-09-21 11:34:37 -0600594
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700595 const auto *attachment_info = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext);
Mike Schuchardt2df08912020-12-15 16:28:09 -0800596 if (((framebuffer_info.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) != 0) && attachment_info != nullptr) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700597 attachments = attachment_info->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100598 }
599
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600600 if (attachments == nullptr) {
601 return skip;
602 }
603 const auto *const_p_cb = static_cast<const CMD_BUFFER_STATE *>(pCB);
604 for (uint32_t i = 0; i < render_pass_info->attachmentCount && i < framebuffer_info.attachmentCount; ++i) {
605 auto image_view = attachments[i];
606 auto view_state = Get<IMAGE_VIEW_STATE>(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100607
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600608 if (!view_state) {
609 LogObjectList objlist(pRenderPassBegin->renderPass);
610 objlist.add(framebuffer_state->framebuffer());
611 objlist.add(image_view);
612 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
613 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
614 report_data->FormatHandle(framebuffer_state->framebuffer()).c_str(), i,
615 report_data->FormatHandle(image_view).c_str());
616 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100617 }
618
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600619 const VkImage image = view_state->create_info.image;
620 const auto *image_state = view_state->image_state.get();
Tobias Hectorbbb12282018-10-22 15:17:59 +0100621
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600622 if (!image_state) {
623 LogObjectList objlist(pRenderPassBegin->renderPass);
624 objlist.add(framebuffer_state->framebuffer());
625 objlist.add(image_view);
626 objlist.add(image);
627 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
628 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
629 report_data->FormatHandle(framebuffer_state->framebuffer()).c_str(), i,
630 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
631 continue;
632 }
633 auto attachment_initial_layout = render_pass_info->pAttachments[i].initialLayout;
634 auto final_layout = render_pass_info->pAttachments[i].finalLayout;
635
636 // Default to expecting stencil in the same layout.
637 auto attachment_stencil_initial_layout = attachment_initial_layout;
638
639 // If a separate layout is specified, look for that.
640 const auto *attachment_description_stencil_layout =
641 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(render_pass_info->pAttachments[i].pNext);
642 if (attachment_description_stencil_layout) {
643 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
644 }
645
646 const ImageSubresourceLayoutMap *subresource_map = nullptr;
647 bool has_queried_map = false;
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600648
649 for (uint32_t aspect_index = 0; aspect_index < 32; aspect_index++) {
650 VkImageAspectFlags test_aspect = 1u << aspect_index;
651 if ((view_state->normalized_subresource_range.aspectMask & test_aspect) == 0) {
652 continue;
653 }
654
655 // Allow for differing depth and stencil layouts
656 VkImageLayout check_layout = attachment_initial_layout;
657 if (test_aspect == VK_IMAGE_ASPECT_STENCIL_BIT) {
658 check_layout = attachment_stencil_initial_layout;
659 }
660
661 // If no layout information for image yet, will be checked at QueueSubmit time
662 if (check_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
663 continue;
664 }
665 if (!has_queried_map) {
666 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to
667 // something in common with the non-const version.) The lookup is expensive, so cache it.
668 subresource_map = const_p_cb->GetImageSubresourceLayoutMap(*image_state);
669 has_queried_map = true;
670 }
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600671 if (!subresource_map) {
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600672 // If no layout information for image yet, will be checked at QueueSubmit time
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600673 continue;
674 }
675 auto normalized_range = view_state->normalized_subresource_range;
676 normalized_range.aspectMask = test_aspect;
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600677 LayoutUseCheckAndMessage layout_check(check_layout, test_aspect);
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600678
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600679 skip |= subresource_map->AnyInRange(
Jeremy Gebbencb13f0f2022-07-15 15:48:05 -0600680 normalized_range, [this, &layout_check, i](const LayoutRange &range, const LayoutEntry &state) {
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600681 bool subres_skip = false;
682 if (!layout_check.Check(state)) {
683 subres_skip = LogError(device, kVUID_Core_DrawState_InvalidRenderpass,
684 "You cannot start a render pass using attachment %u where the render pass initial "
685 "layout is %s "
686 "and the %s layout of the attachment is %s. The layouts must match, or the render "
687 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
688 i, string_VkImageLayout(layout_check.expected_layout), layout_check.message,
689 string_VkImageLayout(layout_check.layout));
690 }
691 return subres_skip;
692 });
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600693 }
Tony-LunarG6cc4c562022-08-24 14:55:28 -0600694 skip |= ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, *view_state,
695 framebuffer, render_pass, i, "initial layout");
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600696
Tony-LunarG6cc4c562022-08-24 14:55:28 -0600697 skip |= ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, *view_state, framebuffer,
698 render_pass, i, "final layout");
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600699 }
700
701 for (uint32_t j = 0; j < render_pass_info->subpassCount; ++j) {
702 auto &subpass = render_pass_info->pSubpasses[j];
Tony-LunarG0857f842022-08-23 10:32:16 -0600703 const auto *ms_rendered_to_single_sampled =
704 LvlFindInChain<VkMultisampledRenderToSingleSampledInfoEXT>(render_pass_info->pSubpasses[j].pNext);
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600705 for (uint32_t k = 0; k < render_pass_info->pSubpasses[j].inputAttachmentCount; ++k) {
706 auto &attachment_ref = subpass.pInputAttachments[k];
707 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
708 auto image_view = attachments[attachment_ref.attachment];
709 auto view_state = Get<IMAGE_VIEW_STATE>(image_view);
Tony-LunarG0857f842022-08-23 10:32:16 -0600710
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600711 if (view_state) {
Tony-LunarG6cc4c562022-08-24 14:55:28 -0600712 skip |= ValidateRenderPassLayoutAgainstFramebufferImageUsage(
713 rp_version, attachment_ref.layout, *view_state, framebuffer, render_pass, attachment_ref.attachment,
714 "input attachment layout");
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600715 }
Tony-LunarG0857f842022-08-23 10:32:16 -0600716 if (ms_rendered_to_single_sampled && ms_rendered_to_single_sampled->multisampledRenderToSingleSampledEnable) {
717 if (render_pass_info->pAttachments[attachment_ref.attachment].samples == VK_SAMPLE_COUNT_1_BIT) {
718 const auto image_create_info = view_state->image_state.get()->createInfo;
719 skip |= ValidateMultipassRenderedToSingleSampledSampleCount(
720 rp_version, framebuffer, render_pass, k, view_state->create_info.image, image_create_info,
721 ms_rendered_to_single_sampled->rasterizationSamples, attachment_ref.attachment);
722 }
723 }
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600724 }
725 }
726
727 for (uint32_t k = 0; k < render_pass_info->pSubpasses[j].colorAttachmentCount; ++k) {
728 auto &attachment_ref = subpass.pColorAttachments[k];
729 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
730 auto image_view = attachments[attachment_ref.attachment];
731 auto view_state = Get<IMAGE_VIEW_STATE>(image_view);
732
733 if (view_state) {
Tony-LunarG6cc4c562022-08-24 14:55:28 -0600734 skip |= ValidateRenderPassLayoutAgainstFramebufferImageUsage(
735 rp_version, attachment_ref.layout, *view_state, framebuffer, render_pass, attachment_ref.attachment,
736 "color attachment layout");
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600737 if (subpass.pResolveAttachments) {
Tony-LunarG6cc4c562022-08-24 14:55:28 -0600738 skip |= ValidateRenderPassLayoutAgainstFramebufferImageUsage(
739 rp_version, attachment_ref.layout, *view_state, framebuffer, render_pass, attachment_ref.attachment,
740 "resolve attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100741 }
742 }
Tony-LunarG0857f842022-08-23 10:32:16 -0600743 if (ms_rendered_to_single_sampled && ms_rendered_to_single_sampled->multisampledRenderToSingleSampledEnable) {
744 if (render_pass_info->pAttachments[attachment_ref.attachment].samples == VK_SAMPLE_COUNT_1_BIT) {
745 const auto image_create_info = view_state->image_state.get()->createInfo;
746 skip |= ValidateMultipassRenderedToSingleSampledSampleCount(
747 rp_version, framebuffer, render_pass, k, view_state->create_info.image, image_create_info,
748 ms_rendered_to_single_sampled->rasterizationSamples, attachment_ref.attachment);
749 }
750 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100751 }
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600752 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100753
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600754 if (render_pass_info->pSubpasses[j].pDepthStencilAttachment) {
755 auto &attachment_ref = *subpass.pDepthStencilAttachment;
756 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
757 auto image_view = attachments[attachment_ref.attachment];
758 auto view_state = Get<IMAGE_VIEW_STATE>(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100759
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600760 if (view_state) {
Tony-LunarG6cc4c562022-08-24 14:55:28 -0600761 skip |= ValidateRenderPassLayoutAgainstFramebufferImageUsage(
762 rp_version, attachment_ref.layout, *view_state, framebuffer, render_pass, attachment_ref.attachment,
763 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100764 }
Tony-LunarG0857f842022-08-23 10:32:16 -0600765 if (ms_rendered_to_single_sampled && ms_rendered_to_single_sampled->multisampledRenderToSingleSampledEnable) {
766 if (render_pass_info->pAttachments[attachment_ref.attachment].samples == VK_SAMPLE_COUNT_1_BIT) {
767 const auto image_create_info = view_state->image_state.get()->createInfo;
768 skip |= ValidateMultipassRenderedToSingleSampledSampleCount(
769 rp_version, framebuffer, render_pass, 0, view_state->create_info.image, image_create_info,
770 ms_rendered_to_single_sampled->rasterizationSamples, attachment_ref.attachment, true);
771 }
772 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100773 }
774 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700775 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600776 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700777}
778
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600779void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700780 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700781 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -0600782 IMAGE_VIEW_STATE *image_view = pCB->GetActiveAttachmentImageViewState(ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600783 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700784 VkImageLayout stencil_layout = kInvalidLayout;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700785 const auto *attachment_reference_stencil_layout = LvlFindInChain<VkAttachmentReferenceStencilLayout>(ref.pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700786 if (attachment_reference_stencil_layout) {
787 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
788 }
789
Jeremy Gebben1ec89332021-08-05 13:51:49 -0600790 pCB->SetImageViewLayout(*image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600791 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700792 }
793}
794
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600795void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
796 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700797 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700798
799 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700800 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700801 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700802 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700803 }
804 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700805 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700806 }
807 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700808 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700809 }
810 }
811}
812
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700813// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
814// 1. Transition into initialLayout state
815// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600816void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700817 FRAMEBUFFER_STATE *framebuffer_state) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700818 // First record expected initialLayout as a potential initial layout usage.
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700819 auto const rpci = render_pass_state->createInfo.ptr();
820 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -0600821 auto *view_state = cb_state->GetActiveAttachmentImageViewState(i);
John Zulauf8e308292018-09-21 11:34:37 -0600822 if (view_state) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700823 IMAGE_STATE *image_state = view_state->image_state.get();
824 const auto initial_layout = rpci->pAttachments[i].initialLayout;
Piers Daniell4fde9b72019-11-27 16:19:46 -0700825 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700826 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(rpci->pAttachments[i].pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700827 if (attachment_description_stencil_layout) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700828 const auto stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
829 VkImageSubresourceRange sub_range = view_state->normalized_subresource_range;
830 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
Jeremy Gebben1ec89332021-08-05 13:51:49 -0600831 cb_state->SetImageInitialLayout(*image_state, sub_range, initial_layout);
John Zulauf81dd1f12021-01-26 16:49:16 -0700832 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
Jeremy Gebben1ec89332021-08-05 13:51:49 -0600833 cb_state->SetImageInitialLayout(*image_state, sub_range, stencil_initial_layout);
John Zulauf81dd1f12021-01-26 16:49:16 -0700834 } else {
Jeremy Gebben1ec89332021-08-05 13:51:49 -0600835 cb_state->SetImageInitialLayout(*image_state, view_state->normalized_subresource_range, initial_layout);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700836 }
John Zulauf8e308292018-09-21 11:34:37 -0600837 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700838 }
839 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700840 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700841}
842
Dave Houlton10b39482017-03-16 13:18:15 -0600843bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600844 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600845 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600846 }
847 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600848 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600849 }
850 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600851 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600852 }
Mike Schuchardt2df08912020-12-15 16:28:09 -0800853 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 -0700854 if (FormatPlaneCount(format) == 1) return false;
855 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600856 return true;
857}
858
sfricke-samsung10b35ce2021-09-29 08:50:20 -0700859// There is a table in the Vulkan spec to list all formats that implicitly require YCbCr conversion,
860// but some features/extensions can explicitly turn that restriction off
861// The implicit check is done in format utils, while feature checks are done here in CoreChecks
862bool CoreChecks::FormatRequiresYcbcrConversionExplicitly(const VkFormat format) const {
863 if (format == VK_FORMAT_R10X6G10X6B10X6A10X6_UNORM_4PACK16 &&
864 enabled_features.rgba10x6_formats_features.formatRgba10x6WithoutYCbCrSampler) {
865 return false;
866 }
867 return FormatRequiresYcbcrConversion(format);
868}
869
Mike Weiblen62d08a32017-03-07 22:18:27 -0700870// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -0700871bool CoreChecks::ValidateBarrierLayoutToImageUsage(const Location &loc, VkImage image, VkImageLayout layout,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700872 VkImageUsageFlags usage_flags) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700873 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700874 bool is_error = false;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700875 switch (layout) {
876 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700877 is_error = ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700878 break;
879 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700880 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700881 break;
882 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700883 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700884 break;
885 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700886 is_error = ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700887 break;
888 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700889 is_error = ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700890 break;
891 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700892 is_error = ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700893 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600894 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700895 is_error = ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0);
Jeff Bolz9af91c52018-09-01 21:53:57 -0500896 break;
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700897 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700898 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700899 break;
900 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700901 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700902 break;
Tony-LunarG10f54412022-08-12 11:43:40 -0600903 case VK_IMAGE_LAYOUT_ATTACHMENT_FEEDBACK_LOOP_OPTIMAL_EXT:
904 is_error = ((usage_flags & (VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) == 0);
905 is_error |= ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0);
906 is_error |= ((usage_flags & VK_IMAGE_USAGE_ATTACHMENT_FEEDBACK_LOOP_BIT_EXT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700907 default:
908 // Other VkImageLayout values do not have VUs defined in this context.
909 break;
910 }
911
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700912 if (is_error) {
913 const auto &vuid = sync_vuid_maps::GetBadImageLayoutVUID(loc, layout);
914
915 skip |=
916 LogError(image, vuid, "%s Image barrier Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".",
917 loc.Message().c_str(), string_VkImageLayout(layout), report_data->FormatHandle(image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700918 }
919 return skip;
920}
921
922// Verify image barriers are compatible with the images they reference.
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700923template <typename ImageBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -0700924bool CoreChecks::ValidateBarriersToImages(const Location &outer_loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700925 uint32_t imageMemoryBarrierCount, const ImageBarrier *pImageMemoryBarriers) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700926 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700927 using sync_vuid_maps::GetImageBarrierVUID;
928 using sync_vuid_maps::ImageError;
Petr Krausad0096a2019-08-09 18:35:04 +0200929
John Zulauf463c51e2018-05-31 13:29:20 -0600930 // Scoreboard for duplicate layout transition barriers within the list
931 // 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 +0200932 const CommandBufferImageLayoutMap &current_map = cb_state->GetImageSubresourceLayoutMap();
933 CommandBufferImageLayoutMap layout_updates;
John Zulauf463c51e2018-05-31 13:29:20 -0600934
Mike Weiblen62d08a32017-03-07 22:18:27 -0700935 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700936 auto loc = outer_loc.dot(Field::pImageMemoryBarriers, i);
Petr Krausad0096a2019-08-09 18:35:04 +0200937 const auto &img_barrier = pImageMemoryBarriers[i];
Mike Weiblen62d08a32017-03-07 22:18:27 -0700938
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600939 auto image_state = Get<IMAGE_STATE>(img_barrier.image);
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600940 if (!image_state) {
941 continue;
942 }
Tony-LunarG10f54412022-08-12 11:43:40 -0600943
944 if ((img_barrier.srcQueueFamilyIndex != img_barrier.dstQueueFamilyIndex) ||
945 (img_barrier.oldLayout != img_barrier.newLayout)) {
946 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
947 skip |=
948 ValidateBarrierLayoutToImageUsage(loc.dot(Field::oldLayout), img_barrier.image, img_barrier.oldLayout, usage_flags);
949 skip |=
950 ValidateBarrierLayoutToImageUsage(loc.dot(Field::newLayout), img_barrier.image, img_barrier.newLayout, usage_flags);
951 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600952
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600953 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
954 if (image_state->layout_locked) {
955 // TODO: Add unique id for error when available
956 skip |= LogError(
957 img_barrier.image, "VUID-Undefined",
958 "%s Attempting to transition shared presentable %s"
959 " from layout %s to layout %s, but image has already been presented and cannot have its layout transitioned.",
960 loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
961 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(img_barrier.newLayout));
962 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600963
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600964 const VkImageCreateInfo &image_create_info = image_state->createInfo;
965 const VkFormat image_format = image_create_info.format;
966 const VkImageAspectFlags aspect_mask = img_barrier.subresourceRange.aspectMask;
967 // For a Depth/Stencil image both aspects MUST be set
968 auto image_loc = loc.dot(Field::image);
969 if (FormatIsDepthAndStencil(image_format)) {
970 if (enabled_features.core12.separateDepthStencilLayouts) {
971 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
972 auto vuid = GetImageBarrierVUID(loc, ImageError::kNotDepthOrStencilAspect);
sfricke-samsung79b00482020-04-01 21:15:50 -0700973 skip |= LogError(img_barrier.image, vuid,
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600974 "%s references %s of format %s that must have either the depth or stencil "
975 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
976 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
977 string_VkFormat(image_format), aspect_mask);
978 }
979 } else {
980 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
981 if ((aspect_mask & ds_mask) != (ds_mask)) {
982 auto error = IsExtEnabled(device_extensions.vk_khr_separate_depth_stencil_layouts)
983 ? ImageError::kNotSeparateDepthAndStencilAspect
984 : ImageError::kNotDepthAndStencilAspect;
985 auto vuid = GetImageBarrierVUID(image_loc, error);
986 skip |= LogError(img_barrier.image, vuid,
987 "%s references %s of format %s that must have the depth and stencil "
988 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700989 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700990 string_VkFormat(image_format), aspect_mask);
991 }
992 }
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600993 }
sfricke-samsung79b00482020-04-01 21:15:50 -0700994
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600995 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
996 // TODO: Set memory invalid which is in mem_tracker currently
997 } else if (!QueueFamilyIsExternal(img_barrier.srcQueueFamilyIndex)) {
998 auto &write_subresource_map = layout_updates[image_state.get()];
999 bool new_write = false;
1000 if (!write_subresource_map) {
1001 write_subresource_map = std::make_shared<ImageSubresourceLayoutMap>(*image_state);
1002 new_write = true;
1003 }
1004 const auto &current_subresource_map = current_map.find(image_state.get());
1005 const auto &read_subresource_map = (new_write && current_subresource_map != current_map.end())
1006 ? (*current_subresource_map).second
1007 : write_subresource_map;
1008
Jeremy Gebben3d6fc342022-04-19 10:03:12 -06001009 // Validate aspects in isolation.
1010 // This is required when handling separate depth-stencil layouts.
1011 for (uint32_t aspect_index = 0; aspect_index < 32; aspect_index++) {
1012 VkImageAspectFlags test_aspect = 1u << aspect_index;
1013 if ((img_barrier.subresourceRange.aspectMask & test_aspect) == 0) {
1014 continue;
1015 }
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -06001016 auto old_layout = NormalizeSynchronization2Layout(img_barrier.subresourceRange.aspectMask, img_barrier.oldLayout);
Jeremy Gebben3d6fc342022-04-19 10:03:12 -06001017
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -06001018 LayoutUseCheckAndMessage layout_check(old_layout, test_aspect);
Jeremy Gebben3d6fc342022-04-19 10:03:12 -06001019 auto normalized_isr = image_state->NormalizeSubresourceRange(img_barrier.subresourceRange);
1020 normalized_isr.aspectMask = test_aspect;
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -06001021 skip |= read_subresource_map->AnyInRange(
Jeremy Gebbencb13f0f2022-07-15 15:48:05 -06001022 normalized_isr, [this, read_subresource_map, cb_state, &layout_check, &loc, &img_barrier](
1023 const LayoutRange &range, const LayoutEntry &state) {
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -06001024 bool subres_skip = false;
1025 if (!layout_check.Check(state)) {
1026 const auto &vuid = GetImageBarrierVUID(loc, ImageError::kConflictingLayout);
Jeremy Gebbencb13f0f2022-07-15 15:48:05 -06001027 auto subres = read_subresource_map->Decode(range.begin);
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -06001028 subres_skip = LogError(
1029 cb_state->commandBuffer(), vuid,
1030 "%s %s cannot transition the layout of aspect=%d level=%d layer=%d from %s when the "
1031 "%s layout is %s.",
1032 loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(), subres.aspectMask,
1033 subres.mipLevel, subres.arrayLayer, string_VkImageLayout(img_barrier.oldLayout),
1034 layout_check.message, string_VkImageLayout(layout_check.layout));
1035 }
1036 return subres_skip;
1037 });
Jeremy Gebben3d6fc342022-04-19 10:03:12 -06001038 write_subresource_map->SetSubresourceRangeLayout(*cb_state, normalized_isr, img_barrier.newLayout);
1039 }
Jeremy Gebben3d6fc342022-04-19 10:03:12 -06001040 }
1041
1042 // checks color format and (single-plane or non-disjoint)
1043 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
1044 if ((FormatIsColor(image_format) == true) &&
1045 ((FormatIsMultiplane(image_format) == false) || (image_state->disjoint == false))) {
1046 if (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT) {
1047 auto error = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion) ? ImageError::kNotColorAspect
1048 : ImageError::kNotColorAspectYcbcr;
1049 const auto &vuid = GetImageBarrierVUID(loc, error);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001050 skip |= LogError(img_barrier.image, vuid,
Jeremy Gebben3d6fc342022-04-19 10:03:12 -06001051 "%s references %s of format %s that must be only VK_IMAGE_ASPECT_COLOR_BIT, "
1052 "but its aspectMask is 0x%" PRIx32 ".",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001053 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -07001054 string_VkFormat(image_format), aspect_mask);
1055 }
Jeremy Gebben3d6fc342022-04-19 10:03:12 -06001056 }
sfricke-samsung79b00482020-04-01 21:15:50 -07001057
Jeremy Gebben3d6fc342022-04-19 10:03:12 -06001058 VkImageAspectFlags valid_disjoint_mask =
1059 VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT | VK_IMAGE_ASPECT_COLOR_BIT;
1060 if ((FormatIsMultiplane(image_format) == true) && (image_state->disjoint == true) &&
1061 ((aspect_mask & valid_disjoint_mask) == 0)) {
1062 const auto &vuid = GetImageBarrierVUID(image_loc, ImageError::kBadMultiplanarAspect);
1063 skip |= LogError(img_barrier.image, vuid,
1064 "%s references %s of format %s has aspectMask (0x%" PRIx32
1065 ") but needs to include either an VK_IMAGE_ASPECT_PLANE_*_BIT or VK_IMAGE_ASPECT_COLOR_BIT.",
1066 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1067 string_VkFormat(image_format), aspect_mask);
1068 }
1069
1070 if ((FormatPlaneCount(image_format) == 2) && ((aspect_mask & VK_IMAGE_ASPECT_PLANE_2_BIT) != 0)) {
1071 const auto &vuid = GetImageBarrierVUID(image_loc, ImageError::kBadPlaneCount);
1072 skip |= LogError(img_barrier.image, vuid,
1073 "%s references %s of format %s has only two planes but included "
1074 "VK_IMAGE_ASPECT_PLANE_2_BIT in its aspectMask (0x%" PRIx32 ").",
1075 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1076 string_VkFormat(image_format), aspect_mask);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001077 }
1078 }
1079 return skip;
1080}
1081
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001082template <typename Barrier, typename TransferBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001083bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const Location &loc, const CMD_BUFFER_STATE *cb_state, const Barrier &barrier,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001084 const QFOTransferBarrierSets<TransferBarrier> &barrier_sets) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001085 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001086 const char *handle_name = TransferBarrier::HandleName();
John Zulauf6b4aae82018-05-09 13:03:36 -06001087 const char *transfer_type = nullptr;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001088 if (!IsTransferOp(barrier)) {
1089 return skip;
1090 }
1091 const TransferBarrier *barrier_record = nullptr;
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001092 if (cb_state->IsReleaseOp(barrier) && !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001093 const auto found = barrier_sets.release.find(barrier);
1094 if (found != barrier_sets.release.cend()) {
1095 barrier_record = &(*found);
1096 transfer_type = "releasing";
John Zulauf6b4aae82018-05-09 13:03:36 -06001097 }
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001098 } else if (cb_state->IsAcquireOp(barrier) && !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001099 const auto found = barrier_sets.acquire.find(barrier);
1100 if (found != barrier_sets.acquire.cend()) {
1101 barrier_record = &(*found);
1102 transfer_type = "acquiring";
John Zulauf6b4aae82018-05-09 13:03:36 -06001103 }
1104 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001105 if (barrier_record != nullptr) {
1106 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001107 LogWarning(cb_state->commandBuffer(), TransferBarrier::ErrMsgDuplicateQFOInCB(),
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001108 "%s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
1109 " duplicates existing barrier recorded in this command buffer.",
1110 loc.Message().c_str(), transfer_type, handle_name, report_data->FormatHandle(barrier_record->handle).c_str(),
1111 barrier_record->srcQueueFamilyIndex, barrier_record->dstQueueFamilyIndex);
1112 }
John Zulauf6b4aae82018-05-09 13:03:36 -06001113 return skip;
1114}
1115
John Zulaufa4472282019-08-22 14:44:34 -06001116VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
1117 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1118}
1119
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001120VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier2KHR &barrier) {
1121 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1122}
1123
Jeremy Gebben9f537102021-10-05 16:37:12 -06001124std::shared_ptr<const IMAGE_STATE> BarrierHandleState(const ValidationStateTracker &device_state,
1125 const VkImageMemoryBarrier &barrier) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001126 return device_state.Get<IMAGE_STATE>(barrier.image);
John Zulaufa4472282019-08-22 14:44:34 -06001127}
1128
Jeremy Gebben9f537102021-10-05 16:37:12 -06001129std::shared_ptr<const IMAGE_STATE> BarrierHandleState(const ValidationStateTracker &device_state,
1130 const VkImageMemoryBarrier2KHR &barrier) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001131 return device_state.Get<IMAGE_STATE>(barrier.image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001132}
1133
John Zulaufa4472282019-08-22 14:44:34 -06001134VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
1135 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1136}
1137
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001138VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier2KHR &barrier) {
1139 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1140}
1141
Jeremy Gebben9f537102021-10-05 16:37:12 -06001142const std::shared_ptr<const BUFFER_STATE> BarrierHandleState(const ValidationStateTracker &device_state,
1143 const VkBufferMemoryBarrier &barrier) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001144 return device_state.Get<BUFFER_STATE>(barrier.buffer);
John Zulaufa4472282019-08-22 14:44:34 -06001145}
1146
Jeremy Gebben9f537102021-10-05 16:37:12 -06001147std::shared_ptr<const BUFFER_STATE> BarrierHandleState(const ValidationStateTracker &device_state,
1148 const VkBufferMemoryBarrier2KHR &barrier) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001149 return device_state.Get<BUFFER_STATE>(barrier.buffer);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001150}
John Zulaufa4472282019-08-22 14:44:34 -06001151
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001152template <typename Barrier, typename TransferBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001153void CoreChecks::RecordBarrierValidationInfo(const Location &loc, CMD_BUFFER_STATE *cb_state, const Barrier &barrier,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001154 QFOTransferBarrierSets<TransferBarrier> &barrier_sets) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001155 if (IsTransferOp(barrier)) {
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001156 if (cb_state->IsReleaseOp(barrier) && !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001157 barrier_sets.release.emplace(barrier);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001158 } else if (cb_state->IsAcquireOp(barrier) && !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001159 barrier_sets.acquire.emplace(barrier);
John Zulaufa4472282019-08-22 14:44:34 -06001160 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001161 }
John Zulaufa4472282019-08-22 14:44:34 -06001162
David Zhao Akeleyd76df472021-05-15 17:25:59 -07001163 // 7.7.4: If the values of srcQueueFamilyIndex and dstQueueFamilyIndex are equal, no ownership transfer is performed, and the
1164 // barrier operates as if they were both set to VK_QUEUE_FAMILY_IGNORED.
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001165 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
1166 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
David Zhao Akeleyd76df472021-05-15 17:25:59 -07001167 const bool is_ownership_transfer = src_queue_family != dst_queue_family;
1168
1169 if (is_ownership_transfer) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001170 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
1171 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
1172 auto handle_state = BarrierHandleState(*this, barrier);
1173 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
1174 if (!mode_concurrent) {
1175 const auto typed_handle = BarrierTypedHandle(barrier);
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001176 core_error::LocationCapture loc_capture(loc);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001177 cb_state->queue_submit_functions.emplace_back(
Jeremy Gebbene5361dd2021-11-18 14:23:56 -07001178 [loc_capture, typed_handle, src_queue_family, dst_queue_family](
1179 const ValidationStateTracker &device_data, const QUEUE_STATE &queue_state, const CMD_BUFFER_STATE &cb_state) {
John Zulaufb4438f02021-02-20 20:22:16 -07001180 return ValidateConcurrentBarrierAtSubmit(loc_capture.Get(), device_data, queue_state, cb_state, typed_handle,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001181 src_queue_family, dst_queue_family);
1182 });
John Zulauf6b4aae82018-05-09 13:03:36 -06001183 }
1184 }
1185}
1186
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001187// Verify image barrier image state and that the image is consistent with FB image
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001188template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001189bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001190 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1191 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001192 const ImgBarrier &img_barrier, const CMD_BUFFER_STATE *primary_cb_state) const {
1193 using sync_vuid_maps::GetImageBarrierVUID;
1194 using sync_vuid_maps::ImageError;
1195
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001196 bool skip = false;
1197 const auto *fb_state = framebuffer;
1198 assert(fb_state);
1199 const auto img_bar_image = img_barrier.image;
1200 bool image_match = false;
1201 bool sub_image_found = false; // Do we find a corresponding subpass description
1202 VkImageLayout sub_image_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1203 uint32_t attach_index = 0;
1204 // Verify that a framebuffer image matches barrier image
1205 const auto attachment_count = fb_state->createInfo.attachmentCount;
1206 for (uint32_t attachment = 0; attachment < attachment_count; ++attachment) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06001207 auto view_state = primary_cb_state ? primary_cb_state->GetActiveAttachmentImageViewState(attachment) : cb_state->GetActiveAttachmentImageViewState(attachment);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001208 if (view_state && (img_bar_image == view_state->create_info.image)) {
1209 image_match = true;
1210 attach_index = attachment;
1211 break;
1212 }
1213 }
1214 if (image_match) { // Make sure subpass is referring to matching attachment
1215 if (sub_desc.pDepthStencilAttachment && sub_desc.pDepthStencilAttachment->attachment == attach_index) {
1216 sub_image_layout = sub_desc.pDepthStencilAttachment->layout;
1217 sub_image_found = true;
1218 }
sfricke-samsung45996a42021-09-16 13:45:27 -07001219 if (!sub_image_found && IsExtEnabled(device_extensions.vk_khr_depth_stencil_resolve)) {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001220 const auto *resolve = LvlFindInChain<VkSubpassDescriptionDepthStencilResolve>(sub_desc.pNext);
1221 if (resolve && resolve->pDepthStencilResolveAttachment &&
1222 resolve->pDepthStencilResolveAttachment->attachment == attach_index) {
1223 sub_image_layout = resolve->pDepthStencilResolveAttachment->layout;
1224 sub_image_found = true;
1225 }
1226 }
1227 if (!sub_image_found) {
1228 for (uint32_t j = 0; j < sub_desc.colorAttachmentCount; ++j) {
1229 if (sub_desc.pColorAttachments && sub_desc.pColorAttachments[j].attachment == attach_index) {
1230 sub_image_layout = sub_desc.pColorAttachments[j].layout;
1231 sub_image_found = true;
1232 break;
1233 }
1234 if (!sub_image_found && sub_desc.pResolveAttachments &&
1235 sub_desc.pResolveAttachments[j].attachment == attach_index) {
1236 sub_image_layout = sub_desc.pResolveAttachments[j].layout;
1237 sub_image_found = true;
1238 break;
1239 }
1240 }
1241 }
1242 if (!sub_image_found) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001243 auto img_loc = loc.dot(Field::image);
1244 const auto &vuid = GetImageBarrierVUID(img_loc, ImageError::kRenderPassMismatch);
1245 skip |=
1246 LogError(rp_handle, vuid,
1247 "%s Barrier for %s is not referenced by the VkSubpassDescription for active subpass (%d) of current %s.",
1248 img_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(), active_subpass,
1249 report_data->FormatHandle(rp_handle).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001250 }
1251 } else { // !image_match
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001252 auto img_loc = loc.dot(Field::image);
1253 const auto &vuid = GetImageBarrierVUID(img_loc, ImageError::kRenderPassMismatch);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001254 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 -07001255 img_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001256 report_data->FormatHandle(fb_state->framebuffer()).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001257 }
1258 if (img_barrier.oldLayout != img_barrier.newLayout) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001259 auto layout_loc = loc.dot(Field::oldLayout);
1260 const auto &vuid = GetImageBarrierVUID(layout_loc, ImageError::kRenderPassLayoutChange);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001261 skip |= LogError(cb_state->commandBuffer(), vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001262 "%s As the Image Barrier for %s is being executed within a render pass instance, oldLayout must "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001263 "equal newLayout yet they are %s and %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001264 layout_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001265 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(img_barrier.newLayout));
1266 } else {
1267 if (sub_image_found && sub_image_layout != img_barrier.oldLayout) {
1268 LogObjectList objlist(rp_handle);
1269 objlist.add(img_bar_image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001270 auto layout_loc = loc.dot(Field::oldLayout);
1271 const auto &vuid = GetImageBarrierVUID(layout_loc, ImageError::kRenderPassLayoutChange);
1272 skip |= LogError(objlist, vuid,
1273 "%s Barrier for %s is referenced by the VkSubpassDescription for active "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001274 "subpass (%d) of current %s as having layout %s, but image barrier has layout %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001275 layout_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(), active_subpass,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001276 report_data->FormatHandle(rp_handle).c_str(), string_VkImageLayout(sub_image_layout),
1277 string_VkImageLayout(img_barrier.oldLayout));
1278 }
1279 }
1280 return skip;
1281}
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001282// explictly instantiate so these can be used in core_validation.cpp
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001283template bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001284 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1285 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
1286 const VkImageMemoryBarrier &img_barrier,
1287 const CMD_BUFFER_STATE *primary_cb_state) const;
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001288template bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001289 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1290 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
1291 const VkImageMemoryBarrier2KHR &img_barrier,
1292 const CMD_BUFFER_STATE *primary_cb_state) const;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001293
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001294template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001295void CoreChecks::EnqueueSubmitTimeValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001296 const ImgBarrier &barrier) {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001297 // Secondary CBs can have null framebuffer so queue up validation in that case 'til FB is known
1298 if ((cb_state->activeRenderPass) && (VK_NULL_HANDLE == cb_state->activeFramebuffer) &&
1299 (VK_COMMAND_BUFFER_LEVEL_SECONDARY == cb_state->createInfo.level)) {
1300 const auto active_subpass = cb_state->activeSubpass;
1301 const auto rp_state = cb_state->activeRenderPass;
1302 const auto &sub_desc = rp_state->createInfo.pSubpasses[active_subpass];
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001303 // Secondary CB case w/o FB specified delay validation
1304 auto *this_ptr = this; // Required for older compilers with c++20 compatibility
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001305 core_error::LocationCapture loc_capture(loc);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001306 const auto render_pass = rp_state->renderPass();
John Zulaufb4438f02021-02-20 20:22:16 -07001307 cb_state->cmd_execute_commands_functions.emplace_back(
Jeremy Gebben057f9d52021-11-05 14:12:31 -06001308 [this_ptr, loc_capture, active_subpass, sub_desc, render_pass, barrier](
1309 const CMD_BUFFER_STATE &secondary_cb, const CMD_BUFFER_STATE *primary_cb, const FRAMEBUFFER_STATE *fb) {
1310 return this_ptr->ValidateImageBarrierAttachment(loc_capture.Get(), &secondary_cb, fb, active_subpass, sub_desc,
John Zulaufb4438f02021-02-20 20:22:16 -07001311 render_pass, barrier, primary_cb);
1312 });
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001313 }
1314}
1315
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001316void CoreChecks::RecordBarriers(Func func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001317 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1318 const VkImageMemoryBarrier *pImageMemBarriers) {
1319 for (uint32_t i = 0; i < bufferBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001320 Location loc(func_name, Struct::VkBufferMemoryBarrier, Field::pBufferMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001321 RecordBarrierValidationInfo(loc, cb_state, pBufferMemBarriers[i], cb_state->qfo_transfer_buffer_barriers);
1322 }
1323 for (uint32_t i = 0; i < imageMemBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001324 Location loc(func_name, Struct::VkImageMemoryBarrier, Field::pImageMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001325 const auto &img_barrier = pImageMemBarriers[i];
1326 RecordBarrierValidationInfo(loc, cb_state, img_barrier, cb_state->qfo_transfer_image_barriers);
1327 EnqueueSubmitTimeValidateImageBarrierAttachment(loc, cb_state, img_barrier);
1328 }
1329}
1330
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001331void CoreChecks::RecordBarriers(Func func_name, CMD_BUFFER_STATE *cb_state, const VkDependencyInfoKHR &dep_info) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001332 for (uint32_t i = 0; i < dep_info.bufferMemoryBarrierCount; i++) {
Tony-LunarG279601c2021-11-16 10:50:51 -07001333 Location loc(func_name, Struct::VkBufferMemoryBarrier2, Field::pBufferMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001334 RecordBarrierValidationInfo(loc, cb_state, dep_info.pBufferMemoryBarriers[i], cb_state->qfo_transfer_buffer_barriers);
1335 }
1336 for (uint32_t i = 0; i < dep_info.imageMemoryBarrierCount; i++) {
Tony-LunarG279601c2021-11-16 10:50:51 -07001337 Location loc(func_name, Struct::VkImageMemoryBarrier2, Field::pImageMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001338 const auto &img_barrier = dep_info.pImageMemoryBarriers[i];
1339 RecordBarrierValidationInfo(loc, cb_state, img_barrier, cb_state->qfo_transfer_image_barriers);
1340 EnqueueSubmitTimeValidateImageBarrierAttachment(loc, cb_state, img_barrier);
1341 }
1342}
1343
1344template <typename TransferBarrier, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001345bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001346 const char *operation, const TransferBarrier &barrier,
1347 Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001348 // Record to the scoreboard or report that we have a duplication
1349 bool skip = false;
Jeremy Gebbencbf22862021-03-03 12:01:22 -07001350 auto inserted = scoreboard->emplace(barrier, cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001351 if (!inserted.second && inserted.first->second != cb_state) {
1352 // 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 -06001353 LogObjectList objlist(cb_state->commandBuffer());
Mark Lobodzinskiea561582020-03-16 18:13:56 -06001354 objlist.add(barrier.handle);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001355 objlist.add(inserted.first->second->commandBuffer());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001356 skip = LogWarning(objlist, TransferBarrier::ErrMsgDuplicateQFOInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001357 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1358 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001359 "vkQueueSubmit()", TransferBarrier::BarrierName(), operation, TransferBarrier::HandleName(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001360 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001361 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer()).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001362 }
1363 return skip;
1364}
1365
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001366template <typename TransferBarrier>
1367bool CoreChecks::ValidateQueuedQFOTransferBarriers(
1368 const CMD_BUFFER_STATE *cb_state, QFOTransferCBScoreboards<TransferBarrier> *scoreboards,
1369 const GlobalQFOTransferBarrierMap<TransferBarrier> &global_release_barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001370 bool skip = false;
Jeremy Gebben159b3cc2021-06-03 09:09:03 -06001371 const auto &cb_barriers = cb_state->GetQFOBarrierSets(TransferBarrier());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001372 const char *barrier_name = TransferBarrier::BarrierName();
1373 const char *handle_name = TransferBarrier::HandleName();
John Zulauf6b4aae82018-05-09 13:03:36 -06001374 // No release should have an extant duplicate (WARNING)
1375 for (const auto &release : cb_barriers.release) {
1376 // Check the global pending release barriers
1377 const auto set_it = global_release_barriers.find(release.handle);
1378 if (set_it != global_release_barriers.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001379 const QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001380 const auto found = set_for_handle.find(release);
1381 if (found != set_for_handle.cend()) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001382 skip |= LogWarning(cb_state->commandBuffer(), TransferBarrier::ErrMsgDuplicateQFOSubmitted(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001383 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1384 " to dstQueueFamilyIndex %" PRIu32
1385 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1386 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1387 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001388 }
1389 }
1390 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1391 }
1392 // Each acquire must have a matching release (ERROR)
1393 for (const auto &acquire : cb_barriers.acquire) {
1394 const auto set_it = global_release_barriers.find(acquire.handle);
1395 bool matching_release_found = false;
1396 if (set_it != global_release_barriers.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001397 const QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001398 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1399 }
1400 if (!matching_release_found) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001401 skip |= LogError(cb_state->commandBuffer(), TransferBarrier::ErrMsgMissingQFOReleaseInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001402 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1403 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1404 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1405 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001406 }
1407 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1408 }
1409 return skip;
1410}
1411
John Zulauf3b04ebd2019-07-18 14:08:11 -06001412bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001413 QFOTransferCBScoreboards<QFOImageTransferBarrier> *qfo_image_scoreboards,
1414 QFOTransferCBScoreboards<QFOBufferTransferBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001415 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001416 skip |=
1417 ValidateQueuedQFOTransferBarriers<QFOImageTransferBarrier>(cb_state, qfo_image_scoreboards, qfo_release_image_barrier_map);
1418 skip |= ValidateQueuedQFOTransferBarriers<QFOBufferTransferBarrier>(cb_state, qfo_buffer_scoreboards,
1419 qfo_release_buffer_barrier_map);
John Zulauf6b4aae82018-05-09 13:03:36 -06001420 return skip;
1421}
1422
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001423template <typename TransferBarrier>
1424void RecordQueuedQFOTransferBarriers(QFOTransferBarrierSets<TransferBarrier> &cb_barriers,
1425 GlobalQFOTransferBarrierMap<TransferBarrier> &global_release_barriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001426 // Add release barriers from this submit to the global map
1427 for (const auto &release : cb_barriers.release) {
1428 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
Jeremy Gebben51499ca2022-01-11 08:36:13 -07001429 // NOTE: vl_concurrent_ordered_map::find() makes a thread safe copy of the result, so we must
1430 // copy back after updating.
1431 auto iter = global_release_barriers.find(release.handle);
1432 iter->second.insert(release);
1433 global_release_barriers.insert_or_assign(release.handle, iter->second);
John Zulauf6b4aae82018-05-09 13:03:36 -06001434 }
1435
1436 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1437 for (const auto &acquire : cb_barriers.acquire) {
1438 // NOTE: We're not using [] because we don't want to create entries for missing releases
1439 auto set_it = global_release_barriers.find(acquire.handle);
1440 if (set_it != global_release_barriers.end()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001441 QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001442 set_for_handle.erase(acquire);
1443 if (set_for_handle.size() == 0) { // Clean up empty sets
Jeremy Gebben51499ca2022-01-11 08:36:13 -07001444 global_release_barriers.erase(acquire.handle);
1445 } else {
1446 // NOTE: vl_concurrent_ordered_map::find() makes a thread safe copy of the result, so we must
1447 // copy back after updating.
1448 global_release_barriers.insert_or_assign(acquire.handle, set_for_handle);
John Zulauf6b4aae82018-05-09 13:03:36 -06001449 }
1450 }
1451 }
1452}
1453
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001454void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001455 RecordQueuedQFOTransferBarriers<QFOImageTransferBarrier>(cb_state->qfo_transfer_image_barriers, qfo_release_image_barrier_map);
1456 RecordQueuedQFOTransferBarriers<QFOBufferTransferBarrier>(cb_state->qfo_transfer_buffer_barriers,
1457 qfo_release_buffer_barrier_map);
John Zulauf6b4aae82018-05-09 13:03:36 -06001458}
1459
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001460template <typename ImgBarrier>
1461void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count, const ImgBarrier *barriers) {
1462 // For ownership transfers, the barrier is specified twice; as a release
1463 // operation on the yielding queue family, and as an acquire operation
1464 // on the acquiring queue family. This barrier may also include a layout
1465 // transition, which occurs 'between' the two operations. For validation
1466 // purposes it doesn't seem important which side performs the layout
1467 // transition, but it must not be performed twice. We'll arbitrarily
1468 // choose to perform it as part of the acquire operation.
1469 //
1470 // However, we still need to record initial layout for the "initial layout" validation
1471 for (uint32_t i = 0; i < barrier_count; i++) {
1472 const auto &mem_barrier = barriers[i];
Jeremy Gebbenefead332021-06-18 08:22:44 -06001473 const bool is_release_op = cb_state->IsReleaseOp(mem_barrier);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001474 auto image_state = Get<IMAGE_STATE>(mem_barrier.image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001475 if (image_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06001476 RecordTransitionImageLayout(cb_state, image_state.get(), mem_barrier, is_release_op);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001477 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001478 }
1479}
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001480// explictly instantiate this template so it can be used in core_validation.cpp
1481template void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1482 const VkImageMemoryBarrier *barrier);
1483template void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1484 const VkImageMemoryBarrier2KHR *barrier);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001485
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001486VkImageLayout NormalizeSynchronization2Layout(const VkImageAspectFlags aspect_mask, VkImageLayout layout);
1487
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001488template <typename ImgBarrier>
unknown86bcb3a2019-07-11 13:05:36 -06001489void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001490 const ImgBarrier &mem_barrier, bool is_release_op) {
Tony-LunarG273f32f2021-09-28 08:56:30 -06001491 if (enabled_features.core13.synchronization2) {
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001492 if (mem_barrier.oldLayout == mem_barrier.newLayout) {
1493 return;
1494 }
1495 }
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06001496 auto normalized_isr = image_state->NormalizeSubresourceRange(mem_barrier.subresourceRange);
unknown86bcb3a2019-07-11 13:05:36 -06001497
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001498 VkImageLayout initial_layout = NormalizeSynchronization2Layout(mem_barrier.subresourceRange.aspectMask, mem_barrier.oldLayout);
1499 VkImageLayout new_layout = NormalizeSynchronization2Layout(mem_barrier.subresourceRange.aspectMask, mem_barrier.newLayout);
Michael Spang8af7c102020-05-03 20:50:09 -04001500
1501 // Layout transitions in external instance are not tracked, so don't validate initial layout.
John Zulaufcea64cb2020-06-10 17:17:27 -06001502 if (QueueFamilyIsExternal(mem_barrier.srcQueueFamilyIndex)) {
Michael Spang8af7c102020-05-03 20:50:09 -04001503 initial_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1504 }
1505
John Zulauf2be3fe02019-12-30 09:48:02 -07001506 if (is_release_op) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06001507 cb_state->SetImageInitialLayout(*image_state, normalized_isr, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001508 } else {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06001509 cb_state->SetImageLayout(*image_state, normalized_isr, new_layout, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001510 }
unknown86bcb3a2019-07-11 13:05:36 -06001511}
1512
John Zulauf15578df2022-06-02 13:50:03 -06001513template <typename RangeFactory>
1514bool CoreChecks::VerifyImageLayoutRange(const CMD_BUFFER_STATE &cb_node, const IMAGE_STATE &image_state,
1515 VkImageAspectFlags aspect_mask, VkImageLayout explicit_layout,
1516 const RangeFactory &range_factory, const char *caller, const char *layout_mismatch_msg_code,
1517 bool *error) const {
1518 bool skip = false;
1519 const auto *subresource_map = cb_node.GetImageSubresourceLayoutMap(image_state);
1520 if (!subresource_map) return skip;
1521
1522 LayoutUseCheckAndMessage layout_check(explicit_layout, aspect_mask);
1523 skip |= subresource_map->AnyInRange(
Jeremy Gebbencb13f0f2022-07-15 15:48:05 -06001524 range_factory(*subresource_map), [this, subresource_map, &cb_node, &image_state, &layout_check, layout_mismatch_msg_code,
1525 caller, error](const LayoutRange &range, const LayoutEntry &state) {
John Zulauf15578df2022-06-02 13:50:03 -06001526 bool subres_skip = false;
1527 if (!layout_check.Check(state)) {
1528 *error = true;
Jeremy Gebbencb13f0f2022-07-15 15:48:05 -06001529 auto subres = subresource_map->Decode(range.begin);
John Zulauf15578df2022-06-02 13:50:03 -06001530 subres_skip |= LogError(cb_node.commandBuffer(), layout_mismatch_msg_code,
1531 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1532 "%s layout %s.",
1533 caller, report_data->FormatHandle(image_state.Handle()).c_str(), subres.arrayLayer,
1534 subres.mipLevel, string_VkImageLayout(layout_check.expected_layout), layout_check.message,
1535 string_VkImageLayout(layout_check.layout));
1536 }
1537 return subres_skip;
1538 });
1539
1540 return skip;
1541}
1542
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001543bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE &cb_node, const IMAGE_STATE &image_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001544 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1545 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1546 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06001547 if (disabled[image_layout_validation]) return false;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001548 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001549
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001550 VkImageSubresourceRange normalized_isr = image_state.NormalizeSubresourceRange(range);
John Zulauf15578df2022-06-02 13:50:03 -06001551 auto range_factory = [&normalized_isr](const ImageSubresourceLayoutMap &map) {
1552 return map.RangeGen(normalized_isr);
1553 };
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001554 skip |= VerifyImageLayoutRange(cb_node, image_state, aspect_mask, explicit_layout, range_factory, caller,
John Zulauf15578df2022-06-02 13:50:03 -06001555 layout_mismatch_msg_code, error);
John Zulauff660ad62019-03-23 07:16:05 -06001556
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001557 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1558 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1559 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001560 if (image_state.createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001561 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001562 skip |= LogPerformanceWarning(cb_node.commandBuffer(), kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001563 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001564 report_data->FormatHandle(image_state.Handle()).c_str(),
Jeremy Gebben6335df62021-11-01 10:50:13 -06001565 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001566 }
sfricke-samsung45996a42021-09-16 13:45:27 -07001567 } else if (IsExtEnabled(device_extensions.vk_khr_shared_presentable_image)) {
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001568 if (image_state.shared_presentable) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001569 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001570 skip |=
1571 LogError(device, layout_invalid_msg_code,
1572 "%s: Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1573 caller, string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001574 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001575 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001576 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001577 *error = true;
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001578 skip |= LogError(cb_node.commandBuffer(), layout_invalid_msg_code,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001579 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001580 report_data->FormatHandle(image_state.Handle()).c_str(), string_VkImageLayout(explicit_layout),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001581 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001582 }
1583 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001584 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001585}
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001586bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE &cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001587 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1588 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001589 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001590 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1591 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1592}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001593
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001594bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE &cb_node, const IMAGE_VIEW_STATE &image_view_state,
Jeremy Gebbene7b99fc2022-06-02 08:44:33 -06001595 VkImageLayout explicit_layout, const char *caller, const char *layout_mismatch_msg_code,
1596 bool *error) const {
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -06001597 if (disabled[image_layout_validation]) return false;
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001598 assert(image_view_state.image_state);
1599 auto range_factory = [&image_view_state](const ImageSubresourceLayoutMap &map) {
1600 return image_layout_map::RangeGenerator(image_view_state.range_generator);
John Zulauf15578df2022-06-02 13:50:03 -06001601 };
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -06001602
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001603 return VerifyImageLayoutRange(cb_node, *image_view_state.image_state, image_view_state.create_info.subresourceRange.aspectMask,
1604 explicit_layout, range_factory, caller, layout_mismatch_msg_code, error);
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -06001605}
1606
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001607void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001608 FRAMEBUFFER_STATE *framebuffer_state) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001609 auto render_pass = Get<RENDER_PASS_STATE>(pRenderPassBegin->renderPass);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001610 if (!render_pass) return;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001611
Mike Schuchardt2df08912020-12-15 16:28:09 -08001612 const VkRenderPassCreateInfo2 *render_pass_info = render_pass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001613 if (framebuffer_state) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001614 for (uint32_t i = 0; i < render_pass_info->attachmentCount; ++i) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06001615 auto *view_state = pCB->GetActiveAttachmentImageViewState(i);
John Zulauf8e308292018-09-21 11:34:37 -06001616 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001617 VkImageLayout stencil_layout = kInvalidLayout;
1618 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001619 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(render_pass_info->pAttachments[i].pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -07001620 if (attachment_description_stencil_layout) {
1621 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1622 }
Jeremy Gebben1ec89332021-08-05 13:51:49 -06001623 pCB->SetImageViewLayout(*view_state, render_pass_info->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001624 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001625 }
1626 }
1627}
Dave Houltone19e20d2018-02-02 16:32:41 -07001628
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001629#ifdef VK_USE_PLATFORM_ANDROID_KHR
1630// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1631// This could also move into a seperate core_validation_android.cpp file... ?
1632
1633//
1634// AHB-specific validation within non-AHB APIs
1635//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001636bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001637 bool skip = false;
1638
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001639 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(create_info->pNext);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001640 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001641 if (0 != ext_fmt_android->externalFormat) {
1642 if (VK_FORMAT_UNDEFINED != create_info->format) {
1643 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001644 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1645 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1646 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001647 }
1648
1649 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001650 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1651 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1652 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001653 }
1654
1655 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001656 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1657 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06001658 "non-zero externalFormat, but usage includes bits (0x%" PRIx32 ") other than VK_IMAGE_USAGE_SAMPLED_BIT.",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001659 create_info->usage);
Dave Houltond9611312018-11-19 17:03:36 -07001660 }
1661
1662 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001663 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1664 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1665 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001666 }
1667 }
1668
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001669 if ((0 != ext_fmt_android->externalFormat) &&
1670 (ahb_ext_formats_map.find(ext_fmt_android->externalFormat) == ahb_ext_formats_map.end())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001671 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001672 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat (%" PRIu64
1673 ") which has "
1674 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().",
1675 ext_fmt_android->externalFormat);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001676 }
1677 }
1678
Dave Houltond9611312018-11-19 17:03:36 -07001679 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001680 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001681 skip |=
1682 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1683 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1684 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001685 }
1686 }
1687
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001688 const VkExternalMemoryImageCreateInfo *emici = LvlFindInChain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001689 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1690 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001691 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001692 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1693 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1694 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1695 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001696 }
1697
1698 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001699 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1700 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1701 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1702 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1703 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001704 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001705 }
1706
1707 return skip;
1708}
1709
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001710bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001711 bool skip = false;
Jeremy Gebbenf4449392022-01-28 10:09:10 -07001712 auto image_state = Get<IMAGE_STATE>(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001713
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06001714 if (image_state->HasAHBFormat()) {
Dave Houltond9611312018-11-19 17:03:36 -07001715 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001716 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1717 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001718 "format member is %s and must be VK_FORMAT_UNDEFINED.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001719 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001720 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001721
Dave Houltond9611312018-11-19 17:03:36 -07001722 // Chain must include a compatible ycbcr conversion
1723 bool conv_found = false;
1724 uint64_t external_format = 0;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001725 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = LvlFindInChain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001726 if (ycbcr_conv_info != nullptr) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001727 auto ycbcr_state = Get<SAMPLER_YCBCR_CONVERSION_STATE>(ycbcr_conv_info->conversion);
Jeremy Gebbenf4fb2a02021-07-08 09:57:46 -06001728 if (ycbcr_state) {
Dave Houltond9611312018-11-19 17:03:36 -07001729 conv_found = true;
Jeremy Gebbenf4fb2a02021-07-08 09:57:46 -06001730 external_format = ycbcr_state->external_format;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001731 }
Dave Houltond9611312018-11-19 17:03:36 -07001732 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001733 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001734 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001735 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1736 "an externalFormat (%" PRIu64
1737 ") but needs a chained VkSamplerYcbcrConversionInfo struct with a VkSamplerYcbcrConversion created "
1738 "with the same external format.",
1739 image_state->ahb_format);
Dave Houltond9611312018-11-19 17:03:36 -07001740 }
1741
1742 // Errors in create_info swizzles
sfricke-samsungbd0e8052020-06-06 01:36:39 -07001743 if (IsIdentitySwizzle(create_info->components) == false) {
1744 skip |= LogError(
1745 create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1746 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1747 "includes one or more non-identity component swizzles, r swizzle = %s, g swizzle = %s, b swizzle = %s, a swizzle "
1748 "= %s.",
1749 string_VkComponentSwizzle(create_info->components.r), string_VkComponentSwizzle(create_info->components.g),
1750 string_VkComponentSwizzle(create_info->components.b), string_VkComponentSwizzle(create_info->components.a));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001751 }
1752 }
Dave Houltond9611312018-11-19 17:03:36 -07001753
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001754 return skip;
1755}
1756
John Zulaufa26d3c82019-08-14 16:09:08 -06001757bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001758 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001759
Jeremy Gebbenf4449392022-01-28 10:09:10 -07001760 auto image_state = Get<IMAGE_STATE>(image);
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001761 if (image_state != nullptr) {
Aitor Camacho3294edd2022-05-16 22:34:19 +02001762 if (image_state->IsExternalAHB() && (0 == image_state->GetBoundMemoryStates().size())) {
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001763 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1764 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1765 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1766 "bound to memory.");
1767 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001768 }
1769 return skip;
1770}
1771
1772#else
1773
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001774bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001775 return false;
1776}
1777
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001778bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001779
John Zulaufa26d3c82019-08-14 16:09:08 -06001780bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001781
1782#endif // VK_USE_PLATFORM_ANDROID_KHR
1783
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001784bool CoreChecks::ValidateImageFormatFeatures(const VkImageCreateInfo *pCreateInfo) const {
1785 bool skip = false;
1786
1787 // validates based on imageCreateFormatFeatures from vkspec.html#resources-image-creation-limits
Lionel Landwerlin21719f62021-12-09 11:40:09 +02001788 VkFormatFeatureFlags2KHR tiling_features = 0;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001789 const VkImageTiling image_tiling = pCreateInfo->tiling;
1790 const VkFormat image_format = pCreateInfo->format;
1791
1792 if (image_format == VK_FORMAT_UNDEFINED) {
1793 // VU 01975 states format can't be undefined unless an android externalFormat
1794#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001795 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001796 if ((image_tiling == VK_IMAGE_TILING_OPTIMAL) && (ext_fmt_android != nullptr) && (0 != ext_fmt_android->externalFormat)) {
1797 auto it = ahb_ext_formats_map.find(ext_fmt_android->externalFormat);
1798 if (it != ahb_ext_formats_map.end()) {
1799 tiling_features = it->second;
1800 }
1801 }
1802#endif
1803 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
Lionel Landwerlin1da35792021-12-14 16:54:13 +02001804 layer_data::unordered_set<uint64_t> drm_format_modifiers;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001805 const VkImageDrmFormatModifierExplicitCreateInfoEXT *drm_explicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001806 LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001807 const VkImageDrmFormatModifierListCreateInfoEXT *drm_implicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001808 LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001809
1810 if (drm_explicit != nullptr) {
Lionel Landwerlin1da35792021-12-14 16:54:13 +02001811 drm_format_modifiers.insert(drm_explicit->drmFormatModifier);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001812 } else {
1813 // VUID 02261 makes sure its only explict or implict in parameter checking
1814 assert(drm_implicit != nullptr);
1815 for (uint32_t i = 0; i < drm_implicit->drmFormatModifierCount; i++) {
Lionel Landwerlin1da35792021-12-14 16:54:13 +02001816 drm_format_modifiers.insert(drm_implicit->pDrmFormatModifiers[i]);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001817 }
1818 }
1819
Lionel Landwerlin1da35792021-12-14 16:54:13 +02001820 auto fmt_drm_props = LvlInitStruct<VkDrmFormatModifierPropertiesListEXT>();
1821 auto fmt_props_2 = LvlInitStruct<VkFormatProperties2>(&fmt_drm_props);
1822 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &fmt_props_2);
Lionel Landwerlin09351a72020-06-22 18:15:59 +03001823 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
Lionel Landwerlin1da35792021-12-14 16:54:13 +02001824 drm_properties.resize(fmt_drm_props.drmFormatModifierCount);
1825 fmt_drm_props.pDrmFormatModifierProperties = drm_properties.data();
1826 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &fmt_props_2);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001827
Lionel Landwerlin1da35792021-12-14 16:54:13 +02001828 for (uint32_t i = 0; i < fmt_drm_props.drmFormatModifierCount; i++) {
1829 if (drm_format_modifiers.find(fmt_drm_props.pDrmFormatModifierProperties[i].drmFormatModifier) !=
1830 drm_format_modifiers.end()) {
1831 tiling_features |= fmt_drm_props.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001832 }
1833 }
1834 } else {
Lionel Landwerlin21719f62021-12-09 11:40:09 +02001835 VkFormatProperties3KHR format_properties = GetPDFormatProperties(image_format);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001836 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
1837 : format_properties.optimalTilingFeatures;
1838 }
1839
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001840 // Lack of disjoint format feature support while using the flag
1841 if (FormatIsMultiplane(image_format) && ((pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT) != 0) &&
Lionel Landwerlin21719f62021-12-09 11:40:09 +02001842 ((tiling_features & VK_FORMAT_FEATURE_2_DISJOINT_BIT_KHR) == 0)) {
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001843 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateFormatFeatures-02260",
1844 "vkCreateImage(): can't use VK_IMAGE_CREATE_DISJOINT_BIT because %s doesn't support "
1845 "VK_FORMAT_FEATURE_DISJOINT_BIT based on imageCreateFormatFeatures.",
1846 string_VkFormat(pCreateInfo->format));
1847 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001848
1849 return skip;
1850}
1851
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001852bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001853 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001854 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001855
sfricke-samsung45996a42021-09-16 13:45:27 -07001856 if (IsExtEnabled(device_extensions.vk_android_external_memory_android_hardware_buffer)) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001857 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001858 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1859 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001860 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1861 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001862 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001863 }
1864
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001865 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1866 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001867 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1868 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1869 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001870 }
Dave Houlton130c0212018-01-29 13:39:56 -07001871 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001872
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001873 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001874 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1875 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1876 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001877 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001878 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width (%u) exceeds "
1879 "device maxFramebufferWidth (%u).",
1880 pCreateInfo->extent.width, device_limits->maxFramebufferWidth);
Dave Houlton130c0212018-01-29 13:39:56 -07001881 }
1882
1883 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001884 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001885 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height (%u) exceeds "
1886 "device maxFramebufferHeight (%u).",
1887 pCreateInfo->extent.height, device_limits->maxFramebufferHeight);
Dave Houlton130c0212018-01-29 13:39:56 -07001888 }
1889
ziga-lunarg44cba6e2021-07-13 17:58:06 +02001890 VkImageCreateFlags sparseFlags =
1891 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
1892 if ((pCreateInfo->flags & sparseFlags) && (pCreateInfo->usage & VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT)) {
1893 skip |= LogError(
1894 device, "VUID-VkImageCreateInfo-None-01925",
1895 "vkCreateImage(): images using sparse memory cannot have VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT set");
1896 }
1897
Agarwal, Arpit78509112022-02-17 15:29:05 -07001898 if (!enabled_features.fragment_density_map_offset_features.fragmentDensityMapOffset) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001899 uint32_t ceiling_width = static_cast<uint32_t>(ceil(
1900 static_cast<float>(device_limits->maxFramebufferWidth) /
1901 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001902 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1903 skip |=
Agarwal, Arpit78509112022-02-17 15:29:05 -07001904 LogError(device, "VUID-VkImageCreateInfo-fragmentDensityMapOffset-06514",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001905 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1906 "ceiling of device "
1907 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1908 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1909 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001910 }
1911
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001912 uint32_t ceiling_height = static_cast<uint32_t>(ceil(
1913 static_cast<float>(device_limits->maxFramebufferHeight) /
1914 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001915 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1916 skip |=
Agarwal, Arpit78509112022-02-17 15:29:05 -07001917 LogError(device, "VUID-VkImageCreateInfo-fragmentDensityMapOffset-06515",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001918 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1919 "ceiling of device "
1920 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1921 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1922 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001923 }
1924 }
1925
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001926 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001927 VkResult result = VK_SUCCESS;
1928 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1929 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1930 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1931 &format_limits);
1932 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001933 auto modifier_list = LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1934 auto explicit_modifier = LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001935 if (modifier_list) {
1936 for (uint32_t i = 0; i < modifier_list->drmFormatModifierCount; i++) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001937 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001938 drm_format_modifier.drmFormatModifier = modifier_list->pDrmFormatModifiers[i];
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001939 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001940 image_format_info.type = pCreateInfo->imageType;
1941 image_format_info.format = pCreateInfo->format;
1942 image_format_info.tiling = pCreateInfo->tiling;
1943 image_format_info.usage = pCreateInfo->usage;
1944 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001945 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001946
1947 result =
1948 DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1949 format_limits = image_format_properties.imageFormatProperties;
1950
1951 /* The application gives a list of modifier and the driver
1952 * selects one. If one is wrong, stop there.
1953 */
1954 if (result != VK_SUCCESS) break;
1955 }
1956 } else if (explicit_modifier) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001957 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001958 drm_format_modifier.drmFormatModifier = explicit_modifier->drmFormatModifier;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001959 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001960 image_format_info.type = pCreateInfo->imageType;
1961 image_format_info.format = pCreateInfo->format;
1962 image_format_info.tiling = pCreateInfo->tiling;
1963 image_format_info.usage = pCreateInfo->usage;
1964 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001965 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001966
1967 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1968 format_limits = image_format_properties.imageFormatProperties;
1969 }
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001970 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001971
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001972 // 1. vkGetPhysicalDeviceImageFormatProperties[2] only success code is VK_SUCCESS
1973 // 2. If call returns an error, then "imageCreateImageFormatPropertiesList" is defined to be the empty list
1974 // 3. All values in 02251 are undefined if "imageCreateImageFormatPropertiesList" is empty.
1975 if (result != VK_SUCCESS) {
1976 // External memory will always have a "imageCreateImageFormatPropertiesList" so skip
Lockee87f87c2019-04-23 17:53:10 -06001977#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001978 if (!LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext)) {
Lockee87f87c2019-04-23 17:53:10 -06001979#endif // VK_USE_PLATFORM_ANDROID_KHR
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001980 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateMaxMipLevels-02251",
Spencer Frickec46fc6d2020-04-16 06:23:05 -07001981 "vkCreateImage(): Format %s is not supported for this combination of parameters and "
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001982 "VkGetPhysicalDeviceImageFormatProperties returned back %s.",
1983 string_VkFormat(pCreateInfo->format), string_VkResult(result));
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001984#ifdef VK_USE_PLATFORM_ANDROID_KHR
1985 }
1986#endif // VK_USE_PLATFORM_ANDROID_KHR
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001987 } else {
1988 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1989 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001990 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1991 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1992 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001993 }
Dave Houlton130c0212018-01-29 13:39:56 -07001994
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001995 uint64_t texel_count = static_cast<uint64_t>(pCreateInfo->extent.width) *
1996 static_cast<uint64_t>(pCreateInfo->extent.height) *
1997 static_cast<uint64_t>(pCreateInfo->extent.depth) * static_cast<uint64_t>(pCreateInfo->arrayLayers) *
1998 static_cast<uint64_t>(pCreateInfo->samples);
Dave Houlton130c0212018-01-29 13:39:56 -07001999
sfricke-samsung2e827212021-09-28 07:52:08 -07002000 // Depth/Stencil formats size can't be accurately calculated
2001 if (!FormatIsDepthAndStencil(pCreateInfo->format)) {
2002 uint64_t total_size =
2003 static_cast<uint64_t>(std::ceil(FormatTexelSize(pCreateInfo->format) * static_cast<double>(texel_count)));
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002004
sfricke-samsung2e827212021-09-28 07:52:08 -07002005 // Round up to imageGranularity boundary
2006 VkDeviceSize image_granularity = phys_dev_props.limits.bufferImageGranularity;
2007 uint64_t ig_mask = image_granularity - 1;
2008 total_size = (total_size + ig_mask) & ~ig_mask;
2009
2010 if (total_size > format_limits.maxResourceSize) {
2011 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
2012 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
2013 ", maximum resource size = 0x%" PRIxLEAST64 " ",
2014 total_size, format_limits.maxResourceSize);
2015 }
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002016 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002017
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002018 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002019 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
2020 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
2021 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002022 }
2023
2024 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002025 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
2026 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
2027 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002028 }
sfricke-samsung612f3622020-06-20 20:42:46 -07002029
2030 if (pCreateInfo->extent.width > format_limits.maxExtent.width) {
2031 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02252",
2032 "vkCreateImage(): extent.width %u exceeds allowable maximum image extent width %u.",
2033 pCreateInfo->extent.width, format_limits.maxExtent.width);
2034 }
2035
2036 if (pCreateInfo->extent.height > format_limits.maxExtent.height) {
2037 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02253",
2038 "vkCreateImage(): extent.height %u exceeds allowable maximum image extent height %u.",
2039 pCreateInfo->extent.height, format_limits.maxExtent.height);
2040 }
2041
2042 if (pCreateInfo->extent.depth > format_limits.maxExtent.depth) {
2043 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02254",
2044 "vkCreateImage(): extent.depth %u exceeds allowable maximum image extent depth %u.",
2045 pCreateInfo->extent.depth, format_limits.maxExtent.depth);
2046 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002047 }
2048
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002049 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsung10b35ce2021-09-29 08:50:20 -07002050 if (FormatRequiresYcbcrConversionExplicitly(pCreateInfo->format)) {
sfricke-samsungcead0802020-01-30 22:20:10 -08002051 if (pCreateInfo->mipLevels != 1) {
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07002052 skip |= LogError(device, "VUID-VkImageCreateInfo-format-06410",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002053 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
tmerilehtica733542022-04-13 14:00:29 +03002054 pCreateInfo->mipLevels);
sfricke-samsungcead0802020-01-30 22:20:10 -08002055 }
2056
2057 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002058 skip |= LogError(
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07002059 device, "VUID-VkImageCreateInfo-format-06411",
sfricke-samsungcead0802020-01-30 22:20:10 -08002060 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
2061 string_VkSampleCountFlagBits(pCreateInfo->samples));
2062 }
2063
2064 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002065 skip |= LogError(
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07002066 device, "VUID-VkImageCreateInfo-format-06412",
sfricke-samsungcead0802020-01-30 22:20:10 -08002067 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
2068 string_VkImageType(pCreateInfo->imageType));
2069 }
2070 }
2071
sfricke-samsung45996a42021-09-16 13:45:27 -07002072 if (IsExtEnabled(device_extensions.vk_khr_maintenance2)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07002073 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
sfricke-samsung08796682021-09-13 07:47:20 -07002074 if (!FormatIsCompressed(pCreateInfo->format)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07002075 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01572",
2076 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
sfricke-samsung08796682021-09-13 07:47:20 -07002077 "format must be a compressed image format, but is %s",
Spencer Fricke48db59b2020-03-23 10:31:46 -07002078 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06002079 }
2080 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07002081 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01573",
2082 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
2083 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06002084 }
2085 }
2086 }
2087
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07002088 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
sfricke-samsung45996a42021-09-16 13:45:27 -07002089 const char *vuid = IsExtEnabled(device_extensions.vk_khr_get_physical_device_properties2)
2090 ? "VUID-VkImageCreateInfo-sharingMode-01420"
2091 : "VUID-VkImageCreateInfo-sharingMode-01392";
Mark Lobodzinski314b9162020-07-16 15:33:08 -06002092 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
ziga-lunarge2e283d2021-08-01 09:55:04 +02002093 "vkCreateImage", "pCreateInfo->pQueueFamilyIndices", vuid);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07002094 }
2095
unknown2c877272019-07-11 12:56:50 -06002096 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
2097 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
2098 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002099 LogError(device, "VUID-VkImageCreateInfo-format-01577",
2100 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
2101 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06002102 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002103
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07002104 const auto swapchain_create_info = LvlFindInChain<VkImageSwapchainCreateInfoKHR>(pCreateInfo->pNext);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002105 if (swapchain_create_info != nullptr) {
2106 if (swapchain_create_info->swapchain != VK_NULL_HANDLE) {
Jeremy Gebbenf4449392022-01-28 10:09:10 -07002107 auto swapchain_state = Get<SWAPCHAIN_NODE>(swapchain_create_info->swapchain);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002108 const VkSwapchainCreateFlagsKHR swapchain_flags = swapchain_state->createInfo.flags;
2109
2110 // Validate rest of Swapchain Image create check that require swapchain state
2111 const char *vuid = "VUID-VkImageSwapchainCreateInfoKHR-swapchain-00995";
2112 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR) != 0) &&
2113 ((pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) == 0)) {
2114 skip |= LogError(
2115 device, vuid,
2116 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR flag so "
2117 "all swapchain images must have the VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT flag set.");
2118 }
2119 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR) != 0) &&
2120 ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) == 0)) {
2121 skip |= LogError(device, vuid,
2122 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR flag so all "
2123 "swapchain images must have the VK_IMAGE_CREATE_PROTECTED_BIT flag set.");
2124 }
Mike Schuchardt2df08912020-12-15 16:28:09 -08002125 const VkImageCreateFlags mutable_flags = (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT | VK_IMAGE_CREATE_EXTENDED_USAGE_BIT);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002126 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR) != 0) &&
2127 ((pCreateInfo->flags & mutable_flags) != mutable_flags)) {
2128 skip |= LogError(device, vuid,
2129 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR flag so "
2130 "all swapchain images must have the VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT and "
Mike Schuchardt2df08912020-12-15 16:28:09 -08002131 "VK_IMAGE_CREATE_EXTENDED_USAGE_BIT flags both set.");
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002132 }
2133 }
2134 }
2135
sfricke-samsungedce77a2020-07-03 22:35:13 -07002136 if ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) != 0) {
2137 if (enabled_features.core11.protectedMemory == VK_FALSE) {
2138 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01890",
2139 "vkCreateImage(): the protectedMemory device feature is disabled: Images cannot be created with the "
2140 "VK_IMAGE_CREATE_PROTECTED_BIT set.");
2141 }
2142 const VkImageCreateFlags invalid_flags =
2143 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
2144 if ((pCreateInfo->flags & invalid_flags) != 0) {
2145 skip |= LogError(device, "VUID-VkImageCreateInfo-None-01891",
2146 "vkCreateImage(): VK_IMAGE_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at same "
2147 "time (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | "
2148 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT).");
2149 }
2150 }
2151
Tony-LunarG24838772022-07-19 14:07:12 -06002152 if ((pCreateInfo->flags & VK_IMAGE_CREATE_MULTISAMPLED_RENDER_TO_SINGLE_SAMPLED_BIT_EXT) != 0) {
2153 if (!(enabled_features.multisampled_render_to_single_sampled_features.multisampledRenderToSingleSampled)) {
2154 skip |= LogError(
2155 device, "VUID-VkImageCreateInfo-multisampledRenderToSingleSampled-06882",
2156 "vkCreateImage(): pCreateInfo.flags contains VK_IMAGE_CREATE_MULTISAMPLED_RENDER_TO_SINGLE_SAMPLED_BIT_EXT "
2157 "but the multisampledRenderToSingleSampled feature is not enabled");
2158 }
2159 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
2160 skip |= LogError(
2161 device, "VUID-VkImageCreateInfo-flags-06883",
2162 "vkCreateImage(): pCreateInfo.flags contains VK_IMAGE_CREATE_MULTISAMPLED_RENDER_TO_SINGLE_SAMPLED_BIT_EXT "
2163 "but samples (%s) is not equal to VK_SAMPLE_COUNT_1_BIT",
2164 string_VkSampleCountFlagBits(pCreateInfo->samples));
2165 }
2166 }
2167
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002168 skip |= ValidateImageFormatFeatures(pCreateInfo);
2169
Nathaniel Cesarioc02c2512020-11-13 12:04:24 -07002170 // Check compatibility with VK_KHR_portability_subset
sfricke-samsung45996a42021-09-16 13:45:27 -07002171 if (IsExtEnabled(device_extensions.vk_khr_portability_subset)) {
Nathaniel Cesarioc02c2512020-11-13 12:04:24 -07002172 if (VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT & pCreateInfo->flags &&
2173 VK_FALSE == enabled_features.portability_subset_features.imageView2DOn3DImage) {
2174 skip |= LogError(device, "VUID-VkImageCreateInfo-imageView2DOn3DImage-04459",
2175 "vkCreateImage (portability error): VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT is not supported.");
2176 }
2177 if ((VK_SAMPLE_COUNT_1_BIT != pCreateInfo->samples) && (1 != pCreateInfo->arrayLayers) &&
2178 (VK_FALSE == enabled_features.portability_subset_features.multisampleArrayImage)) {
2179 skip |=
2180 LogError(device, "VUID-VkImageCreateInfo-multisampleArrayImage-04460",
2181 "vkCreateImage (portability error): Cannot create an image with samples/texel > 1 && arrayLayers != 1");
2182 }
2183 }
2184
ziga-lunarg63f8d7a2021-07-20 22:10:31 +02002185 const auto external_memory_create_info_nv = LvlFindInChain<VkExternalMemoryImageCreateInfoNV>(pCreateInfo->pNext);
ziga-lunarg62aa24f2021-10-09 11:58:30 +02002186 const auto external_memory_create_info = LvlFindInChain<VkExternalMemoryImageCreateInfo>(pCreateInfo->pNext);
2187 if (external_memory_create_info_nv != nullptr && external_memory_create_info != nullptr) {
2188 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-00988",
2189 "vkCreateImage(): VkImageCreateInfo struct has both VkExternalMemoryImageCreateInfoNV and "
2190 "VkExternalMemoryImageCreateInfo chained structs.");
2191 }
2192 if (external_memory_create_info) {
2193 if (external_memory_create_info->handleTypes != 0 && pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_UNDEFINED) {
2194 skip |= LogError(
2195 device, "VUID-VkImageCreateInfo-pNext-01443",
2196 "vkCreateImage: VkImageCreateInfo pNext chain includes VkExternalMemoryImageCreateInfo with handleTypes %" PRIu32
2197 " but pCreateInfo->initialLayout is %s.",
2198 external_memory_create_info->handleTypes, string_VkImageLayout(pCreateInfo->initialLayout));
2199 }
2200 } else if (external_memory_create_info_nv) {
2201 if (external_memory_create_info_nv->handleTypes != 0 && pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_UNDEFINED) {
2202 skip |= LogError(
2203 device, "VUID-VkImageCreateInfo-pNext-01443",
2204 "vkCreateImage: VkImageCreateInfo pNext chain includes VkExternalMemoryImageCreateInfoNV with handleTypes %" PRIu32
2205 " but pCreateInfo->initialLayout is %s.",
2206 external_memory_create_info_nv->handleTypes, string_VkImageLayout(pCreateInfo->initialLayout));
ziga-lunarg63f8d7a2021-07-20 22:10:31 +02002207 }
2208 }
2209
ziga-lunarg374fd9a2021-07-18 10:32:52 +02002210 if (device_group_create_info.physicalDeviceCount == 1) {
2211 if (pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) {
2212 skip |= LogError(device, "VUID-VkImageCreateInfo-physicalDeviceCount-01421",
2213 "vkCreateImage: Device was created with VkDeviceGroupDeviceCreateInfo::physicalDeviceCount 1, but "
2214 "flags contain VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT bit.");
2215 }
2216 }
2217
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002218 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002219}
2220
John Zulauf7eeb6f72019-06-17 11:56:36 -06002221void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
2222 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
2223 if (VK_SUCCESS != result) return;
2224
2225 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
Jeremy Gebben4a8881f2022-01-10 17:04:30 -07002226 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) != 0) {
2227 // non-sparse images set up their layout maps when memory is bound
2228 auto image_state = Get<IMAGE_STATE>(*pImage);
2229 image_state->SetInitialLayoutMap();
2230 }
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07002231}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002232
Jeff Bolz5c801d12019-10-09 10:38:45 -05002233bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeremy Gebbenf4449392022-01-28 10:09:10 -07002234 auto image_state = Get<IMAGE_STATE>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002235 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07002236 if (image_state) {
paul-lunarg4820fd12022-07-12 11:08:01 -06002237 if (image_state->IsSwapchainImage() && image_state->owned_by_swapchain) {
sfricke-samsung73452522021-06-17 08:44:46 -07002238 skip |= LogError(device, "VUID-vkDestroyImage-image-04882",
sfricke-samsung9056cc12021-04-18 22:51:00 -07002239 "vkDestroyImage(): %s is a presentable image and it is controlled by the implementation and is "
2240 "destroyed with vkDestroySwapchainKHR.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002241 report_data->FormatHandle(image_state->image()).c_str());
sfricke-samsung9056cc12021-04-18 22:51:00 -07002242 }
Jeremy Gebben9f537102021-10-05 16:37:12 -06002243 skip |= ValidateObjectNotInUse(image_state.get(), "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002244 }
2245 return skip;
2246}
2247
John Zulauf7eeb6f72019-06-17 11:56:36 -06002248void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
2249 // Clean up validation specific data
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002250 auto image_state = Get<IMAGE_STATE>(image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07002251 qfo_release_image_barrier_map.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06002252 // Clean up generic image state
2253 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002254}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002255
sfricke-samsungcd924d92020-05-20 23:51:17 -07002256bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range,
2257 const char *param_name) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002258 bool skip = false;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002259 const VkImage image = image_state->image();
sfricke-samsungcd924d92020-05-20 23:51:17 -07002260 const VkFormat format = image_state->createInfo.format;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002261
2262 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002263 skip |= LogError(image, "VUID-vkCmdClearColorImage-aspectMask-02498",
2264 "vkCmdClearColorImage(): %s.aspectMasks must only be set to VK_IMAGE_ASPECT_COLOR_BIT.", param_name);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002265 }
2266
sfricke-samsungcd924d92020-05-20 23:51:17 -07002267 if (FormatIsDepthOrStencil(format)) {
2268 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2269 "vkCmdClearColorImage(): %s called with image %s which has a depth/stencil format (%s).", param_name,
2270 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
2271 } else if (FormatIsCompressed(format)) {
2272 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2273 "vkCmdClearColorImage(): %s called with image %s which has a compressed format (%s).", param_name,
2274 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002275 }
2276
2277 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002278 skip |=
2279 LogError(image, "VUID-vkCmdClearColorImage-image-00002",
2280 "vkCmdClearColorImage() %s called with image %s which was created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.",
2281 param_name, report_data->FormatHandle(image).c_str());
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002282 }
2283 return skip;
2284}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002285
John Zulauf07288512019-07-05 11:09:50 -06002286bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
2287 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
2288 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002289 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002290 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2291 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002292 skip |= LogError(image_state->image(), "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002293 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2294 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002295 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002296
2297 } else {
2298 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
sfricke-samsung45996a42021-09-16 13:45:27 -07002299 if (!IsExtEnabled(device_extensions.vk_khr_shared_presentable_image)) {
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002300 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002301 skip |= LogError(image_state->image(), "VUID-vkCmdClearColorImage-imageLayout-00005",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002302 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2303 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002304 }
2305 } else {
2306 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
2307 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002308 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002309 image_state->image(), "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002310 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
2311 func_name, string_VkImageLayout(dest_image_layout));
2312 }
2313 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002314 }
2315
John Zulauff660ad62019-03-23 07:16:05 -06002316 // Cast to const to prevent creation at validate time.
Jeremy Gebben6335df62021-11-01 10:50:13 -06002317 const auto *subresource_map = cb_node->GetImageSubresourceLayoutMap(*image_state);
John Zulauff660ad62019-03-23 07:16:05 -06002318 if (subresource_map) {
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -06002319 LayoutUseCheckAndMessage layout_check(dest_image_layout);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002320 auto normalized_isr = image_state->NormalizeSubresourceRange(range);
Tony Barbour55688172020-09-23 15:19:50 -07002321 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
2322 // the next "constant value" range
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -06002323 skip |= subresource_map->AnyInRange(
Jeremy Gebbencb13f0f2022-07-15 15:48:05 -06002324 normalized_isr, [this, cb_node, &layout_check, func_name](const LayoutRange &range, const LayoutEntry &state) {
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -06002325 bool subres_skip = false;
2326 if (!layout_check.Check(state)) {
2327 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
2328 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2329 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
2330 } else {
2331 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
2332 }
2333 subres_skip |= LogError(cb_node->commandBuffer(), error_code,
2334 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
2335 func_name, string_VkImageLayout(layout_check.expected_layout), layout_check.message,
2336 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002337 }
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -06002338 return subres_skip;
2339 });
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002340 }
2341
2342 return skip;
2343}
2344
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002345bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2346 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002347 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002348 bool skip = false;
2349 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07002350 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07002351 auto image_state = Get<IMAGE_STATE>(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002352 if (cb_node && image_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06002353 skip |= ValidateMemoryIsBoundToImage(image_state.get(), "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
2354 skip |= ValidateCmd(cb_node.get(), CMD_CLEARCOLORIMAGE);
sfricke-samsung45996a42021-09-16 13:45:27 -07002355 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Lionel Landwerlin21719f62021-12-09 11:40:09 +02002356 skip |= ValidateImageFormatFeatureFlags(image_state.get(), VK_FORMAT_FEATURE_2_TRANSFER_DST_BIT_KHR,
2357 "vkCmdClearColorImage", "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04002358 }
Jeremy Gebben9f537102021-10-05 16:37:12 -06002359 skip |= ValidateProtectedImage(cb_node.get(), image_state.get(), "vkCmdClearColorImage()",
2360 "VUID-vkCmdClearColorImage-commandBuffer-01805");
2361 skip |= ValidateUnprotectedImage(cb_node.get(), image_state.get(), "vkCmdClearColorImage()",
sfricke-samsung022fa252020-07-24 03:26:16 -07002362 "VUID-vkCmdClearColorImage-commandBuffer-01806");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002363 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002364 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Jeremy Gebben9f537102021-10-05 16:37:12 -06002365 skip |= ValidateCmdClearColorSubresourceRange(image_state.get(), pRanges[i], param_name.c_str());
2366 skip |= ValidateImageAttributes(image_state.get(), pRanges[i], param_name.c_str());
2367 skip |= VerifyClearImageLayout(cb_node.get(), image_state.get(), pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002368 }
sfricke-samsunge775d492020-02-28 09:02:25 -08002369 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsung10b35ce2021-09-29 08:50:20 -07002370 if (FormatRequiresYcbcrConversionExplicitly(image_state->createInfo.format)) {
sfricke-samsunge775d492020-02-28 09:02:25 -08002371 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
2372 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
2373 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
2374 string_VkFormat(image_state->createInfo.format));
2375 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002376 }
2377 return skip;
2378}
2379
John Zulaufeabb4462019-07-05 14:13:03 -06002380void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2381 const VkClearColorValue *pColor, uint32_t rangeCount,
2382 const VkImageSubresourceRange *pRanges) {
2383 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
2384
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07002385 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002386 auto image_state = Get<IMAGE_STATE>(image);
John Zulaufeabb4462019-07-05 14:13:03 -06002387 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002388 for (uint32_t i = 0; i < rangeCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06002389 cb_node->SetImageInitialLayout(image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002390 }
2391 }
2392}
2393
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002394bool CoreChecks::ValidateClearDepthStencilValue(VkCommandBuffer commandBuffer, VkClearDepthStencilValue clearValue,
2395 const char *apiName) const {
2396 bool skip = false;
2397
2398 // 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 -07002399 if (!IsExtEnabled(device_extensions.vk_ext_depth_range_unrestricted)) {
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002400 if (!(clearValue.depth >= 0.0) || !(clearValue.depth <= 1.0)) {
2401 // Also VUID-VkClearDepthStencilValue-depth-00022
2402 skip |= LogError(commandBuffer, "VUID-VkClearDepthStencilValue-depth-02506",
2403 "%s: VK_EXT_depth_range_unrestricted extension is not enabled and VkClearDepthStencilValue::depth "
2404 "(=%f) is not within the [0.0, 1.0] range.",
2405 apiName, clearValue.depth);
2406 }
2407 }
2408
2409 return skip;
2410}
2411
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002412bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2413 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002414 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002415 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002416
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002417 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07002418 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07002419 auto image_state = Get<IMAGE_STATE>(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002420 if (cb_node && image_state) {
sfricke-samsung30e325a2020-07-25 12:56:13 -07002421 const VkFormat image_format = image_state->createInfo.format;
Jeremy Gebben9f537102021-10-05 16:37:12 -06002422 skip |= ValidateMemoryIsBoundToImage(image_state.get(), "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002423 "VUID-vkCmdClearDepthStencilImage-image-00010");
Jeremy Gebben9f537102021-10-05 16:37:12 -06002424 skip |= ValidateCmd(cb_node.get(), CMD_CLEARDEPTHSTENCILIMAGE);
sfricke-samsung45996a42021-09-16 13:45:27 -07002425 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Lionel Landwerlin21719f62021-12-09 11:40:09 +02002426 skip |= ValidateImageFormatFeatureFlags(image_state.get(), VK_FORMAT_FEATURE_2_TRANSFER_DST_BIT_KHR,
Jeremy Gebben9f537102021-10-05 16:37:12 -06002427 "vkCmdClearDepthStencilImage", "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04002428 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002429 skip |= ValidateClearDepthStencilValue(commandBuffer, *pDepthStencil, "vkCmdClearDepthStencilImage()");
Jeremy Gebben9f537102021-10-05 16:37:12 -06002430 skip |= ValidateProtectedImage(cb_node.get(), image_state.get(), "vkCmdClearDepthStencilImage()",
sfricke-samsung022fa252020-07-24 03:26:16 -07002431 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01807");
Jeremy Gebben9f537102021-10-05 16:37:12 -06002432 skip |= ValidateUnprotectedImage(cb_node.get(), image_state.get(), "vkCmdClearDepthStencilImage()",
sfricke-samsung022fa252020-07-24 03:26:16 -07002433 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01808");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002434
2435 bool any_include_aspect_depth_bit = false;
2436 bool any_include_aspect_stencil_bit = false;
2437
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002438 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002439 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Jeremy Gebben9f537102021-10-05 16:37:12 -06002440 skip |= ValidateCmdClearDepthSubresourceRange(image_state.get(), pRanges[i], param_name.c_str());
2441 skip |=
2442 VerifyClearImageLayout(cb_node.get(), image_state.get(), pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002443 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06002444 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
2445 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002446 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-aspectMask-02824",
2447 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask can only be VK_IMAGE_ASPECT_DEPTH_BIT "
2448 "and/or VK_IMAGE_ASPECT_STENCIL_BIT.",
2449 i);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002450 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002451 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
2452 any_include_aspect_depth_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002453 if (FormatHasDepth(image_format) == false) {
2454 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02826",
2455 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_DEPTH_BIT but %s "
2456 "doesn't have a depth component.",
2457 i, string_VkFormat(image_format));
2458 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002459 }
2460 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
2461 any_include_aspect_stencil_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002462 if (FormatHasStencil(image_format) == false) {
2463 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02825",
2464 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_STENCIL_BIT but "
2465 "%s doesn't have a stencil component.",
2466 i, string_VkFormat(image_format));
2467 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002468 }
2469 }
2470 if (any_include_aspect_stencil_bit) {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07002471 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05002472 if (image_stencil_struct != nullptr) {
2473 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
2474 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002475 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
2476 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
2477 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
2478 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002479 }
2480 } else {
2481 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002482 skip |= LogError(
2483 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05002484 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
2485 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
2486 "in VkImageCreateInfo::usage used to create image");
2487 }
2488 }
2489 }
2490 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002491 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
2492 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
2493 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002494 }
sfricke-samsung30e325a2020-07-25 12:56:13 -07002495 if (image_state && !FormatIsDepthOrStencil(image_format)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002496 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014",
2497 "vkCmdClearDepthStencilImage(): called with image %s which doesn't have a depth/stencil format (%s).",
sfricke-samsung30e325a2020-07-25 12:56:13 -07002498 report_data->FormatHandle(image).c_str(), string_VkFormat(image_format));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002499 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002500 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002501 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009",
2502 "vkCmdClearDepthStencilImage(): called with image %s which was not created with the "
2503 "VK_IMAGE_USAGE_TRANSFER_DST_BIT set.",
2504 report_data->FormatHandle(image).c_str());
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002505 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002506 }
2507 return skip;
2508}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002509
John Zulaufeabb4462019-07-05 14:13:03 -06002510void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2511 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
2512 const VkImageSubresourceRange *pRanges) {
2513 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07002514
2515 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002516 auto image_state = Get<IMAGE_STATE>(image);
John Zulaufeabb4462019-07-05 14:13:03 -06002517 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002518 for (uint32_t i = 0; i < rangeCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06002519 cb_node->SetImageInitialLayout(image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002520 }
2521 }
2522}
2523
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002524// Returns true if [x, xoffset] and [y, yoffset] overlap
2525static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
2526 bool result = false;
2527 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
2528 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
2529
2530 if (intersection_max > intersection_min) {
2531 result = true;
2532 }
2533 return result;
2534}
2535
Aitor Camacho82c1a7a2022-07-05 22:21:19 +02002536// Returns true if source area of first vkImageCopy/vkImageCopy2KHR region intersects dest area of second region
2537// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
2538template <typename RegionType>
2539static bool RegionIntersects(const RegionType *region0, const RegionType *region1, VkImageType type, bool is_multiplane) {
2540 bool result = false;
2541
2542 // Separate planes within a multiplane image cannot intersect
2543 if (is_multiplane && (region0->srcSubresource.aspectMask != region1->dstSubresource.aspectMask)) {
2544 return result;
2545 }
2546
2547 if ((region0->srcSubresource.mipLevel == region1->dstSubresource.mipLevel) &&
2548 (RangesIntersect(region0->srcSubresource.baseArrayLayer, region0->srcSubresource.layerCount,
2549 region1->dstSubresource.baseArrayLayer, region1->dstSubresource.layerCount))) {
2550 result = true;
2551 switch (type) {
2552 case VK_IMAGE_TYPE_3D:
2553 result &= RangesIntersect(region0->srcOffset.z, region0->extent.depth, region1->dstOffset.z, region1->extent.depth);
2554 // fall through
2555 case VK_IMAGE_TYPE_2D:
2556 result &=
2557 RangesIntersect(region0->srcOffset.y, region0->extent.height, region1->dstOffset.y, region1->extent.height);
2558 // fall through
2559 case VK_IMAGE_TYPE_1D:
2560 result &= RangesIntersect(region0->srcOffset.x, region0->extent.width, region1->dstOffset.x, region1->extent.width);
2561 break;
2562 default:
2563 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2564 assert(false);
2565 }
2566 }
2567 return result;
2568}
2569
aitor-lunarg607fe732022-03-31 22:00:08 +02002570template <typename RegionType>
2571static bool RegionIntersectsBlit(const RegionType *region0, const RegionType *region1, VkImageType type, bool is_multiplane) {
2572 bool result = false;
2573
2574 // Separate planes within a multiplane image cannot intersect
2575 if (is_multiplane && (region0->srcSubresource.aspectMask != region1->dstSubresource.aspectMask)) {
2576 return result;
2577 }
2578
2579 if ((region0->srcSubresource.mipLevel == region1->dstSubresource.mipLevel) &&
2580 (RangesIntersect(region0->srcSubresource.baseArrayLayer, region0->srcSubresource.layerCount,
2581 region1->dstSubresource.baseArrayLayer, region1->dstSubresource.layerCount))) {
2582 result = true;
2583 switch (type) {
2584 case VK_IMAGE_TYPE_3D:
2585 result &= RangesIntersect(region0->srcOffsets[0].z, region0->srcOffsets[1].z - region0->srcOffsets[0].z,
2586 region1->dstOffsets[0].z, region1->dstOffsets[1].z - region1->dstOffsets[0].z);
2587 // fall through
2588 case VK_IMAGE_TYPE_2D:
2589 result &= RangesIntersect(region0->srcOffsets[0].y, region0->srcOffsets[1].y - region0->srcOffsets[0].y,
2590 region1->dstOffsets[0].y, region1->dstOffsets[1].y - region1->dstOffsets[0].y);
2591 // fall through
2592 case VK_IMAGE_TYPE_1D:
2593 result &= RangesIntersect(region0->srcOffsets[0].x, region0->srcOffsets[1].x - region0->srcOffsets[0].x,
2594 region1->dstOffsets[0].x, region1->dstOffsets[1].x - region1->dstOffsets[0].x);
2595 break;
2596 default:
2597 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2598 assert(false);
2599 }
2600 }
2601 return result;
2602}
2603
Dave Houltonfc1a4052017-04-27 14:32:45 -06002604// Returns non-zero if offset and extent exceed image extents
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002605static const uint32_t kXBit = 1;
2606static const uint32_t kYBit = 2;
2607static const uint32_t kZBit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002608static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002609 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002610 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002611 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2612 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002613 result |= kZBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002614 }
2615 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2616 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002617 result |= kYBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002618 }
2619 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2620 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002621 result |= kXBit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002622 }
2623 return result;
2624}
2625
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002626// Test if two VkExtent3D structs are equivalent
2627static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2628 bool result = true;
2629 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2630 (extent->depth != other_extent->depth)) {
2631 result = false;
2632 }
2633 return result;
2634}
2635
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002636// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002637static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002638 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2639}
2640
2641// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002642VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002643 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2644 VkExtent3D granularity = {0, 0, 0};
Jeremy Gebbencd7fa282021-10-27 10:25:32 -06002645 const auto pool = cb_node->command_pool;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002646 if (pool) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002647 granularity = physical_device_state->queue_family_properties[pool->queueFamilyIndex].minImageTransferGranularity;
sfricke-samsung01da6312021-10-20 07:51:32 -07002648 if (FormatIsBlockedImage(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002649 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002650 granularity.width *= block_size.width;
2651 granularity.height *= block_size.height;
2652 }
2653 }
2654 return granularity;
2655}
2656
2657// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2658static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2659 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002660 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2661 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002662 valid = false;
2663 }
2664 return valid;
2665}
2666
2667// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002668bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002669 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002670 bool skip = false;
2671 VkExtent3D offset_extent = {};
2672 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2673 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2674 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002675 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002676 // 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 -07002677 if (IsExtentAllZeroes(&offset_extent) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002678 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002679 "%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 "
2680 "image transfer granularity is (w=0, h=0, d=0).",
2681 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002682 }
2683 } else {
2684 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2685 // integer multiples of the image transfer granularity.
2686 if (IsExtentAligned(&offset_extent, granularity) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002687 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002688 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2689 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2690 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2691 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002692 }
2693 }
2694 return skip;
2695}
2696
2697// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002698bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002699 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002700 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002701 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002702 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002703 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2704 // subresource extent.
2705 if (IsExtentEqual(extent, subresource_extent) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002706 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002707 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2708 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2709 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2710 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002711 }
2712 } else {
2713 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2714 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2715 // subresource extent dimensions.
2716 VkExtent3D offset_extent_sum = {};
2717 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2718 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2719 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002720 bool x_ok = true;
2721 bool y_ok = true;
2722 bool z_ok = true;
2723 switch (image_type) {
2724 case VK_IMAGE_TYPE_3D:
2725 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2726 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002727 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002728 case VK_IMAGE_TYPE_2D:
2729 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2730 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002731 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002732 case VK_IMAGE_TYPE_1D:
2733 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2734 (subresource_extent->width == offset_extent_sum.width));
2735 break;
2736 default:
2737 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2738 assert(false);
2739 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002740 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002741 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002742 LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002743 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2744 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2745 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2746 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2747 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2748 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002749 }
2750 }
2751 return skip;
2752}
2753
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002754bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002755 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002756 bool skip = false;
2757 if (mip_level >= img->createInfo.mipLevels) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002758 skip |= LogError(cb_node->commandBuffer(), vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2759 function, i, member, mip_level, report_data->FormatHandle(img->image()).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002760 }
2761 return skip;
2762}
2763
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002764bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002765 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002766 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002767 bool skip = false;
2768 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2769 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002770 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002771 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2772 "%u, but provided %s has %u array layers.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002773 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image()).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002774 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002775 }
2776 return skip;
2777}
2778
Tony Barbour845d29b2021-11-09 11:43:14 -07002779// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy/VkBufferImageCopy2 structure
sfricke-samsung71f04e32022-03-16 01:21:21 -05002780template <typename RegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002781bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
sfricke-samsung71f04e32022-03-16 01:21:21 -05002782 const RegionType *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002783 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002784 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002785 VkExtent3D granularity = GetScaledItg(cb_node, img);
2786 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002787 VkExtent3D subresource_extent = img->GetSubresourceExtent(region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002788 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002789 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002790 return skip;
2791}
2792
Jeff Leger178b1e52020-10-05 12:22:23 -04002793// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy/VkImageCopy2KHR structure
2794template <typename RegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002795bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002796 const IMAGE_STATE *dst_img, const RegionType *region,
2797 const uint32_t i, const char *function,
Tony-LunarGb61514a2021-11-02 12:36:51 -06002798 CMD_TYPE cmd_type) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002799 bool skip = false;
Tony-LunarGb61514a2021-11-02 12:36:51 -06002800 const bool is_2 = (cmd_type == CMD_COPYIMAGE2KHR || cmd_type == CMD_COPYIMAGE2);
Jeff Leger178b1e52020-10-05 12:22:23 -04002801 const char *vuid;
2802
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002803 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002804 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
Tony-LunarGb61514a2021-11-02 12:36:51 -06002805 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
Jeff Leger178b1e52020-10-05 12:22:23 -04002806 skip |= CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", vuid);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002807 VkExtent3D subresource_extent = src_img->GetSubresourceExtent(region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002808 const VkExtent3D extent = region->extent;
Tony-LunarGb61514a2021-11-02 12:36:51 -06002809 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002810 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04002811 i, function, "extent", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002812
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002813 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002814 granularity = GetScaledItg(cb_node, dst_img);
Tony-LunarGb61514a2021-11-02 12:36:51 -06002815 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
Jeff Leger178b1e52020-10-05 12:22:23 -04002816 skip |= CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", vuid);
Dave Houltonee281a52017-12-08 13:51:02 -07002817 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002818 const VkExtent3D dest_effective_extent =
2819 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002820 subresource_extent = dst_img->GetSubresourceExtent(region->dstSubresource);
Tony-LunarGb61514a2021-11-02 12:36:51 -06002821 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002822 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Jeff Leger178b1e52020-10-05 12:22:23 -04002823 dst_img->createInfo.imageType, i, function, "extent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002824 return skip;
2825}
2826
Jeff Leger178b1e52020-10-05 12:22:23 -04002827// Validate contents of a VkImageCopy or VkImageCopy2KHR struct
sfricke-samsung71f04e32022-03-16 01:21:21 -05002828template <typename RegionType>
2829bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const RegionType *pRegions, const IMAGE_STATE *src_state,
2830 const IMAGE_STATE *dst_state, CMD_TYPE cmd_type) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002831 bool skip = false;
Tony-LunarGb61514a2021-11-02 12:36:51 -06002832 const bool is_2 = (cmd_type == CMD_COPYIMAGE2KHR || cmd_type == CMD_COPYIMAGE2);
2833 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04002834 const char *vuid;
Dave Houlton6f9059e2017-05-02 17:15:13 -06002835
2836 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05002837 const RegionType region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002838
2839 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002840 const VkExtent3D src_copy_extent = region.extent;
2841 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002842 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2843
Dave Houlton6f9059e2017-05-02 17:15:13 -06002844 bool slice_override = false;
2845 uint32_t depth_slices = 0;
2846
2847 // Special case for copying between a 1D/2D array and a 3D image
2848 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2849 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002850 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002851 slice_override = (depth_slices != 1);
2852 } 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 -07002853 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002854 slice_override = (depth_slices != 1);
2855 }
2856
2857 // Do all checks on source image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002858 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002859 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002860 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-00146" : "VUID-vkCmdCopyImage-srcImage-00146";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002861 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002862 "%s: pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2863 "be 0 and 1, respectively.",
2864 func_name, i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002865 }
2866 }
2867
Dave Houlton533be9f2018-03-26 17:08:30 -06002868 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 -06002869 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01785" : "VUID-vkCmdCopyImage-srcImage-01785";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002870 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002871 "%s: pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002872 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002873 func_name, i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002874 }
2875
Dave Houlton533be9f2018-03-26 17:08:30 -06002876 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002877 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01787" : "VUID-vkCmdCopyImage-srcImage-01787";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002878 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 -04002879 func_name, i, region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002880 }
2881
sfricke-samsung01da6312021-10-20 07:51:32 -07002882 // Source checks that apply only to "blocked images"
2883 if (FormatIsBlockedImage(src_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002884 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002885 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002886 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2887 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2888 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002889 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01727" : "VUID-vkCmdCopyImage-srcImage-01727";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002890 skip |= LogError(src_state->image(), vuid,
sfricke-samsung01da6312021-10-20 07:51:32 -07002891 "%s: pRegion[%d] srcOffset (%d, %d) must be multiples of the blocked image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002892 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002893 func_name, i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002894 }
2895
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002896 const VkExtent3D mip_extent = src_state->GetSubresourceExtent(region.srcSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07002897 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2898 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002899 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01728" : "VUID-vkCmdCopyImage-srcImage-01728";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002900 skip |= LogError(src_state->image(), vuid,
sfricke-samsung01da6312021-10-20 07:51:32 -07002901 "%s: pRegion[%d] extent width (%d) must be a multiple of the blocked texture block "
Jeff Leger178b1e52020-10-05 12:22:23 -04002902 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2903 func_name, i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002904 }
2905
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002906 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002907 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2908 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002909 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01729" : "VUID-vkCmdCopyImage-srcImage-01729";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002910 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002911 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2912 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2913 func_name, i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002914 }
2915
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002916 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002917 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2918 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002919 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01730" : "VUID-vkCmdCopyImage-srcImage-01730";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002920 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002921 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2922 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2923 func_name, i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002924 }
2925 } // Compressed
2926
2927 // Do all checks on dest image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002928 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002929 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002930 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-00152" : "VUID-vkCmdCopyImage-dstImage-00152";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002931 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002932 "%s: pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002933 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002934 func_name, i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002935 }
2936 }
2937
Dave Houlton533be9f2018-03-26 17:08:30 -06002938 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 -06002939 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01786" : "VUID-vkCmdCopyImage-dstImage-01786";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002940 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002941 "%s: pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2942 "and 1, respectively.",
2943 func_name, i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002944 }
2945
Dave Houlton533be9f2018-03-26 17:08:30 -06002946 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002947 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01788" : "VUID-vkCmdCopyImage-dstImage-01788";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002948 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 -04002949 func_name, i, region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002950 }
2951
sfricke-samsung30b094c2020-05-30 11:42:11 -07002952 // Handle difference between Maintenance 1
sfricke-samsung45996a42021-09-16 13:45:27 -07002953 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002954 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2955 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002956 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-04443" : "VUID-vkCmdCopyImage-srcImage-04443";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002957 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002958 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2959 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2960 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002961 }
2962 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002963 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002964 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002965 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-04444" : "VUID-vkCmdCopyImage-dstImage-04444";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002966 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002967 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2968 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2969 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002970 }
2971 }
2972 } else { // Pre maint 1
2973 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002974 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002975 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002976 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002977 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and "
sfricke-samsung30b094c2020-05-30 11:42:11 -07002978 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2979 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002980 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002981 }
Dave Houltonee281a52017-12-08 13:51:02 -07002982 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002983 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002984 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002985 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002986 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2987 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002988 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002989 }
2990 }
2991 }
2992
sfricke-samsung01da6312021-10-20 07:51:32 -07002993 // Dest checks that apply only to "blocked images"
2994 if (FormatIsBlockedImage(dst_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002995 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002996
2997 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002998 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2999 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
3000 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003001 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01731" : "VUID-vkCmdCopyImage-dstImage-01731";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003002 skip |= LogError(dst_state->image(), vuid,
sfricke-samsung01da6312021-10-20 07:51:32 -07003003 "%s: pRegion[%d] dstOffset (%d, %d) must be multiples of the blocked image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003004 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04003005 func_name, i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003006 }
3007
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003008 const VkExtent3D mip_extent = dst_state->GetSubresourceExtent(region.dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07003009 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
3010 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003011 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01732" : "VUID-vkCmdCopyImage-dstImage-01732";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003012 skip |= LogError(dst_state->image(), vuid,
sfricke-samsung01da6312021-10-20 07:51:32 -07003013 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the blocked texture "
Jeff Leger178b1e52020-10-05 12:22:23 -04003014 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
3015 func_name, i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06003016 }
3017
Dave Houltonee281a52017-12-08 13:51:02 -07003018 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
3019 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
3020 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003021 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01733" : "VUID-vkCmdCopyImage-dstImage-01733";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003022 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003023 "%s: pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003024 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
3025 "height (%d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04003026 func_name, i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003027 }
3028
Dave Houltonee281a52017-12-08 13:51:02 -07003029 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
3030 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
3031 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003032 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01734" : "VUID-vkCmdCopyImage-dstImage-01734";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003033 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003034 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
3035 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
3036 func_name, i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003037 }
3038 } // Compressed
3039 }
3040 return skip;
3041}
3042
Jeff Leger178b1e52020-10-05 12:22:23 -04003043template <typename RegionType>
3044bool CoreChecks::ValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3045 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Tony-LunarGb61514a2021-11-02 12:36:51 -06003046 const RegionType *pRegions, CMD_TYPE cmd_type) const {
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07003047 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07003048 auto src_image_state = Get<IMAGE_STATE>(srcImage);
3049 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Aitor Camacho82c1a7a2022-07-05 22:21:19 +02003050 const VkFormat src_format = src_image_state->createInfo.format;
3051 const VkFormat dst_format = dst_image_state->createInfo.format;
3052 const bool is_2 = (cmd_type == CMD_COPYIMAGE2KHR || cmd_type == CMD_COPYIMAGE2);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003053 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003054
sfricke-samsung85584a72021-09-30 21:43:38 -07003055 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04003056 const char *vuid;
Tony-LunarGb61514a2021-11-02 12:36:51 -06003057 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state.get(), dst_image_state.get(), cmd_type);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003058
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003059 VkCommandBuffer command_buffer = cb_node->commandBuffer();
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003060
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003061 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003062 const RegionType region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07003063
3064 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
3065 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08003066 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07003067
Dave Houlton6f9059e2017-05-02 17:15:13 -06003068 bool slice_override = false;
3069 uint32_t depth_slices = 0;
3070
3071 // Special case for copying between a 1D/2D array and a 3D image
3072 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
3073 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
3074 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07003075 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06003076 slice_override = (depth_slices != 1);
3077 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
3078 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07003079 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06003080 slice_override = (depth_slices != 1);
3081 }
3082
Jeremy Gebben9f537102021-10-05 16:37:12 -06003083 skip |= ValidateImageSubresourceLayers(cb_node.get(), &region.srcSubresource, func_name, "srcSubresource", i);
3084 skip |= ValidateImageSubresourceLayers(cb_node.get(), &region.dstSubresource, func_name, "dstSubresource", i);
Tony-LunarGb61514a2021-11-02 12:36:51 -06003085 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcSubresource-01696" : "VUID-vkCmdCopyImage-srcSubresource-01696";
3086 skip |=
3087 ValidateImageMipLevel(cb_node.get(), src_image_state.get(), region.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
3088 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstSubresource-01697" : "VUID-vkCmdCopyImage-dstSubresource-01697";
3089 skip |=
3090 ValidateImageMipLevel(cb_node.get(), dst_image_state.get(), region.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
3091 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcSubresource-01698" : "VUID-vkCmdCopyImage-srcSubresource-01698";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003092 skip |= ValidateImageArrayLayerRange(cb_node.get(), src_image_state.get(), region.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003093 region.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
Tony-LunarGb61514a2021-11-02 12:36:51 -06003094 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstSubresource-01699" : "VUID-vkCmdCopyImage-dstSubresource-01699";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003095 skip |= ValidateImageArrayLayerRange(cb_node.get(), dst_image_state.get(), region.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003096 region.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003097
sfricke-samsung45996a42021-09-16 13:45:27 -07003098 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06003099 // No chance of mismatch if we're overriding depth slice count
3100 if (!slice_override) {
3101 // The number of depth slices in srcSubresource and dstSubresource must match
3102 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
3103 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07003104 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
3105 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003106 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07003107 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
3108 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003109 if (src_slices != dst_slices) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003110 vuid = is_2 ? "VUID-VkImageCopy2-extent-00140" : "VUID-VkImageCopy-extent-00140";
Jeff Leger178b1e52020-10-05 12:22:23 -04003111 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003112 "%s: number of depth slices in source (%u) and destination (%u) subresources for pRegions[%u] "
3113 "do not match.",
3114 func_name, src_slices, dst_slices, i);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003115 }
3116 }
3117 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06003118 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07003119 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003120 vuid = is_2 ? "VUID-VkImageCopy2-layerCount-00138" : "VUID-VkImageCopy-layerCount-00138";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003121 skip |=
3122 LogError(command_buffer, vuid,
3123 "%s: number of layers in source (%u) and destination (%u) subresources for pRegions[%u] do not match",
3124 func_name, region.srcSubresource.layerCount, region.dstSubresource.layerCount, i);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06003125 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003126 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003127
Dave Houltonc991cc92018-03-06 11:08:51 -07003128 // Do multiplane-specific checks, if extension enabled
sfricke-samsung45996a42021-09-16 13:45:27 -07003129 if (IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)) {
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003130 if ((!FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format))) {
3131 // If neither image is multi-plane the aspectMask member of src and dst must match
3132 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003133 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01551" : "VUID-vkCmdCopyImage-srcImage-01551";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003134 skip |= LogError(command_buffer, vuid,
3135 "%s: Copy between non-multiplane images with differing aspectMasks in pRegions[%u] with "
3136 "source (0x%x) destination (0x%x).",
3137 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
3138 }
3139 } else {
3140 // Source image multiplane checks
3141 uint32_t planes = FormatPlaneCount(src_format);
3142 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
3143 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003144 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01552" : "VUID-vkCmdCopyImage-srcImage-01552";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003145 skip |= LogError(command_buffer, vuid,
3146 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
3147 i, aspect);
3148 }
3149 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
3150 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003151 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01553" : "VUID-vkCmdCopyImage-srcImage-01553";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003152 skip |= LogError(command_buffer, vuid,
3153 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
3154 i, aspect);
3155 }
3156 // Single-plane to multi-plane
3157 if ((!FormatIsMultiplane(src_format)) && (FormatIsMultiplane(dst_format)) &&
3158 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003159 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01557" : "VUID-vkCmdCopyImage-dstImage-01557";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003160 skip |= LogError(command_buffer, vuid,
3161 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
3162 func_name, i, aspect);
3163 }
Dave Houltonc991cc92018-03-06 11:08:51 -07003164
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003165 // Dest image multiplane checks
3166 planes = FormatPlaneCount(dst_format);
3167 aspect = region.dstSubresource.aspectMask;
3168 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003169 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01554" : "VUID-vkCmdCopyImage-dstImage-01554";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003170 skip |= LogError(command_buffer, vuid,
3171 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
3172 i, aspect);
3173 }
3174 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
3175 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003176 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01555" : "VUID-vkCmdCopyImage-dstImage-01555";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003177 skip |= LogError(command_buffer, vuid,
3178 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
3179 i, aspect);
3180 }
3181 // Multi-plane to single-plane
3182 if ((FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format)) &&
3183 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003184 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01556" : "VUID-vkCmdCopyImage-srcImage-01556";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003185 skip |= LogError(command_buffer, vuid,
3186 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
3187 func_name, i, aspect);
3188 }
3189 }
3190 } else {
3191 // !vk_khr_sampler_ycbcr_conversion
Dave Houltonf5217612018-02-02 16:18:52 -07003192 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
3193 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003194 vuid = is_2 ? "VUID-VkImageCopy2-aspectMask-00137" : "VUID-VkImageCopy-aspectMask-00137";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003195 skip |= LogError(
3196 command_buffer, vuid,
3197 "%s: Copy between images with differing aspectMasks in pRegions[%u] with source (0x%x) destination (0x%x).",
3198 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
Dave Houltonf5217612018-02-02 16:18:52 -07003199 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003200 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003201
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003202 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08003203 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003204 vuid = is_2 ? "VUID-VkCopyImageInfo2-aspectMask-00142" : "VUID-vkCmdCopyImage-aspectMask-00142";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003205 skip |=
3206 LogError(command_buffer, vuid,
3207 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) cannot specify aspects not present in source image.",
3208 func_name, i, region.srcSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003209 }
3210
3211 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08003212 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003213 vuid = is_2 ? "VUID-VkCopyImageInfo2-aspectMask-00143" : "VUID-vkCmdCopyImage-aspectMask-00143";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003214 skip |= LogError(
3215 command_buffer, vuid,
3216 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) cannot specify aspects not present in destination image.",
3217 func_name, i, region.dstSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003218 }
3219
sfricke-samsung5f11b0e2022-03-22 14:12:15 -05003220 // Make sure not a empty region
3221 if (src_copy_extent.width == 0) {
3222 vuid = is_2 ? "VUID-VkImageCopy2-extent-06668" : "VUID-VkImageCopy-extent-06668";
3223 skip |=
3224 LogError(command_buffer, vuid,
3225 "%s: pRegion[%" PRIu32 "] extent.width must not be zero as empty copies are not allowed.", func_name, i);
3226 }
3227 if (src_copy_extent.height == 0) {
3228 vuid = is_2 ? "VUID-VkImageCopy2-extent-06669" : "VUID-VkImageCopy-extent-06669";
3229 skip |=
3230 LogError(command_buffer, vuid,
3231 "%s: pRegion[%" PRIu32 "] extent.height must not be zero as empty copies are not allowed.", func_name, i);
3232 }
3233 if (src_copy_extent.depth == 0) {
3234 vuid = is_2 ? "VUID-VkImageCopy2-extent-06670" : "VUID-VkImageCopy-extent-06670";
3235 skip |=
3236 LogError(command_buffer, vuid,
3237 "%s: pRegion[%" PRIu32 "] extent.depth must not be zero as empty copies are not allowed.", func_name, i);
3238 }
3239
Dave Houltonfc1a4052017-04-27 14:32:45 -06003240 // Each dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003241 VkExtent3D subresource_extent = src_image_state->GetSubresourceExtent(region.srcSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07003242 if (slice_override) src_copy_extent.depth = depth_slices;
3243 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003244 if (extent_check & kXBit) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003245 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcOffset-00144" : "VUID-vkCmdCopyImage-srcOffset-00144";
Jeff Leger178b1e52020-10-05 12:22:23 -04003246 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003247 "%s: Source image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003248 "width [%1d].",
3249 func_name, i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003250 }
3251
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003252 if (extent_check & kYBit) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003253 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcOffset-00145" : "VUID-vkCmdCopyImage-srcOffset-00145";
Jeff Leger178b1e52020-10-05 12:22:23 -04003254 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003255 "%s: Source image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003256 "height [%1d].",
3257 func_name, i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003258 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003259 if (extent_check & kZBit) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003260 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcOffset-00147" : "VUID-vkCmdCopyImage-srcOffset-00147";
Jeff Leger178b1e52020-10-05 12:22:23 -04003261 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003262 "%s: Source image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003263 "depth [%1d].",
3264 func_name, i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003265 }
3266
Dave Houltonee281a52017-12-08 13:51:02 -07003267 // Adjust dest extent if necessary
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003268 subresource_extent = dst_image_state->GetSubresourceExtent(region.dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07003269 if (slice_override) dst_copy_extent.depth = depth_slices;
3270
3271 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003272 if (extent_check & kXBit) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003273 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstOffset-00150" : "VUID-vkCmdCopyImage-dstOffset-00150";
Jeff Leger178b1e52020-10-05 12:22:23 -04003274 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003275 "%s: Dest image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003276 "width [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003277 func_name, i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003278 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003279 if (extent_check & kYBit) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003280 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstOffset-00151" : "VUID-vkCmdCopyImage-dstOffset-00151";
Jeff Leger178b1e52020-10-05 12:22:23 -04003281 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003282 "%s): Dest image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003283 "height [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003284 func_name, i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003285 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003286 if (extent_check & kZBit) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003287 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstOffset-00153" : "VUID-vkCmdCopyImage-dstOffset-00153";
Jeff Leger178b1e52020-10-05 12:22:23 -04003288 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003289 "%s: Dest image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003290 "depth [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003291 func_name, i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003292 }
3293
Aitor Camacho82c1a7a2022-07-05 22:21:19 +02003294 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
3295 // must not overlap in memory
3296 if (src_image_state->image() == dst_image_state->image()) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003297 for (uint32_t j = 0; j < regionCount; j++) {
Aitor Camacho82c1a7a2022-07-05 22:21:19 +02003298 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
3299 FormatIsMultiplane(src_format))) {
3300 vuid = is_2 ? "VUID-VkCopyImageInfo2-pRegions-00124" : "VUID-vkCmdCopyImage-pRegions-00124";
3301 skip |= LogError(command_buffer, vuid, "%s: pRegion[%u] src overlaps with pRegions[%u].", func_name, i, j);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003302 }
3303 }
3304 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08003305
3306 // 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 -07003307 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
sfricke-samsung48172ca2020-02-13 23:38:11 -08003308 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3309 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3310 (src_copy_extent.depth != 1)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003311 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01790" : "VUID-vkCmdCopyImage-srcImage-01790";
Jeff Leger178b1e52020-10-05 12:22:23 -04003312 skip |= LogError(command_buffer, vuid,
3313 "%s: pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1",
3314 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003315 }
3316 } else {
3317 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
3318 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3319 (src_copy_extent.depth != 1)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003320 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01789" : "VUID-vkCmdCopyImage-srcImage-01789";
Jeff Leger178b1e52020-10-05 12:22:23 -04003321 skip |= LogError(command_buffer, vuid,
3322 "%s: pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1",
3323 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003324 }
3325 }
3326
3327 // Check if 2D with 3D and depth not equal to 2D layerCount
3328 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3329 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
3330 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003331 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01791" : "VUID-vkCmdCopyImage-srcImage-01791";
Jeff Leger178b1e52020-10-05 12:22:23 -04003332 skip |= LogError(command_buffer, vuid,
3333 "%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 -08003334 "srcSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003335 func_name, i, src_copy_extent.depth, region.srcSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003336 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
3337 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
3338 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003339 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01792" : "VUID-vkCmdCopyImage-dstImage-01792";
Jeff Leger178b1e52020-10-05 12:22:23 -04003340 skip |= LogError(command_buffer, vuid,
3341 "%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 -08003342 "dstSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003343 func_name, i, src_copy_extent.depth, region.dstSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003344 }
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003345
3346 // Check for multi-plane format compatiblity
3347 if (FormatIsMultiplane(src_format) || FormatIsMultiplane(dst_format)) {
sfricke-samsung73e755c2021-09-30 08:34:57 -07003348 const VkFormat src_plane_format = FormatIsMultiplane(src_format)
3349 ? FindMultiplaneCompatibleFormat(src_format, region.srcSubresource.aspectMask)
3350 : src_format;
3351 const VkFormat dst_plane_format = FormatIsMultiplane(dst_format)
3352 ? FindMultiplaneCompatibleFormat(dst_format, region.dstSubresource.aspectMask)
3353 : dst_format;
3354 const size_t src_format_size = FormatElementSize(src_plane_format);
3355 const size_t dst_format_size = FormatElementSize(dst_plane_format);
3356
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003357 // If size is still zero, then format is invalid and will be caught in another VU
3358 if ((src_format_size != dst_format_size) && (src_format_size != 0) && (dst_format_size != 0)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003359 vuid = is_2 ? "VUID-VkCopyImageInfo2-None-01549" : "VUID-vkCmdCopyImage-None-01549";
Jeff Leger178b1e52020-10-05 12:22:23 -04003360 skip |= LogError(command_buffer, vuid,
3361 "%s: pRegions[%u] called with non-compatible image formats. "
3362 "The src format %s with aspectMask %s is not compatible with dst format %s aspectMask %s.",
3363 func_name, i, string_VkFormat(src_format),
3364 string_VkImageAspectFlags(region.srcSubresource.aspectMask).c_str(), string_VkFormat(dst_format),
3365 string_VkImageAspectFlags(region.dstSubresource.aspectMask).c_str());
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003366 }
3367 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003368 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003369
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003370 // The formats of non-multiplane src_image and dst_image must be compatible. Formats are considered compatible if their texel
3371 // size in bytes is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT
3372 // because because both texels are 4 bytes in size.
3373 if (!FormatIsMultiplane(src_format) && !FormatIsMultiplane(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003374 const char *compatible_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003375 IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
Tony-LunarGb61514a2021-11-02 12:36:51 -06003376 ? (is_2 ? "VUID-VkCopyImageInfo2-srcImage-01548" : "VUID-vkCmdCopyImage-srcImage-01548")
3377 : (is_2 ? "VUID-VkCopyImageInfo2-srcImage-00135" : "VUID-vkCmdCopyImage-srcImage-00135");
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003378 // Depth/stencil formats must match exactly.
3379 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3380 if (src_format != dst_format) {
3381 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003382 "%s: Depth/stencil formats must match exactly for src (%s) and dst (%s).", func_name,
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003383 string_VkFormat(src_format), string_VkFormat(dst_format));
3384 }
3385 } else {
Jeff Leger178b1e52020-10-05 12:22:23 -04003386 if (FormatElementSize(src_format) != FormatElementSize(dst_format)) {
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003387 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003388 "%s: Unmatched image format sizes. "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06003389 "The src format %s has size of %" PRIu32 " and dst format %s has size of %" PRIu32 ".",
Jeff Leger178b1e52020-10-05 12:22:23 -04003390 func_name, string_VkFormat(src_format), FormatElementSize(src_format), string_VkFormat(dst_format),
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003391 FormatElementSize(dst_format));
3392 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003393 }
3394 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003395
Dave Houlton33c22b72017-02-28 13:16:02 -07003396 // Source and dest image sample counts must match
3397 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003398 std::stringstream ss;
3399 ss << func_name << " called on image pair with non-identical sample counts.";
Tony-LunarGb61514a2021-11-02 12:36:51 -06003400 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-00136" : "VUID-vkCmdCopyImage-srcImage-00136";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003401 skip |=
3402 LogError(command_buffer, vuid, "%s: The src image sample count (%s) dose not match the dst image sample count (%s).",
3403 func_name, string_VkSampleCountFlagBits(src_image_state->createInfo.samples),
3404 string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Dave Houlton33c22b72017-02-28 13:16:02 -07003405 }
3406
Aitor Camacho82c1a7a2022-07-05 22:21:19 +02003407 vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
3408 ? (is_2 ? "VUID-VkCopyImageInfo2-srcImage-01546" : "VUID-vkCmdCopyImage-srcImage-01546")
3409 : (is_2 ? "VUID-VkCopyImageInfo2-srcImage-00127" : "VUID-vkCmdCopyImage-srcImage-00127");
3410 skip |= ValidateMemoryIsBoundToImage(src_image_state.get(), func_name, vuid);
3411 vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
3412 ? (is_2 ? "VUID-VkCopyImageInfo2-dstImage-01547" : "VUID-vkCmdCopyImage-dstImage-01547")
3413 : (is_2 ? "VUID-VkCopyImageInfo2-dstImage-00132" : "VUID-vkCmdCopyImage-dstImage-00132");
3414 skip |= ValidateMemoryIsBoundToImage(dst_image_state.get(), func_name, vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003415 // Validate that SRC & DST images have correct usage flags set
Tony-LunarGb61514a2021-11-02 12:36:51 -06003416 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-00126" : "VUID-vkCmdCopyImage-srcImage-00126";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003417 skip |= ValidateImageUsageFlags(src_image_state.get(), VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04003418 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tony-LunarGb61514a2021-11-02 12:36:51 -06003419 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-00131" : "VUID-vkCmdCopyImage-dstImage-00131";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003420 skip |= ValidateImageUsageFlags(dst_image_state.get(), VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04003421 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Tony-LunarGb61514a2021-11-02 12:36:51 -06003422 vuid = is_2 ? "VUID-vkCmdCopyImage2-commandBuffer-01825" : "VUID-vkCmdCopyImage-commandBuffer-01825";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003423 skip |= ValidateProtectedImage(cb_node.get(), src_image_state.get(), func_name, vuid);
Tony-LunarGb61514a2021-11-02 12:36:51 -06003424 vuid = is_2 ? "VUID-vkCmdCopyImage2-commandBuffer-01826" : "VUID-vkCmdCopyImage-commandBuffer-01826";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003425 skip |= ValidateProtectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
Tony-LunarGb61514a2021-11-02 12:36:51 -06003426 vuid = is_2 ? "VUID-vkCmdCopyImage2-commandBuffer-01827" : "VUID-vkCmdCopyImage-commandBuffer-01827";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003427 skip |= ValidateUnprotectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003428
3429 // Validation for VK_EXT_fragment_density_map
3430 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003431 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
Jeff Leger178b1e52020-10-05 12:22:23 -04003432 skip |=
3433 LogError(command_buffer, vuid,
3434 "%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 +02003435 }
3436 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003437 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
Jeff Leger178b1e52020-10-05 12:22:23 -04003438 skip |=
3439 LogError(command_buffer, vuid,
3440 "%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 +02003441 }
3442
sfricke-samsung45996a42021-09-16 13:45:27 -07003443 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003444 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01995" : "VUID-vkCmdCopyImage-srcImage-01995";
3445 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(), VK_FORMAT_FEATURE_2_TRANSFER_SRC_BIT, func_name, vuid);
3446 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01996" : "VUID-vkCmdCopyImage-dstImage-01996";
3447 skip |= ValidateImageFormatFeatureFlags(dst_image_state.get(), VK_FORMAT_FEATURE_2_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003448 }
Jeremy Gebben9f537102021-10-05 16:37:12 -06003449 skip |= ValidateCmd(cb_node.get(), cmd_type);
Tobin Ehlisc8266452017-04-07 12:20:30 -06003450 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04003451
3452 const char *invalid_src_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003453 (src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Tony-LunarGb61514a2021-11-02 12:36:51 -06003454 ? (is_2 ? "VUID-VkCopyImageInfo2-srcImageLayout-01917" : "VUID-vkCmdCopyImage-srcImageLayout-01917")
3455 : (is_2 ? "VUID-VkCopyImageInfo2-srcImageLayout-00129" : "VUID-vkCmdCopyImage-srcImageLayout-00129");
Jeff Leger178b1e52020-10-05 12:22:23 -04003456 const char *invalid_dst_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003457 (dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Tony-LunarGb61514a2021-11-02 12:36:51 -06003458 ? (is_2 ? "VUID-VkCopyImageInfo2-dstImageLayout-01395" : "VUID-vkCmdCopyImage-dstImageLayout-01395")
3459 : (is_2 ? "VUID-VkCopyImageInfo2-dstImageLayout-00134" : "VUID-vkCmdCopyImage-dstImageLayout-00134");
Jeff Leger178b1e52020-10-05 12:22:23 -04003460
aitor-lunargd0d85e12022-01-28 16:56:49 +01003461 bool same_image = (src_image_state == dst_image_state);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003462 for (uint32_t i = 0; i < regionCount; ++i) {
aitor-lunargd0d85e12022-01-28 16:56:49 +01003463 // When performing copy from and to same subresource, VK_IMAGE_LAYOUT_GENERAL is the only option
sfricke-samsung71f04e32022-03-16 01:21:21 -05003464 const RegionType region = pRegions[i];
3465 const auto &src_sub = region.srcSubresource;
3466 const auto &dst_sub = region.dstSubresource;
aitor-lunargd0d85e12022-01-28 16:56:49 +01003467 bool same_subresource =
3468 (same_image && (src_sub.mipLevel == dst_sub.mipLevel) && (src_sub.baseArrayLayer == dst_sub.baseArrayLayer));
3469 VkImageLayout source_optimal = (same_subresource ? VK_IMAGE_LAYOUT_GENERAL : VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL);
3470 VkImageLayout destination_optimal = (same_subresource ? VK_IMAGE_LAYOUT_GENERAL : VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL);
Tony-LunarGb61514a2021-11-02 12:36:51 -06003471 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImageLayout-00128" : "VUID-vkCmdCopyImage-srcImageLayout-00128";
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06003472 skip |= VerifyImageLayout(*cb_node, *src_image_state, region.srcSubresource, srcImageLayout, source_optimal, func_name,
3473 invalid_src_layout_vuid, vuid, &hit_error);
Tony-LunarGb61514a2021-11-02 12:36:51 -06003474 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImageLayout-00133" : "VUID-vkCmdCopyImage-dstImageLayout-00133";
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06003475 skip |= VerifyImageLayout(*cb_node, *dst_image_state, region.dstSubresource, dstImageLayout, destination_optimal, func_name,
3476 invalid_dst_layout_vuid, vuid, &hit_error);
Jeremy Gebben9f537102021-10-05 16:37:12 -06003477 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node.get(), src_image_state.get(), dst_image_state.get(),
sfricke-samsung71f04e32022-03-16 01:21:21 -05003478 &region, i, func_name, cmd_type);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003479 }
3480
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003481 return skip;
3482}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003483
Jeff Leger178b1e52020-10-05 12:22:23 -04003484bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3485 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3486 const VkImageCopy *pRegions) const {
3487 return ValidateCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
Tony-LunarGb61514a2021-11-02 12:36:51 -06003488 CMD_COPYIMAGE);
Jeff Leger178b1e52020-10-05 12:22:23 -04003489}
3490
3491bool CoreChecks::PreCallValidateCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) const {
3492 return ValidateCmdCopyImage(commandBuffer, pCopyImageInfo->srcImage, pCopyImageInfo->srcImageLayout, pCopyImageInfo->dstImage,
3493 pCopyImageInfo->dstImageLayout, pCopyImageInfo->regionCount, pCopyImageInfo->pRegions,
Tony-LunarGb61514a2021-11-02 12:36:51 -06003494 CMD_COPYIMAGE2KHR);
3495}
3496
3497bool CoreChecks::PreCallValidateCmdCopyImage2(VkCommandBuffer commandBuffer, const VkCopyImageInfo2 *pCopyImageInfo) const {
3498 return ValidateCmdCopyImage(commandBuffer, pCopyImageInfo->srcImage, pCopyImageInfo->srcImageLayout, pCopyImageInfo->dstImage,
3499 pCopyImageInfo->dstImageLayout, pCopyImageInfo->regionCount, pCopyImageInfo->pRegions,
3500 CMD_COPYIMAGE2);
Jeff Leger178b1e52020-10-05 12:22:23 -04003501}
3502
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003503void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3504 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3505 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003506 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3507 pRegions);
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07003508 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003509 auto src_image_state = Get<IMAGE_STATE>(srcImage);
3510 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003511
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003512 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003513 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06003514 cb_node->SetImageInitialLayout(*src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3515 cb_node->SetImageInitialLayout(*dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003516 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003517}
3518
Aitor Camacho82c1a7a2022-07-05 22:21:19 +02003519void CoreChecks::RecordCmdCopyImage2(VkCommandBuffer commandBuffer, const VkCopyImageInfo2 *pCopyImageInfo) {
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07003520 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003521 auto src_image_state = Get<IMAGE_STATE>(pCopyImageInfo->srcImage);
3522 auto dst_image_state = Get<IMAGE_STATE>(pCopyImageInfo->dstImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04003523
3524 // Make sure that all image slices are updated to correct layout
3525 for (uint32_t i = 0; i < pCopyImageInfo->regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06003526 cb_node->SetImageInitialLayout(*src_image_state, pCopyImageInfo->pRegions[i].srcSubresource,
3527 pCopyImageInfo->srcImageLayout);
3528 cb_node->SetImageInitialLayout(*dst_image_state, pCopyImageInfo->pRegions[i].dstSubresource,
3529 pCopyImageInfo->dstImageLayout);
Jeff Leger178b1e52020-10-05 12:22:23 -04003530 }
3531}
3532
Tony-LunarGb61514a2021-11-02 12:36:51 -06003533void CoreChecks::PreCallRecordCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) {
3534 StateTracker::PreCallRecordCmdCopyImage2KHR(commandBuffer, pCopyImageInfo);
Aitor Camacho82c1a7a2022-07-05 22:21:19 +02003535 RecordCmdCopyImage2(commandBuffer, pCopyImageInfo);
Tony-LunarGb61514a2021-11-02 12:36:51 -06003536}
3537
3538void CoreChecks::PreCallRecordCmdCopyImage2(VkCommandBuffer commandBuffer, const VkCopyImageInfo2 *pCopyImageInfo) {
3539 StateTracker::PreCallRecordCmdCopyImage2(commandBuffer, pCopyImageInfo);
Aitor Camacho82c1a7a2022-07-05 22:21:19 +02003540 RecordCmdCopyImage2(commandBuffer, pCopyImageInfo);
Tony-LunarGb61514a2021-11-02 12:36:51 -06003541}
3542
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003543// Returns true if sub_rect is entirely contained within rect
3544static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
3545 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 -07003546 (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 -07003547 return false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003548 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003549 return true;
3550}
3551
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003552bool CoreChecks::ValidateClearAttachmentExtent(const CMD_BUFFER_STATE &cb_node, uint32_t attachment_index,
amhagana448ea52021-11-02 14:09:14 -04003553 const IMAGE_VIEW_STATE* image_view_state,
3554 const VkRect2D &render_area, uint32_t rect_count, const VkClearRect *clear_rects) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07003555 bool skip = false;
John Zulauf3a548ef2019-02-01 16:14:07 -07003556
3557 for (uint32_t j = 0; j < rect_count; j++) {
3558 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003559 skip |= LogError(cb_node.Handle(), "VUID-vkCmdClearAttachments-pRects-00016",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003560 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
3561 "the current render pass instance.",
3562 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07003563 }
3564
3565 if (image_view_state) {
3566 // The layers specified by a given element of pRects must be contained within every attachment that
3567 // pAttachments refers to
ziga-lunargff6485c2021-10-08 18:18:32 +02003568 const uint32_t attachment_layer_count = image_view_state->GetAttachmentLayerCount();
John Zulauf3a548ef2019-02-01 16:14:07 -07003569 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
3570 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003571 skip |= LogError(cb_node.Handle(), "VUID-vkCmdClearAttachments-pRects-00017",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003572 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
3573 "of pAttachment[%d].",
3574 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07003575 }
3576 }
3577 }
3578 return skip;
3579}
3580
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003581bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3582 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003583 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003584 bool skip = false;
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07003585 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Petr Kraus2dffb382019-08-10 02:52:12 +02003586 if (!cb_node) return skip;
3587
Jeremy Gebben9f537102021-10-05 16:37:12 -06003588 skip |= ValidateCmd(cb_node.get(), CMD_CLEARATTACHMENTS);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003589
3590 // Validate that attachment is in reference list of active subpass
3591 if (cb_node->activeRenderPass) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08003592 const VkRenderPassCreateInfo2 *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07003593 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Mike Schuchardt2df08912020-12-15 16:28:09 -08003594 const VkSubpassDescription2 *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
locke-lunargaecf2152020-05-12 17:15:41 -06003595 const auto *framebuffer = cb_node->activeFramebuffer.get();
Aaron Hagan1656b2b2021-12-21 11:52:41 -05003596 const auto &render_area = (cb_node->activeRenderPass->use_dynamic_rendering) ?
3597 cb_node->activeRenderPass->dynamic_rendering_begin_rendering_info.renderArea :
3598 cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003599
John Zulauf3a548ef2019-02-01 16:14:07 -07003600 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3601 auto clear_desc = &pAttachments[attachment_index];
3602 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003603 const VkImageAspectFlags aspect_mask = clear_desc->aspectMask;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003604
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003605 if (aspect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
3606 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020",
3607 "vkCmdClearAttachments() pAttachments[%u] mask contains VK_IMAGE_ASPECT_METADATA_BIT",
3608 attachment_index);
3609 } else if (aspect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
3610 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
3611 skip |=
3612 LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-02246",
3613 "vkCmdClearAttachments() pAttachments[%u] mask contains a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit",
3614 attachment_index);
3615 } else if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07003616 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
Aaron Haganc6bafff2021-11-29 23:30:07 -05003617 if (subpass_desc) {
amhagana448ea52021-11-02 14:09:14 -04003618 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
3619 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3620 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
3621 skip |= LogError(
3622 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3623 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
3624 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
3625 attachment_index, clear_desc->colorAttachment,
3626 report_data->FormatHandle(cb_node->activeRenderPass->renderPass()).c_str(), cb_node->activeSubpass,
3627 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07003628
amhagana448ea52021-11-02 14:09:14 -04003629 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
3630 }
3631 } else {
3632 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3633 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
3634 " subpass %u. colorAttachmentCount=%u",
3635 attachment_index, clear_desc->colorAttachment,
3636 report_data->FormatHandle(cb_node->activeRenderPass->renderPass()).c_str(),
3637 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
John Zulauff2582972019-02-09 14:53:30 -07003638 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003639 }
John Zulauff2582972019-02-09 14:53:30 -07003640 fb_attachment = color_attachment;
3641
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003642 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
3643 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
3644 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019",
3645 "vkCmdClearAttachments() pAttachments[%u] aspectMask must set only VK_IMAGE_ASPECT_COLOR_BIT "
3646 "of a color attachment.",
3647 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003648 }
3649 } else { // Must be depth and/or stencil
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003650 bool subpass_depth = false;
3651 bool subpass_stencil = false;
amhagana448ea52021-11-02 14:09:14 -04003652 if (subpass_desc) {
3653 if (subpass_desc->pDepthStencilAttachment &&
3654 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3655 auto index = subpass_desc->pDepthStencilAttachment->attachment;
3656 subpass_depth = FormatHasDepth(renderpass_create_info->pAttachments[index].format);
3657 subpass_stencil = FormatHasStencil(renderpass_create_info->pAttachments[index].format);
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003658 }
amhagana448ea52021-11-02 14:09:14 -04003659 if (!subpass_desc->pDepthStencilAttachment ||
3660 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3661 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) && !subpass_depth) {
3662 skip |= LogError(
3663 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02502",
3664 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_DEPTH_BIT but there is no "
3665 "depth attachment in subpass",
3666 attachment_index);
3667 }
3668 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) && !subpass_stencil) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003669 skip |= LogError(
3670 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02503",
3671 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_STENCIL_BIT but there is no "
amhagana448ea52021-11-02 14:09:14 -04003672 "stencil attachment in subpass",
3673 attachment_index);
3674 }
3675 } else {
3676 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003677 }
amhagana448ea52021-11-02 14:09:14 -04003678 if (subpass_depth) {
3679 skip |= ValidateClearDepthStencilValue(commandBuffer, clear_desc->clearValue.depthStencil,
3680 "vkCmdClearAttachments()");
3681 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08003682 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003683 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003684 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
amhagana448ea52021-11-02 14:09:14 -04003685 const IMAGE_VIEW_STATE* image_view_state = nullptr;
3686 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
3687 image_view_state = cb_node->GetActiveAttachmentImageViewState(fb_attachment);
3688 }
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003689 skip |= ValidateClearAttachmentExtent(*cb_node, attachment_index, image_view_state, render_area,
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003690 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06003691 }
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003692
3693 // Once the framebuffer attachment is found, can get the image view state
3694 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) &&
3695 (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003696 const auto *image_view_state = cb_node->GetActiveAttachmentImageViewState(fb_attachment);
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003697 if (image_view_state != nullptr) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06003698 skip |= ValidateProtectedImage(cb_node.get(), image_view_state->image_state.get(), "vkCmdClearAttachments()",
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003699 "VUID-vkCmdClearAttachments-commandBuffer-02504");
Jeremy Gebben9f537102021-10-05 16:37:12 -06003700 skip |= ValidateUnprotectedImage(cb_node.get(), image_view_state->image_state.get(), "vkCmdClearAttachments()",
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003701 "VUID-vkCmdClearAttachments-commandBuffer-02505");
3702 }
3703 }
ziga-lunargfa335aa2021-08-05 16:59:39 +02003704
amhagana448ea52021-11-02 14:09:14 -04003705 // When a subpass uses a non-zero view mask, multiview functionality is considered to be enabled
3706 if (subpass_desc && (subpass_desc->viewMask > 0)) {
3707 for (uint32_t i = 0; i < rectCount; ++i) {
3708 if (pRects[i].baseArrayLayer != 0 || pRects[i].layerCount != 1) {
3709 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-baseArrayLayer-00018",
3710 "vkCmdClearAttachments(): pRects[%" PRIu32 "] baseArrayLayer is %" PRIu32
3711 " and layerCount is %" PRIu32 ", but the render pass instance uses multiview.",
3712 i, pRects[i].baseArrayLayer, pRects[i].layerCount);
3713 }
ziga-lunargfa335aa2021-08-05 16:59:39 +02003714 }
3715 }
3716 }
John Zulauf441558b2019-08-12 11:47:39 -06003717 }
3718 return skip;
3719}
3720
3721void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3722 const VkClearAttachment *pAttachments, uint32_t rectCount,
3723 const VkClearRect *pRects) {
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07003724 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
John Zulauf441558b2019-08-12 11:47:39 -06003725 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
John Zulauf441558b2019-08-12 11:47:39 -06003726 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
Aaron Haganc6bafff2021-11-29 23:30:07 -05003727 if (cb_node->activeRenderPass->use_dynamic_rendering_inherited) {
3728 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3729 const auto clear_desc = &pAttachments[attachment_index];
3730 auto colorAttachmentCount = cb_node->activeRenderPass->inheritance_rendering_info.colorAttachmentCount;
3731 int image_index = -1;
3732 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3733 (clear_desc->colorAttachment < colorAttachmentCount)) {
3734 image_index = cb_node->GetDynamicColorAttachmentImageIndex(clear_desc->colorAttachment);
3735 }
3736 else if (clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT)) {
3737 image_index = cb_node->GetDynamicDepthAttachmentImageIndex();
3738 }
3739 else if (clear_desc->aspectMask & (VK_IMAGE_ASPECT_STENCIL_BIT)) {
3740 image_index = cb_node->GetDynamicStencilAttachmentImageIndex();
3741 }
amhagana448ea52021-11-02 14:09:14 -04003742
Aaron Haganc6bafff2021-11-29 23:30:07 -05003743 if (image_index != -1) {
3744 if (!clear_rect_copy) {
3745 // We need a copy of the clear rectangles that will persist until the last lambda executes
3746 // but we want to create it as lazily as possible
3747 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
amhagana448ea52021-11-02 14:09:14 -04003748 }
Aaron Haganc6bafff2021-11-29 23:30:07 -05003749 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3750 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
3751 auto val_fn = [this, attachment_index, image_index, rectCount, clear_rect_copy](
3752 const CMD_BUFFER_STATE &secondary, const CMD_BUFFER_STATE *prim_cb,
3753 const FRAMEBUFFER_STATE *fb) {
3754 assert(rectCount == clear_rect_copy->size());
3755 bool skip = false;
3756 const IMAGE_VIEW_STATE* image_view_state = nullptr;
3757 if (image_index != -1) {
3758 image_view_state = (*prim_cb->active_attachments)[image_index];
3759 }
3760 skip = ValidateClearAttachmentExtent(secondary, attachment_index, image_view_state,
3761 prim_cb->activeRenderPass->dynamic_rendering_begin_rendering_info.renderArea,
3762 rectCount, clear_rect_copy->data());
3763 return skip;
3764 };
3765 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003766 }
amhagana448ea52021-11-02 14:09:14 -04003767 }
3768 }
Aaron Haganc6bafff2021-11-29 23:30:07 -05003769 else if (cb_node->activeRenderPass->use_dynamic_rendering == false)
amhagana448ea52021-11-02 14:09:14 -04003770 {
3771 const VkRenderPassCreateInfo2* renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3772 const VkSubpassDescription2* subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
sfricke-samsung21286f82021-11-16 08:21:46 -08003773
amhagana448ea52021-11-02 14:09:14 -04003774 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3775 const auto clear_desc = &pAttachments[attachment_index];
3776 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3777 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3778 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3779 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3780 }
3781 else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3782 subpass_desc->pDepthStencilAttachment) {
3783 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3784 }
3785 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
3786 if (!clear_rect_copy) {
3787 // We need a copy of the clear rectangles that will persist until the last lambda executes
3788 // but we want to create it as lazily as possible
3789 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
3790 }
3791 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3792 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003793 auto val_fn = [this, attachment_index, fb_attachment, rectCount, clear_rect_copy](
3794 const CMD_BUFFER_STATE &secondary, const CMD_BUFFER_STATE *prim_cb,
3795 const FRAMEBUFFER_STATE *fb) {
amhagana448ea52021-11-02 14:09:14 -04003796 assert(rectCount == clear_rect_copy->size());
3797 const auto& render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3798 bool skip = false;
3799 const IMAGE_VIEW_STATE* image_view_state = nullptr;
3800 if (fb && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < fb->createInfo.attachmentCount)) {
3801 image_view_state = prim_cb->GetActiveAttachmentImageViewState(fb_attachment);
3802 }
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003803 skip = ValidateClearAttachmentExtent(secondary, attachment_index, image_view_state, render_area, rectCount,
3804 clear_rect_copy->data());
amhagana448ea52021-11-02 14:09:14 -04003805 return skip;
3806 };
3807 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
3808 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003809 }
3810 }
3811 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003812}
3813
Jeff Leger178b1e52020-10-05 12:22:23 -04003814template <typename RegionType>
3815bool CoreChecks::ValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3816 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Tony-LunarG562fc102021-11-12 13:58:35 -07003817 const RegionType *pRegions, CMD_TYPE cmd_type) const {
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07003818 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07003819 auto src_image_state = Get<IMAGE_STATE>(srcImage);
3820 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Tony-LunarG562fc102021-11-12 13:58:35 -07003821 const bool is_2 = (cmd_type == CMD_RESOLVEIMAGE2KHR || cmd_type == CMD_RESOLVEIMAGE2);
sfricke-samsung85584a72021-09-30 21:43:38 -07003822 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04003823 const char *vuid;
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003824
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003825 bool skip = false;
3826 if (cb_node && src_image_state && dst_image_state) {
Tony-LunarG562fc102021-11-12 13:58:35 -07003827 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-00256" : "VUID-vkCmdResolveImage-srcImage-00256";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003828 skip |= ValidateMemoryIsBoundToImage(src_image_state.get(), func_name, vuid);
Tony-LunarG562fc102021-11-12 13:58:35 -07003829 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-00258" : "VUID-vkCmdResolveImage-dstImage-00258";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003830 skip |= ValidateMemoryIsBoundToImage(dst_image_state.get(), func_name, vuid);
3831 skip |= ValidateCmd(cb_node.get(), cmd_type);
Tony-LunarG562fc102021-11-12 13:58:35 -07003832 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-02003" : "VUID-vkCmdResolveImage-dstImage-02003";
3833 skip |= ValidateImageFormatFeatureFlags(dst_image_state.get(), VK_FORMAT_FEATURE_2_COLOR_ATTACHMENT_BIT, func_name, vuid);
3834 vuid = is_2 ? "VUID-vkCmdResolveImage2-commandBuffer-01837" : "VUID-vkCmdResolveImage-commandBuffer-01837";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003835 skip |= ValidateProtectedImage(cb_node.get(), src_image_state.get(), func_name, vuid);
Tony-LunarG562fc102021-11-12 13:58:35 -07003836 vuid = is_2 ? "VUID-vkCmdResolveImage2-commandBuffer-01838" : "VUID-vkCmdResolveImage-commandBuffer-01838";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003837 skip |= ValidateProtectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
Tony-LunarG562fc102021-11-12 13:58:35 -07003838 vuid = is_2 ? "VUID-vkCmdResolveImage2-commandBuffer-01839" : "VUID-vkCmdResolveImage-commandBuffer-01839";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003839 skip |= ValidateUnprotectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
ziga-lunarg73154fd2022-05-18 14:36:33 +02003840 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-06762" : "VUID-vkCmdResolveImage-srcImage-06762";
3841 skip |= ValidateImageUsageFlags(src_image_state.get(), VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3842 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3843 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-06763" : "VUID-vkCmdResolveImage-srcImage-06763";
3844 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(), VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
3845 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-06764" : "VUID-vkCmdResolveImage-dstImage-06764";
3846 skip |= ValidateImageUsageFlags(dst_image_state.get(), VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3847 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3848 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-06765" : "VUID-vkCmdResolveImage-dstImage-06765";
3849 skip |= ValidateImageFormatFeatureFlags(dst_image_state.get(), VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003850
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003851 // Validation for VK_EXT_fragment_density_map
3852 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony-LunarG562fc102021-11-12 13:58:35 -07003853 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003854 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003855 "%s: srcImage must not have been created with flags containing "
3856 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3857 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003858 }
3859 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony-LunarG562fc102021-11-12 13:58:35 -07003860 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003861 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003862 "%s: dstImage must not have been created with flags containing "
3863 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3864 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003865 }
3866
Cort Stratton7df30962018-05-17 19:45:57 -07003867 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003868 const char *invalid_src_layout_vuid =
Tony-LunarG562fc102021-11-12 13:58:35 -07003869 is_2 ? ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
3870 ? "VUID-VkResolveImageInfo2-srcImageLayout-01400"
3871 : "VUID-VkResolveImageInfo2-srcImageLayout-00261")
sfricke-samsung45996a42021-09-16 13:45:27 -07003872 : ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003873 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3874 : "VUID-vkCmdResolveImage-srcImageLayout-00261");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003875 const char *invalid_dst_layout_vuid =
Tony-LunarG562fc102021-11-12 13:58:35 -07003876 is_2 ? ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
3877 ? "VUID-VkResolveImageInfo2-dstImageLayout-01401"
3878 : "VUID-VkResolveImageInfo2-dstImageLayout-00263")
sfricke-samsung45996a42021-09-16 13:45:27 -07003879 : ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003880 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3881 : "VUID-vkCmdResolveImage-dstImageLayout-00263");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003882 // For each region, the number of layers in the image subresource should not be zero
3883 // For each region, src and dest image aspect must be color only
3884 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003885 const RegionType region = pRegions[i];
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003886 const VkImageSubresourceLayers src_subresource = region.srcSubresource;
3887 const VkImageSubresourceLayers dst_subresource = region.dstSubresource;
Tony-LunarG562fc102021-11-12 13:58:35 -07003888
Jeremy Gebben9f537102021-10-05 16:37:12 -06003889 skip |= ValidateImageSubresourceLayers(cb_node.get(), &src_subresource, func_name, "srcSubresource", i);
3890 skip |= ValidateImageSubresourceLayers(cb_node.get(), &dst_subresource, func_name, "dstSubresource", i);
Tony-LunarG562fc102021-11-12 13:58:35 -07003891 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImageLayout-00260" : "VUID-vkCmdResolveImage-srcImageLayout-00260";
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06003892 skip |= VerifyImageLayout(*cb_node, *src_image_state, src_subresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003893 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
Tony-LunarG562fc102021-11-12 13:58:35 -07003894 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImageLayout-00262" : "VUID-vkCmdResolveImage-dstImageLayout-00262";
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06003895 skip |= VerifyImageLayout(*cb_node, *dst_image_state, dst_subresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003896 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
Tony-LunarG562fc102021-11-12 13:58:35 -07003897 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcSubresource-01709" : "VUID-vkCmdResolveImage-srcSubresource-01709";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003898 skip |= ValidateImageMipLevel(cb_node.get(), src_image_state.get(), src_subresource.mipLevel, i, func_name,
3899 "srcSubresource", vuid);
Tony-LunarG562fc102021-11-12 13:58:35 -07003900 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstSubresource-01710" : "VUID-vkCmdResolveImage-dstSubresource-01710";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003901 skip |= ValidateImageMipLevel(cb_node.get(), dst_image_state.get(), dst_subresource.mipLevel, i, func_name,
3902 "dstSubresource", vuid);
Tony-LunarG562fc102021-11-12 13:58:35 -07003903 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcSubresource-01711" : "VUID-vkCmdResolveImage-srcSubresource-01711";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003904 skip |= ValidateImageArrayLayerRange(cb_node.get(), src_image_state.get(), src_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003905 src_subresource.layerCount, i, func_name, "srcSubresource", vuid);
Tony-LunarG562fc102021-11-12 13:58:35 -07003906 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstSubresource-01712" : "VUID-vkCmdResolveImage-dstSubresource-01712";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003907 skip |= ValidateImageArrayLayerRange(cb_node.get(), dst_image_state.get(), dst_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003908 dst_subresource.layerCount, i, func_name, "srcSubresource", vuid);
Cort Stratton7df30962018-05-17 19:45:57 -07003909
3910 // layer counts must match
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003911 if (src_subresource.layerCount != dst_subresource.layerCount) {
Tony-LunarG562fc102021-11-12 13:58:35 -07003912 vuid = is_2 ? "VUID-VkImageResolve2-layerCount-00267" : "VUID-VkImageResolve-layerCount-00267";
Jeff Leger178b1e52020-10-05 12:22:23 -04003913 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003914 LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003915 "%s: layerCount in source and destination subresource of pRegions[%u] does not match.", func_name, i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003916 }
Cort Stratton7df30962018-05-17 19:45:57 -07003917 // For each region, src and dest image aspect must be color only
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003918 if ((src_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3919 (dst_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
Tony-LunarG562fc102021-11-12 13:58:35 -07003920 vuid = is_2 ? "VUID-VkImageResolve2-aspectMask-00266" : "VUID-VkImageResolve-aspectMask-00266";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003921 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003922 "%s: src and dest aspectMasks for pRegions[%u] must specify only VK_IMAGE_ASPECT_COLOR_BIT.",
3923 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003924 }
3925
3926 const VkImageType src_image_type = src_image_state->createInfo.imageType;
3927 const VkImageType dst_image_type = dst_image_state->createInfo.imageType;
3928
3929 if ((VK_IMAGE_TYPE_3D == src_image_type) || (VK_IMAGE_TYPE_3D == dst_image_type)) {
Shannon McPherson74b341c2020-09-08 15:43:05 -06003930 if ((0 != src_subresource.baseArrayLayer) || (1 != src_subresource.layerCount)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003931 LogObjectList objlist(cb_node->commandBuffer());
3932 objlist.add(src_image_state->image());
3933 objlist.add(dst_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003934 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-04446" : "VUID-vkCmdResolveImage-srcImage-04446";
Jeff Leger178b1e52020-10-05 12:22:23 -04003935 skip |= LogError(objlist, vuid,
3936 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
Shannon McPherson74b341c2020-09-08 15:43:05 -06003937 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003938 func_name, i);
Shannon McPherson74b341c2020-09-08 15:43:05 -06003939 }
3940 if ((0 != dst_subresource.baseArrayLayer) || (1 != dst_subresource.layerCount)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003941 LogObjectList objlist(cb_node->commandBuffer());
3942 objlist.add(src_image_state->image());
3943 objlist.add(dst_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003944 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-04447" : "VUID-vkCmdResolveImage-srcImage-04447";
Jeff Leger178b1e52020-10-05 12:22:23 -04003945 skip |= LogError(objlist, vuid,
3946 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003947 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003948 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003949 }
3950 }
3951
3952 if (VK_IMAGE_TYPE_1D == src_image_type) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05003953 if ((region.srcOffset.y != 0) || (region.extent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003954 LogObjectList objlist(cb_node->commandBuffer());
3955 objlist.add(src_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003956 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-00271" : "VUID-vkCmdResolveImage-srcImage-00271";
Jeff Leger178b1e52020-10-05 12:22:23 -04003957 skip |= LogError(objlist, vuid,
3958 "%s: srcImage (%s) is 1D but pRegions[%u] srcOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003959 "extent.height (%u) is not 1.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05003960 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.y,
3961 region.extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003962 }
3963 }
3964 if ((VK_IMAGE_TYPE_1D == src_image_type) || (VK_IMAGE_TYPE_2D == src_image_type)) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05003965 if ((region.srcOffset.z != 0) || (region.extent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003966 LogObjectList objlist(cb_node->commandBuffer());
3967 objlist.add(src_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003968 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-00273" : "VUID-vkCmdResolveImage-srcImage-00273";
Jeff Leger178b1e52020-10-05 12:22:23 -04003969 skip |= LogError(objlist, vuid,
3970 "%s: srcImage (%s) is 2D but pRegions[%u] srcOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003971 "extent.depth (%u) is not 1.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05003972 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.z,
3973 region.extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003974 }
3975 }
3976
3977 if (VK_IMAGE_TYPE_1D == dst_image_type) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05003978 if ((region.dstOffset.y != 0) || (region.extent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003979 LogObjectList objlist(cb_node->commandBuffer());
3980 objlist.add(dst_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003981 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-00276" : "VUID-vkCmdResolveImage-dstImage-00276";
Jeff Leger178b1e52020-10-05 12:22:23 -04003982 skip |= LogError(objlist, vuid,
3983 "%s: dstImage (%s) is 1D but pRegions[%u] dstOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003984 "extent.height (%u) is not 1.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05003985 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.dstOffset.y,
3986 region.extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003987 }
3988 }
3989 if ((VK_IMAGE_TYPE_1D == dst_image_type) || (VK_IMAGE_TYPE_2D == dst_image_type)) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05003990 if ((region.dstOffset.z != 0) || (region.extent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003991 LogObjectList objlist(cb_node->commandBuffer());
3992 objlist.add(dst_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003993 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-00278" : "VUID-vkCmdResolveImage-dstImage-00278";
Jeff Leger178b1e52020-10-05 12:22:23 -04003994 skip |= LogError(objlist, vuid,
3995 "%s: dstImage (%s) is 2D but pRegions[%u] dstOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003996 "extent.depth (%u) is not 1.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05003997 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.dstOffset.z,
3998 region.extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003999 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07004000 }
sfricke-samsungdfeb3172020-07-25 21:17:07 -07004001
4002 // Each srcImage dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06004003 VkExtent3D subresource_extent = src_image_state->GetSubresourceExtent(src_subresource);
sfricke-samsungdfeb3172020-07-25 21:17:07 -07004004 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
4005 // developer
4006 if (src_subresource.mipLevel < src_image_state->createInfo.mipLevels) {
4007 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004008 if ((extent_check & kXBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004009 LogObjectList objlist(cb_node->commandBuffer());
4010 objlist.add(src_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07004011 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcOffset-00269" : "VUID-vkCmdResolveImage-srcOffset-00269";
Jeff Leger178b1e52020-10-05 12:22:23 -04004012 skip |= LogError(objlist, vuid,
4013 "%s: srcImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07004014 "exceeds subResource width [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004015 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07004016 region.extent.width, subresource_extent.width);
4017 }
4018
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004019 if ((extent_check & kYBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004020 LogObjectList objlist(cb_node->commandBuffer());
4021 objlist.add(src_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07004022 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcOffset-00270" : "VUID-vkCmdResolveImage-srcOffset-00270";
Jeff Leger178b1e52020-10-05 12:22:23 -04004023 skip |= LogError(objlist, vuid,
4024 "%s: srcImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07004025 "exceeds subResource height [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004026 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07004027 region.extent.height, subresource_extent.height);
4028 }
4029
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004030 if ((extent_check & kZBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004031 LogObjectList objlist(cb_node->commandBuffer());
4032 objlist.add(src_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07004033 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcOffset-00272" : "VUID-vkCmdResolveImage-srcOffset-00272";
Jeff Leger178b1e52020-10-05 12:22:23 -04004034 skip |= LogError(objlist, vuid,
4035 "%s: srcImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07004036 "exceeds subResource depth [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004037 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07004038 region.extent.depth, subresource_extent.depth);
4039 }
4040 }
4041
4042 // Each dstImage dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06004043 subresource_extent = dst_image_state->GetSubresourceExtent(dst_subresource);
sfricke-samsungdfeb3172020-07-25 21:17:07 -07004044 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
4045 // developer
4046 if (dst_subresource.mipLevel < dst_image_state->createInfo.mipLevels) {
4047 uint32_t extent_check = ExceedsBounds(&(region.dstOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004048 if ((extent_check & kXBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004049 LogObjectList objlist(cb_node->commandBuffer());
4050 objlist.add(dst_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07004051 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstOffset-00274" : "VUID-vkCmdResolveImage-dstOffset-00274";
Jeff Leger178b1e52020-10-05 12:22:23 -04004052 skip |= LogError(objlist, vuid,
4053 "%s: dstImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07004054 "exceeds subResource width [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004055 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07004056 region.extent.width, subresource_extent.width);
4057 }
4058
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004059 if ((extent_check & kYBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004060 LogObjectList objlist(cb_node->commandBuffer());
4061 objlist.add(dst_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07004062 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstOffset-00275" : "VUID-vkCmdResolveImage-dstOffset-00275";
Jeff Leger178b1e52020-10-05 12:22:23 -04004063 skip |= LogError(objlist, vuid,
4064 "%s: dstImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07004065 "exceeds subResource height [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004066 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07004067 region.extent.height, subresource_extent.height);
4068 }
4069
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004070 if ((extent_check & kZBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004071 LogObjectList objlist(cb_node->commandBuffer());
4072 objlist.add(dst_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07004073 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstOffset-00277" : "VUID-vkCmdResolveImage-dstOffset-00277";
Jeff Leger178b1e52020-10-05 12:22:23 -04004074 skip |= LogError(objlist, vuid,
4075 "%s: dstImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07004076 "exceeds subResource depth [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004077 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07004078 region.extent.depth, subresource_extent.depth);
4079 }
4080 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07004081 }
4082
4083 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
Tony-LunarG562fc102021-11-12 13:58:35 -07004084 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-01386" : "VUID-vkCmdResolveImage-srcImage-01386";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004085 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 -04004086 func_name, string_VkFormat(src_image_state->createInfo.format),
4087 string_VkFormat(dst_image_state->createInfo.format));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07004088 }
4089 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004090 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_MismatchedImageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04004091 "%s: srcImage type (%s) and dstImage type (%s) are not the same.", func_name,
sfricke-samsungc26350e2020-05-30 12:31:31 -07004092 string_VkImageType(src_image_state->createInfo.imageType),
4093 string_VkImageType(dst_image_state->createInfo.imageType));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07004094 }
4095 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
Tony-LunarG562fc102021-11-12 13:58:35 -07004096 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-00257" : "VUID-vkCmdResolveImage-srcImage-00257";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004097 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 -07004098 }
4099 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
Tony-LunarG562fc102021-11-12 13:58:35 -07004100 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-00259" : "VUID-vkCmdResolveImage-dstImage-00259";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004101 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 -04004102 func_name, string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07004103 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004104 } else {
4105 assert(0);
4106 }
4107 return skip;
4108}
4109
Jeff Leger178b1e52020-10-05 12:22:23 -04004110bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4111 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4112 const VkImageResolve *pRegions) const {
4113 return ValidateCmdResolveImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
Tony-LunarG562fc102021-11-12 13:58:35 -07004114 CMD_RESOLVEIMAGE);
Jeff Leger178b1e52020-10-05 12:22:23 -04004115}
4116
4117bool CoreChecks::PreCallValidateCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
4118 const VkResolveImageInfo2KHR *pResolveImageInfo) const {
4119 return ValidateCmdResolveImage(commandBuffer, pResolveImageInfo->srcImage, pResolveImageInfo->srcImageLayout,
4120 pResolveImageInfo->dstImage, pResolveImageInfo->dstImageLayout, pResolveImageInfo->regionCount,
Tony-LunarG562fc102021-11-12 13:58:35 -07004121 pResolveImageInfo->pRegions, CMD_RESOLVEIMAGE2KHR);
4122}
4123
4124bool CoreChecks::PreCallValidateCmdResolveImage2(VkCommandBuffer commandBuffer,
4125 const VkResolveImageInfo2 *pResolveImageInfo) const {
4126 return ValidateCmdResolveImage(commandBuffer, pResolveImageInfo->srcImage, pResolveImageInfo->srcImageLayout,
4127 pResolveImageInfo->dstImage, pResolveImageInfo->dstImageLayout, pResolveImageInfo->regionCount,
4128 pResolveImageInfo->pRegions, CMD_RESOLVEIMAGE2);
Jeff Leger178b1e52020-10-05 12:22:23 -04004129}
4130
4131template <typename RegionType>
4132bool CoreChecks::ValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4133 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Tony-LunarG542ae912021-11-04 16:06:44 -06004134 const RegionType *pRegions, VkFilter filter, CMD_TYPE cmd_type) const {
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07004135 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07004136 auto src_image_state = Get<IMAGE_STATE>(srcImage);
4137 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Tony-LunarG542ae912021-11-04 16:06:44 -06004138 const bool is_2 = (cmd_type == CMD_BLITIMAGE2KHR || cmd_type == CMD_BLITIMAGE2);
sfricke-samsung85584a72021-09-30 21:43:38 -07004139 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04004140
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004141 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07004142 if (cb_node) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06004143 skip |= ValidateCmd(cb_node.get(), cmd_type);
John Zulauf5c2750c2018-01-30 15:04:56 -07004144 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004145 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004146 const char *vuid;
Tony-LunarG542ae912021-11-04 16:06:44 -06004147 std::string loc_head = std::string(func_name);
4148 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00233" : "VUID-vkCmdBlitImage-srcImage-00233";
4149 const char *location1 = is_2 ? loc_head.append("(): pBlitImageInfo->srcImage").c_str() : "vkCmdBlitImage(): srcImage";
4150 skip |= ValidateImageSampleCount(src_image_state.get(), VK_SAMPLE_COUNT_1_BIT, location1, vuid);
4151 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-00234" : "VUID-vkCmdBlitImage-dstImage-00234";
4152 loc_head = std::string(func_name);
4153 const char *location2 = is_2 ? loc_head.append("(): pBlitImageInfo->dstImage").c_str() : "vkCmdBlitImage(): dstImage";
4154 skip |= ValidateImageSampleCount(dst_image_state.get(), VK_SAMPLE_COUNT_1_BIT, location2, vuid);
4155 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00220" : "VUID-vkCmdBlitImage-srcImage-00220";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004156 skip |= ValidateMemoryIsBoundToImage(src_image_state.get(), func_name, vuid);
Tony-LunarG542ae912021-11-04 16:06:44 -06004157 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-00225" : "VUID-vkCmdBlitImage-dstImage-00225";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004158 skip |= ValidateMemoryIsBoundToImage(dst_image_state.get(), func_name, vuid);
Tony-LunarG542ae912021-11-04 16:06:44 -06004159 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00219" : "VUID-vkCmdBlitImage-srcImage-00219";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004160 skip |= ValidateImageUsageFlags(src_image_state.get(), VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04004161 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tony-LunarG542ae912021-11-04 16:06:44 -06004162 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-00224" : "VUID-vkCmdBlitImage-dstImage-00224";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004163 skip |= ValidateImageUsageFlags(dst_image_state.get(), VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04004164 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Jeremy Gebben9f537102021-10-05 16:37:12 -06004165 skip |= ValidateCmd(cb_node.get(), cmd_type);
Tony-LunarG542ae912021-11-04 16:06:44 -06004166 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-01999" : "VUID-vkCmdBlitImage-srcImage-01999";
4167 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(), VK_FORMAT_FEATURE_2_BLIT_SRC_BIT, func_name, vuid);
4168 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-02000" : "VUID-vkCmdBlitImage-dstImage-02000";
4169 skip |= ValidateImageFormatFeatureFlags(dst_image_state.get(), VK_FORMAT_FEATURE_2_BLIT_DST_BIT, func_name, vuid);
4170 vuid = is_2 ? "VUID-vkCmdBlitImage2-commandBuffer-01834" : "VUID-vkCmdBlitImage-commandBuffer-01834";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004171 skip |= ValidateProtectedImage(cb_node.get(), src_image_state.get(), func_name, vuid);
Tony-LunarG542ae912021-11-04 16:06:44 -06004172 vuid = is_2 ? "VUID-vkCmdBlitImage2-commandBuffer-01835" : "VUID-vkCmdBlitImage-commandBuffer-01835";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004173 skip |= ValidateProtectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
Tony-LunarG542ae912021-11-04 16:06:44 -06004174 vuid = is_2 ? "VUID-vkCmdBlitImage2-commandBuffer-01836" : "VUID-vkCmdBlitImage-commandBuffer-01836";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004175 skip |= ValidateUnprotectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
sfricke-samsung022fa252020-07-24 03:26:16 -07004176
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02004177 // Validation for VK_EXT_fragment_density_map
4178 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004179 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004180 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004181 "%s: srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
4182 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02004183 }
4184 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004185 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004186 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004187 "%s: dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
4188 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02004189 }
4190
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06004191 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004192
Dave Houlton33c2d252017-06-09 17:08:32 -06004193 VkFormat src_format = src_image_state->createInfo.format;
4194 VkFormat dst_format = dst_image_state->createInfo.format;
4195 VkImageType src_type = src_image_state->createInfo.imageType;
4196 VkImageType dst_type = dst_image_state->createInfo.imageType;
4197
Cort Stratton186b1a22018-05-01 20:18:06 -04004198 if (VK_FILTER_LINEAR == filter) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004199 vuid = is_2 ? "VUID-VkBlitImageInfo2-filter-02001" : "VUID-vkCmdBlitImage-filter-02001";
4200 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(), VK_FORMAT_FEATURE_2_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Jeremy Gebben9f537102021-10-05 16:37:12 -06004201 func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04004202 } else if (VK_FILTER_CUBIC_IMG == filter) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004203 vuid = is_2 ? "VUID-VkBlitImageInfo2-filter-02002" : "VUID-vkCmdBlitImage-filter-02002";
4204 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(), VK_FORMAT_FEATURE_2_SAMPLED_IMAGE_FILTER_CUBIC_BIT,
Jeff Leger178b1e52020-10-05 12:22:23 -04004205 func_name, vuid);
Dave Houlton33c2d252017-06-09 17:08:32 -06004206 }
4207
sfricke-samsung10b35ce2021-09-29 08:50:20 -07004208 if (FormatRequiresYcbcrConversionExplicitly(src_format)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004209 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-06421" : "VUID-vkCmdBlitImage-srcImage-06421";
Jeff Leger178b1e52020-10-05 12:22:23 -04004210 skip |= LogError(device, vuid,
4211 "%s: srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004212 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04004213 func_name, string_VkFormat(src_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004214 }
4215
sfricke-samsung10b35ce2021-09-29 08:50:20 -07004216 if (FormatRequiresYcbcrConversionExplicitly(dst_format)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004217 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-06422" : "VUID-vkCmdBlitImage-dstImage-06422";
Jeff Leger178b1e52020-10-05 12:22:23 -04004218 skip |= LogError(device, vuid,
4219 "%s: dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004220 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04004221 func_name, string_VkFormat(dst_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004222 }
4223
ziga-lunarg52604a12021-09-09 16:02:05 +02004224 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_2D != src_type)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004225 vuid = is_2 ? "VUID-VkBlitImageInfo2-filter-00237" : "VUID-vkCmdBlitImage-filter-00237";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004226 skip |= LogError(cb_node->commandBuffer(), vuid,
ziga-lunarg52604a12021-09-09 16:02:05 +02004227 "%s: source image type must be VK_IMAGE_TYPE_2D when cubic filtering is specified.", func_name);
Dave Houlton33c2d252017-06-09 17:08:32 -06004228 }
4229
Dave Houlton33c2d252017-06-09 17:08:32 -06004230 // Validate consistency for unsigned formats
sfricke-samsunge3086292021-11-18 23:02:35 -08004231 if (FormatIsUINT(src_format) != FormatIsUINT(dst_format)) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004232 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004233 ss << func_name << ": If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06004234 << "the other one must also have unsigned integer format. "
4235 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Tony-LunarG542ae912021-11-04 16:06:44 -06004236 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00230" : "VUID-vkCmdBlitImage-srcImage-00230";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004237 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004238 }
4239
4240 // Validate consistency for signed formats
sfricke-samsunge3086292021-11-18 23:02:35 -08004241 if (FormatIsSINT(src_format) != FormatIsSINT(dst_format)) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004242 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004243 ss << func_name << ": If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06004244 << "the other one must also have signed integer format. "
4245 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Tony-LunarG542ae912021-11-04 16:06:44 -06004246 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00229" : "VUID-vkCmdBlitImage-srcImage-00229";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004247 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004248 }
4249
4250 // Validate filter for Depth/Stencil formats
4251 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
4252 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004253 ss << func_name << ": If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06004254 << "then filter must be VK_FILTER_NEAREST.";
Tony-LunarG542ae912021-11-04 16:06:44 -06004255 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00232" : "VUID-vkCmdBlitImage-srcImage-00232";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004256 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004257 }
4258
4259 // Validate aspect bits and formats for depth/stencil images
4260 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
4261 if (src_format != dst_format) {
4262 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004263 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 -06004264 << "stencil, the other one must have exactly the same format. "
4265 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
4266 << string_VkFormat(dst_format);
Tony-LunarG542ae912021-11-04 16:06:44 -06004267 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00231" : "VUID-vkCmdBlitImage-srcImage-00231";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004268 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004269 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004270 } // Depth or Stencil
4271
4272 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004273 const char *invalid_src_layout_vuid =
Tony-LunarG542ae912021-11-04 16:06:44 -06004274 is_2 ? ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
4275 ? "VUID-VkBlitImageInfo2-srcImageLayout-01398"
4276 : "VUID-VkBlitImageInfo2-srcImageLayout-00222")
sfricke-samsung45996a42021-09-16 13:45:27 -07004277 : ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04004278 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
4279 : "VUID-vkCmdBlitImage-srcImageLayout-00222");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004280 const char *invalid_dst_layout_vuid =
Tony-LunarG542ae912021-11-04 16:06:44 -06004281 is_2 ? ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
4282 ? "VUID-VkBlitImageInfo2-dstImageLayout-01399"
4283 : "VUID-VkBlitImageInfo2-dstImageLayout-00227")
sfricke-samsung45996a42021-09-16 13:45:27 -07004284 : ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04004285 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
4286 : "VUID-vkCmdBlitImage-dstImageLayout-00227");
Aitor Camachoc22c3602022-06-07 20:45:50 +02004287
4288 bool same_image = (src_image_state == dst_image_state);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004289 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05004290 const RegionType region = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004291 bool hit_error = false;
Tony-LunarG542ae912021-11-04 16:06:44 -06004292
Aitor Camachoc22c3602022-06-07 20:45:50 +02004293 // When performing blit from and to same subresource, VK_IMAGE_LAYOUT_GENERAL is the only option
4294 const auto &src_sub = pRegions[i].srcSubresource;
4295 const auto &dst_sub = pRegions[i].dstSubresource;
4296 bool same_subresource =
4297 (same_image && (src_sub.mipLevel == dst_sub.mipLevel) && (src_sub.baseArrayLayer == dst_sub.baseArrayLayer));
4298 VkImageLayout source_optimal = (same_subresource ? VK_IMAGE_LAYOUT_GENERAL : VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL);
4299 VkImageLayout destination_optimal = (same_subresource ? VK_IMAGE_LAYOUT_GENERAL : VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL);
4300
Tony-LunarG542ae912021-11-04 16:06:44 -06004301 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImageLayout-00221" : "VUID-vkCmdBlitImage-srcImageLayout-00221";
Aitor Camachoc22c3602022-06-07 20:45:50 +02004302 skip |= VerifyImageLayout(*cb_node, *src_image_state, region.srcSubresource, srcImageLayout, source_optimal, func_name,
4303 invalid_src_layout_vuid, vuid, &hit_error);
Tony-LunarG542ae912021-11-04 16:06:44 -06004304 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImageLayout-00226" : "VUID-vkCmdBlitImage-dstImageLayout-00226";
Aitor Camachoc22c3602022-06-07 20:45:50 +02004305 skip |= VerifyImageLayout(*cb_node, *dst_image_state, region.dstSubresource, dstImageLayout, destination_optimal,
4306 func_name, invalid_dst_layout_vuid, vuid, &hit_error);
sfricke-samsung71f04e32022-03-16 01:21:21 -05004307 skip |= ValidateImageSubresourceLayers(cb_node.get(), &region.srcSubresource, func_name, "srcSubresource", i);
4308 skip |= ValidateImageSubresourceLayers(cb_node.get(), &region.dstSubresource, func_name, "dstSubresource", i);
Tony-LunarG542ae912021-11-04 16:06:44 -06004309 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcSubresource-01705" : "VUID-vkCmdBlitImage-srcSubresource-01705";
sfricke-samsung71f04e32022-03-16 01:21:21 -05004310 skip |= ValidateImageMipLevel(cb_node.get(), src_image_state.get(), region.srcSubresource.mipLevel, i, func_name,
Jeremy Gebben9f537102021-10-05 16:37:12 -06004311 "srcSubresource", vuid);
Tony-LunarG542ae912021-11-04 16:06:44 -06004312 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstSubresource-01706" : "VUID-vkCmdBlitImage-dstSubresource-01706";
sfricke-samsung71f04e32022-03-16 01:21:21 -05004313 skip |= ValidateImageMipLevel(cb_node.get(), dst_image_state.get(), region.dstSubresource.mipLevel, i, func_name,
Jeremy Gebben9f537102021-10-05 16:37:12 -06004314 "dstSubresource", vuid);
Tony-LunarG542ae912021-11-04 16:06:44 -06004315 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcSubresource-01707" : "VUID-vkCmdBlitImage-srcSubresource-01707";
sfricke-samsung71f04e32022-03-16 01:21:21 -05004316 skip |= ValidateImageArrayLayerRange(cb_node.get(), src_image_state.get(), region.srcSubresource.baseArrayLayer,
4317 region.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
Tony-LunarG542ae912021-11-04 16:06:44 -06004318 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstSubresource-01708" : "VUID-vkCmdBlitImage-dstSubresource-01708";
sfricke-samsung71f04e32022-03-16 01:21:21 -05004319 skip |= ValidateImageArrayLayerRange(cb_node.get(), dst_image_state.get(), region.dstSubresource.baseArrayLayer,
4320 region.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004321 // Warn for zero-sized regions
sfricke-samsung71f04e32022-03-16 01:21:21 -05004322 if ((region.srcOffsets[0].x == region.srcOffsets[1].x) || (region.srcOffsets[0].y == region.srcOffsets[1].y) ||
4323 (region.srcOffsets[0].z == region.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004324 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004325 ss << func_name << ": pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004326 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004327 }
sfricke-samsung71f04e32022-03-16 01:21:21 -05004328 if ((region.dstOffsets[0].x == region.dstOffsets[1].x) || (region.dstOffsets[0].y == region.dstOffsets[1].y) ||
4329 (region.dstOffsets[0].z == region.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004330 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004331 ss << func_name << ": pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004332 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004333 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004334
4335 // Check that src/dst layercounts match
sfricke-samsung71f04e32022-03-16 01:21:21 -05004336 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004337 vuid = is_2 ? "VUID-VkImageBlit2-layerCount-00239" : "VUID-VkImageBlit-layerCount-00239";
Jeff Leger178b1e52020-10-05 12:22:23 -04004338 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004339 LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004340 "%s: layerCount in source and destination subresource of pRegions[%d] does not match.", func_name, i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004341 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07004342
sfricke-samsung71f04e32022-03-16 01:21:21 -05004343 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004344 vuid = is_2 ? "VUID-VkImageBlit2-aspectMask-00238" : "VUID-VkImageBlit-aspectMask-00238";
Jeff Leger178b1e52020-10-05 12:22:23 -04004345 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004346 LogError(cb_node->commandBuffer(), vuid, "%s: aspectMask members for pRegion[%d] do not match.", func_name, i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07004347 }
Dave Houlton48989f32017-05-26 15:01:46 -06004348
sfricke-samsung71f04e32022-03-16 01:21:21 -05004349 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004350 vuid = is_2 ? "VUID-VkBlitImageInfo2-aspectMask-00241" : "VUID-vkCmdBlitImage-aspectMask-00241";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004351 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004352 "%s: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004353 "image format %s.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004354 func_name, i, region.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004355 }
4356
sfricke-samsung71f04e32022-03-16 01:21:21 -05004357 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004358 vuid = is_2 ? "VUID-VkBlitImageInfo2-aspectMask-00242" : "VUID-vkCmdBlitImage-aspectMask-00242";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004359 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004360 "%s: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004361 func_name, i, region.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004362 }
4363
Dave Houlton48989f32017-05-26 15:01:46 -06004364 // Validate source image offsets
sfricke-samsung71f04e32022-03-16 01:21:21 -05004365 VkExtent3D src_extent = src_image_state->GetSubresourceExtent(region.srcSubresource);
Dave Houlton33c2d252017-06-09 17:08:32 -06004366 if (VK_IMAGE_TYPE_1D == src_type) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05004367 if ((0 != region.srcOffsets[0].y) || (1 != region.srcOffsets[1].y)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004368 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00245" : "VUID-vkCmdBlitImage-srcImage-00245";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004369 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004370 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
4371 "of (%1d, %1d). These must be (0, 1).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004372 func_name, i, region.srcOffsets[0].y, region.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004373 }
4374 }
4375
Dave Houlton33c2d252017-06-09 17:08:32 -06004376 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05004377 if ((0 != region.srcOffsets[0].z) || (1 != region.srcOffsets[1].z)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004378 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00247" : "VUID-vkCmdBlitImage-srcImage-00247";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004379 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004380 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
4381 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004382 func_name, i, region.srcOffsets[0].z, region.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004383 }
4384 }
4385
Dave Houlton33c2d252017-06-09 17:08:32 -06004386 bool oob = false;
sfricke-samsung71f04e32022-03-16 01:21:21 -05004387 if ((region.srcOffsets[0].x < 0) || (region.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
4388 (region.srcOffsets[1].x < 0) || (region.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004389 oob = true;
Tony-LunarG542ae912021-11-04 16:06:44 -06004390 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcOffset-00243" : "VUID-vkCmdBlitImage-srcOffset-00243";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004391 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004392 "%s: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004393 func_name, i, region.srcOffsets[0].x, region.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004394 }
sfricke-samsung71f04e32022-03-16 01:21:21 -05004395 if ((region.srcOffsets[0].y < 0) || (region.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
4396 (region.srcOffsets[1].y < 0) || (region.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004397 oob = true;
Tony-LunarG542ae912021-11-04 16:06:44 -06004398 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcOffset-00244" : "VUID-vkCmdBlitImage-srcOffset-00244";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004399 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004400 "%s: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004401 func_name, i, region.srcOffsets[0].y, region.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004402 }
sfricke-samsung71f04e32022-03-16 01:21:21 -05004403 if ((region.srcOffsets[0].z < 0) || (region.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
4404 (region.srcOffsets[1].z < 0) || (region.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004405 oob = true;
Tony-LunarG542ae912021-11-04 16:06:44 -06004406 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcOffset-00246" : "VUID-vkCmdBlitImage-srcOffset-00246";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004407 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004408 "%s: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004409 func_name, i, region.srcOffsets[0].z, region.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004410 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004411 if (oob) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004412 vuid = is_2 ? "VUID-VkBlitImageInfo2-pRegions-00215" : "VUID-vkCmdBlitImage-pRegions-00215";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004413 skip |= LogError(cb_node->commandBuffer(), vuid, "%s: region [%d] source image blit region exceeds image dimensions.",
Jeff Leger178b1e52020-10-05 12:22:23 -04004414 func_name, i);
Dave Houlton33c2d252017-06-09 17:08:32 -06004415 }
Dave Houlton48989f32017-05-26 15:01:46 -06004416
4417 // Validate dest image offsets
sfricke-samsung71f04e32022-03-16 01:21:21 -05004418 VkExtent3D dst_extent = dst_image_state->GetSubresourceExtent(region.dstSubresource);
Dave Houlton33c2d252017-06-09 17:08:32 -06004419 if (VK_IMAGE_TYPE_1D == dst_type) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05004420 if ((0 != region.dstOffsets[0].y) || (1 != region.dstOffsets[1].y)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004421 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-00250" : "VUID-vkCmdBlitImage-dstImage-00250";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004422 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004423 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
4424 "(%1d, %1d). These must be (0, 1).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004425 func_name, i, region.dstOffsets[0].y, region.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004426 }
4427 }
4428
Dave Houlton33c2d252017-06-09 17:08:32 -06004429 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05004430 if ((0 != region.dstOffsets[0].z) || (1 != region.dstOffsets[1].z)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004431 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-00252" : "VUID-vkCmdBlitImage-dstImage-00252";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004432 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004433 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004434 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004435 func_name, i, region.dstOffsets[0].z, region.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004436 }
4437 }
4438
Dave Houlton33c2d252017-06-09 17:08:32 -06004439 oob = false;
sfricke-samsung71f04e32022-03-16 01:21:21 -05004440 if ((region.dstOffsets[0].x < 0) || (region.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
4441 (region.dstOffsets[1].x < 0) || (region.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004442 oob = true;
Tony-LunarG542ae912021-11-04 16:06:44 -06004443 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstOffset-00248" : "VUID-vkCmdBlitImage-dstOffset-00248";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004444 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004445 "%s: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004446 func_name, i, region.dstOffsets[0].x, region.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004447 }
sfricke-samsung71f04e32022-03-16 01:21:21 -05004448 if ((region.dstOffsets[0].y < 0) || (region.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
4449 (region.dstOffsets[1].y < 0) || (region.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004450 oob = true;
Tony-LunarG542ae912021-11-04 16:06:44 -06004451 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstOffset-00249" : "VUID-vkCmdBlitImage-dstOffset-00249";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004452 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004453 "%s: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004454 func_name, i, region.dstOffsets[0].y, region.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004455 }
sfricke-samsung71f04e32022-03-16 01:21:21 -05004456 if ((region.dstOffsets[0].z < 0) || (region.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
4457 (region.dstOffsets[1].z < 0) || (region.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004458 oob = true;
Tony-LunarG542ae912021-11-04 16:06:44 -06004459 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstOffset-00251" : "VUID-vkCmdBlitImage-dstOffset-00251";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004460 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004461 "%s: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004462 func_name, i, region.dstOffsets[0].z, region.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004463 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004464 if (oob) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004465 vuid = is_2 ? "VUID-VkBlitImageInfo2-pRegions-00216" : "VUID-vkCmdBlitImage-pRegions-00216";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004466 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004467 "%s: region [%d] destination image blit region exceeds image dimensions.", func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004468 }
4469
Dave Houlton33c2d252017-06-09 17:08:32 -06004470 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05004471 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount) ||
4472 (0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004473 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00240" : "VUID-vkCmdBlitImage-srcImage-00240";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004474 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004475 "%s: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
4476 "layerCount other than 1.",
4477 func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004478 }
4479 }
aitor-lunarg607fe732022-03-31 22:00:08 +02004480
4481 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
4482 // must not overlap in memory
4483 if (srcImage == dstImage) {
4484 for (uint32_t j = 0; j < regionCount; j++) {
4485 if (RegionIntersectsBlit(&region, &pRegions[j], src_image_state->createInfo.imageType,
4486 FormatIsMultiplane(src_format))) {
4487 vuid = is_2 ? "VUID-VkBlitImageInfo2-pRegions-00217" : "VUID-vkCmdBlitImage-pRegions-00217";
4488 skip |= LogError(cb_node->commandBuffer(), vuid,
4489 "%s: pRegion[%" PRIu32 "] src overlaps with pRegions[%" PRIu32 "] dst.", func_name, i, j);
4490 }
4491 }
4492 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004493 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004494 } else {
4495 assert(0);
4496 }
4497 return skip;
4498}
4499
Jeff Leger178b1e52020-10-05 12:22:23 -04004500bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4501 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4502 const VkImageBlit *pRegions, VkFilter filter) const {
4503 return ValidateCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter,
Tony-LunarG542ae912021-11-04 16:06:44 -06004504 CMD_BLITIMAGE);
Jeff Leger178b1e52020-10-05 12:22:23 -04004505}
4506
4507bool CoreChecks::PreCallValidateCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) const {
4508 return ValidateCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4509 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
Tony-LunarG542ae912021-11-04 16:06:44 -06004510 pBlitImageInfo->filter, CMD_BLITIMAGE2KHR);
4511}
4512
4513bool CoreChecks::PreCallValidateCmdBlitImage2(VkCommandBuffer commandBuffer, const VkBlitImageInfo2 *pBlitImageInfo) const {
4514 return ValidateCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4515 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4516 pBlitImageInfo->filter, CMD_BLITIMAGE2);
Jeff Leger178b1e52020-10-05 12:22:23 -04004517}
4518
4519template <typename RegionType>
4520void CoreChecks::RecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
4521 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
4522 VkFilter filter) {
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07004523 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06004524 auto src_image_state = Get<IMAGE_STATE>(srcImage);
4525 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004526
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004527 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004528 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06004529 cb_node->SetImageInitialLayout(*src_image_state, pRegions[i].srcSubresource, srcImageLayout);
4530 cb_node->SetImageInitialLayout(*dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004531 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004532}
4533
Jeff Leger178b1e52020-10-05 12:22:23 -04004534void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4535 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4536 const VkImageBlit *pRegions, VkFilter filter) {
4537 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
4538 pRegions, filter);
4539 RecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter);
4540}
4541
4542void CoreChecks::PreCallRecordCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) {
4543 StateTracker::PreCallRecordCmdBlitImage2KHR(commandBuffer, pBlitImageInfo);
4544 RecordCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4545 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4546 pBlitImageInfo->filter);
4547}
4548
Tony-LunarG542ae912021-11-04 16:06:44 -06004549void CoreChecks::PreCallRecordCmdBlitImage2(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) {
4550 StateTracker::PreCallRecordCmdBlitImage2(commandBuffer, pBlitImageInfo);
4551 RecordCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4552 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4553 pBlitImageInfo->filter);
4554}
4555
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004556GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap &map, const IMAGE_STATE &image_state) {
John Zulauf2076e812020-01-08 14:55:54 -07004557 // This approach allows for a single hash lookup or/create new
Jeremy Gebben6335df62021-11-01 10:50:13 -06004558 auto &layout_map = map[&image_state];
John Zulauf17708d02021-02-22 11:20:58 -07004559 if (!layout_map) {
4560 layout_map.emplace(image_state.subresource_encoder.SubresourceCount());
John Zulauf2076e812020-01-08 14:55:54 -07004561 }
John Zulauf17708d02021-02-22 11:20:58 -07004562 return &layout_map;
John Zulauf2076e812020-01-08 14:55:54 -07004563}
4564
Jeremy Gebben6335df62021-11-01 10:50:13 -06004565const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, const IMAGE_STATE &image_state) {
4566 auto it = map.find(&image_state);
John Zulauf2076e812020-01-08 14:55:54 -07004567 if (it != map.end()) {
John Zulauf17708d02021-02-22 11:20:58 -07004568 return &it->second;
John Zulauf2076e812020-01-08 14:55:54 -07004569 }
4570 return nullptr;
4571}
4572
Jeremy Gebben53631302021-04-13 16:46:37 -06004573// Helper to update the Global or Overlay layout map
4574struct GlobalLayoutUpdater {
4575 bool update(VkImageLayout &dst, const image_layout_map::ImageSubresourceLayoutMap::LayoutEntry &src) const {
4576 if (src.current_layout != image_layout_map::kInvalidLayout && dst != src.current_layout) {
4577 dst = src.current_layout;
4578 return true;
4579 }
4580 return false;
4581 }
4582
4583 layer_data::optional<VkImageLayout> insert(const image_layout_map::ImageSubresourceLayoutMap::LayoutEntry &src) const {
4584 layer_data::optional<VkImageLayout> result;
4585 if (src.current_layout != image_layout_map::kInvalidLayout) {
4586 result.emplace(src.current_layout);
4587 }
4588 return result;
4589 }
4590};
4591
Shannon McPherson449fa9c2018-10-25 11:51:07 -06004592// 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 -07004593bool CoreChecks::ValidateCmdBufImageLayouts(const Location &loc, const CMD_BUFFER_STATE *pCB,
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004594 GlobalImageLayoutMap &overlayLayoutMap) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06004595 if (disabled[image_layout_validation]) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004596 bool skip = false;
John Zulauff660ad62019-03-23 07:16:05 -06004597 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07004598 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06004599 for (const auto &layout_map_entry : pCB->image_layout_map) {
Jeremy Gebben6335df62021-11-01 10:50:13 -06004600 const auto *image_state = layout_map_entry.first;
unknown089cdb82019-07-11 12:58:43 -06004601 const auto &subres_map = layout_map_entry.second;
Jeremy Gebben53631302021-04-13 16:46:37 -06004602 const auto &layout_map = subres_map->GetLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06004603 // Validate the initial_uses for each subresource referenced
Jeremy Gebben53631302021-04-13 16:46:37 -06004604 if (layout_map.empty()) continue;
John Zulauf2076e812020-01-08 14:55:54 -07004605
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004606 auto *overlay_map = GetLayoutRangeMap(overlayLayoutMap, *image_state);
Jeremy Gebben4a8881f2022-01-10 17:04:30 -07004607 const auto *global_map = image_state->layout_range_map.get();
4608 assert(global_map);
4609 auto global_map_guard = global_map->ReadLock();
John Zulauf2076e812020-01-08 14:55:54 -07004610
4611 // Note: don't know if it would matter
4612 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
4613
Jeremy Gebben53631302021-04-13 16:46:37 -06004614 auto pos = layout_map.begin();
4615 const auto end = layout_map.end();
4616 sparse_container::parallel_iterator<const GlobalImageLayoutRangeMap> current_layout(*overlay_map, *global_map,
4617 pos->first.begin);
John Zulauf2076e812020-01-08 14:55:54 -07004618 while (pos != end) {
Jeremy Gebben53631302021-04-13 16:46:37 -06004619 VkImageLayout initial_layout = pos->second.initial_layout;
4620 assert(initial_layout != image_layout_map::kInvalidLayout);
4621 if (initial_layout == image_layout_map::kInvalidLayout) {
4622 continue;
4623 }
4624
John Zulauf2076e812020-01-08 14:55:54 -07004625 VkImageLayout image_layout = kInvalidLayout;
Jeremy Gebben53631302021-04-13 16:46:37 -06004626
John Zulauf2076e812020-01-08 14:55:54 -07004627 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 -07004628 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004629 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07004630 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004631 image_layout = current_layout->pos_B->lower_bound->second;
4632 }
4633 const auto intersected_range = pos->first & current_layout->range;
4634 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
4635 // TODO: Set memory invalid which is in mem_tracker currently
4636 } else if (image_layout != initial_layout) {
Hans-Kristian Arntzen6cb03492021-07-05 16:57:31 +02004637 const auto aspect_mask = image_state->subresource_encoder.Decode(intersected_range.begin).aspectMask;
4638 bool matches = ImageLayoutMatches(aspect_mask, image_layout, initial_layout);
John Zulauf2076e812020-01-08 14:55:54 -07004639 if (!matches) {
John Zulauf2076e812020-01-08 14:55:54 -07004640 // We can report all the errors for the intersected range directly
4641 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
locke-lunarg296a3c92020-03-25 01:04:29 -06004642 const auto subresource = image_state->subresource_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004643 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004644 pCB->commandBuffer(), kVUID_Core_DrawState_InvalidImageLayout,
sfricke-samsung6b447aa2021-07-26 09:42:26 -07004645 "%s command buffer %s expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004646 "to be in layout %s--instead, current layout is %s.",
sfricke-samsung6b447aa2021-07-26 09:42:26 -07004647 loc.Message().c_str(), report_data->FormatHandle(pCB->commandBuffer()).c_str(),
Jeremy Gebben6335df62021-11-01 10:50:13 -06004648 report_data->FormatHandle(image_state->Handle()).c_str(), subresource.aspectMask, subresource.arrayLayer,
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004649 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
John Zulaufb61ed972019-04-09 16:12:35 -06004650 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004651 }
4652 }
John Zulauf2076e812020-01-08 14:55:54 -07004653 if (pos->first.includes(intersected_range.end)) {
4654 current_layout.seek(intersected_range.end);
4655 } else {
4656 ++pos;
4657 if (pos != end) {
4658 current_layout.seek(pos->first.begin);
4659 }
4660 }
John Zulauff660ad62019-03-23 07:16:05 -06004661 }
locke-lunargf155ccf2020-02-18 11:34:15 -07004662 // Update all layout set operations (which will be a subset of the initial_layouts)
Jeremy Gebben53631302021-04-13 16:46:37 -06004663 sparse_container::splice(*overlay_map, subres_map->GetLayoutMap(), GlobalLayoutUpdater());
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004664 }
John Zulauff660ad62019-03-23 07:16:05 -06004665
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004666 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004667}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07004668
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004669void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06004670 for (const auto &layout_map_entry : pCB->image_layout_map) {
Jeremy Gebben6335df62021-11-01 10:50:13 -06004671 const auto *image_state = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07004672 const auto &subres_map = layout_map_entry.second;
Jeremy Gebben4a8881f2022-01-10 17:04:30 -07004673 auto guard = image_state->layout_range_map->WriteLock();
4674 sparse_container::splice(*image_state->layout_range_map, subres_map->GetLayoutMap(), GlobalLayoutUpdater());
Tony Barbourdf013b92017-01-25 12:53:48 -07004675 }
4676}
4677
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004678// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004679// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
4680// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004681bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
4682 const VkImageLayout first_layout, const uint32_t attachment,
Mike Schuchardt2df08912020-12-15 16:28:09 -08004683 const VkAttachmentDescription2 &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004684 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004685 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
4686
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004687 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
sfricke-samsung55f01952020-03-24 08:16:41 -07004688 // for both loadOp and stencilLoaOp rp2 has it in 1 VU while rp1 has it in 2 VU with half behind Maintenance2 extension
4689 // Each is VUID is below in following order: rp2 -> rp1 with Maintenance2 -> rp1 with no extenstion
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004690 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07004691 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4692 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4693 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004694 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004695 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004696 string_VkImageLayout(first_layout));
sfricke-samsung45996a42021-09-16 13:45:27 -07004697 } else if ((use_rp2 == false) && IsExtEnabled(device_extensions.vk_khr_maintenance2) &&
sfricke-samsung55f01952020-03-24 08:16:41 -07004698 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL)) {
4699 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01566",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004700 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004701 string_VkImageLayout(first_layout));
4702 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4703 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004704 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004705 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004706 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004707 }
4708 }
sfricke-samsung55f01952020-03-24 08:16:41 -07004709
4710 // Same as above for loadOp, but for stencilLoadOp
4711 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
4712 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4713 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4714 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL))) {
4715 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02523",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004716 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004717 string_VkImageLayout(first_layout));
sfricke-samsung45996a42021-09-16 13:45:27 -07004718 } else if ((use_rp2 == false) && IsExtEnabled(device_extensions.vk_khr_maintenance2) &&
sfricke-samsung55f01952020-03-24 08:16:41 -07004719 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL)) {
4720 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01567",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004721 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004722 string_VkImageLayout(first_layout));
4723 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4724 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
4725 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-02511",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004726 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004727 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02004728 }
4729 }
4730
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004731 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004732}
4733
Mark Lobodzinski96210742017-02-09 10:33:46 -07004734// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4735// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004736template <typename T1>
4737bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
4738 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
4739 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004740 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004741 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004742 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004743 if (strict) {
4744 correct_usage = ((actual & desired) == desired);
4745 } else {
4746 correct_usage = ((actual & desired) != 0);
4747 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004748
Mark Lobodzinski96210742017-02-09 10:33:46 -07004749 if (!correct_usage) {
sfricke-samsungbb971942020-09-10 22:11:56 -07004750 // All callers should have a valid VUID
4751 assert(msgCode != kVUIDUndefined);
4752 skip =
4753 LogError(object, msgCode, "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4754 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004755 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004756 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004757}
4758
4759// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4760// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004761bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004762 char const *func_name, char const *usage_string) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004763 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image(),
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06004764 image_state->Handle(), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004765}
4766
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004767bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags2KHR desired,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004768 char const *func_name, const char *vuid) const {
Cort Stratton186b1a22018-05-01 20:18:06 -04004769 bool skip = false;
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004770 const VkFormatFeatureFlags2KHR image_format_features = image_state->format_features;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004771 if ((image_format_features & desired) != desired) {
4772 // Same error, but more details if it was an AHB external format
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06004773 if (image_state->HasAHBFormat()) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004774 skip |= LogError(image_state->image(), vuid,
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004775 "In %s, VkFormatFeatureFlags (0x%" PRIxLEAST64 ") does not support required feature %s for the external format "
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004776 "found in VkAndroidHardwareBufferFormatPropertiesANDROID::formatFeatures used by %s.",
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004777 func_name, image_format_features, string_VkFormatFeatureFlags2KHR(desired).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004778 report_data->FormatHandle(image_state->image()).c_str());
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004779 } else {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004780 skip |= LogError(image_state->image(), vuid,
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004781 "In %s, VkFormatFeatureFlags (0x%" PRIxLEAST64 ") does not support required feature %s for format %u used by %s "
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004782 "with tiling %s.",
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004783 func_name, image_format_features, string_VkFormatFeatureFlags2KHR(desired).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004784 image_state->createInfo.format, report_data->FormatHandle(image_state->image()).c_str(),
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004785 string_VkImageTiling(image_state->createInfo.tiling));
Cort Stratton186b1a22018-05-01 20:18:06 -04004786 }
4787 }
4788 return skip;
4789}
4790
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004791bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004792 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004793 bool skip = false;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004794 const VkImageAspectFlags apsect_mask = subresource_layers->aspectMask;
Cort Strattond619a302018-05-17 19:46:32 -07004795 // layerCount must not be zero
4796 if (subresource_layers->layerCount == 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004797 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-layerCount-01700",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004798 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004799 }
4800 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004801 if (apsect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004802 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-00168",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004803 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004804 }
4805 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004806 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 -06004807 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-00167",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004808 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4809 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4810 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004811 }
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004812 // aspectMask must not contain VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT
4813 if (apsect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
4814 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004815 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-02247",
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004816 "In %s, pRegions[%u].%s.aspectMask has a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit set.", func_name, i,
4817 member);
4818 }
Cort Strattond619a302018-05-17 19:46:32 -07004819 return skip;
4820}
4821
Mark Lobodzinski96210742017-02-09 10:33:46 -07004822// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4823// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004824bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004825 char const *func_name, char const *usage_string) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004826 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer(),
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06004827 buffer_state->Handle(), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004828}
4829
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004830bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004831 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004832 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004833
4834 const VkDeviceSize &range = pCreateInfo->range;
4835 if (range != VK_WHOLE_SIZE) {
4836 // Range must be greater than 0
4837 if (range <= 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004838 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00928",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004839 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004840 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4841 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004842 }
4843 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004844 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4845 if (SafeModulo(range, format_size) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004846 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00929",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004847 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004848 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4849 "(%" PRIu32 ").",
4850 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004851 }
4852 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004853 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004854 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00930",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004855 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004856 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4857 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4858 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004859 }
4860 // The sum of range and offset must be less than or equal to the size of buffer
4861 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004862 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-offset-00931",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004863 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004864 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4865 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4866 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004867 }
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004868 } else {
4869 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4870
4871 // Size of buffer - offset, divided by the element size of format must be less than or equal to
4872 // VkPhysicalDeviceLimits::maxTexelBufferElements
4873 if (SafeDivision(buffer_state->createInfo.size - pCreateInfo->offset, format_size) >
4874 device_limits->maxTexelBufferElements) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004875 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-04059",
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004876 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
4877 ") equals VK_WHOLE_SIZE, the buffer's size (%" PRIuLEAST64 ") minus the offset (%" PRIuLEAST64
4878 "), divided by the element size of the format (%" PRIu32
4879 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4880 range, buffer_state->createInfo.size, pCreateInfo->offset, format_size,
4881 device_limits->maxTexelBufferElements);
4882 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004883 }
4884 return skip;
4885}
4886
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004887bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004888 bool skip = false;
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004889 const VkFormatProperties3KHR format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004890 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004891 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_2_UNIFORM_TEXEL_BUFFER_BIT_KHR)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004892 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-00933",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004893 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004894 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format (%s) must "
4895 "be supported for uniform texel buffers",
4896 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004897 }
4898 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004899 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_2_STORAGE_TEXEL_BUFFER_BIT_KHR)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004900 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-00934",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004901 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004902 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format (%s) must "
4903 "be supported for storage texel buffers",
4904 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004905 }
4906 return skip;
4907}
4908
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004909bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004910 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004911 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004912
Dave Houltond8ed0212018-05-16 17:18:24 -06004913 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004914
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004915 auto chained_devaddr_struct = LvlFindInChain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
Jeff Bolz87697532019-01-11 22:54:00 -06004916 if (chained_devaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004917 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz87697532019-01-11 22:54:00 -06004918 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004919 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4920 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004921 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004922 }
4923 }
4924
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004925 auto chained_opaqueaddr_struct = LvlFindInChain<VkBufferOpaqueCaptureAddressCreateInfo>(pCreateInfo->pNext);
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004926 if (chained_opaqueaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004927 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004928 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004929 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
Mike Schuchardt2df08912020-12-15 16:28:09 -08004930 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfo::opaqueCaptureAddress"
4931 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004932 }
4933 }
4934
ziga-lunarg2e2be1e2021-07-18 23:09:15 +02004935 auto dedicated_allocation_buffer = LvlFindInChain<VkDedicatedAllocationBufferCreateInfoNV>(pCreateInfo->pNext);
4936 if (dedicated_allocation_buffer && dedicated_allocation_buffer->dedicatedAllocation == VK_TRUE) {
4937 if (pCreateInfo->flags &
4938 (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT)) {
4939 skip |= LogError(device, "VUID-VkBufferCreateInfo-pNext-01571",
4940 "vkCreateBuffer(): pCreateInfos->flags must not include VK_BUFFER_CREATE_SPARSE_BINDING_BIT, "
4941 "VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT, or VK_BUFFER_CREATE_SPARSE_ALIASED_BIT when "
4942 "VkDedicatedAllocationBufferCreateInfoNV is in pNext chain with dedicatedAllocation VK_TRUE.");
4943 }
4944 }
4945
Mike Schuchardt2df08912020-12-15 16:28:09 -08004946 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz33fc6722020-03-31 12:58:16 -05004947 !enabled_features.core12.bufferDeviceAddressCaptureReplay &&
sfricke-samsung828e59d2021-08-22 23:20:49 -07004948 !enabled_features.buffer_device_address_ext_features.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004949 skip |= LogError(
4950 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004951 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004952 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT set.");
Jeff Bolz87697532019-01-11 22:54:00 -06004953 }
4954
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004955 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
sfricke-samsung45996a42021-09-16 13:45:27 -07004956 const char *vuid = IsExtEnabled(device_extensions.vk_khr_get_physical_device_properties2)
4957 ? "VUID-VkBufferCreateInfo-sharingMode-01419"
4958 : "VUID-VkBufferCreateInfo-sharingMode-01391";
Mark Lobodzinski314b9162020-07-16 15:33:08 -06004959 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
ziga-lunarga0b4f8a2021-07-28 13:23:02 +02004960 "vkCreateBuffer", "pCreateInfo->pQueueFamilyIndices", vuid);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004961 }
4962
sfricke-samsungedce77a2020-07-03 22:35:13 -07004963 if ((pCreateInfo->flags & VK_BUFFER_CREATE_PROTECTED_BIT) != 0) {
4964 if (enabled_features.core11.protectedMemory == VK_FALSE) {
4965 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-01887",
4966 "vkCreateBuffer(): the protectedMemory device feature is disabled: Buffers cannot be created with the "
4967 "VK_BUFFER_CREATE_PROTECTED_BIT set.");
4968 }
4969 const VkBufferCreateFlags invalid_flags =
4970 VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT;
4971 if ((pCreateInfo->flags & invalid_flags) != 0) {
4972 skip |= LogError(device, "VUID-VkBufferCreateInfo-None-01888",
4973 "vkCreateBuffer(): VK_BUFFER_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at "
4974 "same time (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | "
4975 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT).");
4976 }
4977 }
4978
ziga-lunargfe74b8d2022-04-18 17:37:46 +02004979 if ((pCreateInfo->usage & (VK_BUFFER_USAGE_VIDEO_DECODE_SRC_BIT_KHR | VK_BUFFER_USAGE_VIDEO_DECODE_DST_BIT_KHR)) > 0) {
4980 bool has_decode_codec_operation = false;
Mike Schuchardt0e558a52022-08-18 15:14:51 -07004981 const auto* video_profiles = LvlFindInChain<VkVideoProfileListInfoKHR>(pCreateInfo->pNext);
ziga-lunargfe74b8d2022-04-18 17:37:46 +02004982 if (video_profiles) {
4983 for (uint32_t i = 0; i < video_profiles->profileCount; ++i) {
4984 if (video_profiles->pProfiles[i].videoCodecOperation &
4985 (VK_VIDEO_CODEC_OPERATION_DECODE_H264_BIT_EXT | VK_VIDEO_CODEC_OPERATION_DECODE_H265_BIT_EXT)) {
4986 has_decode_codec_operation = true;
4987 break;
4988 }
4989 }
4990 }
4991 if (!has_decode_codec_operation) {
4992 skip |= LogError(device, "VUID-VkBufferCreateInfo-usage-04813",
Mike Schuchardt0e558a52022-08-18 15:14:51 -07004993 "vkCreateBuffer(): pCreateInfo->usage is %s, but pNext chain does not include VkVideoProfileListInfoKHR with "
ziga-lunargfe74b8d2022-04-18 17:37:46 +02004994 "a decode codec-operation.",
4995 string_VkBufferUsageFlags(pCreateInfo->usage).c_str());
4996 }
4997 }
4998 if ((pCreateInfo->usage & (VK_BUFFER_USAGE_VIDEO_ENCODE_SRC_BIT_KHR | VK_BUFFER_USAGE_VIDEO_ENCODE_DST_BIT_KHR)) > 0) {
4999 bool has_encode_codec_operation = false;
Mike Schuchardt0e558a52022-08-18 15:14:51 -07005000 const auto *video_profiles = LvlFindInChain<VkVideoProfileListInfoKHR>(pCreateInfo->pNext);
ziga-lunargfe74b8d2022-04-18 17:37:46 +02005001 if (video_profiles) {
5002 for (uint32_t i = 0; i < video_profiles->profileCount; ++i) {
5003 if (video_profiles->pProfiles[i].videoCodecOperation &
5004 (VK_VIDEO_CODEC_OPERATION_ENCODE_H264_BIT_EXT | VK_VIDEO_CODEC_OPERATION_ENCODE_H265_BIT_EXT)) {
5005 has_encode_codec_operation = true;
5006 break;
5007 }
5008 }
5009 }
5010 if (!has_encode_codec_operation) {
5011 skip |= LogError(device, "VUID-VkBufferCreateInfo-usage-04814",
Mike Schuchardt0e558a52022-08-18 15:14:51 -07005012 "vkCreateBuffer(): pCreateInfo->usage is %s, but pNext chain does not include VkVideoProfileListInfoKHR with "
ziga-lunargfe74b8d2022-04-18 17:37:46 +02005013 "an encode codec-operation.",
5014 string_VkBufferUsageFlags(pCreateInfo->usage).c_str());
5015 }
5016 }
5017
Mark Lobodzinski96210742017-02-09 10:33:46 -07005018 return skip;
5019}
5020
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005021bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005022 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07005023 bool skip = false;
Jeremy Gebbenf4449392022-01-28 10:09:10 -07005024 auto buffer_state = Get<BUFFER_STATE>(pCreateInfo->buffer);
sfricke-samsung2e827212021-09-28 07:52:08 -07005025
5026 if (FormatIsDepthOrStencil(pCreateInfo->format)) {
5027 // Should never hopefully get here, but there are known driver advertising the wrong feature flags
5028 // see https://gitlab.khronos.org/vulkan/vulkan/-/merge_requests/4849
5029 skip |= LogError(device, kVUID_Core_invalidDepthStencilFormat,
5030 "vkCreateBufferView(): format is a depth/stencil format (%s) but depth/stencil formats do not have a "
5031 "defined sizes for alignment, replace with a color format.",
5032 string_VkFormat(pCreateInfo->format));
5033 }
5034
Mark Lobodzinski96210742017-02-09 10:33:46 -07005035 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
5036 if (buffer_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06005037 skip |=
5038 ValidateMemoryIsBoundToBuffer(buffer_state.get(), "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07005039 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
5040 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Jeremy Gebben9f537102021-10-05 16:37:12 -06005041 skip |= ValidateBufferUsageFlags(buffer_state.get(),
Dave Houltond8ed0212018-05-16 17:18:24 -06005042 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
5043 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
5044 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06005045
Shannon McPherson0eb84f62018-06-18 16:32:40 -06005046 // Buffer view offset must be less than the size of buffer
5047 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005048 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-offset-00925",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07005049 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005050 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
5051 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06005052 }
5053
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06005054 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05005055 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
5056 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
5057 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
sfricke-samsung45996a42021-09-16 13:45:27 -07005058 const char *vuid = IsExtEnabled(device_extensions.vk_ext_texel_buffer_alignment)
5059 ? "VUID-VkBufferViewCreateInfo-offset-02749"
5060 : "VUID-VkBufferViewCreateInfo-offset-00926";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005061 skip |= LogError(buffer_state->buffer(), vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07005062 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005063 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
5064 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05005065 }
5066
5067 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005068 VkDeviceSize element_size = FormatElementSize(pCreateInfo->format);
5069 if ((element_size % 3) == 0) {
5070 element_size /= 3;
Jeff Bolzd5554e62019-07-19 13:23:52 -05005071 }
5072 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005073 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05005074 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
5075 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005076 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05005077 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005078 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005079 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005080 buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-02750",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07005081 "vkCreateBufferView(): If buffer was created with usage containing "
5082 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05005083 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
5084 ") must be a multiple of the lesser of "
5085 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
5086 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
5087 "(%" PRId32
5088 ") is VK_TRUE, the size of a texel of the requested format. "
5089 "If the size of a texel is a multiple of three bytes, then the size of a "
5090 "single component of format is used instead",
5091 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
5092 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
5093 }
5094 }
5095 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005096 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05005097 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
5098 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005099 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05005100 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005101 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005102 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005103 buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-02751",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07005104 "vkCreateBufferView(): If buffer was created with usage containing "
5105 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05005106 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
5107 ") must be a multiple of the lesser of "
5108 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
5109 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
5110 "(%" PRId32
5111 ") is VK_TRUE, the size of a texel of the requested format. "
5112 "If the size of a texel is a multiple of three bytes, then the size of a "
5113 "single component of format is used instead",
5114 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
5115 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
5116 }
5117 }
5118 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06005119
Jeremy Gebben9f537102021-10-05 16:37:12 -06005120 skip |= ValidateBufferViewRange(buffer_state.get(), pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06005121
Jeremy Gebben9f537102021-10-05 16:37:12 -06005122 skip |= ValidateBufferViewBuffer(buffer_state.get(), pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07005123 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07005124 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07005125}
5126
Mark Lobodzinski602de982017-02-09 11:01:33 -07005127// For the given format verify that the aspect masks make sense
Aitor Camachoeb35fed2022-06-07 14:07:42 +02005128bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, bool is_image_disjoint,
5129 const char *func_name, const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005130 bool skip = false;
sfricke-samsung79b00482020-04-01 21:15:50 -07005131 // checks color format and (single-plane or non-disjoint)
5132 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
Aitor Camachoeb35fed2022-06-07 14:07:42 +02005133 if ((FormatIsColor(format)) && ((FormatIsMultiplane(format) == false) || (is_image_disjoint == false))) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005134 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08005135 skip |= LogError(
5136 image, vuid,
5137 "%s: Using format (%s) with aspect flags (%s) but color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.",
5138 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005139 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08005140 skip |= LogError(image, vuid,
5141 "%s: Using format (%s) with aspect flags (%s) but color image formats must have ONLY the "
5142 "VK_IMAGE_ASPECT_COLOR_BIT set.",
5143 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005144 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06005145 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005146 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005147 skip |= LogError(image, vuid,
sfricke-samsung7687a482021-01-29 23:19:22 -08005148 "%s: Using format (%s) with aspect flags (%s) but depth/stencil image formats must have at least one "
5149 "of VK_IMAGE_ASPECT_DEPTH_BIT and VK_IMAGE_ASPECT_STENCIL_BIT set.",
5150 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005151 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005152 skip |= LogError(image, vuid,
sfricke-samsung7687a482021-01-29 23:19:22 -08005153 "%s: Using format (%s) with aspect flags (%s) but combination depth/stencil image formats can have "
5154 "only the VK_IMAGE_ASPECT_DEPTH_BIT and VK_IMAGE_ASPECT_STENCIL_BIT set.",
5155 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005156 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06005157 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005158 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08005159 skip |= LogError(image, vuid,
5160 "%s: Using format (%s) with aspect flags (%s) but depth-only image formats must have the "
5161 "VK_IMAGE_ASPECT_DEPTH_BIT set.",
5162 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005163 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08005164 skip |= LogError(image, vuid,
5165 "%s: Using format (%s) with aspect flags (%s) but depth-only image formats can have only the "
5166 "VK_IMAGE_ASPECT_DEPTH_BIT set.",
5167 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005168 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06005169 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005170 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08005171 skip |= LogError(image, vuid,
5172 "%s: Using format (%s) with aspect flags (%s) but stencil-only image formats must have the "
5173 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
5174 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005175 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08005176 skip |= LogError(image, vuid,
5177 "%s: Using format (%s) with aspect flags (%s) but stencil-only image formats can have only the "
5178 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
5179 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005180 }
Dave Houlton501b15b2018-03-30 15:07:41 -06005181 } else if (FormatIsMultiplane(format)) {
5182 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
5183 if (3 == FormatPlaneCount(format)) {
5184 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
5185 }
5186 if ((aspect_mask & valid_flags) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08005187 skip |= LogError(image, vuid,
5188 "%s: Using format (%s) with aspect flags (%s) but multi-plane image formats may have only "
5189 "VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs set, where n = [0, 1, 2].",
5190 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Dave Houlton501b15b2018-03-30 15:07:41 -06005191 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005192 }
5193 return skip;
5194}
5195
ziga-lunarg69aa72f2022-03-29 15:24:35 +02005196bool CoreChecks::ValidateImageAcquired(IMAGE_STATE const &image_state, const char *func_name) const {
ziga-lunarg04e94b32021-10-03 01:42:37 +02005197 bool skip = false;
5198
ziga-lunarg04e94b32021-10-03 01:42:37 +02005199 return skip;
5200}
5201
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005202bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
5203 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005204 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
Jeremy Gebben5573a8c2021-06-04 08:55:10 -06005205 const SubresourceRangeErrorCodes &errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005206 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02005207
5208 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02005209 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005210 skip |= LogError(image, errorCodes.base_mip_err,
5211 "%s: %s.baseMipLevel (= %" PRIu32
5212 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
5213 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02005214 }
Petr Kraus4d718682017-05-18 03:38:41 +02005215
Petr Krausffa94af2017-08-08 21:46:02 +02005216 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
5217 if (subresourceRange.levelCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07005218 skip |=
5219 LogError(image, "VUID-VkImageSubresourceRange-levelCount-01720", "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02005220 } else {
5221 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02005222
Petr Krausffa94af2017-08-08 21:46:02 +02005223 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005224 skip |= LogError(image, errorCodes.mip_count_err,
5225 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
5226 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
5227 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
5228 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02005229 }
Petr Kraus4d718682017-05-18 03:38:41 +02005230 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005231 }
Petr Kraus4d718682017-05-18 03:38:41 +02005232
5233 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02005234 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005235 skip |= LogError(image, errorCodes.base_layer_err,
5236 "%s: %s.baseArrayLayer (= %" PRIu32
5237 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
5238 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02005239 }
Petr Kraus4d718682017-05-18 03:38:41 +02005240
Petr Krausffa94af2017-08-08 21:46:02 +02005241 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
5242 if (subresourceRange.layerCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07005243 skip |=
5244 LogError(image, "VUID-VkImageSubresourceRange-layerCount-01721", "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02005245 } else {
5246 const uint64_t necessary_layer_count =
5247 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02005248
Petr Krausffa94af2017-08-08 21:46:02 +02005249 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005250 skip |= LogError(image, errorCodes.layer_count_err,
5251 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
5252 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
5253 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
5254 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02005255 }
Petr Kraus4d718682017-05-18 03:38:41 +02005256 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005257 }
Petr Kraus4d718682017-05-18 03:38:41 +02005258
ziga-lunargb4e90752021-08-02 13:58:29 +02005259 if (subresourceRange.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
5260 if (subresourceRange.aspectMask &
5261 (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT)) {
5262 skip |= LogError(image, "VUID-VkImageSubresourceRange-aspectMask-01670",
5263 "%s: aspectMask includes both VK_IMAGE_ASPECT_COLOR_BIT and one of VK_IMAGE_ASPECT_PLANE_0_BIT, "
5264 "VK_IMAGE_ASPECT_PLANE_1_BIT, or VK_IMAGE_ASPECT_PLANE_2_BIT.",
5265 cmd_name);
5266 }
5267 }
5268
Mark Lobodzinski602de982017-02-09 11:01:33 -07005269 return skip;
5270}
5271
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005272bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005273 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07005274 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Tony-LunarGbe956362022-04-05 13:34:31 -06005275 bool is_2d_compatible = (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT) ? true : false;
5276 if (device_extensions.vk_ext_image_2d_view_of_3d)
5277 is_2d_compatible |= (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_VIEW_COMPATIBLE_BIT_EXT) ? true : false;
5278 bool is_image_slicable =
5279 (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) && is_2d_compatible;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005280 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 +02005281
David McFarland2853f2f2020-11-30 15:50:39 -04005282 uint32_t image_layer_count;
5283
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005284 if (is_3_d_to_2_d_map) {
David McFarland2853f2f2020-11-30 15:50:39 -04005285 const auto layers = LayersFromRange(subresourceRange);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06005286 const auto extent = image_state->GetSubresourceExtent(layers);
David McFarland2853f2f2020-11-30 15:50:39 -04005287 image_layer_count = extent.depth;
5288 } else {
5289 image_layer_count = image_state->createInfo.arrayLayers;
5290 }
5291
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005292 const auto image_layer_count_var_name = is_3_d_to_2_d_map ? "extent.depth" : "arrayLayers";
Petr Krausffa94af2017-08-08 21:46:02 +02005293
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005294 SubresourceRangeErrorCodes subresource_range_error_codes = {};
5295 subresource_range_error_codes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
5296 subresource_range_error_codes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
5297 subresource_range_error_codes.base_layer_err =
5298 is_khr_maintenance1
Tony-LunarGbe956362022-04-05 13:34:31 -06005299 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-image-02724"
5300 : (device_extensions.vk_ext_image_2d_view_of_3d ? "VUID-VkImageViewCreateInfo-image-06724"
5301 : "VUID-VkImageViewCreateInfo-image-01482"))
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005302 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
Tony-LunarGbe956362022-04-05 13:34:31 -06005303 subresource_range_error_codes.layer_count_err =
5304 is_khr_maintenance1
5305 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
5306 : (device_extensions.vk_ext_image_2d_view_of_3d ? "VUID-VkImageViewCreateInfo-subresourceRange-06725"
5307 : "VUID-VkImageViewCreateInfo-subresourceRange-01483"))
5308 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02005309
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005310 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02005311 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005312 image_state->image(), subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02005313}
5314
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005315bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06005316 const VkImageSubresourceRange &subresourceRange,
5317 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005318 SubresourceRangeErrorCodes subresource_range_error_codes = {};
5319 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
5320 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
5321 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
5322 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02005323
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005324 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005325 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image(),
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005326 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02005327}
5328
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005329bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06005330 const VkImageSubresourceRange &subresourceRange,
5331 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005332 SubresourceRangeErrorCodes subresource_range_error_codes = {};
5333 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
5334 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
5335 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
5336 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02005337
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005338 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005339 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image(),
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005340 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02005341}
5342
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005343bool CoreChecks::ValidateImageBarrierSubresourceRange(const Location &loc, const IMAGE_STATE *image_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005344 const VkImageSubresourceRange &subresourceRange) const {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005345 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005346 loc.StringFunc().c_str(), loc.StringField().c_str(), "arrayLayers", image_state->image(),
Jeremy Gebbenbb845612021-02-18 18:16:05 -07005347 sync_vuid_maps::GetSubResourceVUIDs(loc));
Petr Krausffa94af2017-08-08 21:46:02 +02005348}
5349
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005350namespace barrier_queue_families {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005351using sync_vuid_maps::GetBarrierQueueVUID;
5352using sync_vuid_maps::kQueueErrorSummary;
5353using sync_vuid_maps::QueueError;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005354
5355class ValidatorState {
5356 public:
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005357 ValidatorState(const ValidationStateTracker *device_data, LogObjectList &&obj, const core_error::Location &location,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005358 const VulkanTypedHandle &barrier_handle, const VkSharingMode sharing_mode)
5359 : device_data_(device_data),
John Zulaufbea70432021-02-23 07:03:12 -07005360 objects_(std::move(obj)),
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005361 loc_(location),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005362 barrier_handle_(barrier_handle),
5363 sharing_mode_(sharing_mode),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005364 limit_(static_cast<uint32_t>(device_data->physical_device_state->queue_family_properties.size())),
5365 mem_ext_(IsExtEnabled(device_data->device_extensions.vk_khr_external_memory)) {}
5366
5367 // Log the messages using boilerplate from object state, and Vu specific information from the template arg
5368 // 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 -07005369 bool LogMsg(QueueError vu_index, uint32_t family, const char *param_name) const {
5370 const std::string val_code = GetBarrierQueueVUID(loc_, vu_index);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005371 const char *annotation = GetFamilyAnnotation(family);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005372 return device_data_->LogError(objects_, val_code, "%s Barrier using %s %s created with sharingMode %s, has %s %u%s. %s",
5373 loc_.Message().c_str(), GetTypeString(),
5374 device_data_->report_data->FormatHandle(barrier_handle_).c_str(), GetModeString(), param_name,
5375 family, annotation, kQueueErrorSummary.at(vu_index).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005376 }
5377
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005378 bool LogMsg(QueueError vu_index, uint32_t src_family, uint32_t dst_family) const {
5379 const std::string val_code = GetBarrierQueueVUID(loc_, vu_index);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005380 const char *src_annotation = GetFamilyAnnotation(src_family);
5381 const char *dst_annotation = GetFamilyAnnotation(dst_family);
5382 return device_data_->LogError(
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005383 objects_, val_code,
5384 "%s Barrier using %s %s created with sharingMode %s, has srcQueueFamilyIndex %u%s and dstQueueFamilyIndex %u%s. %s",
5385 loc_.Message().c_str(), GetTypeString(), device_data_->report_data->FormatHandle(barrier_handle_).c_str(),
5386 GetModeString(), src_family, src_annotation, dst_family, dst_annotation, kQueueErrorSummary.at(vu_index).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005387 }
5388
5389 // This abstract Vu can only be tested at submit time, thus we need a callback from the closure containing the needed
5390 // data. Note that the mem_barrier is copied to the closure as the lambda lifespan exceed the guarantees of validity for
5391 // application input.
5392 static bool ValidateAtQueueSubmit(const QUEUE_STATE *queue_state, const ValidationStateTracker *device_data,
5393 uint32_t src_family, uint32_t dst_family, const ValidatorState &val) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005394 auto error_code = QueueError::kSubmitQueueMustMatchSrcOrDst;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005395 uint32_t queue_family = queue_state->queueFamilyIndex;
5396 if ((src_family != queue_family) && (dst_family != queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005397 const std::string val_code = GetBarrierQueueVUID(val.loc_, error_code);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005398 const char *src_annotation = val.GetFamilyAnnotation(src_family);
5399 const char *dst_annotation = val.GetFamilyAnnotation(dst_family);
5400 return device_data->LogError(
Jeremy Gebben63f3cb02021-09-07 15:16:32 -06005401 queue_state->Handle(), val_code,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005402 "%s Barrier submitted to queue with family index %u, using %s %s created with sharingMode %s, has "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005403 "srcQueueFamilyIndex %u%s and dstQueueFamilyIndex %u%s. %s",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005404 val.loc_.Message().c_str(), queue_family, val.GetTypeString(),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005405 device_data->report_data->FormatHandle(val.barrier_handle_).c_str(), val.GetModeString(), src_family,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005406 src_annotation, dst_family, dst_annotation, kQueueErrorSummary.at(error_code).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005407 }
5408 return false;
5409 }
5410 // Logical helpers for semantic clarity
5411 inline bool KhrExternalMem() const { return mem_ext_; }
5412 inline bool IsValid(uint32_t queue_family) const { return (queue_family < limit_); }
5413 inline bool IsValidOrSpecial(uint32_t queue_family) const {
5414 return IsValid(queue_family) || (mem_ext_ && QueueFamilyIsExternal(queue_family));
5415 }
5416
5417 // Helpers for LogMsg
5418 const char *GetModeString() const { return string_VkSharingMode(sharing_mode_); }
5419
5420 // Descriptive text for the various types of queue family index
5421 const char *GetFamilyAnnotation(uint32_t family) const {
5422 const char *external = " (VK_QUEUE_FAMILY_EXTERNAL)";
5423 const char *foreign = " (VK_QUEUE_FAMILY_FOREIGN_EXT)";
5424 const char *ignored = " (VK_QUEUE_FAMILY_IGNORED)";
5425 const char *valid = " (VALID)";
5426 const char *invalid = " (INVALID)";
5427 switch (family) {
5428 case VK_QUEUE_FAMILY_EXTERNAL:
5429 return external;
5430 case VK_QUEUE_FAMILY_FOREIGN_EXT:
5431 return foreign;
5432 case VK_QUEUE_FAMILY_IGNORED:
5433 return ignored;
5434 default:
5435 if (IsValid(family)) {
5436 return valid;
5437 }
5438 return invalid;
5439 };
5440 }
5441 const char *GetTypeString() const { return object_string[barrier_handle_.type]; }
5442 VkSharingMode GetSharingMode() const { return sharing_mode_; }
5443
5444 protected:
5445 const ValidationStateTracker *device_data_;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005446 const LogObjectList objects_;
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005447 const core_error::Location loc_;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005448 const VulkanTypedHandle barrier_handle_;
5449 const VkSharingMode sharing_mode_;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005450 const uint32_t limit_;
5451 const bool mem_ext_;
5452};
5453
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005454bool Validate(const CoreChecks *device_data, const CMD_BUFFER_STATE *cb_state, const ValidatorState &val,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005455 const uint32_t src_queue_family, const uint32_t dst_queue_family) {
5456 bool skip = false;
5457
5458 const bool mode_concurrent = val.GetSharingMode() == VK_SHARING_MODE_CONCURRENT;
5459 const bool src_ignored = QueueFamilyIsIgnored(src_queue_family);
5460 const bool dst_ignored = QueueFamilyIsIgnored(dst_queue_family);
5461 if (val.KhrExternalMem()) {
5462 if (mode_concurrent) {
Tony-LunarG273f32f2021-09-28 08:56:30 -06005463 bool sync2 = device_data->enabled_features.core13.synchronization2 != 0;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005464 // this requirement is removed by VK_KHR_synchronization2
5465 if (!(src_ignored || dst_ignored) && !sync2) {
5466 skip |= val.LogMsg(QueueError::kSrcOrDstMustBeIgnore, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005467 }
5468 if ((src_ignored && !(dst_ignored || QueueFamilyIsExternal(dst_queue_family))) ||
5469 (dst_ignored && !(src_ignored || QueueFamilyIsExternal(src_queue_family)))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005470 skip |= val.LogMsg(QueueError::kSpecialOrIgnoreOnly, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005471 }
5472 } else {
5473 // VK_SHARING_MODE_EXCLUSIVE
5474 if (src_queue_family != dst_queue_family) {
5475 if (!val.IsValidOrSpecial(dst_queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005476 skip |= val.LogMsg(QueueError::kSrcAndDstValidOrSpecial, dst_queue_family, "dstQueueFamilyIndex");
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005477 }
5478 if (!val.IsValidOrSpecial(src_queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005479 skip |= val.LogMsg(QueueError::kSrcAndDstValidOrSpecial, src_queue_family, "srcQueueFamilyIndex");
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005480 }
5481 }
5482 }
5483 } else {
5484 // No memory extension
5485 if (mode_concurrent) {
Tony-LunarG273f32f2021-09-28 08:56:30 -06005486 bool sync2 = device_data->enabled_features.core13.synchronization2 != 0;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005487 // this requirement is removed by VK_KHR_synchronization2
5488 if ((!src_ignored || !dst_ignored) && !sync2) {
5489 skip |= val.LogMsg(QueueError::kSrcAndDestMustBeIgnore, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005490 }
5491 } else {
5492 // VK_SHARING_MODE_EXCLUSIVE
5493 if ((src_queue_family != dst_queue_family) && !(val.IsValid(src_queue_family) && val.IsValid(dst_queue_family))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005494 skip |= val.LogMsg(QueueError::kSrcAndDstBothValid, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005495 }
5496 }
5497 }
5498 return skip;
5499}
5500} // namespace barrier_queue_families
5501
Jeremy Gebbene5361dd2021-11-18 14:23:56 -07005502bool CoreChecks::ValidateConcurrentBarrierAtSubmit(const Location &loc, const ValidationStateTracker &state_data,
5503 const QUEUE_STATE &queue_state, const CMD_BUFFER_STATE &cb_state,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005504 const VulkanTypedHandle &typed_handle, uint32_t src_queue_family,
5505 uint32_t dst_queue_family) {
5506 using barrier_queue_families::ValidatorState;
Jeremy Gebbene5361dd2021-11-18 14:23:56 -07005507 ValidatorState val(&state_data, LogObjectList(cb_state.Handle()), loc, typed_handle, VK_SHARING_MODE_CONCURRENT);
5508 return ValidatorState::ValidateAtQueueSubmit(&queue_state, &state_data, src_queue_family, dst_queue_family, val);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005509}
5510
5511// Type specific wrapper for image barriers
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005512template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005513bool CoreChecks::ValidateBarrierQueueFamilies(const Location &loc, const CMD_BUFFER_STATE *cb_state, const ImgBarrier &barrier,
5514 const IMAGE_STATE *state_data) const {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005515 // State data is required
5516 if (!state_data) {
5517 return false;
5518 }
5519
5520 // Create the validator state from the image state
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005521 barrier_queue_families::ValidatorState val(this, LogObjectList(cb_state->commandBuffer()), loc,
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06005522 state_data->Handle(), state_data->createInfo.sharingMode);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005523 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
5524 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005525 return barrier_queue_families::Validate(this, cb_state, val, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005526}
5527
5528// Type specific wrapper for buffer barriers
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005529template <typename BufBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005530bool CoreChecks::ValidateBarrierQueueFamilies(const Location &loc, const CMD_BUFFER_STATE *cb_state, const BufBarrier &barrier,
5531 const BUFFER_STATE *state_data) const {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005532 // State data is required
5533 if (!state_data) {
5534 return false;
5535 }
5536
5537 // Create the validator state from the buffer state
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005538 barrier_queue_families::ValidatorState val(this, LogObjectList(cb_state->commandBuffer()), loc,
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06005539 state_data->Handle(), state_data->createInfo.sharingMode);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005540 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
5541 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005542 return barrier_queue_families::Validate(this, cb_state, val, src_queue_family, dst_queue_family);
5543}
5544
5545template <typename Barrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005546bool CoreChecks::ValidateBufferBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005547 const Barrier &mem_barrier) const {
5548 using sync_vuid_maps::BufferError;
5549 using sync_vuid_maps::GetBufferBarrierVUID;
5550
5551 bool skip = false;
5552
5553 skip |= ValidateQFOTransferBarrierUniqueness(loc, cb_state, mem_barrier, cb_state->qfo_transfer_buffer_barriers);
5554
5555 // Validate buffer barrier queue family indices
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06005556 auto buffer_state = Get<BUFFER_STATE>(mem_barrier.buffer);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005557 if (buffer_state) {
5558 auto buf_loc = loc.dot(Field::buffer);
5559 const auto &mem_vuid = GetBufferBarrierVUID(buf_loc, BufferError::kNoMemory);
Jeremy Gebben9f537102021-10-05 16:37:12 -06005560 skip |= ValidateMemoryIsBoundToBuffer(buffer_state.get(), loc.StringFunc().c_str(), mem_vuid.c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005561
Jeremy Gebben9f537102021-10-05 16:37:12 -06005562 skip |= ValidateBarrierQueueFamilies(buf_loc, cb_state, mem_barrier, buffer_state.get());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005563
5564 auto buffer_size = buffer_state->createInfo.size;
5565 if (mem_barrier.offset >= buffer_size) {
5566 auto offset_loc = loc.dot(Field::offset);
5567 const auto &vuid = GetBufferBarrierVUID(offset_loc, BufferError::kOffsetTooBig);
5568
5569 skip |= LogError(objects, vuid, "%s %s has offset 0x%" PRIx64 " which is not less than total size 0x%" PRIx64 ".",
5570 offset_loc.Message().c_str(), report_data->FormatHandle(mem_barrier.buffer).c_str(),
5571 HandleToUint64(mem_barrier.offset), HandleToUint64(buffer_size));
5572 } else if (mem_barrier.size != VK_WHOLE_SIZE && (mem_barrier.offset + mem_barrier.size > buffer_size)) {
5573 auto size_loc = loc.dot(Field::size);
5574 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kSizeOutOfRange);
5575 skip |= LogError(objects, vuid,
5576 "%s %s has offset 0x%" PRIx64 " and size 0x%" PRIx64 " whose sum is greater than total size 0x%" PRIx64
5577 ".",
5578 size_loc.Message().c_str(), report_data->FormatHandle(mem_barrier.buffer).c_str(),
5579 HandleToUint64(mem_barrier.offset), HandleToUint64(mem_barrier.size), HandleToUint64(buffer_size));
5580 }
5581 if (mem_barrier.size == 0) {
5582 auto size_loc = loc.dot(Field::size);
5583 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kSizeZero);
5584 skip |= LogError(objects, vuid, "%s %s has a size of 0.", loc.Message().c_str(),
5585 report_data->FormatHandle(mem_barrier.buffer).c_str());
5586 }
5587 }
ziga-lunarg8e2506c2022-04-18 20:06:00 +02005588
5589 if (mem_barrier.srcQueueFamilyIndex == VK_QUEUE_FAMILY_EXTERNAL &&
5590 mem_barrier.dstQueueFamilyIndex == VK_QUEUE_FAMILY_EXTERNAL) {
5591 auto size_loc = loc.dot(Field::srcQueueFamilyIndex);
5592 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kQueueFamilyExternal);
5593 skip |= LogError(objects, vuid, "Both srcQueueFamilyIndex and dstQueueFamilyIndex are VK_QUEUE_FAMILY_EXTERNAL.");
5594 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005595 return skip;
5596}
5597
5598template <typename Barrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005599bool CoreChecks::ValidateImageBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005600 const Barrier &mem_barrier) const {
5601 bool skip = false;
5602
5603 skip |= ValidateQFOTransferBarrierUniqueness(loc, cb_state, mem_barrier, cb_state->qfo_transfer_image_barriers);
5604
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005605 bool is_ilt = true;
Tony-LunarG273f32f2021-09-28 08:56:30 -06005606 if (enabled_features.core13.synchronization2) {
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005607 is_ilt = mem_barrier.oldLayout != mem_barrier.newLayout;
5608 }
5609
5610 if (is_ilt) {
5611 if (mem_barrier.newLayout == VK_IMAGE_LAYOUT_UNDEFINED || mem_barrier.newLayout == VK_IMAGE_LAYOUT_PREINITIALIZED) {
5612 auto layout_loc = loc.dot(Field::newLayout);
5613 const auto &vuid = sync_vuid_maps::GetImageBarrierVUID(loc, sync_vuid_maps::ImageError::kBadLayout);
5614 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005615 LogError(cb_state->commandBuffer(), vuid, "%s Image Layout cannot be transitioned to UNDEFINED or PREINITIALIZED.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005616 layout_loc.Message().c_str());
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005617 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005618 }
5619
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06005620 auto image_data = Get<IMAGE_STATE>(mem_barrier.image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005621 if (image_data) {
5622 auto image_loc = loc.dot(Field::image);
5623
Jeremy Gebben9f537102021-10-05 16:37:12 -06005624 skip |= ValidateMemoryIsBoundToImage(image_data.get(), loc);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005625
Jeremy Gebben9f537102021-10-05 16:37:12 -06005626 skip |= ValidateBarrierQueueFamilies(image_loc, cb_state, mem_barrier, image_data.get());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005627
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005628 skip |= ValidateImageAspectMask(image_data->image(), image_data->createInfo.format, mem_barrier.subresourceRange.aspectMask,
Aitor Camachoeb35fed2022-06-07 14:07:42 +02005629 image_data->disjoint, loc.StringFunc().c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005630
Jeremy Gebben9f537102021-10-05 16:37:12 -06005631 skip |=
5632 ValidateImageBarrierSubresourceRange(loc.dot(Field::subresourceRange), image_data.get(), mem_barrier.subresourceRange);
ziga-lunarg69aa72f2022-03-29 15:24:35 +02005633 skip |= ValidateImageAcquired(*image_data, loc.StringFunc().c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005634 }
5635 return skip;
5636}
5637
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005638bool CoreChecks::ValidateBarriers(const Location &outer_loc, const CMD_BUFFER_STATE *cb_state, VkPipelineStageFlags src_stage_mask,
5639 VkPipelineStageFlags dst_stage_mask, uint32_t memBarrierCount,
5640 const VkMemoryBarrier *pMemBarriers, uint32_t bufferBarrierCount,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005641 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
5642 const VkImageMemoryBarrier *pImageMemBarriers) const {
5643 bool skip = false;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005644 LogObjectList objects(cb_state->commandBuffer());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005645
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005646 for (uint32_t i = 0; i < memBarrierCount; ++i) {
5647 const auto &mem_barrier = pMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005648 auto loc = outer_loc.dot(Struct::VkMemoryBarrier, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005649 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005650 }
5651 for (uint32_t i = 0; i < imageMemBarrierCount; ++i) {
5652 const auto &mem_barrier = pImageMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005653 auto loc = outer_loc.dot(Struct::VkImageMemoryBarrier, Field::pImageMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005654 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005655 skip |= ValidateImageBarrier(objects, loc, cb_state, mem_barrier);
5656 }
5657 {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005658 Location loc(outer_loc.function, Struct::VkImageMemoryBarrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005659 skip |= ValidateBarriersToImages(loc, cb_state, imageMemBarrierCount, pImageMemBarriers);
5660 }
5661 for (uint32_t i = 0; i < bufferBarrierCount; ++i) {
5662 const auto &mem_barrier = pBufferMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005663 auto loc = outer_loc.dot(Struct::VkBufferMemoryBarrier, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005664 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005665 skip |= ValidateBufferBarrier(objects, loc, cb_state, mem_barrier);
5666 }
5667 return skip;
5668}
5669
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005670bool CoreChecks::ValidateDependencyInfo(const LogObjectList &objects, const Location &outer_loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbenefead332021-06-18 08:22:44 -06005671 const VkDependencyInfoKHR *dep_info) const {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005672 bool skip = false;
5673
5674 if (cb_state->activeRenderPass) {
5675 skip |= ValidateRenderPassPipelineBarriers(outer_loc, cb_state, dep_info);
5676 if (skip) return true; // Early return to avoid redundant errors from below calls
5677 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005678 for (uint32_t i = 0; i < dep_info->memoryBarrierCount; ++i) {
5679 const auto &mem_barrier = dep_info->pMemoryBarriers[i];
Tony-LunarG279601c2021-11-16 10:50:51 -07005680 auto loc = outer_loc.dot(Struct::VkMemoryBarrier2, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005681 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005682 }
5683 for (uint32_t i = 0; i < dep_info->imageMemoryBarrierCount; ++i) {
5684 const auto &mem_barrier = dep_info->pImageMemoryBarriers[i];
Tony-LunarG279601c2021-11-16 10:50:51 -07005685 auto loc = outer_loc.dot(Struct::VkImageMemoryBarrier2, Field::pImageMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005686 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005687 skip |= ValidateImageBarrier(objects, loc, cb_state, mem_barrier);
5688 }
5689 {
Tony-LunarG279601c2021-11-16 10:50:51 -07005690 Location loc(outer_loc.function, Struct::VkImageMemoryBarrier2);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005691 skip |= ValidateBarriersToImages(loc, cb_state, dep_info->imageMemoryBarrierCount, dep_info->pImageMemoryBarriers);
5692 }
5693
5694 for (uint32_t i = 0; i < dep_info->bufferMemoryBarrierCount; ++i) {
5695 const auto &mem_barrier = dep_info->pBufferMemoryBarriers[i];
Tony-LunarG279601c2021-11-16 10:50:51 -07005696 auto loc = outer_loc.dot(Struct::VkBufferMemoryBarrier2, Field::pBufferMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005697 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005698 skip |= ValidateBufferBarrier(objects, loc, cb_state, mem_barrier);
5699 }
5700
5701 return skip;
5702}
5703
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005704// template to check all original barrier structures
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005705template <typename Barrier>
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005706bool CoreChecks::ValidateMemoryBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
5707 const Barrier &barrier, VkPipelineStageFlags src_stage_mask,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005708 VkPipelineStageFlags dst_stage_mask) const {
5709 bool skip = false;
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005710 assert(cb_state);
5711 auto queue_flags = cb_state->GetQueueFlags();
5712
5713 if (!cb_state->IsAcquireOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005714 skip |= ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), queue_flags, barrier.srcAccessMask, src_stage_mask);
5715 }
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005716 if (!cb_state->IsReleaseOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005717 skip |= ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), queue_flags, barrier.dstAccessMask, dst_stage_mask);
5718 }
5719 return skip;
5720}
5721
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005722// template to check all synchronization2 barrier structures
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005723template <typename Barrier>
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005724bool CoreChecks::ValidateMemoryBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
5725 const Barrier &barrier) const {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005726 bool skip = false;
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005727 assert(cb_state);
5728 auto queue_flags = cb_state->GetQueueFlags();
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005729
Jeremy Gebbenefead332021-06-18 08:22:44 -06005730 skip |= ValidatePipelineStage(objects, loc.dot(Field::srcStageMask), queue_flags, barrier.srcStageMask);
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005731 if (!cb_state->IsAcquireOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005732 skip |=
5733 ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), queue_flags, barrier.srcAccessMask, barrier.srcStageMask);
5734 }
Jeremy Gebbenefead332021-06-18 08:22:44 -06005735
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005736 skip |= ValidatePipelineStage(objects, loc.dot(Field::dstStageMask), queue_flags, barrier.dstStageMask);
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005737 if (!cb_state->IsReleaseOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005738 skip |=
5739 ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), queue_flags, barrier.dstAccessMask, barrier.dstStageMask);
5740 }
5741 return skip;
5742}
5743
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005744// VkSubpassDependency validation happens when vkCreateRenderPass() is called.
5745// Dependencies between subpasses can only use pipeline stages compatible with VK_QUEUE_GRAPHICS_BIT,
5746// for external subpasses we don't have a yet command buffer so we have to assume all of them are valid.
5747static inline VkQueueFlags SubpassToQueueFlags(uint32_t subpass) {
5748 return subpass == VK_SUBPASS_EXTERNAL ? sync_utils::kAllQueueTypes : static_cast<VkQueueFlags>(VK_QUEUE_GRAPHICS_BIT);
5749}
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005750
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005751bool CoreChecks::ValidateSubpassDependency(const LogObjectList &objects, const Location &in_loc,
5752 const VkSubpassDependency2 &dependency) const {
5753 bool skip = false;
5754 Location loc = in_loc;
5755 VkMemoryBarrier2KHR converted_barrier;
5756 const auto *mem_barrier = LvlFindInChain<VkMemoryBarrier2KHR>(dependency.pNext);
5757
Tony-LunarG273f32f2021-09-28 08:56:30 -06005758 if (mem_barrier && enabled_features.core13.synchronization2) {
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005759 if (dependency.srcAccessMask != 0) {
5760 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-srcAccessMask",
5761 "%s is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5762 loc.dot(Field::srcAccessMask).Message().c_str());
5763 }
5764 if (dependency.dstAccessMask != 0) {
5765 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-dstAccessMask",
5766 "%s dstAccessMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5767 loc.dot(Field::dstAccessMask).Message().c_str());
5768 }
5769 if (dependency.srcStageMask != 0) {
5770 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-srcStageMask",
5771 "%s srcStageMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5772 loc.dot(Field::srcStageMask).Message().c_str());
5773 }
5774 if (dependency.dstStageMask != 0) {
5775 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-dstStageMask",
5776 "%s dstStageMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5777 loc.dot(Field::dstStageMask).Message().c_str());
5778 }
5779 loc = in_loc.dot(Field::pNext);
5780 converted_barrier = *mem_barrier;
5781 } else {
5782 if (mem_barrier) {
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005783 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-pNext",
5784 "%s a VkMemoryBarrier2KHR is present in pNext but synchronization2 is not enabled.",
5785 loc.Message().c_str());
5786 }
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005787 // use the subpass dependency flags, upconverted into wider synchronization2 fields.
5788 converted_barrier.srcStageMask = dependency.srcStageMask;
5789 converted_barrier.dstStageMask = dependency.dstStageMask;
5790 converted_barrier.srcAccessMask = dependency.srcAccessMask;
5791 converted_barrier.dstAccessMask = dependency.dstAccessMask;
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005792 }
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005793 auto src_queue_flags = SubpassToQueueFlags(dependency.srcSubpass);
5794 skip |= ValidatePipelineStage(objects, loc.dot(Field::srcStageMask), src_queue_flags, converted_barrier.srcStageMask);
5795 skip |= ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), src_queue_flags, converted_barrier.srcAccessMask,
5796 converted_barrier.srcStageMask);
5797
5798 auto dst_queue_flags = SubpassToQueueFlags(dependency.dstSubpass);
5799 skip |= ValidatePipelineStage(objects, loc.dot(Field::dstStageMask), dst_queue_flags, converted_barrier.dstStageMask);
5800 skip |= ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), dst_queue_flags, converted_barrier.dstAccessMask,
5801 converted_barrier.dstStageMask);
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005802 return skip;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005803}
5804
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005805bool CoreChecks::ValidateImageViewFormatFeatures(const IMAGE_STATE *image_state, const VkFormat view_format,
5806 const VkImageUsageFlags image_usage) const {
5807 // Pass in image_usage here instead of extracting it from image_state in case there's a chained VkImageViewUsageCreateInfo
5808 bool skip = false;
5809
Lionel Landwerlin21719f62021-12-09 11:40:09 +02005810 VkFormatFeatureFlags2KHR tiling_features = 0;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005811 const VkImageTiling image_tiling = image_state->createInfo.tiling;
5812
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06005813 if (image_state->HasAHBFormat()) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005814 // AHB image view and image share same feature sets
5815 tiling_features = image_state->format_features;
5816 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5817 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
sfricke-samsung45996a42021-09-16 13:45:27 -07005818 assert(IsExtEnabled(device_extensions.vk_ext_image_drm_format_modifier));
sjfrickee9b39372022-05-22 13:02:17 +09005819 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = LvlInitStruct<VkImageDrmFormatModifierPropertiesEXT>();
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005820 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image_state->image(), &drm_format_properties);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005821
Lionel Landwerlin1da35792021-12-14 16:54:13 +02005822 auto fmt_drm_props = LvlInitStruct<VkDrmFormatModifierPropertiesListEXT>();
5823 auto fmt_props_2 = LvlInitStruct<VkFormatProperties2>(&fmt_drm_props);
5824 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &fmt_props_2);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005825
nyorain38a9d232021-03-06 13:06:12 +01005826 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
Lionel Landwerlin1da35792021-12-14 16:54:13 +02005827 drm_properties.resize(fmt_drm_props.drmFormatModifierCount);
5828 fmt_drm_props.pDrmFormatModifierProperties = drm_properties.data();
nyorain38a9d232021-03-06 13:06:12 +01005829
Lionel Landwerlin1da35792021-12-14 16:54:13 +02005830 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &fmt_props_2);
nyorain38a9d232021-03-06 13:06:12 +01005831
Lionel Landwerlin1da35792021-12-14 16:54:13 +02005832 for (uint32_t i = 0; i < fmt_drm_props.drmFormatModifierCount; i++) {
5833 if (fmt_drm_props.pDrmFormatModifierProperties[i].drmFormatModifier == drm_format_properties.drmFormatModifier) {
5834 tiling_features = fmt_drm_props.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
5835 break;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005836 }
5837 }
5838 } else {
Lionel Landwerlin21719f62021-12-09 11:40:09 +02005839 VkFormatProperties3KHR format_properties = GetPDFormatProperties(view_format);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005840 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
5841 : format_properties.optimalTilingFeatures;
5842 }
5843
5844 if (tiling_features == 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005845 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-None-02273",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005846 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
5847 "physical device.",
5848 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5849 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005850 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02274",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005851 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5852 "VK_IMAGE_USAGE_SAMPLED_BIT.",
5853 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5854 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005855 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02275",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005856 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5857 "VK_IMAGE_USAGE_STORAGE_BIT.",
5858 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5859 } 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 -06005860 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02276",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005861 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5862 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
5863 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5864 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
5865 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005866 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02277",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005867 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5868 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5869 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5870 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
5871 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005872 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02652",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005873 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5874 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5875 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Tobias Hector6663c9b2020-11-05 10:18:02 +00005876 } else if ((image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) &&
5877 !(tiling_features & VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR)) {
5878 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005879 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-04550",
Tobias Hector6663c9b2020-11-05 10:18:02 +00005880 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5881 "VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR.",
5882 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5883 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005884 }
5885
5886 return skip;
5887}
5888
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005889bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005890 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005891 bool skip = false;
Jeremy Gebbenf4449392022-01-28 10:09:10 -07005892 auto image_state = Get<IMAGE_STATE>(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005893 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005894 skip |=
Jeremy Gebben9f537102021-10-05 16:37:12 -06005895 ValidateImageUsageFlags(image_state.get(),
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005896 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
5897 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
sfricke-samsungbb971942020-09-10 22:11:56 -07005898 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV |
5899 VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
5900 false, "VUID-VkImageViewCreateInfo-image-04441", "vkCreateImageView()",
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005901 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
sfricke-samsungbb971942020-09-10 22:11:56 -07005902 "TRANSIENT_ATTACHMENT|SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005903 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Jeremy Gebben9f537102021-10-05 16:37:12 -06005904 skip |= ValidateMemoryIsBoundToImage(image_state.get(), "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005905 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02005906 skip |= ValidateCreateImageViewSubresourceRange(
Jeremy Gebben9f537102021-10-05 16:37:12 -06005907 image_state.get(),
5908 pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005909 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005910
5911 VkImageCreateFlags image_flags = image_state->createInfo.flags;
5912 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005913 VkImageUsageFlags image_usage = image_state->createInfo.usage;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005914 VkFormat view_format = pCreateInfo->format;
5915 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06005916 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005917 VkImageViewType view_type = pCreateInfo->viewType;
sfricke-samsung20a8a372021-07-14 06:12:17 -07005918 uint32_t layer_count = pCreateInfo->subresourceRange.layerCount;
Mark Lobodzinski602de982017-02-09 11:01:33 -07005919
Dave Houltonbd2e2622018-04-10 16:41:14 -06005920 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005921 auto chained_ivuci_struct = LvlFindInChain<VkImageViewUsageCreateInfo>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06005922 if (chained_ivuci_struct) {
sfricke-samsung45996a42021-09-16 13:45:27 -07005923 if (IsExtEnabled(device_extensions.vk_khr_maintenance2)) {
5924 if (!IsExtEnabled(device_extensions.vk_ext_separate_stencil_usage)) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05005925 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005926 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
5927 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
5928 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05005929 }
5930 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005931 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05005932 if (image_stencil_struct == nullptr) {
5933 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005934 skip |= LogError(
5935 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005936 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
5937 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
5938 "any bits that were not set in VkImageCreateInfo::usage used to create image");
5939 }
5940 } else {
5941 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
5942 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
5943 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005944 skip |= LogError(
5945 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005946 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5947 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5948 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
5949 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
5950 }
5951 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
5952 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005953 skip |= LogError(
5954 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005955 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5956 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5957 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
5958 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
5959 }
5960 }
5961 }
5962 }
5963
Dave Houltonbd2e2622018-04-10 16:41:14 -06005964 image_usage = chained_ivuci_struct->usage;
5965 }
5966
sfricke-samsungf60b6c82021-04-05 22:59:20 -07005967 // If image used VkImageFormatListCreateInfo need to make sure a format from list is used
5968 const auto format_list_info = LvlFindInChain<VkImageFormatListCreateInfo>(image_state->createInfo.pNext);
5969 if (format_list_info && (format_list_info->viewFormatCount > 0)) {
5970 bool foundFormat = false;
5971 for (uint32_t i = 0; i < format_list_info->viewFormatCount; i++) {
5972 if (format_list_info->pViewFormats[i] == view_format) {
5973 foundFormat = true;
5974 break;
5975 }
5976 }
5977 if (foundFormat == false) {
5978 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-01585",
5979 "vkCreateImageView(): image was created with a VkImageFormatListCreateInfo in pNext of "
5980 "vkImageCreateInfo, but none of the formats match the VkImageViewCreateInfo::format (%s).",
5981 string_VkFormat(view_format));
5982 }
5983 }
5984
Dave Houlton6f5f20a2018-05-04 12:37:44 -06005985 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
5986 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005987 if (FormatIsMultiplane(image_format)) {
sjfricke67b79bc2022-07-14 14:44:37 +09005988 const VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
5989 auto image_class = FormatCompatibilityClass(compat_format);
5990 auto view_class = FormatCompatibilityClass(view_format);
5991 // Need to only check if one is NONE to handle edge case both are NONE
5992 if ((image_class != view_class) || (image_class == FORMAT_COMPATIBILITY_CLASS::NONE)) {
Graeme Leese605ca512019-05-08 12:59:44 +01005993 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06005994 std::stringstream ss;
5995 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01005996 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
sjfricke67b79bc2022-07-14 14:44:37 +09005997 << string_VkFormat(image_format) << ", must be compatible with " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005998 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005999 }
sjfricke7e0d07c2022-07-14 14:44:05 +09006000 } else if (!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT)) {
6001 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
6002 auto image_class = FormatCompatibilityClass(image_format);
6003 auto view_class = FormatCompatibilityClass(view_format);
6004 // Need to only check if one is NONE to handle edge case both are NONE
6005 if ((image_class != view_class) || (image_class == FORMAT_COMPATIBILITY_CLASS::NONE)) {
6006 const char *error_vuid;
6007 if ((!IsExtEnabled(device_extensions.vk_khr_maintenance2)) &&
6008 (!IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion))) {
6009 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
6010 } else if ((IsExtEnabled(device_extensions.vk_khr_maintenance2)) &&
6011 (!IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion))) {
6012 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
6013 } else if ((!IsExtEnabled(device_extensions.vk_khr_maintenance2)) &&
6014 (IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion))) {
6015 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
6016 } else {
6017 // both enabled
6018 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
Dave Houltonc7988072018-04-16 11:46:56 -06006019 }
sjfricke7e0d07c2022-07-14 14:44:05 +09006020 std::stringstream ss;
6021 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
6022 << " is not in the same format compatibility class as "
6023 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
6024 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
6025 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
6026 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Lenny Komowb79f04a2017-09-18 17:07:00 -06006027 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07006028 }
6029 } else {
6030 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07006031 // Unless it is a multi-planar color bit aspect
6032 if ((image_format != view_format) &&
6033 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
sfricke-samsung45996a42021-09-16 13:45:27 -07006034 const char *vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
6035 ? "VUID-VkImageViewCreateInfo-image-01762"
6036 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07006037 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06006038 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07006039 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07006040 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07006041 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07006042 }
6043 }
6044
ziga-lunargebb32de2021-08-29 21:24:30 +02006045 if (image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT && view_type != VK_IMAGE_VIEW_TYPE_2D &&
6046 view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
6047 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04972",
6048 "vkCreateImageView(): image was created with sample count %s, but pCreateInfo->viewType is %s.",
6049 string_VkSampleCountFlagBits(image_state->createInfo.samples), string_VkImageViewType(view_type));
6050 }
6051
Mark Lobodzinski602de982017-02-09 11:01:33 -07006052 // Validate correct image aspect bits for desired formats and format consistency
Aitor Camachoeb35fed2022-06-07 14:07:42 +02006053 skip |=
6054 ValidateImageAspectMask(image_state->image(), image_format, aspect_mask, image_state->disjoint, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06006055
sfricke-samsung20a8a372021-07-14 06:12:17 -07006056 // Valdiate Image/ImageView type compatibility #resources-image-views-compatibility
Jeremy Kniager846ab732017-07-10 13:12:04 -06006057 switch (image_type) {
6058 case VK_IMAGE_TYPE_1D:
6059 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006060 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
6061 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
6062 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06006063 }
6064 break;
6065 case VK_IMAGE_TYPE_2D:
6066 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
6067 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
6068 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006069 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
6070 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
6071 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06006072 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006073 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
6074 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
6075 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06006076 }
6077 }
6078 break;
6079 case VK_IMAGE_TYPE_3D:
sfricke-samsung45996a42021-09-16 13:45:27 -07006080 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06006081 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
6082 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
Tony-LunarGbe956362022-04-05 13:34:31 -06006083 if (device_extensions.vk_ext_image_2d_view_of_3d) {
6084 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT)) {
6085 if (view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
6086 skip |= LogError(
6087 pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-06723",
6088 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type "
6089 "%s since the image doesn't have VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT flag set.",
6090 string_VkImageViewType(view_type), string_VkImageType(image_type));
6091 } else if (view_type == VK_IMAGE_VIEW_TYPE_2D &&
6092 !(image_flags & VK_IMAGE_CREATE_2D_VIEW_COMPATIBLE_BIT_EXT)) {
6093 skip |= LogError(
6094 pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-06728",
6095 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type "
6096 "%s since the image doesn't have VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT or "
6097 "VK_IMAGE_CREATE_2D_VIEW_COMPATIBLE_BIT_EXT flag set.",
6098 string_VkImageViewType(view_type), string_VkImageType(image_type));
6099 }
6100 }
6101 } else if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT) &&
6102 (view_type == VK_IMAGE_VIEW_TYPE_2D)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06006103 skip |=
Tony-LunarGbe956362022-04-05 13:34:31 -06006104 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-06727",
6105 "vkCreateImageView(): pCreateInfo->viewType VK_IMAGE_VIEW_TYPE_2D is not compatible "
6106 "with image type "
sfricke-samsungd9b3e122021-07-15 22:50:00 -07006107 "%s since the image doesn't have VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT flag set.",
Tony-LunarGbe956362022-04-05 13:34:31 -06006108 string_VkImageType(image_type));
6109 }
6110 if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
Jeremy Kniager846ab732017-07-10 13:12:04 -06006111 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006112 skip |= LogError(
sfricke-samsungd9b3e122021-07-15 22:50:00 -07006113 pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04971",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006114 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
6115 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
6116 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
6117 string_VkImageViewType(view_type), string_VkImageType(image_type));
sfricke-samsungd9b3e122021-07-15 22:50:00 -07006118 } else if (pCreateInfo->subresourceRange.levelCount != 1) {
6119 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04970",
6120 "vkCreateImageView(): pCreateInfo->viewType %s is with image type %s must have a "
6121 "levelCount of 1 but it is %u.",
6122 string_VkImageViewType(view_type), string_VkImageType(image_type),
6123 pCreateInfo->subresourceRange.levelCount);
Jeremy Kniager846ab732017-07-10 13:12:04 -06006124 }
6125 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006126 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
6127 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
6128 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06006129 }
6130 }
6131 } else {
6132 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
sfricke-samsungd9b3e122021-07-15 22:50:00 -07006133 // Help point to VK_KHR_maintenance1
6134 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
6135 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
6136 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
6137 "without VK_KHR_maintenance1 enabled which was promoted in Vulkan 1.0.",
6138 string_VkImageViewType(view_type), string_VkImageType(image_type));
6139 } else {
6140 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
6141 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
6142 string_VkImageViewType(view_type), string_VkImageType(image_type));
6143 }
Jeremy Kniager846ab732017-07-10 13:12:04 -06006144 }
6145 }
6146 break;
6147 default:
6148 break;
6149 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06006150
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006151 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
sfricke-samsung45996a42021-09-16 13:45:27 -07006152 if (IsExtEnabled(device_extensions.vk_android_external_memory_android_hardware_buffer)) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07006153 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06006154 }
6155
Jeremy Gebben9f537102021-10-05 16:37:12 -06006156 skip |= ValidateImageViewFormatFeatures(image_state.get(), view_format, image_usage);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006157
sfricke-samsung828e59d2021-08-22 23:20:49 -07006158 if (enabled_features.shading_rate_image_features.shadingRateImage) {
Tobias Hector6663c9b2020-11-05 10:18:02 +00006159 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
6160 if (view_format != VK_FORMAT_R8_UINT) {
6161 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
6162 "vkCreateImageView() If image was created with usage containing "
6163 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
6164 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05006165 }
Tobias Hector6663c9b2020-11-05 10:18:02 +00006166 }
6167
sfricke-samsung828e59d2021-08-22 23:20:49 -07006168 if (enabled_features.shading_rate_image_features.shadingRateImage ||
Tobias Hector6663c9b2020-11-05 10:18:02 +00006169 enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
6170 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) {
6171 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
6172 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
6173 "vkCreateImageView() If image was created with usage containing "
6174 "VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR, viewType must be "
6175 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
6176 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05006177 }
6178 }
Jeff Bolz99e3f632020-03-24 22:59:22 -05006179
Tobias Hector6663c9b2020-11-05 10:18:02 +00006180 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate &&
6181 !phys_dev_ext_props.fragment_shading_rate_props.layeredShadingRateAttachments &&
sfricke-samsung20a8a372021-07-14 06:12:17 -07006182 image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR && layer_count != 1) {
Tobias Hector6663c9b2020-11-05 10:18:02 +00006183 skip |= LogError(device, "VUID-VkImageViewCreateInfo-usage-04551",
6184 "vkCreateImageView(): subresourceRange.layerCount is %u for a shading rate attachment image view.",
sfricke-samsung20a8a372021-07-14 06:12:17 -07006185 layer_count);
Tobias Hector6663c9b2020-11-05 10:18:02 +00006186 }
6187
sfricke-samsung20a8a372021-07-14 06:12:17 -07006188 if (layer_count == VK_REMAINING_ARRAY_LAYERS) {
6189 const uint32_t remaining_layers = image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer;
6190 if (view_type == VK_IMAGE_VIEW_TYPE_CUBE && remaining_layers != 6) {
Jeff Bolz99e3f632020-03-24 22:59:22 -05006191 skip |= LogError(device, "VUID-VkImageViewCreateInfo-viewType-02962",
6192 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be 6",
sfricke-samsung20a8a372021-07-14 06:12:17 -07006193 remaining_layers);
Jeff Bolz99e3f632020-03-24 22:59:22 -05006194 }
sfricke-samsung20a8a372021-07-14 06:12:17 -07006195 if (view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY && ((remaining_layers) % 6) != 0) {
Jeff Bolz99e3f632020-03-24 22:59:22 -05006196 skip |= LogError(
6197 device, "VUID-VkImageViewCreateInfo-viewType-02963",
6198 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be a multiple of 6",
sfricke-samsung20a8a372021-07-14 06:12:17 -07006199 remaining_layers);
6200 }
6201 if ((remaining_layers != 1) && ((view_type == VK_IMAGE_VIEW_TYPE_1D) || (view_type == VK_IMAGE_VIEW_TYPE_2D) ||
6202 (view_type == VK_IMAGE_VIEW_TYPE_3D))) {
6203 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-imageViewType-04974",
6204 "vkCreateImageView(): Using pCreateInfo->viewType %s and the subresourceRange.layerCount "
6205 "VK_REMAINING_ARRAY_LAYERS=(%d) and must 1 (try looking into VK_IMAGE_VIEW_TYPE_*_ARRAY).",
6206 string_VkImageViewType(view_type), remaining_layers);
6207 }
6208 } else {
6209 if ((layer_count != 1) && ((view_type == VK_IMAGE_VIEW_TYPE_1D) || (view_type == VK_IMAGE_VIEW_TYPE_2D) ||
6210 (view_type == VK_IMAGE_VIEW_TYPE_3D))) {
6211 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-imageViewType-04973",
ziga-lunargc9d29f72022-05-15 19:55:08 +02006212 "vkCreateImageView(): subresourceRange.layerCount (%" PRIu32
6213 ") must be 1 when using viewType %s (try looking into VK_IMAGE_VIEW_TYPE_*_ARRAY).",
6214 layer_count, string_VkImageViewType(view_type));
Jeff Bolz99e3f632020-03-24 22:59:22 -05006215 }
6216 }
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006217
6218 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
ziga-lunarga77a2832022-05-03 11:12:00 +02006219 const auto normalized_subresource_range = image_state->NormalizeSubresourceRange(pCreateInfo->subresourceRange);
6220 if (normalized_subresource_range.levelCount != 1) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06006221 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02571",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006222 "vkCreateImageView(): If image was created with usage containing "
6223 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, subresourceRange.levelCount (%d) must: be 1",
6224 pCreateInfo->subresourceRange.levelCount);
6225 }
6226 }
6227 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
6228 if (!enabled_features.fragment_density_map_features.fragmentDensityMapDynamic) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06006229 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-02572",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006230 "vkCreateImageView(): If the fragmentDensityMapDynamic feature is not enabled, "
6231 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
6232 }
6233 } else {
6234 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
6235 if (image_flags & (VK_IMAGE_CREATE_PROTECTED_BIT | VK_IMAGE_CREATE_SPARSE_BINDING_BIT |
6236 VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT)) {
Shannon McPherson8d0d1f92020-07-06 11:58:21 -06006237 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-04116",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006238 "vkCreateImageView(): If image was created with usage containing "
6239 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT flags must not contain any of "
6240 "VK_IMAGE_CREATE_PROTECTED_BIT, VK_IMAGE_CREATE_SPARSE_BINDING_BIT, "
6241 "VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or VK_IMAGE_CREATE_SPARSE_ALIASED_BIT");
6242 }
6243 }
6244 }
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07006245
ziga-lunarg966ac0e2021-07-18 11:51:44 +02006246 if (image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
6247 if (pCreateInfo->subresourceRange.levelCount != 1) {
6248 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01584",
6249 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit, "
6250 "but subresourcesRange.levelCount (%" PRIu32 ") is not 1.",
6251 pCreateInfo->subresourceRange.levelCount);
6252 }
6253 if (pCreateInfo->subresourceRange.layerCount != 1) {
6254 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01584",
6255 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit, "
6256 "but subresourcesRange.layerCount (%" PRIu32 ") is not 1.",
6257 pCreateInfo->subresourceRange.layerCount);
6258 }
ziga-lunarg966ac0e2021-07-18 11:51:44 +02006259
sfricke-samsungd750f812022-02-04 10:23:34 -08006260 if (!FormatIsCompressed(view_format) && pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_3D) {
6261 skip |=
6262 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04739",
ziga-lunargc290c7f2021-07-31 22:01:46 +02006263 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit and "
6264 "non-compressed format (%s), but pCreateInfo->viewType is VK_IMAGE_VIEW_TYPE_3D.",
6265 string_VkFormat(image_format));
sfricke-samsungd750f812022-02-04 10:23:34 -08006266 }
6267
6268 const bool class_compatible = FormatCompatibilityClass(view_format) == FormatCompatibilityClass(image_format);
6269 // "uncompressed format that is size-compatible" so if compressed, same as not being compatible
6270 const bool size_compatible =
6271 FormatIsCompressed(view_format) ? false : FormatElementSize(view_format) == FormatElementSize(image_format);
6272 if (!class_compatible && !size_compatible) {
6273 skip |=
6274 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01583",
6275 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit and "
6276 "format (%s), but pCreateInfo->format (%s) are not compatible.",
6277 string_VkFormat(image_format), string_VkFormat(view_format));
6278 }
ziga-lunargc290c7f2021-07-31 22:01:46 +02006279 }
6280
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02006281 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT) {
6282 if (!enabled_features.fragment_density_map2_features.fragmentDensityMapDeferred) {
6283 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03567",
6284 "vkCreateImageView(): If the fragmentDensityMapDeferred feature is not enabled, "
6285 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT");
6286 }
6287 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
6288 skip |=
6289 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03568",
6290 "vkCreateImageView(): If flags contains VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT, "
6291 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
6292 }
6293 }
sfricke-samsung45996a42021-09-16 13:45:27 -07006294 if (IsExtEnabled(device_extensions.vk_ext_fragment_density_map2)) {
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02006295 if ((image_flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) && (image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) &&
sfricke-samsung20a8a372021-07-14 06:12:17 -07006296 (layer_count > phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers)) {
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02006297 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-03569",
6298 "vkCreateImageView(): If image was created with flags containing "
6299 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT and usage containing VK_IMAGE_USAGE_SAMPLED_BIT "
6300 "subresourceRange.layerCount (%d) must: be less than or equal to maxSubsampledArrayLayers (%d)",
sfricke-samsung20a8a372021-07-14 06:12:17 -07006301 layer_count, phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers);
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02006302 }
6303 }
6304
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07006305 auto astc_decode_mode = LvlFindInChain<VkImageViewASTCDecodeModeEXT>(pCreateInfo->pNext);
sfricke-samsung45996a42021-09-16 13:45:27 -07006306 if (IsExtEnabled(device_extensions.vk_ext_astc_decode_mode) && (astc_decode_mode != nullptr)) {
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07006307 if ((enabled_features.astc_decode_features.decodeModeSharedExponent == VK_FALSE) &&
6308 (astc_decode_mode->decodeMode == VK_FORMAT_E5B9G9R9_UFLOAT_PACK32)) {
6309 skip |= LogError(device, "VUID-VkImageViewASTCDecodeModeEXT-decodeMode-02231",
6310 "vkCreateImageView(): decodeModeSharedExponent is not enabled but "
6311 "VkImageViewASTCDecodeModeEXT::decodeMode is VK_FORMAT_E5B9G9R9_UFLOAT_PACK32.");
6312 }
6313 }
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07006314
sfricke-samsung45996a42021-09-16 13:45:27 -07006315 if (IsExtEnabled(device_extensions.vk_khr_portability_subset)) {
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07006316 // If swizzling is disabled, make sure it isn't used
Nathaniel Cesario17d057e2021-06-21 22:58:45 -06006317 // NOTE: as of spec version 1.2.183, VUID 04465 states: "all elements of components _must_ be
6318 // VK_COMPONENT_SWIZZLE_IDENTITY."
6319 // However, issue https://github.com/KhronosGroup/Vulkan-Portability/issues/27 points out that the identity can
6320 // also be defined via R, G, B, A enums in the correct order.
6321 // Spec change is at https://gitlab.khronos.org/vulkan/vulkan/-/merge_requests/4600
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07006322 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatSwizzle) &&
Nathaniel Cesario17d057e2021-06-21 22:58:45 -06006323 !IsIdentitySwizzle(pCreateInfo->components)) {
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07006324 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatSwizzle-04465",
6325 "vkCreateImageView (portability error): swizzle is disabled for this device.");
6326 }
6327
6328 // Ensure ImageView's format has the same number of bits and components as Image's format if format reinterpretation is
6329 // disabled
6330 // TODO (ncesario): This is not correct for some cases (e.g., VK_FORMAT_B10G11R11_UFLOAT_PACK32 and
6331 // VK_FORMAT_E5B9G9R9_UFLOAT_PACK32), but requires additional information that should probably be generated from the
6332 // spec. See Github issue #2361.
6333 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatReinterpretation) &&
6334 ((FormatElementSize(pCreateInfo->format, VK_IMAGE_ASPECT_COLOR_BIT) !=
6335 FormatElementSize(image_state->createInfo.format, VK_IMAGE_ASPECT_COLOR_BIT)) ||
sfricke-samsunged028b02021-09-06 23:14:51 -07006336 (FormatComponentCount(pCreateInfo->format) != FormatComponentCount(image_state->createInfo.format)))) {
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07006337 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatReinterpretation-04466",
6338 "vkCreateImageView (portability error): ImageView format must have"
6339 " the same number of components and bits per component as the Image's format");
6340 }
6341 }
Tony-LunarG69604c42021-11-22 16:00:12 -07006342
6343 auto image_view_min_lod = LvlFindInChain<VkImageViewMinLodCreateInfoEXT>(pCreateInfo->pNext);
6344 if (image_view_min_lod) {
6345 if ((!enabled_features.image_view_min_lod_features.minLod) && (image_view_min_lod->minLod != 0)) {
6346 skip |= LogError(device, "VUID-VkImageViewMinLodCreateInfoEXT-minLod-06455",
6347 "vkCreateImageView(): VkImageViewMinLodCreateInfoEXT::minLod = %f, but the minLod feature is not "
6348 "enabled. If the minLod feature is not enabled, minLod must be 0.0",
6349 image_view_min_lod->minLod);
6350 }
6351 auto max_level = (pCreateInfo->subresourceRange.baseMipLevel + (pCreateInfo->subresourceRange.levelCount - 1));
6352 if (image_view_min_lod->minLod > max_level) {
6353 skip |= LogError(device, "VUID-VkImageViewMinLodCreateInfoEXT-minLod-06456",
6354 "vkCreateImageView(): minLod (%f) must be less or equal to the index of the last mipmap level "
6355 "accessible to the view (%" PRIu32 ")",
6356 image_view_min_lod->minLod, max_level);
6357 }
6358 }
sfricke-samsung0dae8952022-03-03 20:34:23 -06006359
6360 if (FormatRequiresYcbcrConversionExplicitly(view_format)) {
6361 const auto ycbcr_conversion = LvlFindInChain<VkSamplerYcbcrConversionInfo>(pCreateInfo->pNext);
6362 if (!ycbcr_conversion || ycbcr_conversion->conversion == VK_NULL_HANDLE) {
6363 skip |= LogError(
6364 device, "VUID-VkImageViewCreateInfo-format-06415",
6365 "vkCreateImageView(): Format %s requires a VkSamplerYcbcrConversion but one was not passed in the pNext chain.",
6366 string_VkFormat(view_format));
6367 }
6368 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07006369 }
6370 return skip;
6371}
6372
Jeff Leger178b1e52020-10-05 12:22:23 -04006373template <typename RegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006374bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
Tony-LunarGef035472021-11-02 10:23:33 -06006375 uint32_t regionCount, const RegionType *pRegions, CMD_TYPE cmd_type) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006376 bool skip = false;
Tony-LunarGef035472021-11-02 10:23:33 -06006377 const bool is_2 = (cmd_type == CMD_COPYBUFFER2KHR || cmd_type == CMD_COPYBUFFER2);
6378 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04006379 const char *vuid;
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006380
6381 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
6382 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
Aitor Camacho2542b9d2022-06-01 18:37:49 +02006383 bool are_buffers_sparse = src_buffer_state->sparse || dst_buffer_state->sparse;
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006384
6385 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006386 const RegionType region = pRegions[i];
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006387
6388 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
sfricke-samsung71f04e32022-03-16 01:21:21 -05006389 if (region.srcOffset >= src_buffer_size) {
Tony-LunarGef035472021-11-02 10:23:33 -06006390 vuid = is_2 ? "VUID-VkCopyBufferInfo2-srcOffset-00113" : "VUID-vkCmdCopyBuffer-srcOffset-00113";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006391 skip |= LogError(src_buffer_state->buffer(), vuid,
ziga-lunargd6b58ce2021-10-16 01:22:56 +02006392 "%s: pRegions[%" PRIu32 "].srcOffset (%" PRIuLEAST64
6393 ") is greater than size of srcBuffer (%" PRIuLEAST64 ").",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006394 func_name, i, region.srcOffset, src_buffer_size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006395 }
6396
6397 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
sfricke-samsung71f04e32022-03-16 01:21:21 -05006398 if (region.dstOffset >= dst_buffer_size) {
Tony-LunarGef035472021-11-02 10:23:33 -06006399 vuid = is_2 ? "VUID-VkCopyBufferInfo2-dstOffset-00114" : "VUID-vkCmdCopyBuffer-dstOffset-00114";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006400 skip |= LogError(dst_buffer_state->buffer(), vuid,
ziga-lunargd6b58ce2021-10-16 01:22:56 +02006401 "%s: pRegions[%" PRIu32 "].dstOffset (%" PRIuLEAST64
6402 ") is greater than size of dstBuffer (%" PRIuLEAST64 ").",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006403 func_name, i, region.dstOffset, dst_buffer_size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006404 }
6405
6406 // 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 -05006407 if (region.size > (src_buffer_size - region.srcOffset)) {
Tony-LunarGef035472021-11-02 10:23:33 -06006408 vuid = is_2 ? "VUID-VkCopyBufferInfo2-size-00115" : "VUID-vkCmdCopyBuffer-size-00115";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006409 skip |= LogError(src_buffer_state->buffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006410 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the source buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006411 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006412 func_name, i, region.size, src_buffer_size, i, region.srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006413 }
6414
6415 // 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 -05006416 if (region.size > (dst_buffer_size - region.dstOffset)) {
Tony-LunarGef035472021-11-02 10:23:33 -06006417 vuid = is_2 ? "VUID-VkCopyBufferInfo2-size-00116" : "VUID-vkCmdCopyBuffer-size-00116";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006418 skip |= LogError(dst_buffer_state->buffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006419 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the destination buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006420 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006421 func_name, i, region.size, dst_buffer_size, i, region.dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006422 }
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006423
ziga-lunargb94ff002022-03-23 23:30:19 +01006424 // The union of the source regions, and the union of the destination regions, must not overlap in memory
Aitor Camacho2542b9d2022-06-01 18:37:49 +02006425 if (!skip && !are_buffers_sparse) {
6426 auto src_region = sparse_container::range<VkDeviceSize>{region.srcOffset, region.srcOffset + region.size};
aitor-lunarg26fbbc22022-04-22 18:42:08 +02006427 for (uint32_t j = 0; j < regionCount; j++) {
Aitor Camacho2542b9d2022-06-01 18:37:49 +02006428 auto dst_region =
6429 sparse_container::range<VkDeviceSize>{pRegions[j].dstOffset, pRegions[j].dstOffset + pRegions[j].size};
6430 if (src_buffer_state->DoesResourceMemoryOverlap(src_region, dst_buffer_state, dst_region)) {
aitor-lunarg26fbbc22022-04-22 18:42:08 +02006431 vuid = is_2 ? "VUID-VkCopyBufferInfo2-pRegions-00117" : "VUID-vkCmdCopyBuffer-pRegions-00117";
6432 skip |= LogError(src_buffer_state->buffer(), vuid,
6433 "%s: Detected overlap between source and dest regions in memory.", func_name);
6434 }
ziga-lunargb94ff002022-03-23 23:30:19 +01006435 }
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006436 }
6437 }
6438
6439 return skip;
6440}
sfricke-samsung11813ab2021-10-20 14:53:37 -07006441template <typename RegionType>
6442bool CoreChecks::ValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer, uint32_t regionCount,
Tony-LunarGef035472021-11-02 10:23:33 -06006443 const RegionType *pRegions, CMD_TYPE cmd_type) const {
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07006444 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07006445 auto src_buffer_state = Get<BUFFER_STATE>(srcBuffer);
6446 auto dst_buffer_state = Get<BUFFER_STATE>(dstBuffer);
Tony-LunarGef035472021-11-02 10:23:33 -06006447 const bool is_2 = (cmd_type == CMD_COPYBUFFER2KHR || cmd_type == CMD_COPYBUFFER2);
sfricke-samsung11813ab2021-10-20 14:53:37 -07006448 const char *func_name = CommandTypeString(cmd_type);
6449 const char *vuid;
6450
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006451 bool skip = false;
Tony-LunarGef035472021-11-02 10:23:33 -06006452 vuid = is_2 ? "VUID-VkCopyBufferInfo2-srcBuffer-00119" : "VUID-vkCmdCopyBuffer-srcBuffer-00119";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006453 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state.get(), func_name, vuid);
Tony-LunarGef035472021-11-02 10:23:33 -06006454 vuid = is_2 ? "VUID-VkCopyBufferInfo2-dstBuffer-00121" : "VUID-vkCmdCopyBuffer-dstBuffer-00121";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006455 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state.get(), func_name, vuid);
sfricke-samsung11813ab2021-10-20 14:53:37 -07006456
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006457 // Validate that SRC & DST buffers have correct usage flags set
Tony-LunarGef035472021-11-02 10:23:33 -06006458 vuid = is_2 ? "VUID-VkCopyBufferInfo2-srcBuffer-00118" : "VUID-vkCmdCopyBuffer-srcBuffer-00118";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006459 skip |= ValidateBufferUsageFlags(src_buffer_state.get(), VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
sfricke-samsung11813ab2021-10-20 14:53:37 -07006460 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Tony-LunarGef035472021-11-02 10:23:33 -06006461 vuid = is_2 ? "VUID-VkCopyBufferInfo2-dstBuffer-00120" : "VUID-vkCmdCopyBuffer-dstBuffer-00120";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006462 skip |= ValidateBufferUsageFlags(dst_buffer_state.get(), VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
sfricke-samsung11813ab2021-10-20 14:53:37 -07006463 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
6464
Jeremy Gebben9f537102021-10-05 16:37:12 -06006465 skip |= ValidateCmd(cb_node.get(), cmd_type);
Tony-LunarGef035472021-11-02 10:23:33 -06006466 skip |= ValidateCmdCopyBufferBounds(src_buffer_state.get(), dst_buffer_state.get(), regionCount, pRegions, cmd_type);
sfricke-samsung11813ab2021-10-20 14:53:37 -07006467
Tony-LunarGef035472021-11-02 10:23:33 -06006468 vuid = is_2 ? "VUID-vkCmdCopyBuffer2-commandBuffer-01822" : "VUID-vkCmdCopyBuffer-commandBuffer-01822";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006469 skip |= ValidateProtectedBuffer(cb_node.get(), src_buffer_state.get(), func_name, vuid);
Tony-LunarGef035472021-11-02 10:23:33 -06006470 vuid = is_2 ? "VUID-vkCmdCopyBuffer2-commandBuffer-01823" : "VUID-vkCmdCopyBuffer-commandBuffer-01823";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006471 skip |= ValidateProtectedBuffer(cb_node.get(), dst_buffer_state.get(), func_name, vuid);
Tony-LunarGef035472021-11-02 10:23:33 -06006472 vuid = is_2 ? "VUID-vkCmdCopyBuffer2-commandBuffer-01824" : "VUID-vkCmdCopyBuffer-commandBuffer-01824";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006473 skip |= ValidateUnprotectedBuffer(cb_node.get(), dst_buffer_state.get(), func_name, vuid);
Tony-LunarGef035472021-11-02 10:23:33 -06006474
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006475 return skip;
6476}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07006477
sfricke-samsung11813ab2021-10-20 14:53:37 -07006478bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
6479 uint32_t regionCount, const VkBufferCopy *pRegions) const {
Tony-LunarGef035472021-11-02 10:23:33 -06006480 return ValidateCmdCopyBuffer(commandBuffer, srcBuffer, dstBuffer, regionCount, pRegions, CMD_COPYBUFFER);
sfricke-samsung11813ab2021-10-20 14:53:37 -07006481}
6482
Jeff Leger178b1e52020-10-05 12:22:23 -04006483bool CoreChecks::PreCallValidateCmdCopyBuffer2KHR(VkCommandBuffer commandBuffer,
6484 const VkCopyBufferInfo2KHR *pCopyBufferInfos) const {
sfricke-samsung11813ab2021-10-20 14:53:37 -07006485 return ValidateCmdCopyBuffer(commandBuffer, pCopyBufferInfos->srcBuffer, pCopyBufferInfos->dstBuffer,
Tony-LunarGef035472021-11-02 10:23:33 -06006486 pCopyBufferInfos->regionCount, pCopyBufferInfos->pRegions, CMD_COPYBUFFER2KHR);
6487}
6488
6489bool CoreChecks::PreCallValidateCmdCopyBuffer2(VkCommandBuffer commandBuffer, const VkCopyBufferInfo2 *pCopyBufferInfos) const {
6490 return ValidateCmdCopyBuffer(commandBuffer, pCopyBufferInfos->srcBuffer, pCopyBufferInfos->dstBuffer,
6491 pCopyBufferInfos->regionCount, pCopyBufferInfos->pRegions, CMD_COPYBUFFER2);
Jeff Leger178b1e52020-10-05 12:22:23 -04006492}
6493
Aitor Camacho2542b9d2022-06-01 18:37:49 +02006494template <typename RegionType>
6495void CoreChecks::RecordCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer, uint32_t regionCount,
6496 const RegionType *pRegions, CMD_TYPE cmd_type) {
6497 const bool is_2 = (cmd_type == CMD_COPYBUFFER2KHR || cmd_type == CMD_COPYBUFFER2);
6498 const char *func_name = CommandTypeString(cmd_type);
6499 const char *vuid = is_2 ? "VUID-VkCopyBufferInfo2-pRegions-00117" : "VUID-vkCmdCopyBuffer-pRegions-00117";
6500
6501 auto src_buffer_state = Get<BUFFER_STATE>(srcBuffer);
6502 auto dst_buffer_state = Get<BUFFER_STATE>(dstBuffer);
6503 if (src_buffer_state->sparse || dst_buffer_state->sparse) {
6504 auto cb_node = Get<CMD_BUFFER_STATE>(commandBuffer);
6505
6506 std::vector<sparse_container::range<VkDeviceSize>> src_ranges;
6507 std::vector<sparse_container::range<VkDeviceSize>> dst_ranges;
6508
6509 for (uint32_t i = 0u; i < regionCount; ++i) {
6510 const RegionType &region = pRegions[i];
6511 src_ranges.emplace_back(sparse_container::range<VkDeviceSize>{region.srcOffset, region.srcOffset + region.size});
6512 dst_ranges.emplace_back(sparse_container::range<VkDeviceSize>{region.dstOffset, region.dstOffset + region.size});
6513 }
6514
6515 auto queue_submit_validation = [this, src_buffer_state, dst_buffer_state, src_ranges, dst_ranges, vuid, func_name](
6516 const ValidationStateTracker &device_data, const class QUEUE_STATE &queue_state,
6517 const CMD_BUFFER_STATE &cb_state) -> bool {
6518 bool skip = false;
6519 for (const auto &src : src_ranges) {
6520 for (const auto &dst : dst_ranges) {
6521 if (src_buffer_state->DoesResourceMemoryOverlap(src, dst_buffer_state.get(), dst)) {
6522 skip |= this->LogError(src_buffer_state->buffer(), vuid,
6523 "%s: Detected overlap between source and dest regions in memory.", func_name);
6524 }
6525 }
6526 }
6527
6528 return skip;
6529 };
6530
6531 cb_node->queue_submit_functions.emplace_back(queue_submit_validation);
6532 }
6533}
6534
6535void CoreChecks::PreCallRecordCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
6536 uint32_t regionCount, const VkBufferCopy *pRegions) {
6537 RecordCmdCopyBuffer(commandBuffer, srcBuffer, dstBuffer, regionCount, pRegions, CMD_COPYBUFFER);
6538}
6539
6540void CoreChecks::PreCallRecordCmdCopyBuffer2KHR(VkCommandBuffer commandBuffer, const VkCopyBufferInfo2KHR *pCopyBufferInfos) {
6541 RecordCmdCopyBuffer(commandBuffer, pCopyBufferInfos->srcBuffer, pCopyBufferInfos->dstBuffer, pCopyBufferInfos->regionCount,
6542 pCopyBufferInfos->pRegions, CMD_COPYBUFFER2KHR);
6543}
6544
6545void CoreChecks::PreCallRecordCmdCopyBuffer2(VkCommandBuffer commandBuffer, const VkCopyBufferInfo2 *pCopyBufferInfos) {
6546 RecordCmdCopyBuffer(commandBuffer, pCopyBufferInfos->srcBuffer, pCopyBufferInfos->dstBuffer, pCopyBufferInfos->regionCount,
6547 pCopyBufferInfos->pRegions, CMD_COPYBUFFER2);
6548}
6549
Jeff Bolz5c801d12019-10-09 10:38:45 -05006550bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
6551 const VkAllocationCallbacks *pAllocator) const {
Jeremy Gebbenf4449392022-01-28 10:09:10 -07006552 auto image_view_state = Get<IMAGE_VIEW_STATE>(imageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07006553
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006554 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07006555 if (image_view_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06006556 skip |= ValidateObjectNotInUse(image_view_state.get(), "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006557 }
6558 return skip;
6559}
6560
Jeff Bolz5c801d12019-10-09 10:38:45 -05006561bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Jeremy Gebben8afa7162022-08-03 19:29:10 -06006562 auto buffer_state = Get<BUFFER_STATE>(buffer);
6563
6564 bool skip = false;
6565 if (buffer_state) {
6566 skip |= ValidateObjectNotInUse(buffer_state.get(), "vkDestroyBuffer", "VUID-vkDestroyBuffer-buffer-00922");
6567 }
6568 return skip;
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006569}
6570
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006571bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006572 const VkAllocationCallbacks *pAllocator) const {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006573 auto buffer_view_state = Get<BUFFER_VIEW_STATE>(bufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006574 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07006575 if (buffer_view_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06006576 skip |= ValidateObjectNotInUse(buffer_view_state.get(), "vkDestroyBufferView", "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006577 }
6578 return skip;
6579}
6580
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006581bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006582 VkDeviceSize size, uint32_t data) const {
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07006583 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006584 auto buffer_state = Get<BUFFER_STATE>(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006585 bool skip = false;
Jeremy Gebben9f537102021-10-05 16:37:12 -06006586 skip |= ValidateMemoryIsBoundToBuffer(buffer_state.get(), "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
6587 skip |= ValidateCmd(cb_node.get(), CMD_FILLBUFFER);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006588 // Validate that DST buffer has correct usage flags set
Jeremy Gebben9f537102021-10-05 16:37:12 -06006589 skip |=
6590 ValidateBufferUsageFlags(buffer_state.get(), VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
6591 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006592
Jeremy Gebben9f537102021-10-05 16:37:12 -06006593 skip |=
6594 ValidateProtectedBuffer(cb_node.get(), buffer_state.get(), "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01811");
6595 skip |= ValidateUnprotectedBuffer(cb_node.get(), buffer_state.get(), "vkCmdFillBuffer()",
6596 "VUID-vkCmdFillBuffer-commandBuffer-01812");
sfricke-samsung022fa252020-07-24 03:26:16 -07006597
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006598 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006599 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
6600 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
6601 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
6602 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006603 }
6604
6605 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006606 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
6607 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
6608 ") minus dstOffset (0x%" PRIxLEAST64 ").",
6609 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006610 }
6611
sfricke-samsung45996a42021-09-16 13:45:27 -07006612 if (!IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06006613 skip |= ValidateCmdQueueFlags(cb_node.get(), "vkCmdFillBuffer()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
ziga-lunarg3c5c84e2021-08-04 15:18:56 +02006614 "VUID-vkCmdFillBuffer-commandBuffer-00030");
6615 }
6616
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006617 return skip;
6618}
6619
sfricke-samsung71f04e32022-03-16 01:21:21 -05006620template <typename RegionType>
6621bool CoreChecks::ValidateBufferImageCopyData(const CMD_BUFFER_STATE *cb_node, uint32_t regionCount, const RegionType *pRegions,
6622 const IMAGE_STATE *image_state, const char *function, CMD_TYPE cmd_type,
6623 bool image_to_buffer) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006624 bool skip = false;
Tony Barbour845d29b2021-11-09 11:43:14 -07006625 const bool is_2 = (cmd_type == CMD_COPYBUFFERTOIMAGE2KHR || cmd_type == CMD_COPYBUFFERTOIMAGE2);
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07006626 const char *vuid;
Jeff Leger178b1e52020-10-05 12:22:23 -04006627
sfricke-samsung125d2b42020-05-28 06:32:43 -07006628 assert(image_state != nullptr);
6629 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006630
6631 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006632 const RegionType region = pRegions[i];
6633 const VkImageAspectFlags region_aspect_mask = region.imageSubresource.aspectMask;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006634 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006635 if ((region.imageOffset.y != 0) || (region.imageExtent.height != 1)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006636 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00199", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006637 "%s: pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
6638 "and 1, respectively.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006639 function, i, region.imageOffset.y, region.imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006640 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006641 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006642
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006643 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006644 if ((region.imageOffset.z != 0) || (region.imageExtent.depth != 1)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006645 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00201", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006646 "%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 -07006647 "must be 0 and 1, respectively.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006648 function, i, region.imageOffset.z, region.imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006649 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006650 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006651
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006652 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006653 if ((0 != region.imageSubresource.baseArrayLayer) || (1 != region.imageSubresource.layerCount)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006654 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00213", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006655 "%s: pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006656 "For 3D images these must be 0 and 1, respectively.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006657 function, i, region.imageSubresource.baseArrayLayer, region.imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006658 }
6659 }
6660
6661 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07006662 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
sfricke-samsung73e755c2021-09-30 08:34:57 -07006663 const uint32_t element_size =
6664 FormatIsDepthOrStencil(image_format) ? 0 : FormatElementSize(image_format, region_aspect_mask);
sfricke-samsung71f04e32022-03-16 01:21:21 -05006665 const VkDeviceSize bufferOffset = region.bufferOffset;
Locke497739c2019-03-08 11:50:47 -07006666
sfricke-samsung8feecc12021-01-23 03:28:38 -08006667 if (FormatIsDepthOrStencil(image_format)) {
6668 if (SafeModulo(bufferOffset, 4) != 0) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006669 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("04053", image_to_buffer, is_2),
sfricke-samsung8feecc12021-01-23 03:28:38 -08006670 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6671 " must be a multiple 4 if using a depth/stencil format (%s).",
6672 function, i, bufferOffset, string_VkFormat(image_format));
6673 }
6674 } else {
6675 // If not depth/stencil and not multi-plane
6676 if (!FormatIsMultiplane(image_format) && (SafeModulo(bufferOffset, element_size) != 0)) {
sfricke-samsung45996a42021-09-16 13:45:27 -07006677 vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
Tony Barbour845d29b2021-11-09 11:43:14 -07006678 ? GetBufferImageCopyCommandVUID("01558", image_to_buffer, is_2)
6679 : GetBufferImageCopyCommandVUID("00193", image_to_buffer, is_2);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006680 skip |= LogError(image_state->image(), vuid,
sfricke-samsung8feecc12021-01-23 03:28:38 -08006681 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6682 " must be a multiple of this format's texel size (%" PRIu32 ").",
6683 function, i, bufferOffset, element_size);
6684 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006685 }
6686
sfricke-samsung5f11b0e2022-03-22 14:12:15 -05006687 // Make sure not a empty region
6688 if (region.imageExtent.width == 0) {
6689 vuid = is_2 ? "VUID-VkBufferImageCopy2-imageExtent-06659" : "VUID-VkBufferImageCopy-imageExtent-06659";
6690 LogObjectList objlist(cb_node->commandBuffer());
6691 objlist.add(image_state->image());
6692 skip |=
6693 LogError(objlist, vuid, "%s: pRegion[%" PRIu32 "] extent.width must not be zero as empty copies are not allowed.",
6694 function, i);
6695 }
6696 if (region.imageExtent.height == 0) {
6697 vuid = is_2 ? "VUID-VkBufferImageCopy2-imageExtent-06660" : "VUID-VkBufferImageCopy-imageExtent-06660";
6698 LogObjectList objlist(cb_node->commandBuffer());
6699 objlist.add(image_state->image());
6700 skip |=
6701 LogError(objlist, vuid, "%s: pRegion[%" PRIu32 "] extent.height must not be zero as empty copies are not allowed.",
6702 function, i);
6703 }
6704 if (region.imageExtent.depth == 0) {
6705 vuid = is_2 ? "VUID-VkBufferImageCopy2-imageExtent-06661" : "VUID-VkBufferImageCopy-imageExtent-06661";
6706 LogObjectList objlist(cb_node->commandBuffer());
6707 objlist.add(image_state->image());
6708 skip |=
6709 LogError(objlist, vuid, "%s: pRegion[%" PRIu32 "] extent.depth must not be zero as empty copies are not allowed.",
6710 function, i);
6711 }
6712
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006713 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
sfricke-samsung71f04e32022-03-16 01:21:21 -05006714 if ((region.bufferRowLength != 0) && (region.bufferRowLength < region.imageExtent.width)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006715 vuid = (is_2) ? "VUID-VkBufferImageCopy2-bufferRowLength-00195" : "VUID-VkBufferImageCopy-bufferRowLength-00195";
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06006716 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006717 LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006718 "%s: pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006719 function, i, region.bufferRowLength, region.imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006720 }
6721
6722 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
sfricke-samsung71f04e32022-03-16 01:21:21 -05006723 if ((region.bufferImageHeight != 0) && (region.bufferImageHeight < region.imageExtent.height)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006724 vuid = (is_2) ? "VUID-VkBufferImageCopy2-bufferImageHeight-00196" : "VUID-VkBufferImageCopy-bufferImageHeight-00196";
Jeff Leger178b1e52020-10-05 12:22:23 -04006725 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006726 LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006727 "%s: pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006728 function, i, region.bufferImageHeight, region.imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006729 }
6730
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006731 // Calculate adjusted image extent, accounting for multiplane image factors
sfricke-samsung71f04e32022-03-16 01:21:21 -05006732 VkExtent3D adjusted_image_extent = image_state->GetSubresourceExtent(region.imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006733 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
sfricke-samsung71f04e32022-03-16 01:21:21 -05006734 if ((region.imageOffset.x < 0) || (region.imageOffset.x > static_cast<int32_t>(adjusted_image_extent.width)) ||
6735 ((region.imageOffset.x + static_cast<int32_t>(region.imageExtent.width)) >
Mark Lobodzinski72b1a222020-03-18 11:36:10 -06006736 static_cast<int32_t>(adjusted_image_extent.width))) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006737 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00197", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006738 "%s: Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006739 "zero or <= image subresource width (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006740 function, i, region.imageOffset.x, (region.imageOffset.x + region.imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006741 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006742 }
6743
6744 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
sfricke-samsung71f04e32022-03-16 01:21:21 -05006745 if ((region.imageOffset.y < 0) || (region.imageOffset.y > static_cast<int32_t>(adjusted_image_extent.height)) ||
6746 ((region.imageOffset.y + static_cast<int32_t>(region.imageExtent.height)) >
Mark Lobodzinski72b1a222020-03-18 11:36:10 -06006747 static_cast<int32_t>(adjusted_image_extent.height))) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006748 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00198", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006749 "%s: Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006750 "zero or <= image subresource height (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006751 function, i, region.imageOffset.y, (region.imageOffset.y + region.imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006752 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006753 }
6754
6755 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
sfricke-samsung71f04e32022-03-16 01:21:21 -05006756 if ((region.imageOffset.z < 0) || (region.imageOffset.z > static_cast<int32_t>(adjusted_image_extent.depth)) ||
6757 ((region.imageOffset.z + static_cast<int32_t>(region.imageExtent.depth)) >
Mark Lobodzinski72b1a222020-03-18 11:36:10 -06006758 static_cast<int32_t>(adjusted_image_extent.depth))) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006759 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00200", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006760 "%s: Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006761 "zero or <= image subresource depth (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006762 function, i, region.imageOffset.z, (region.imageOffset.z + region.imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006763 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006764 }
6765
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006766 // subresource aspectMask must have exactly 1 bit set
6767 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
sfricke-samsung125d2b42020-05-28 06:32:43 -07006768 std::bitset<num_bits> aspect_mask_bits(region_aspect_mask);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006769 if (aspect_mask_bits.count() != 1) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006770 vuid = (is_2) ? "VUID-VkBufferImageCopy2-aspectMask-00212" : "VUID-VkBufferImageCopy-aspectMask-00212";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006771 skip |= LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006772 "%s: aspectMasks for imageSubresource in pRegion[%d] must have only a single bit set.", function, i);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006773 }
6774
6775 // image subresource aspect bit must match format
sfricke-samsung125d2b42020-05-28 06:32:43 -07006776 if (!VerifyAspectsPresent(region_aspect_mask, image_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006777 skip |=
Tony Barbour845d29b2021-11-09 11:43:14 -07006778 LogError(image_state->image(), GetBufferImageCopyCommandVUID("00211", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006779 "%s: pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
6780 function, i, region_aspect_mask, image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006781 }
6782
6783 // Checks that apply only to compressed images
sfricke-samsung01da6312021-10-20 07:51:32 -07006784 if (FormatIsBlockedImage(image_format)) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006785 auto block_size = FormatTexelBlockExtent(image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006786
6787 // BufferRowLength must be a multiple of block width
sfricke-samsung71f04e32022-03-16 01:21:21 -05006788 if (SafeModulo(region.bufferRowLength, block_size.width) != 0) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006789 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00203", image_to_buffer, is_2),
sfricke-samsung01da6312021-10-20 07:51:32 -07006790 "%s: pRegion[%d] bufferRowLength (%d) must be a multiple of the blocked image's texel width (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006791 function, i, region.bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006792 }
6793
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006794 // BufferRowHeight must be a multiple of block height
sfricke-samsung71f04e32022-03-16 01:21:21 -05006795 if (SafeModulo(region.bufferImageHeight, block_size.height) != 0) {
sfricke-samsung01da6312021-10-20 07:51:32 -07006796 skip |=
Tony Barbour845d29b2021-11-09 11:43:14 -07006797 LogError(image_state->image(), GetBufferImageCopyCommandVUID("00204", image_to_buffer, is_2),
sfricke-samsung01da6312021-10-20 07:51:32 -07006798 "%s: pRegion[%d] bufferImageHeight (%d) must be a multiple of the blocked image's texel height (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006799 function, i, region.bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006800 }
6801
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006802 // image offsets must be multiples of block dimensions
sfricke-samsung71f04e32022-03-16 01:21:21 -05006803 if ((SafeModulo(region.imageOffset.x, block_size.width) != 0) ||
6804 (SafeModulo(region.imageOffset.y, block_size.height) != 0) ||
6805 (SafeModulo(region.imageOffset.z, block_size.depth) != 0)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006806 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00205", image_to_buffer, is_2),
sfricke-samsung01da6312021-10-20 07:51:32 -07006807 "%s: pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the blocked image's texel "
Petr Krausb0d5e592021-05-21 23:37:11 +02006808 "width & height (%d, %d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006809 function, i, region.imageOffset.x, region.imageOffset.y, block_size.width, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006810 }
6811
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006812 // bufferOffset must be a multiple of block size (linear bytes)
sfricke-samsung73e755c2021-09-30 08:34:57 -07006813 if (SafeModulo(bufferOffset, element_size) != 0) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006814 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00206", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006815 "%s: pRegion[%d] bufferOffset (0x%" PRIxLEAST64
sfricke-samsung01da6312021-10-20 07:51:32 -07006816 ") must be a multiple of the blocked image's texel block size (%" PRIu32 ").",
sfricke-samsung73e755c2021-09-30 08:34:57 -07006817 function, i, bufferOffset, element_size);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006818 }
Dave Houlton67e9b532017-03-02 17:00:10 -07006819
6820 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
sfricke-samsung71f04e32022-03-16 01:21:21 -05006821 VkExtent3D mip_extent = image_state->GetSubresourceExtent(region.imageSubresource);
6822 if ((SafeModulo(region.imageExtent.width, block_size.width) != 0) &&
6823 (region.imageExtent.width + region.imageOffset.x != mip_extent.width)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006824 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00207", image_to_buffer, is_2),
sfricke-samsung01da6312021-10-20 07:51:32 -07006825 "%s: pRegion[%d] extent width (%d) must be a multiple of the blocked texture block width "
Petr Krausb0d5e592021-05-21 23:37:11 +02006826 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006827 function, i, region.imageExtent.width, block_size.width, region.imageOffset.x, mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07006828 }
6829
6830 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
sfricke-samsung71f04e32022-03-16 01:21:21 -05006831 if ((SafeModulo(region.imageExtent.height, block_size.height) != 0) &&
6832 (region.imageExtent.height + region.imageOffset.y != mip_extent.height)) {
6833 skip |=
6834 LogError(image_state->image(), GetBufferImageCopyCommandVUID("00208", image_to_buffer, is_2),
6835 "%s: pRegion[%d] extent height (%d) must be a multiple of the blocked texture block height "
6836 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d).",
6837 function, i, region.imageExtent.height, block_size.height, region.imageOffset.y, mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07006838 }
6839
6840 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
sfricke-samsung71f04e32022-03-16 01:21:21 -05006841 if ((SafeModulo(region.imageExtent.depth, block_size.depth) != 0) &&
6842 (region.imageExtent.depth + region.imageOffset.z != mip_extent.depth)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006843 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00209", image_to_buffer, is_2),
sfricke-samsung01da6312021-10-20 07:51:32 -07006844 "%s: pRegion[%d] extent width (%d) must be a multiple of the blocked texture block depth "
Petr Krausb0d5e592021-05-21 23:37:11 +02006845 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006846 function, i, region.imageExtent.depth, block_size.depth, region.imageOffset.z, mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07006847 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006848 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08006849
6850 // Checks that apply only to multi-planar format images
sfricke-samsung125d2b42020-05-28 06:32:43 -07006851 if (FormatIsMultiplane(image_format)) {
sfricke-samsung552d5e12020-01-07 22:00:20 -08006852 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
sfricke-samsung125d2b42020-05-28 06:32:43 -07006853 if ((FormatPlaneCount(image_format) < 3) && (region_aspect_mask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006854 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006855 "%s: pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006856 "format has three planes.",
6857 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08006858 }
6859
6860 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
sfricke-samsung125d2b42020-05-28 06:32:43 -07006861 if (0 ==
6862 (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 -07006863 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006864 "%s: pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006865 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
6866 function, i);
sfricke-samsung125d2b42020-05-28 06:32:43 -07006867 } else {
6868 // Know aspect mask is valid
6869 const VkFormat compatible_format = FindMultiplaneCompatibleFormat(image_format, region_aspect_mask);
6870 const uint32_t compatible_size = FormatElementSize(compatible_format);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006871 if (SafeModulo(bufferOffset, compatible_size) != 0) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006872 skip |= LogError(
Tony Barbour845d29b2021-11-09 11:43:14 -07006873 image_state->image(), GetBufferImageCopyCommandVUID("01559", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006874 "%s: pRegion[%d]->bufferOffset is 0x%" PRIxLEAST64
sfricke-samsung125d2b42020-05-28 06:32:43 -07006875 " 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 -08006876 function, i, bufferOffset, element_size, GetPlaneIndex(region_aspect_mask),
sfricke-samsung125d2b42020-05-28 06:32:43 -07006877 string_VkFormat(compatible_format));
6878 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08006879 }
6880 }
sfricke-samsung8feecc12021-01-23 03:28:38 -08006881
6882 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
Jeremy Gebbencd7fa282021-10-27 10:25:32 -06006883 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool;
sfricke-samsung8feecc12021-01-23 03:28:38 -08006884 assert(command_pool != nullptr);
6885 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006886 const VkQueueFlags queue_flags = physical_device_state->queue_family_properties[queue_family_index].queueFlags;
sfricke-samsung8feecc12021-01-23 03:28:38 -08006887 if (((queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT)) == 0) && (SafeModulo(bufferOffset, 4) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006888 LogObjectList objlist(cb_node->commandBuffer());
6889 objlist.add(command_pool->commandPool());
sfricke-samsung4389faa2022-03-23 01:19:42 -05006890 objlist.add(image_state->image());
6891 skip |= LogError(objlist, GetBufferImageCopyCommandVUID("04052", image_to_buffer, is_2),
sfricke-samsung8feecc12021-01-23 03:28:38 -08006892 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6893 " must be a multiple 4 because the command buffer %s was allocated from the command pool %s "
6894 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT or "
6895 "VK_QUEUE_COMPUTE_BIT flag.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006896 function, i, bufferOffset, report_data->FormatHandle(cb_node->commandBuffer()).c_str(),
6897 report_data->FormatHandle(command_pool->commandPool()).c_str(), queue_family_index);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006898 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006899 }
6900
6901 return skip;
6902}
6903
sfricke-samsung71f04e32022-03-16 01:21:21 -05006904template <typename RegionType>
6905bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount, const RegionType *pRegions,
6906 const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006907 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006908 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006909
6910 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006911 const RegionType region = pRegions[i];
6912 VkExtent3D extent = region.imageExtent;
6913 VkOffset3D offset = region.imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006914
sfricke-samsung71f04e32022-03-16 01:21:21 -05006915 VkExtent3D image_extent = image_state->GetSubresourceExtent(region.imageSubresource);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006916
sfricke-samsung01da6312021-10-20 07:51:32 -07006917 // If we're using a blocked image format, valid extent is rounded up to multiple of block size (per
6918 // vkspec.html#_common_operation)
6919 if (FormatIsBlockedImage(image_info->format)) {
Dave Houltona585d132019-01-18 13:05:42 -07006920 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006921 if (image_extent.width % block_extent.width) {
6922 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
6923 }
6924 if (image_extent.height % block_extent.height) {
6925 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
6926 }
6927 if (image_extent.depth % block_extent.depth) {
6928 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
6929 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006930 }
6931
Dave Houltonfc1a4052017-04-27 14:32:45 -06006932 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Petr Krausb0d5e592021-05-21 23:37:11 +02006933 skip |= LogError(image_state->image(), msg_code, "%s: pRegion[%d] exceeds image bounds.", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006934 }
6935 }
6936
6937 return skip;
6938}
6939
sfricke-samsung71f04e32022-03-16 01:21:21 -05006940template <typename RegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006941bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
sfricke-samsung71f04e32022-03-16 01:21:21 -05006942 const RegionType *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006943 bool skip = false;
6944
sfricke-samsung11d15ba2021-09-30 09:19:56 -07006945 const VkDeviceSize buffer_size = buff_state->createInfo.size;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006946
6947 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006948 const RegionType region = pRegions[i];
6949 const VkDeviceSize buffer_copy_size = GetBufferSizeFromCopyImage(region, image_state->createInfo.format);
sfricke-samsung11d15ba2021-09-30 09:19:56 -07006950 // This blocks against invalid VkBufferCopyImage that already have been caught elsewhere
6951 if (buffer_copy_size != 0) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006952 const VkDeviceSize max_buffer_copy = buffer_copy_size + region.bufferOffset;
sfricke-samsung11d15ba2021-09-30 09:19:56 -07006953 if (buffer_size < max_buffer_copy) {
6954 skip |= LogError(device, msg_code,
6955 "%s: pRegion[%" PRIu32 "] is trying to copy %" PRIu64 " bytes plus %" PRIu64
6956 " offset to/from the VkBuffer (%s) which exceeds the VkBuffer total size of %" PRIu64 " bytes.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006957 func_name, i, buffer_copy_size, region.bufferOffset,
sfricke-samsung11d15ba2021-09-30 09:19:56 -07006958 report_data->FormatHandle(buff_state->buffer()).c_str(), buffer_size);
6959 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006960 }
6961 }
6962
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006963 return skip;
6964}
6965
sfricke-samsung71f04e32022-03-16 01:21:21 -05006966template <typename RegionType>
Jeff Leger178b1e52020-10-05 12:22:23 -04006967bool CoreChecks::ValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
sfricke-samsung71f04e32022-03-16 01:21:21 -05006968 VkBuffer dstBuffer, uint32_t regionCount, const RegionType *pRegions,
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006969
6970 CMD_TYPE cmd_type) const {
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07006971 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07006972 auto src_image_state = Get<IMAGE_STATE>(srcImage);
6973 auto dst_buffer_state = Get<BUFFER_STATE>(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006974
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006975 const bool is_2 = (cmd_type == CMD_COPYIMAGETOBUFFER2KHR || cmd_type == CMD_COPYIMAGETOBUFFER2);
sfricke-samsung85584a72021-09-30 21:43:38 -07006976 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04006977 const char *vuid;
6978
Tony Barbour845d29b2021-11-09 11:43:14 -07006979 bool skip = ValidateBufferImageCopyData(cb_node.get(), regionCount, pRegions, src_image_state.get(), func_name, cmd_type, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006980
6981 // Validate command buffer state
Jeremy Gebben9f537102021-10-05 16:37:12 -06006982 skip |= ValidateCmd(cb_node.get(), cmd_type);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006983
6984 // Command pool must support graphics, compute, or transfer operations
Jeremy Gebbencd7fa282021-10-27 10:25:32 -06006985 const auto pool = cb_node->command_pool;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006986
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006987 VkQueueFlags queue_flags = physical_device_state->queue_family_properties[pool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07006988
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006989 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006990 vuid = is_2 ? "VUID-vkCmdCopyImageToBuffer2-commandBuffer-cmdpool" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool";
Jeff Leger178b1e52020-10-05 12:22:23 -04006991 skip |= LogError(cb_node->createInfo.commandPool, vuid,
6992 "Cannot call %s on a command buffer allocated from a pool without graphics, compute, "
6993 "or transfer capabilities.",
6994 func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006995 }
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006996
6997 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-pRegions-00182" : "VUID-vkCmdCopyImageToBuffer-pRegions-06220";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006998 skip |= ValidateImageBounds(src_image_state.get(), regionCount, pRegions, func_name, vuid);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006999 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-pRegions-00183" : "VUID-vkCmdCopyImageToBuffer-pRegions-00183";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007000 skip |= ValidateBufferBounds(src_image_state.get(), dst_buffer_state.get(), regionCount, pRegions, func_name, vuid);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07007001
Tony-LunarGaf3632a2021-11-10 15:51:57 -07007002 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImage-00188" : "VUID-vkCmdCopyImageToBuffer-srcImage-00188";
7003 std::string location = func_name;
7004 location.append("() : srcImage");
7005 skip |= ValidateImageSampleCount(src_image_state.get(), VK_SAMPLE_COUNT_1_BIT, location.c_str(), vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04007006
Tony-LunarGaf3632a2021-11-10 15:51:57 -07007007 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImage-00187" : "VUID-vkCmdCopyImageToBuffer-srcImage-00187";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007008 skip |= ValidateMemoryIsBoundToImage(src_image_state.get(), func_name, vuid);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07007009 vuid = is_2 ? "vkCmdCopyImageToBuffer-dstBuffer2-00192" : "vkCmdCopyImageToBuffer dstBuffer-00192";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007010 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state.get(), func_name, vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07007011
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07007012 // Validate that SRC image & DST buffer have correct usage flags set
Tony-LunarGaf3632a2021-11-10 15:51:57 -07007013 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImage-00186" : "VUID-vkCmdCopyImageToBuffer-srcImage-00186";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007014 skip |= ValidateImageUsageFlags(src_image_state.get(), VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06007015 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tony-LunarGaf3632a2021-11-10 15:51:57 -07007016 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-dstBuffer-00191" : "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007017 skip |= ValidateBufferUsageFlags(dst_buffer_state.get(), VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06007018 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Tony-LunarGaf3632a2021-11-10 15:51:57 -07007019 vuid = is_2 ? "VUID-vkCmdCopyImageToBuffer2-commandBuffer-01831" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01831";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007020 skip |= ValidateProtectedImage(cb_node.get(), src_image_state.get(), func_name, vuid);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07007021 vuid = is_2 ? "VUID-vkCmdCopyImageToBuffer2-commandBuffer-01832" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01832";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007022 skip |= ValidateProtectedBuffer(cb_node.get(), dst_buffer_state.get(), func_name, vuid);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07007023 vuid = is_2 ? "VUID-vkCmdCopyImageToBuffer2-commandBuffer-01833" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01833";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007024 skip |= ValidateUnprotectedBuffer(cb_node.get(), dst_buffer_state.get(), func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02007025
7026 // Validation for VK_EXT_fragment_density_map
7027 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony-LunarGaf3632a2021-11-10 15:51:57 -07007028 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImage-02544" : "VUID-vkCmdCopyImageToBuffer-srcImage-02544";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06007029 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04007030 "%s: srcImage must not have been created with flags containing "
7031 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
7032 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02007033 }
7034
sfricke-samsung45996a42021-09-16 13:45:27 -07007035 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Tony-LunarGaf3632a2021-11-10 15:51:57 -07007036 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImage-01998" : "VUID-vkCmdCopyImageToBuffer-srcImage-01998";
7037 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(), VK_FORMAT_FEATURE_2_TRANSFER_SRC_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04007038 }
Tobin Ehlisc8266452017-04-07 12:20:30 -06007039 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04007040
sfricke-samsung45996a42021-09-16 13:45:27 -07007041 const char *src_invalid_layout_vuid =
7042 (src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Tony-LunarGaf3632a2021-11-10 15:51:57 -07007043 ? (vuid =
7044 is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImageLayout-01397" : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397")
7045 : (vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImageLayout-00190"
7046 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190");
Jeff Leger178b1e52020-10-05 12:22:23 -04007047
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07007048 for (uint32_t i = 0; i < regionCount; ++i) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05007049 const RegionType region = pRegions[i];
7050 skip |= ValidateImageSubresourceLayers(cb_node.get(), &region.imageSubresource, func_name, "imageSubresource", i);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07007051 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImageLayout-00189" : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189";
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06007052 skip |= VerifyImageLayout(*cb_node, *src_image_state, region.imageSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04007053 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, src_invalid_layout_vuid, vuid, &hit_error);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07007054 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-imageOffset-01794" : "VUID-vkCmdCopyImageToBuffer-imageOffset-01794";
sfricke-samsung71f04e32022-03-16 01:21:21 -05007055 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node.get(), src_image_state.get(), &region, i, func_name,
7056 vuid);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07007057 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-imageSubresource-01703" : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703";
sfricke-samsung71f04e32022-03-16 01:21:21 -05007058 skip |= ValidateImageMipLevel(cb_node.get(), src_image_state.get(), region.imageSubresource.mipLevel, i, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04007059 "imageSubresource", vuid);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07007060 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-imageSubresource-01704" : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704";
sfricke-samsung71f04e32022-03-16 01:21:21 -05007061 skip |= ValidateImageArrayLayerRange(cb_node.get(), src_image_state.get(), region.imageSubresource.baseArrayLayer,
7062 region.imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07007063 }
7064 return skip;
7065}
7066
Jeff Leger178b1e52020-10-05 12:22:23 -04007067bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
7068 VkBuffer dstBuffer, uint32_t regionCount,
7069 const VkBufferImageCopy *pRegions) const {
7070 return ValidateCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions,
Tony-LunarGaf3632a2021-11-10 15:51:57 -07007071 CMD_COPYIMAGETOBUFFER);
Jeff Leger178b1e52020-10-05 12:22:23 -04007072}
7073
7074bool CoreChecks::PreCallValidateCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
7075 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) const {
7076 return ValidateCmdCopyImageToBuffer(commandBuffer, pCopyImageToBufferInfo->srcImage, pCopyImageToBufferInfo->srcImageLayout,
7077 pCopyImageToBufferInfo->dstBuffer, pCopyImageToBufferInfo->regionCount,
Tony-LunarGaf3632a2021-11-10 15:51:57 -07007078 pCopyImageToBufferInfo->pRegions, CMD_COPYIMAGETOBUFFER2KHR);
Jeff Leger178b1e52020-10-05 12:22:23 -04007079}
7080
Tony Barbour845d29b2021-11-09 11:43:14 -07007081bool CoreChecks::PreCallValidateCmdCopyImageToBuffer2(VkCommandBuffer commandBuffer,
7082 const VkCopyImageToBufferInfo2 *pCopyImageToBufferInfo) const {
7083 return ValidateCmdCopyImageToBuffer(commandBuffer, pCopyImageToBufferInfo->srcImage, pCopyImageToBufferInfo->srcImageLayout,
7084 pCopyImageToBufferInfo->dstBuffer, pCopyImageToBufferInfo->regionCount,
Tony-LunarGaf3632a2021-11-10 15:51:57 -07007085 pCopyImageToBufferInfo->pRegions, CMD_COPYIMAGETOBUFFER2);
Tony Barbour845d29b2021-11-09 11:43:14 -07007086}
7087
John Zulauf1686f232019-07-09 16:27:11 -06007088void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
7089 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
7090 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
7091
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07007092 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06007093 auto src_image_state = Get<IMAGE_STATE>(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06007094 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07007095 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06007096 cb_node->SetImageInitialLayout(*src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06007097 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07007098}
7099
Jeff Leger178b1e52020-10-05 12:22:23 -04007100void CoreChecks::PreCallRecordCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
7101 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) {
7102 StateTracker::PreCallRecordCmdCopyImageToBuffer2KHR(commandBuffer, pCopyImageToBufferInfo);
7103
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07007104 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06007105 auto src_image_state = Get<IMAGE_STATE>(pCopyImageToBufferInfo->srcImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04007106 // Make sure that all image slices record referenced layout
7107 for (uint32_t i = 0; i < pCopyImageToBufferInfo->regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06007108 cb_node->SetImageInitialLayout(*src_image_state, pCopyImageToBufferInfo->pRegions[i].imageSubresource,
7109 pCopyImageToBufferInfo->srcImageLayout);
Jeff Leger178b1e52020-10-05 12:22:23 -04007110 }
7111}
7112
Tony-LunarGaf3632a2021-11-10 15:51:57 -07007113void CoreChecks::PreCallRecordCmdCopyImageToBuffer2(VkCommandBuffer commandBuffer,
7114 const VkCopyImageToBufferInfo2 *pCopyImageToBufferInfo) {
7115 StateTracker::PreCallRecordCmdCopyImageToBuffer2(commandBuffer, pCopyImageToBufferInfo);
7116
7117 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
7118 auto src_image_state = Get<IMAGE_STATE>(pCopyImageToBufferInfo->srcImage);
7119 // Make sure that all image slices record referenced layout
7120 for (uint32_t i = 0; i < pCopyImageToBufferInfo->regionCount; ++i) {
7121 cb_node->SetImageInitialLayout(*src_image_state, pCopyImageToBufferInfo->pRegions[i].imageSubresource,
7122 pCopyImageToBufferInfo->srcImageLayout);
7123 }
7124}
7125
Jeff Leger178b1e52020-10-05 12:22:23 -04007126template <typename RegionType>
7127bool CoreChecks::ValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
7128 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
Tony Barbour845d29b2021-11-09 11:43:14 -07007129 CMD_TYPE cmd_type) const {
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07007130 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07007131 auto src_buffer_state = Get<BUFFER_STATE>(srcBuffer);
7132 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07007133
Tony Barbour845d29b2021-11-09 11:43:14 -07007134 const bool is_2 = (cmd_type == CMD_COPYBUFFERTOIMAGE2KHR || cmd_type == CMD_COPYBUFFERTOIMAGE2);
sfricke-samsung85584a72021-09-30 21:43:38 -07007135 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04007136 const char *vuid;
7137
Tony Barbour845d29b2021-11-09 11:43:14 -07007138 bool skip =
7139 ValidateBufferImageCopyData(cb_node.get(), regionCount, pRegions, dst_image_state.get(), func_name, cmd_type, false);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07007140
7141 // Validate command buffer state
Jeremy Gebben9f537102021-10-05 16:37:12 -06007142 skip |= ValidateCmd(cb_node.get(), cmd_type);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07007143
Tony Barbour845d29b2021-11-09 11:43:14 -07007144 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-pRegions-00172" : "VUID-vkCmdCopyBufferToImage-pRegions-06217";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007145 skip |= ValidateImageBounds(dst_image_state.get(), regionCount, pRegions, func_name, vuid);
Tony Barbour845d29b2021-11-09 11:43:14 -07007146 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-pRegions-00171" : "VUID-vkCmdCopyBufferToImage-pRegions-00171";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007147 skip |= ValidateBufferBounds(dst_image_state.get(), src_buffer_state.get(), regionCount, pRegions, func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04007148
Tony Barbour845d29b2021-11-09 11:43:14 -07007149 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImage-00179" : "VUID-vkCmdCopyBufferToImage-dstImage-00179";
7150 std::string location = func_name;
7151 location.append("() : dstImage");
7152 skip |= ValidateImageSampleCount(dst_image_state.get(), VK_SAMPLE_COUNT_1_BIT, location.c_str(), vuid);
7153 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-srcBuffer-00176" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00176";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007154 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state.get(), func_name, vuid);
Tony Barbour845d29b2021-11-09 11:43:14 -07007155 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImage-00178" : "VUID-vkCmdCopyBufferToImage-dstImage-00178";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007156 skip |= ValidateMemoryIsBoundToImage(dst_image_state.get(), func_name, vuid);
Tony Barbour845d29b2021-11-09 11:43:14 -07007157 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-srcBuffer-00174" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00174";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007158 skip |= ValidateBufferUsageFlags(src_buffer_state.get(), VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06007159 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Tony Barbour845d29b2021-11-09 11:43:14 -07007160 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImage-00177" : "VUID-vkCmdCopyBufferToImage-dstImage-00177";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007161 skip |= ValidateImageUsageFlags(dst_image_state.get(), VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06007162 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Tony Barbour845d29b2021-11-09 11:43:14 -07007163 vuid = is_2 ? "VUID-vkCmdCopyBufferToImage2-commandBuffer-01828" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01828";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007164 skip |= ValidateProtectedBuffer(cb_node.get(), src_buffer_state.get(), func_name, vuid);
Tony Barbour845d29b2021-11-09 11:43:14 -07007165 vuid = is_2 ? "VUID-vkCmdCopyBufferToImage2-commandBuffer-01829" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01829";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007166 skip |= ValidateProtectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
Tony Barbour845d29b2021-11-09 11:43:14 -07007167 vuid = is_2 ? "VUID-vkCmdCopyBufferToImage-commandBuffer-01830" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01830";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007168 skip |= ValidateUnprotectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02007169
7170 // Validation for VK_EXT_fragment_density_map
7171 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony Barbour845d29b2021-11-09 11:43:14 -07007172 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImage-02543" : "VUID-vkCmdCopyBufferToImage-dstImage-02543";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06007173 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04007174 "%s: dstImage must not have been created with flags containing "
7175 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
7176 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02007177 }
7178
sfricke-samsung45996a42021-09-16 13:45:27 -07007179 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07007180 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImage-01997" : "VUID-vkCmdCopyBufferToImage-dstImage-01997";
7181 skip |= ValidateImageFormatFeatureFlags(dst_image_state.get(), VK_FORMAT_FEATURE_2_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04007182 }
Tobin Ehlisc8266452017-04-07 12:20:30 -06007183 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04007184
sfricke-samsung45996a42021-09-16 13:45:27 -07007185 const char *dst_invalid_layout_vuid =
7186 (dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Tony Barbour845d29b2021-11-09 11:43:14 -07007187 ? (is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImageLayout-01396"
sfricke-samsung45996a42021-09-16 13:45:27 -07007188 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396")
Tony Barbour845d29b2021-11-09 11:43:14 -07007189 : (is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImageLayout-00181"
sfricke-samsung45996a42021-09-16 13:45:27 -07007190 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181");
Jeff Leger178b1e52020-10-05 12:22:23 -04007191
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07007192 for (uint32_t i = 0; i < regionCount; ++i) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05007193 const RegionType region = pRegions[i];
7194 skip |= ValidateImageSubresourceLayers(cb_node.get(), &region.imageSubresource, func_name, "imageSubresource", i);
Tony Barbour845d29b2021-11-09 11:43:14 -07007195 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImageLayout-00180" : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180";
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06007196 skip |= VerifyImageLayout(*cb_node, *dst_image_state, region.imageSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04007197 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, dst_invalid_layout_vuid, vuid, &hit_error);
Tony Barbour845d29b2021-11-09 11:43:14 -07007198 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-imageOffset-01793" : "VUID-vkCmdCopyBufferToImage-imageOffset-01793";
sfricke-samsung71f04e32022-03-16 01:21:21 -05007199 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node.get(), dst_image_state.get(), &region, i, func_name,
7200 vuid);
Tony Barbour845d29b2021-11-09 11:43:14 -07007201 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-imageSubresource-01701" : "VUID-vkCmdCopyBufferToImage-imageSubresource-01701";
sfricke-samsung71f04e32022-03-16 01:21:21 -05007202 skip |= ValidateImageMipLevel(cb_node.get(), dst_image_state.get(), region.imageSubresource.mipLevel, i, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04007203 "imageSubresource", vuid);
Tony Barbour845d29b2021-11-09 11:43:14 -07007204 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-imageSubresource-01702" : "VUID-vkCmdCopyBufferToImage-imageSubresource-01702";
sfricke-samsung71f04e32022-03-16 01:21:21 -05007205 skip |= ValidateImageArrayLayerRange(cb_node.get(), dst_image_state.get(), region.imageSubresource.baseArrayLayer,
7206 region.imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
sfricke-samsungea4fd142020-10-17 23:51:59 -07007207
7208 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
Jeremy Gebbencd7fa282021-10-27 10:25:32 -06007209 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool;
sfricke-samsungea4fd142020-10-17 23:51:59 -07007210 assert(command_pool != nullptr);
7211 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06007212 const VkQueueFlags queue_flags = physical_device_state->queue_family_properties[queue_family_index].queueFlags;
sfricke-samsung71f04e32022-03-16 01:21:21 -05007213 const VkImageAspectFlags region_aspect_mask = region.imageSubresource.aspectMask;
sfricke-samsungea4fd142020-10-17 23:51:59 -07007214 if (((queue_flags & VK_QUEUE_GRAPHICS_BIT) == 0) &&
7215 ((region_aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06007216 LogObjectList objlist(cb_node->commandBuffer());
7217 objlist.add(command_pool->commandPool());
sfricke-samsung4389faa2022-03-23 01:19:42 -05007218 objlist.add(dst_image_state->image());
Tony Barbour845d29b2021-11-09 11:43:14 -07007219 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-commandBuffer-04477"
sfricke-samsungea4fd142020-10-17 23:51:59 -07007220 : "VUID-vkCmdCopyBufferToImage-commandBuffer-04477";
sfricke-samsung4389faa2022-03-23 01:19:42 -05007221 skip |= LogError(objlist, vuid,
sfricke-samsungea4fd142020-10-17 23:51:59 -07007222 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies VK_IMAGE_ASPECT_DEPTH_BIT or "
7223 "VK_IMAGE_ASPECT_STENCIL_BIT but the command buffer %s was allocated from the command pool %s "
7224 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT flag.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06007225 func_name, i, region_aspect_mask, report_data->FormatHandle(cb_node->commandBuffer()).c_str(),
7226 report_data->FormatHandle(command_pool->commandPool()).c_str(), queue_family_index);
sfricke-samsungea4fd142020-10-17 23:51:59 -07007227 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07007228 }
7229 return skip;
7230}
7231
Jeff Leger178b1e52020-10-05 12:22:23 -04007232bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
7233 VkImageLayout dstImageLayout, uint32_t regionCount,
7234 const VkBufferImageCopy *pRegions) const {
7235 return ValidateCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions,
Tony Barbour845d29b2021-11-09 11:43:14 -07007236 CMD_COPYBUFFERTOIMAGE);
Jeff Leger178b1e52020-10-05 12:22:23 -04007237}
7238
7239bool CoreChecks::PreCallValidateCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
7240 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo) const {
7241 return ValidateCmdCopyBufferToImage(commandBuffer, pCopyBufferToImageInfo->srcBuffer, pCopyBufferToImageInfo->dstImage,
7242 pCopyBufferToImageInfo->dstImageLayout, pCopyBufferToImageInfo->regionCount,
Tony Barbour845d29b2021-11-09 11:43:14 -07007243 pCopyBufferToImageInfo->pRegions, CMD_COPYBUFFERTOIMAGE2KHR);
7244}
7245
7246bool CoreChecks::PreCallValidateCmdCopyBufferToImage2(VkCommandBuffer commandBuffer,
7247 const VkCopyBufferToImageInfo2 *pCopyBufferToImageInfo) const {
7248 return ValidateCmdCopyBufferToImage(commandBuffer, pCopyBufferToImageInfo->srcBuffer, pCopyBufferToImageInfo->dstImage,
7249 pCopyBufferToImageInfo->dstImageLayout, pCopyBufferToImageInfo->regionCount,
7250 pCopyBufferToImageInfo->pRegions, CMD_COPYBUFFERTOIMAGE2);
Jeff Leger178b1e52020-10-05 12:22:23 -04007251}
7252
John Zulauf1686f232019-07-09 16:27:11 -06007253void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
7254 VkImageLayout dstImageLayout, uint32_t regionCount,
7255 const VkBufferImageCopy *pRegions) {
7256 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
7257
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07007258 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06007259 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06007260 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07007261 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06007262 cb_node->SetImageInitialLayout(*dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06007263 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07007264}
Mike Weiblen672b58b2017-02-21 14:32:53 -07007265
Jeff Leger178b1e52020-10-05 12:22:23 -04007266void CoreChecks::PreCallRecordCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
7267 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo2KHR) {
7268 StateTracker::PreCallRecordCmdCopyBufferToImage2KHR(commandBuffer, pCopyBufferToImageInfo2KHR);
7269
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07007270 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06007271 auto dst_image_state = Get<IMAGE_STATE>(pCopyBufferToImageInfo2KHR->dstImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04007272 // Make sure that all image slices are record referenced layout
7273 for (uint32_t i = 0; i < pCopyBufferToImageInfo2KHR->regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06007274 cb_node->SetImageInitialLayout(*dst_image_state, pCopyBufferToImageInfo2KHR->pRegions[i].imageSubresource,
7275 pCopyBufferToImageInfo2KHR->dstImageLayout);
Jeff Leger178b1e52020-10-05 12:22:23 -04007276 }
7277}
Tony Barbour845d29b2021-11-09 11:43:14 -07007278
7279void CoreChecks::PreCallRecordCmdCopyBufferToImage2(VkCommandBuffer commandBuffer,
7280 const VkCopyBufferToImageInfo2 *pCopyBufferToImageInfo) {
7281 StateTracker::PreCallRecordCmdCopyBufferToImage2(commandBuffer, pCopyBufferToImageInfo);
7282
7283 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
7284 auto dst_image_state = Get<IMAGE_STATE>(pCopyBufferToImageInfo->dstImage);
7285 // Make sure that all image slices are record referenced layout
7286 for (uint32_t i = 0; i < pCopyBufferToImageInfo->regionCount; ++i) {
7287 cb_node->SetImageInitialLayout(*dst_image_state, pCopyBufferToImageInfo->pRegions[i].imageSubresource,
7288 pCopyBufferToImageInfo->dstImageLayout);
7289 }
7290}
7291
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07007292bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05007293 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07007294 bool skip = false;
7295 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
7296
Dave Houlton1d960ff2018-01-19 12:17:05 -07007297 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07007298 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
7299 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
7300 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07007301 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
7302 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07007303 }
7304
Jeremy Gebbenf4449392022-01-28 10:09:10 -07007305 auto image_entry = Get<IMAGE_STATE>(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07007306 if (!image_entry) {
7307 return skip;
7308 }
7309
Mark Lobodzinski6f358172019-10-02 11:09:12 -06007310 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
sfricke-samsung45996a42021-09-16 13:45:27 -07007311 if (IsExtEnabled(device_extensions.vk_ext_image_drm_format_modifier)) {
Mark Lobodzinski6f358172019-10-02 11:09:12 -06007312 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
7313 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07007314 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
7315 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
7316 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06007317 }
7318 } else {
7319 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07007320 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
7321 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06007322 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07007323 }
7324
Dave Houlton1d960ff2018-01-19 12:17:05 -07007325 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07007326 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07007327 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
7328 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
7329 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07007330 }
7331
Dave Houlton1d960ff2018-01-19 12:17:05 -07007332 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07007333 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07007334 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
7335 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
7336 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07007337 }
7338
Dave Houlton1d960ff2018-01-19 12:17:05 -07007339 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07007340 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06007341 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
7342 if (FormatIsMultiplane(img_format)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08007343 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06007344 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
7345 if (FormatPlaneCount(img_format) > 2u) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08007346 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06007347 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
7348 }
7349 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07007350 skip |= LogError(image, vuid,
7351 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
7352 ") must be a single-plane specifier flag.",
7353 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06007354 }
7355 } else if (FormatIsColor(img_format)) {
7356 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
ziga-lunargcc568bc2021-09-05 13:45:45 +02007357 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04461",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07007358 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
7359 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06007360 }
7361 } else if (FormatIsDepthOrStencil(img_format)) {
Nathaniel Cesario8c80f352021-07-15 15:06:48 -06007362 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06007363 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07007364 }
ziga-lunarg4ecbd5b2021-07-15 20:48:30 +02007365 if (!FormatIsDepthAndStencil(img_format) && !FormatIsDepthOnly(img_format)) {
7366 if (sub_aspect & VK_IMAGE_ASPECT_DEPTH_BIT) {
7367 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04464",
7368 "vkGetImageSubresourceLayout(): Image format (%s) does not contain a depth component, "
7369 "but VkImageSubresource.aspectMask contains VK_IMAGE_ASPECT_DEPTH_BIT.",
7370 string_VkFormat(img_format));
7371 }
7372 } else {
7373 if ((sub_aspect & VK_IMAGE_ASPECT_DEPTH_BIT) == 0) {
7374 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04462",
7375 "vkGetImageSubresourceLayout(): Image format (%s) contains a depth component, "
7376 "but VkImageSubresource.aspectMask does not contain VK_IMAGE_ASPECT_DEPTH_BIT.",
7377 string_VkFormat(img_format));
7378 }
7379 }
7380 if (!FormatIsDepthAndStencil(img_format) && !FormatIsStencilOnly(img_format)) {
7381 if (sub_aspect & VK_IMAGE_ASPECT_STENCIL_BIT) {
7382 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04464",
7383 "vkGetImageSubresourceLayout(): Image format (%s) does not contain a stencil component, "
7384 "but VkImageSubresource.aspectMask contains VK_IMAGE_ASPECT_STENCIL_BIT.",
7385 string_VkFormat(img_format));
7386 }
7387 } else {
7388 if ((sub_aspect & VK_IMAGE_ASPECT_STENCIL_BIT) == 0) {
7389 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04463",
7390 "vkGetImageSubresourceLayout(): Image format (%s) contains a stencil component, "
7391 "but VkImageSubresource.aspectMask does not contain VK_IMAGE_ASPECT_STENCIL_BIT.",
7392 string_VkFormat(img_format));
7393 }
7394 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06007395 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
7396 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
7397 (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 +02007398 skip |= LogError(
7399 image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
7400 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask (%s) must be VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.",
7401 string_VkImageAspectFlags(sub_aspect).c_str());
7402 } else {
7403 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
7404 assert(IsExtEnabled(device_extensions.vk_ext_image_drm_format_modifier));
7405 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = LvlInitStruct<VkImageDrmFormatModifierPropertiesEXT>();
7406 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image, &drm_format_properties);
7407
7408 auto fmt_drm_props = LvlInitStruct<VkDrmFormatModifierPropertiesListEXT>();
7409 auto fmt_props_2 = LvlInitStruct<VkFormatProperties2>(&fmt_drm_props);
7410 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_entry->createInfo.format, &fmt_props_2);
7411 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties{fmt_drm_props.drmFormatModifierCount};
7412 fmt_drm_props.pDrmFormatModifierProperties = drm_properties.data();
7413 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_entry->createInfo.format, &fmt_props_2);
7414
7415 uint32_t max_plane_count = 0u;
7416
7417 for (auto const &drm_property : drm_properties) {
7418 if (drm_format_properties.drmFormatModifier == drm_property.drmFormatModifier) {
7419 max_plane_count = drm_property.drmFormatModifierPlaneCount;
7420 break;
7421 }
7422 }
7423
7424 VkImageAspectFlagBits allowed_plane_indices[] = {
7425 VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT, VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT,
7426 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT, VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT};
7427
7428 bool is_valid = false;
7429
7430 for (uint32_t i = 0u; i < max_plane_count; ++i) {
7431 if (sub_aspect == allowed_plane_indices[i]) {
7432 is_valid = true;
7433 break;
7434 }
7435 }
7436
7437 if (!is_valid) {
7438 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
7439 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask (%s) must be "
7440 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT, with i being less than the "
7441 "VkDrmFormatModifierPropertiesEXT::drmFormatModifierPlaneCount (%" PRIu32
7442 ") associated with the image's format (%s) and "
7443 "VkImageDrmFormatModifierPropertiesEXT::drmFormatModifier (%" PRIu64 ").",
7444 string_VkImageAspectFlags(sub_aspect).c_str(), max_plane_count,
7445 string_VkFormat(image_entry->createInfo.format), drm_format_properties.drmFormatModifier);
7446 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07007447 }
7448 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06007449
sfricke-samsung45996a42021-09-16 13:45:27 -07007450 if (IsExtEnabled(device_extensions.vk_android_external_memory_android_hardware_buffer)) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07007451 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06007452 }
7453
Mike Weiblen672b58b2017-02-21 14:32:53 -07007454 return skip;
7455}
sfricke-samsung022fa252020-07-24 03:26:16 -07007456
7457// Validates the image is allowed to be protected
7458bool CoreChecks::ValidateProtectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06007459 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07007460 bool skip = false;
sfricke-samsung21286f82021-11-16 08:21:46 -08007461
7462 // if driver supports protectedNoFault the operation is valid, just has undefined values
7463 if ((!phys_dev_props_core11.protectedNoFault) && (cb_state->unprotected == true) && (image_state->unprotected == false)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06007464 LogObjectList objlist(cb_state->commandBuffer());
7465 objlist.add(image_state->image());
locke-lunarg351c9d82020-10-23 14:43:21 -06007466 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 -06007467 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
7468 report_data->FormatHandle(image_state->image()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07007469 }
7470 return skip;
7471}
7472
7473// Validates the image is allowed to be unprotected
7474bool CoreChecks::ValidateUnprotectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06007475 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07007476 bool skip = false;
sfricke-samsung21286f82021-11-16 08:21:46 -08007477
7478 // if driver supports protectedNoFault the operation is valid, just has undefined values
7479 if ((!phys_dev_props_core11.protectedNoFault) && (cb_state->unprotected == false) && (image_state->unprotected == true)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06007480 LogObjectList objlist(cb_state->commandBuffer());
7481 objlist.add(image_state->image());
locke-lunarg351c9d82020-10-23 14:43:21 -06007482 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 -06007483 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
7484 report_data->FormatHandle(image_state->image()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07007485 }
7486 return skip;
7487}
7488
7489// Validates the buffer is allowed to be protected
7490bool CoreChecks::ValidateProtectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06007491 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07007492 bool skip = false;
sfricke-samsung21286f82021-11-16 08:21:46 -08007493
7494 // if driver supports protectedNoFault the operation is valid, just has undefined values
7495 if ((!phys_dev_props_core11.protectedNoFault) && (cb_state->unprotected == true) && (buffer_state->unprotected == false)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06007496 LogObjectList objlist(cb_state->commandBuffer());
7497 objlist.add(buffer_state->buffer());
locke-lunarg351c9d82020-10-23 14:43:21 -06007498 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 -06007499 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
7500 report_data->FormatHandle(buffer_state->buffer()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07007501 }
7502 return skip;
7503}
7504
7505// Validates the buffer is allowed to be unprotected
7506bool CoreChecks::ValidateUnprotectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06007507 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07007508 bool skip = false;
sfricke-samsung21286f82021-11-16 08:21:46 -08007509
7510 // if driver supports protectedNoFault the operation is valid, just has undefined values
7511 if ((!phys_dev_props_core11.protectedNoFault) && (cb_state->unprotected == false) && (buffer_state->unprotected == true)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06007512 LogObjectList objlist(cb_state->commandBuffer());
7513 objlist.add(buffer_state->buffer());
locke-lunarg351c9d82020-10-23 14:43:21 -06007514 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 -06007515 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
7516 report_data->FormatHandle(buffer_state->buffer()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07007517 }
7518 return skip;
7519}