blob: 31974f8425d22c4593c5289eb368b1e710c91e06 [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}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700361
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700362bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600363 const IMAGE_VIEW_STATE &image_view_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700364 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600365 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100366 bool skip = false;
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600367 const auto &image_view = image_view_state.Handle();
368 const auto *image_state = image_view_state.image_state.get();
369 const auto &image = image_state->Handle();
Tobias Hectorbbb12282018-10-22 15:17:59 +0100370 const char *vuid;
371 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700372 const char *function_name = use_rp2 ? "vkCmdBeginRenderPass2()" : "vkCmdBeginRenderPass()";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100373
374 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600375 LogObjectList objlist(image);
376 objlist.add(renderpass);
377 objlist.add(framebuffer);
378 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700379 skip |=
sfricke-samsung4389faa2022-03-23 01:19:42 -0500380 LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700381 "%s: RenderPass %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
382 function_name, report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
383 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100384 return skip;
385 }
386
387 auto image_usage = image_state->createInfo.usage;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700388 const auto stencil_usage_info = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Ricardo Garcia3f5984c2020-04-09 10:56:34 +0200389 if (stencil_usage_info) {
390 image_usage |= stencil_usage_info->stencilUsage;
391 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100392
393 // Check for layouts that mismatch image usages in the framebuffer
394 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800395 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600396 LogObjectList objlist(image);
397 objlist.add(renderpass);
398 objlist.add(framebuffer);
399 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700400 skip |= LogError(objlist, vuid,
401 "%s: Layout/usage mismatch for attachment %u in %s"
402 " - the %s is %s but the image attached to %s via %s"
403 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
404 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
405 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
406 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100407 }
408
409 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
410 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800411 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600412 LogObjectList objlist(image);
413 objlist.add(renderpass);
414 objlist.add(framebuffer);
415 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700416 skip |= LogError(objlist, vuid,
417 "%s: Layout/usage mismatch for attachment %u in %s"
418 " - the %s is %s but the image attached to %s via %s"
419 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
420 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
421 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
422 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100423 }
424
425 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800426 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600427 LogObjectList objlist(image);
428 objlist.add(renderpass);
429 objlist.add(framebuffer);
430 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700431 skip |= LogError(objlist, vuid,
432 "%s: Layout/usage mismatch for attachment %u in %s"
433 " - the %s is %s but the image attached to %s via %s"
434 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
435 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
436 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
437 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100438 }
439
440 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800441 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
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_TRANSFER_DST_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
Tony-LunarG10f54412022-08-12 11:43:40 -0600455 if (layout == VK_IMAGE_LAYOUT_ATTACHMENT_FEEDBACK_LOOP_OPTIMAL_EXT) {
456 if (((image_usage & (VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) == 0) ||
457 ((image_usage & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0)) {
458 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-07002" : "VUID-vkCmdBeginRenderPass-initialLayout-07000";
459 LogObjectList objlist(image);
460 objlist.add(renderpass);
461 objlist.add(framebuffer);
462 objlist.add(image_view);
463 skip |=
464 LogError(objlist, vuid,
465 "%s: Layout/usage mismatch for attachment %" PRIu32
466 " in %s"
467 " - the %s is %s but the image attached to %s via %s"
468 " was not created with either the VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT or "
469 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT usage bits, and the VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or "
470 "VK_IMAGE_USAGE_SAMPLED_BIT usage bits",
471 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
472 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
473 report_data->FormatHandle(image_view).c_str());
474 }
475 if (!(image_usage & VK_IMAGE_USAGE_ATTACHMENT_FEEDBACK_LOOP_BIT_EXT)) {
476 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-07003" : "VUID-vkCmdBeginRenderPass-initialLayout-07001";
477 LogObjectList objlist(image);
478 objlist.add(renderpass);
479 objlist.add(framebuffer);
480 objlist.add(image_view);
481 skip |= LogError(objlist, vuid,
482 "%s: Layout/usage mismatch for attachment %" PRIu32
483 " in %s"
484 " - the %s is %s but the image attached to %s via %s"
485 " was not created with the VK_IMAGE_USAGE_ATTACHMENT_FEEDBACK_LOOP_BIT_EXT usage bit",
486 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
487 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
488 report_data->FormatHandle(image_view).c_str());
489 }
490 }
491
sfricke-samsung45996a42021-09-16 13:45:27 -0700492 if (IsExtEnabled(device_extensions.vk_khr_maintenance2)) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100493 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
494 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
495 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
496 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
497 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800498 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600499 LogObjectList objlist(image);
500 objlist.add(renderpass);
501 objlist.add(framebuffer);
502 objlist.add(image_view);
503 skip |= LogError(objlist, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700504 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700505 " - the %s is %s but the image attached to %s via %s"
506 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700507 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700508 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
509 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100510 }
511 } else {
512 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
513 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
514 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
515 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600516 LogObjectList objlist(image);
517 objlist.add(renderpass);
518 objlist.add(framebuffer);
519 objlist.add(image_view);
520 skip |= LogError(objlist, "VUID-vkCmdBeginRenderPass-initialLayout-00896",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700521 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700522 " - the %s is %s but the image attached to %s via %s"
523 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700524 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700525 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
526 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100527 }
528 }
529 return skip;
530}
531
John Zulauf17a01bb2019-08-09 16:41:19 -0600532bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700533 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600534 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600535 bool skip = false;
Jeremy Gebbenf4449392022-01-28 10:09:10 -0700536 auto render_pass_state = Get<RENDER_PASS_STATE>(pRenderPassBegin->renderPass);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600537 const auto *render_pass_info = render_pass_state->createInfo.ptr();
538 auto render_pass = render_pass_state->renderPass();
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700539 auto const &framebuffer_info = framebuffer_state->createInfo;
540 const VkImageView *attachments = framebuffer_info.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100541
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600542 auto framebuffer = framebuffer_state->framebuffer();
Tobias Hectorbbb12282018-10-22 15:17:59 +0100543
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700544 if (render_pass_info->attachmentCount != framebuffer_info.attachmentCount) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600545 skip |= LogError(pCB->commandBuffer(), kVUID_Core_DrawState_InvalidRenderpass,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700546 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700547 }
John Zulauf8e308292018-09-21 11:34:37 -0600548
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700549 const auto *attachment_info = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext);
Mike Schuchardt2df08912020-12-15 16:28:09 -0800550 if (((framebuffer_info.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) != 0) && attachment_info != nullptr) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700551 attachments = attachment_info->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100552 }
553
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600554 if (attachments == nullptr) {
555 return skip;
556 }
557 const auto *const_p_cb = static_cast<const CMD_BUFFER_STATE *>(pCB);
558 for (uint32_t i = 0; i < render_pass_info->attachmentCount && i < framebuffer_info.attachmentCount; ++i) {
559 auto image_view = attachments[i];
560 auto view_state = Get<IMAGE_VIEW_STATE>(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100561
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600562 if (!view_state) {
563 LogObjectList objlist(pRenderPassBegin->renderPass);
564 objlist.add(framebuffer_state->framebuffer());
565 objlist.add(image_view);
566 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
567 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
568 report_data->FormatHandle(framebuffer_state->framebuffer()).c_str(), i,
569 report_data->FormatHandle(image_view).c_str());
570 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100571 }
572
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600573 const VkImage image = view_state->create_info.image;
574 const auto *image_state = view_state->image_state.get();
Tobias Hectorbbb12282018-10-22 15:17:59 +0100575
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600576 if (!image_state) {
577 LogObjectList objlist(pRenderPassBegin->renderPass);
578 objlist.add(framebuffer_state->framebuffer());
579 objlist.add(image_view);
580 objlist.add(image);
581 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
582 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
583 report_data->FormatHandle(framebuffer_state->framebuffer()).c_str(), i,
584 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
585 continue;
586 }
587 auto attachment_initial_layout = render_pass_info->pAttachments[i].initialLayout;
588 auto final_layout = render_pass_info->pAttachments[i].finalLayout;
589
590 // Default to expecting stencil in the same layout.
591 auto attachment_stencil_initial_layout = attachment_initial_layout;
592
593 // If a separate layout is specified, look for that.
594 const auto *attachment_description_stencil_layout =
595 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(render_pass_info->pAttachments[i].pNext);
596 if (attachment_description_stencil_layout) {
597 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
598 }
599
600 const ImageSubresourceLayoutMap *subresource_map = nullptr;
601 bool has_queried_map = false;
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600602
603 for (uint32_t aspect_index = 0; aspect_index < 32; aspect_index++) {
604 VkImageAspectFlags test_aspect = 1u << aspect_index;
605 if ((view_state->normalized_subresource_range.aspectMask & test_aspect) == 0) {
606 continue;
607 }
608
609 // Allow for differing depth and stencil layouts
610 VkImageLayout check_layout = attachment_initial_layout;
611 if (test_aspect == VK_IMAGE_ASPECT_STENCIL_BIT) {
612 check_layout = attachment_stencil_initial_layout;
613 }
614
615 // If no layout information for image yet, will be checked at QueueSubmit time
616 if (check_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
617 continue;
618 }
619 if (!has_queried_map) {
620 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to
621 // something in common with the non-const version.) The lookup is expensive, so cache it.
622 subresource_map = const_p_cb->GetImageSubresourceLayoutMap(*image_state);
623 has_queried_map = true;
624 }
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600625 if (!subresource_map) {
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600626 // If no layout information for image yet, will be checked at QueueSubmit time
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600627 continue;
628 }
629 auto normalized_range = view_state->normalized_subresource_range;
630 normalized_range.aspectMask = test_aspect;
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600631 LayoutUseCheckAndMessage layout_check(check_layout, test_aspect);
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600632
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600633 skip |= subresource_map->AnyInRange(
Jeremy Gebbencb13f0f2022-07-15 15:48:05 -0600634 normalized_range, [this, &layout_check, i](const LayoutRange &range, const LayoutEntry &state) {
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600635 bool subres_skip = false;
636 if (!layout_check.Check(state)) {
637 subres_skip = LogError(device, kVUID_Core_DrawState_InvalidRenderpass,
638 "You cannot start a render pass using attachment %u where the render pass initial "
639 "layout is %s "
640 "and the %s layout of the attachment is %s. The layouts must match, or the render "
641 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
642 i, string_VkImageLayout(layout_check.expected_layout), layout_check.message,
643 string_VkImageLayout(layout_check.layout));
644 }
645 return subres_skip;
646 });
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600647 }
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600648 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, *view_state, framebuffer,
649 render_pass, i, "initial layout");
650
651 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, *view_state, framebuffer, render_pass, i,
652 "final layout");
653 }
654
655 for (uint32_t j = 0; j < render_pass_info->subpassCount; ++j) {
656 auto &subpass = render_pass_info->pSubpasses[j];
657 for (uint32_t k = 0; k < render_pass_info->pSubpasses[j].inputAttachmentCount; ++k) {
658 auto &attachment_ref = subpass.pInputAttachments[k];
659 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
660 auto image_view = attachments[attachment_ref.attachment];
661 auto view_state = Get<IMAGE_VIEW_STATE>(image_view);
662
663 if (view_state) {
664 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, *view_state,
665 framebuffer, render_pass, attachment_ref.attachment,
666 "input attachment layout");
667 }
668 }
669 }
670
671 for (uint32_t k = 0; k < render_pass_info->pSubpasses[j].colorAttachmentCount; ++k) {
672 auto &attachment_ref = subpass.pColorAttachments[k];
673 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
674 auto image_view = attachments[attachment_ref.attachment];
675 auto view_state = Get<IMAGE_VIEW_STATE>(image_view);
676
677 if (view_state) {
678 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, *view_state,
679 framebuffer, render_pass, attachment_ref.attachment,
680 "color attachment layout");
681 if (subpass.pResolveAttachments) {
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600682 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, *view_state,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700683 framebuffer, render_pass, attachment_ref.attachment,
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600684 "resolve attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100685 }
686 }
687 }
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600688 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100689
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600690 if (render_pass_info->pSubpasses[j].pDepthStencilAttachment) {
691 auto &attachment_ref = *subpass.pDepthStencilAttachment;
692 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
693 auto image_view = attachments[attachment_ref.attachment];
694 auto view_state = Get<IMAGE_VIEW_STATE>(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100695
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600696 if (view_state) {
697 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, *view_state,
698 framebuffer, render_pass, attachment_ref.attachment,
699 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100700 }
701 }
702 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700703 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600704 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700705}
706
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600707void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700708 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700709 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -0600710 IMAGE_VIEW_STATE *image_view = pCB->GetActiveAttachmentImageViewState(ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600711 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700712 VkImageLayout stencil_layout = kInvalidLayout;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700713 const auto *attachment_reference_stencil_layout = LvlFindInChain<VkAttachmentReferenceStencilLayout>(ref.pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700714 if (attachment_reference_stencil_layout) {
715 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
716 }
717
Jeremy Gebben1ec89332021-08-05 13:51:49 -0600718 pCB->SetImageViewLayout(*image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600719 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700720 }
721}
722
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600723void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
724 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700725 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700726
727 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700728 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700729 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700730 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700731 }
732 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700733 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700734 }
735 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700736 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700737 }
738 }
739}
740
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700741// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
742// 1. Transition into initialLayout state
743// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600744void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700745 FRAMEBUFFER_STATE *framebuffer_state) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700746 // First record expected initialLayout as a potential initial layout usage.
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700747 auto const rpci = render_pass_state->createInfo.ptr();
748 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -0600749 auto *view_state = cb_state->GetActiveAttachmentImageViewState(i);
John Zulauf8e308292018-09-21 11:34:37 -0600750 if (view_state) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700751 IMAGE_STATE *image_state = view_state->image_state.get();
752 const auto initial_layout = rpci->pAttachments[i].initialLayout;
Piers Daniell4fde9b72019-11-27 16:19:46 -0700753 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700754 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(rpci->pAttachments[i].pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700755 if (attachment_description_stencil_layout) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700756 const auto stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
757 VkImageSubresourceRange sub_range = view_state->normalized_subresource_range;
758 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
Jeremy Gebben1ec89332021-08-05 13:51:49 -0600759 cb_state->SetImageInitialLayout(*image_state, sub_range, initial_layout);
John Zulauf81dd1f12021-01-26 16:49:16 -0700760 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
Jeremy Gebben1ec89332021-08-05 13:51:49 -0600761 cb_state->SetImageInitialLayout(*image_state, sub_range, stencil_initial_layout);
John Zulauf81dd1f12021-01-26 16:49:16 -0700762 } else {
Jeremy Gebben1ec89332021-08-05 13:51:49 -0600763 cb_state->SetImageInitialLayout(*image_state, view_state->normalized_subresource_range, initial_layout);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700764 }
John Zulauf8e308292018-09-21 11:34:37 -0600765 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700766 }
767 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700768 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700769}
770
Dave Houlton10b39482017-03-16 13:18:15 -0600771bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600772 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600773 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600774 }
775 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600776 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600777 }
778 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600779 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600780 }
Mike Schuchardt2df08912020-12-15 16:28:09 -0800781 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 -0700782 if (FormatPlaneCount(format) == 1) return false;
783 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600784 return true;
785}
786
sfricke-samsung10b35ce2021-09-29 08:50:20 -0700787// There is a table in the Vulkan spec to list all formats that implicitly require YCbCr conversion,
788// but some features/extensions can explicitly turn that restriction off
789// The implicit check is done in format utils, while feature checks are done here in CoreChecks
790bool CoreChecks::FormatRequiresYcbcrConversionExplicitly(const VkFormat format) const {
791 if (format == VK_FORMAT_R10X6G10X6B10X6A10X6_UNORM_4PACK16 &&
792 enabled_features.rgba10x6_formats_features.formatRgba10x6WithoutYCbCrSampler) {
793 return false;
794 }
795 return FormatRequiresYcbcrConversion(format);
796}
797
Mike Weiblen62d08a32017-03-07 22:18:27 -0700798// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -0700799bool CoreChecks::ValidateBarrierLayoutToImageUsage(const Location &loc, VkImage image, VkImageLayout layout,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700800 VkImageUsageFlags usage_flags) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700801 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700802 bool is_error = false;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700803 switch (layout) {
804 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700805 is_error = ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700806 break;
807 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700808 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700809 break;
810 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700811 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700812 break;
813 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700814 is_error = ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700815 break;
816 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700817 is_error = ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700818 break;
819 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700820 is_error = ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700821 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600822 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700823 is_error = ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0);
Jeff Bolz9af91c52018-09-01 21:53:57 -0500824 break;
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700825 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700826 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700827 break;
828 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700829 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700830 break;
Tony-LunarG10f54412022-08-12 11:43:40 -0600831 case VK_IMAGE_LAYOUT_ATTACHMENT_FEEDBACK_LOOP_OPTIMAL_EXT:
832 is_error = ((usage_flags & (VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) == 0);
833 is_error |= ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0);
834 is_error |= ((usage_flags & VK_IMAGE_USAGE_ATTACHMENT_FEEDBACK_LOOP_BIT_EXT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700835 default:
836 // Other VkImageLayout values do not have VUs defined in this context.
837 break;
838 }
839
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700840 if (is_error) {
841 const auto &vuid = sync_vuid_maps::GetBadImageLayoutVUID(loc, layout);
842
843 skip |=
844 LogError(image, vuid, "%s Image barrier Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".",
845 loc.Message().c_str(), string_VkImageLayout(layout), report_data->FormatHandle(image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700846 }
847 return skip;
848}
849
850// Verify image barriers are compatible with the images they reference.
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700851template <typename ImageBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -0700852bool CoreChecks::ValidateBarriersToImages(const Location &outer_loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700853 uint32_t imageMemoryBarrierCount, const ImageBarrier *pImageMemoryBarriers) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700854 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700855 using sync_vuid_maps::GetImageBarrierVUID;
856 using sync_vuid_maps::ImageError;
Petr Krausad0096a2019-08-09 18:35:04 +0200857
John Zulauf463c51e2018-05-31 13:29:20 -0600858 // Scoreboard for duplicate layout transition barriers within the list
859 // 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 +0200860 const CommandBufferImageLayoutMap &current_map = cb_state->GetImageSubresourceLayoutMap();
861 CommandBufferImageLayoutMap layout_updates;
John Zulauf463c51e2018-05-31 13:29:20 -0600862
Mike Weiblen62d08a32017-03-07 22:18:27 -0700863 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700864 auto loc = outer_loc.dot(Field::pImageMemoryBarriers, i);
Petr Krausad0096a2019-08-09 18:35:04 +0200865 const auto &img_barrier = pImageMemoryBarriers[i];
Mike Weiblen62d08a32017-03-07 22:18:27 -0700866
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600867 auto image_state = Get<IMAGE_STATE>(img_barrier.image);
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600868 if (!image_state) {
869 continue;
870 }
Tony-LunarG10f54412022-08-12 11:43:40 -0600871
872 if ((img_barrier.srcQueueFamilyIndex != img_barrier.dstQueueFamilyIndex) ||
873 (img_barrier.oldLayout != img_barrier.newLayout)) {
874 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
875 skip |=
876 ValidateBarrierLayoutToImageUsage(loc.dot(Field::oldLayout), img_barrier.image, img_barrier.oldLayout, usage_flags);
877 skip |=
878 ValidateBarrierLayoutToImageUsage(loc.dot(Field::newLayout), img_barrier.image, img_barrier.newLayout, usage_flags);
879 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600880
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600881 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
882 if (image_state->layout_locked) {
883 // TODO: Add unique id for error when available
884 skip |= LogError(
885 img_barrier.image, "VUID-Undefined",
886 "%s Attempting to transition shared presentable %s"
887 " from layout %s to layout %s, but image has already been presented and cannot have its layout transitioned.",
888 loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
889 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(img_barrier.newLayout));
890 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600891
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600892 const VkImageCreateInfo &image_create_info = image_state->createInfo;
893 const VkFormat image_format = image_create_info.format;
894 const VkImageAspectFlags aspect_mask = img_barrier.subresourceRange.aspectMask;
895 // For a Depth/Stencil image both aspects MUST be set
896 auto image_loc = loc.dot(Field::image);
897 if (FormatIsDepthAndStencil(image_format)) {
898 if (enabled_features.core12.separateDepthStencilLayouts) {
899 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
900 auto vuid = GetImageBarrierVUID(loc, ImageError::kNotDepthOrStencilAspect);
sfricke-samsung79b00482020-04-01 21:15:50 -0700901 skip |= LogError(img_barrier.image, vuid,
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600902 "%s references %s of format %s that must have either the depth or stencil "
903 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
904 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
905 string_VkFormat(image_format), aspect_mask);
906 }
907 } else {
908 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
909 if ((aspect_mask & ds_mask) != (ds_mask)) {
910 auto error = IsExtEnabled(device_extensions.vk_khr_separate_depth_stencil_layouts)
911 ? ImageError::kNotSeparateDepthAndStencilAspect
912 : ImageError::kNotDepthAndStencilAspect;
913 auto vuid = GetImageBarrierVUID(image_loc, error);
914 skip |= LogError(img_barrier.image, vuid,
915 "%s references %s of format %s that must have the depth and stencil "
916 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700917 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700918 string_VkFormat(image_format), aspect_mask);
919 }
920 }
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600921 }
sfricke-samsung79b00482020-04-01 21:15:50 -0700922
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600923 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
924 // TODO: Set memory invalid which is in mem_tracker currently
925 } else if (!QueueFamilyIsExternal(img_barrier.srcQueueFamilyIndex)) {
926 auto &write_subresource_map = layout_updates[image_state.get()];
927 bool new_write = false;
928 if (!write_subresource_map) {
929 write_subresource_map = std::make_shared<ImageSubresourceLayoutMap>(*image_state);
930 new_write = true;
931 }
932 const auto &current_subresource_map = current_map.find(image_state.get());
933 const auto &read_subresource_map = (new_write && current_subresource_map != current_map.end())
934 ? (*current_subresource_map).second
935 : write_subresource_map;
936
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600937 // Validate aspects in isolation.
938 // This is required when handling separate depth-stencil layouts.
939 for (uint32_t aspect_index = 0; aspect_index < 32; aspect_index++) {
940 VkImageAspectFlags test_aspect = 1u << aspect_index;
941 if ((img_barrier.subresourceRange.aspectMask & test_aspect) == 0) {
942 continue;
943 }
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600944 auto old_layout = NormalizeSynchronization2Layout(img_barrier.subresourceRange.aspectMask, img_barrier.oldLayout);
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600945
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600946 LayoutUseCheckAndMessage layout_check(old_layout, test_aspect);
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600947 auto normalized_isr = image_state->NormalizeSubresourceRange(img_barrier.subresourceRange);
948 normalized_isr.aspectMask = test_aspect;
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600949 skip |= read_subresource_map->AnyInRange(
Jeremy Gebbencb13f0f2022-07-15 15:48:05 -0600950 normalized_isr, [this, read_subresource_map, cb_state, &layout_check, &loc, &img_barrier](
951 const LayoutRange &range, const LayoutEntry &state) {
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600952 bool subres_skip = false;
953 if (!layout_check.Check(state)) {
954 const auto &vuid = GetImageBarrierVUID(loc, ImageError::kConflictingLayout);
Jeremy Gebbencb13f0f2022-07-15 15:48:05 -0600955 auto subres = read_subresource_map->Decode(range.begin);
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600956 subres_skip = LogError(
957 cb_state->commandBuffer(), vuid,
958 "%s %s cannot transition the layout of aspect=%d level=%d layer=%d from %s when the "
959 "%s layout is %s.",
960 loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(), subres.aspectMask,
961 subres.mipLevel, subres.arrayLayer, string_VkImageLayout(img_barrier.oldLayout),
962 layout_check.message, string_VkImageLayout(layout_check.layout));
963 }
964 return subres_skip;
965 });
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600966 write_subresource_map->SetSubresourceRangeLayout(*cb_state, normalized_isr, img_barrier.newLayout);
967 }
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600968 }
969
970 // checks color format and (single-plane or non-disjoint)
971 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
972 if ((FormatIsColor(image_format) == true) &&
973 ((FormatIsMultiplane(image_format) == false) || (image_state->disjoint == false))) {
974 if (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT) {
975 auto error = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion) ? ImageError::kNotColorAspect
976 : ImageError::kNotColorAspectYcbcr;
977 const auto &vuid = GetImageBarrierVUID(loc, error);
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700978 skip |= LogError(img_barrier.image, vuid,
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600979 "%s references %s of format %s that must be only VK_IMAGE_ASPECT_COLOR_BIT, "
980 "but its aspectMask is 0x%" PRIx32 ".",
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700981 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700982 string_VkFormat(image_format), aspect_mask);
983 }
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600984 }
sfricke-samsung79b00482020-04-01 21:15:50 -0700985
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600986 VkImageAspectFlags valid_disjoint_mask =
987 VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT | VK_IMAGE_ASPECT_COLOR_BIT;
988 if ((FormatIsMultiplane(image_format) == true) && (image_state->disjoint == true) &&
989 ((aspect_mask & valid_disjoint_mask) == 0)) {
990 const auto &vuid = GetImageBarrierVUID(image_loc, ImageError::kBadMultiplanarAspect);
991 skip |= LogError(img_barrier.image, vuid,
992 "%s references %s of format %s has aspectMask (0x%" PRIx32
993 ") but needs to include either an VK_IMAGE_ASPECT_PLANE_*_BIT or VK_IMAGE_ASPECT_COLOR_BIT.",
994 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
995 string_VkFormat(image_format), aspect_mask);
996 }
997
998 if ((FormatPlaneCount(image_format) == 2) && ((aspect_mask & VK_IMAGE_ASPECT_PLANE_2_BIT) != 0)) {
999 const auto &vuid = GetImageBarrierVUID(image_loc, ImageError::kBadPlaneCount);
1000 skip |= LogError(img_barrier.image, vuid,
1001 "%s references %s of format %s has only two planes but included "
1002 "VK_IMAGE_ASPECT_PLANE_2_BIT in its aspectMask (0x%" PRIx32 ").",
1003 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1004 string_VkFormat(image_format), aspect_mask);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001005 }
1006 }
1007 return skip;
1008}
1009
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001010template <typename Barrier, typename TransferBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001011bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const Location &loc, const CMD_BUFFER_STATE *cb_state, const Barrier &barrier,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001012 const QFOTransferBarrierSets<TransferBarrier> &barrier_sets) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001013 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001014 const char *handle_name = TransferBarrier::HandleName();
John Zulauf6b4aae82018-05-09 13:03:36 -06001015 const char *transfer_type = nullptr;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001016 if (!IsTransferOp(barrier)) {
1017 return skip;
1018 }
1019 const TransferBarrier *barrier_record = nullptr;
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001020 if (cb_state->IsReleaseOp(barrier) && !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001021 const auto found = barrier_sets.release.find(barrier);
1022 if (found != barrier_sets.release.cend()) {
1023 barrier_record = &(*found);
1024 transfer_type = "releasing";
John Zulauf6b4aae82018-05-09 13:03:36 -06001025 }
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001026 } else if (cb_state->IsAcquireOp(barrier) && !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001027 const auto found = barrier_sets.acquire.find(barrier);
1028 if (found != barrier_sets.acquire.cend()) {
1029 barrier_record = &(*found);
1030 transfer_type = "acquiring";
John Zulauf6b4aae82018-05-09 13:03:36 -06001031 }
1032 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001033 if (barrier_record != nullptr) {
1034 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001035 LogWarning(cb_state->commandBuffer(), TransferBarrier::ErrMsgDuplicateQFOInCB(),
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001036 "%s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
1037 " duplicates existing barrier recorded in this command buffer.",
1038 loc.Message().c_str(), transfer_type, handle_name, report_data->FormatHandle(barrier_record->handle).c_str(),
1039 barrier_record->srcQueueFamilyIndex, barrier_record->dstQueueFamilyIndex);
1040 }
John Zulauf6b4aae82018-05-09 13:03:36 -06001041 return skip;
1042}
1043
John Zulaufa4472282019-08-22 14:44:34 -06001044VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
1045 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1046}
1047
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001048VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier2KHR &barrier) {
1049 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1050}
1051
Jeremy Gebben9f537102021-10-05 16:37:12 -06001052std::shared_ptr<const IMAGE_STATE> BarrierHandleState(const ValidationStateTracker &device_state,
1053 const VkImageMemoryBarrier &barrier) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001054 return device_state.Get<IMAGE_STATE>(barrier.image);
John Zulaufa4472282019-08-22 14:44:34 -06001055}
1056
Jeremy Gebben9f537102021-10-05 16:37:12 -06001057std::shared_ptr<const IMAGE_STATE> BarrierHandleState(const ValidationStateTracker &device_state,
1058 const VkImageMemoryBarrier2KHR &barrier) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001059 return device_state.Get<IMAGE_STATE>(barrier.image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001060}
1061
John Zulaufa4472282019-08-22 14:44:34 -06001062VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
1063 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1064}
1065
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001066VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier2KHR &barrier) {
1067 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1068}
1069
Jeremy Gebben9f537102021-10-05 16:37:12 -06001070const std::shared_ptr<const BUFFER_STATE> BarrierHandleState(const ValidationStateTracker &device_state,
1071 const VkBufferMemoryBarrier &barrier) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001072 return device_state.Get<BUFFER_STATE>(barrier.buffer);
John Zulaufa4472282019-08-22 14:44:34 -06001073}
1074
Jeremy Gebben9f537102021-10-05 16:37:12 -06001075std::shared_ptr<const BUFFER_STATE> BarrierHandleState(const ValidationStateTracker &device_state,
1076 const VkBufferMemoryBarrier2KHR &barrier) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001077 return device_state.Get<BUFFER_STATE>(barrier.buffer);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001078}
John Zulaufa4472282019-08-22 14:44:34 -06001079
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001080template <typename Barrier, typename TransferBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001081void CoreChecks::RecordBarrierValidationInfo(const Location &loc, CMD_BUFFER_STATE *cb_state, const Barrier &barrier,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001082 QFOTransferBarrierSets<TransferBarrier> &barrier_sets) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001083 if (IsTransferOp(barrier)) {
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001084 if (cb_state->IsReleaseOp(barrier) && !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001085 barrier_sets.release.emplace(barrier);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001086 } else if (cb_state->IsAcquireOp(barrier) && !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001087 barrier_sets.acquire.emplace(barrier);
John Zulaufa4472282019-08-22 14:44:34 -06001088 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001089 }
John Zulaufa4472282019-08-22 14:44:34 -06001090
David Zhao Akeleyd76df472021-05-15 17:25:59 -07001091 // 7.7.4: If the values of srcQueueFamilyIndex and dstQueueFamilyIndex are equal, no ownership transfer is performed, and the
1092 // barrier operates as if they were both set to VK_QUEUE_FAMILY_IGNORED.
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001093 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
1094 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
David Zhao Akeleyd76df472021-05-15 17:25:59 -07001095 const bool is_ownership_transfer = src_queue_family != dst_queue_family;
1096
1097 if (is_ownership_transfer) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001098 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
1099 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
1100 auto handle_state = BarrierHandleState(*this, barrier);
1101 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
1102 if (!mode_concurrent) {
1103 const auto typed_handle = BarrierTypedHandle(barrier);
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001104 core_error::LocationCapture loc_capture(loc);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001105 cb_state->queue_submit_functions.emplace_back(
Jeremy Gebbene5361dd2021-11-18 14:23:56 -07001106 [loc_capture, typed_handle, src_queue_family, dst_queue_family](
1107 const ValidationStateTracker &device_data, const QUEUE_STATE &queue_state, const CMD_BUFFER_STATE &cb_state) {
John Zulaufb4438f02021-02-20 20:22:16 -07001108 return ValidateConcurrentBarrierAtSubmit(loc_capture.Get(), device_data, queue_state, cb_state, typed_handle,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001109 src_queue_family, dst_queue_family);
1110 });
John Zulauf6b4aae82018-05-09 13:03:36 -06001111 }
1112 }
1113}
1114
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001115// Verify image barrier image state and that the image is consistent with FB image
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001116template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001117bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001118 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1119 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001120 const ImgBarrier &img_barrier, const CMD_BUFFER_STATE *primary_cb_state) const {
1121 using sync_vuid_maps::GetImageBarrierVUID;
1122 using sync_vuid_maps::ImageError;
1123
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001124 bool skip = false;
1125 const auto *fb_state = framebuffer;
1126 assert(fb_state);
1127 const auto img_bar_image = img_barrier.image;
1128 bool image_match = false;
1129 bool sub_image_found = false; // Do we find a corresponding subpass description
1130 VkImageLayout sub_image_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1131 uint32_t attach_index = 0;
1132 // Verify that a framebuffer image matches barrier image
1133 const auto attachment_count = fb_state->createInfo.attachmentCount;
1134 for (uint32_t attachment = 0; attachment < attachment_count; ++attachment) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06001135 auto view_state = primary_cb_state ? primary_cb_state->GetActiveAttachmentImageViewState(attachment) : cb_state->GetActiveAttachmentImageViewState(attachment);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001136 if (view_state && (img_bar_image == view_state->create_info.image)) {
1137 image_match = true;
1138 attach_index = attachment;
1139 break;
1140 }
1141 }
1142 if (image_match) { // Make sure subpass is referring to matching attachment
1143 if (sub_desc.pDepthStencilAttachment && sub_desc.pDepthStencilAttachment->attachment == attach_index) {
1144 sub_image_layout = sub_desc.pDepthStencilAttachment->layout;
1145 sub_image_found = true;
1146 }
sfricke-samsung45996a42021-09-16 13:45:27 -07001147 if (!sub_image_found && IsExtEnabled(device_extensions.vk_khr_depth_stencil_resolve)) {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001148 const auto *resolve = LvlFindInChain<VkSubpassDescriptionDepthStencilResolve>(sub_desc.pNext);
1149 if (resolve && resolve->pDepthStencilResolveAttachment &&
1150 resolve->pDepthStencilResolveAttachment->attachment == attach_index) {
1151 sub_image_layout = resolve->pDepthStencilResolveAttachment->layout;
1152 sub_image_found = true;
1153 }
1154 }
1155 if (!sub_image_found) {
1156 for (uint32_t j = 0; j < sub_desc.colorAttachmentCount; ++j) {
1157 if (sub_desc.pColorAttachments && sub_desc.pColorAttachments[j].attachment == attach_index) {
1158 sub_image_layout = sub_desc.pColorAttachments[j].layout;
1159 sub_image_found = true;
1160 break;
1161 }
1162 if (!sub_image_found && sub_desc.pResolveAttachments &&
1163 sub_desc.pResolveAttachments[j].attachment == attach_index) {
1164 sub_image_layout = sub_desc.pResolveAttachments[j].layout;
1165 sub_image_found = true;
1166 break;
1167 }
1168 }
1169 }
1170 if (!sub_image_found) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001171 auto img_loc = loc.dot(Field::image);
1172 const auto &vuid = GetImageBarrierVUID(img_loc, ImageError::kRenderPassMismatch);
1173 skip |=
1174 LogError(rp_handle, vuid,
1175 "%s Barrier for %s is not referenced by the VkSubpassDescription for active subpass (%d) of current %s.",
1176 img_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(), active_subpass,
1177 report_data->FormatHandle(rp_handle).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001178 }
1179 } else { // !image_match
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001180 auto img_loc = loc.dot(Field::image);
1181 const auto &vuid = GetImageBarrierVUID(img_loc, ImageError::kRenderPassMismatch);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001182 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 -07001183 img_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001184 report_data->FormatHandle(fb_state->framebuffer()).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001185 }
1186 if (img_barrier.oldLayout != img_barrier.newLayout) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001187 auto layout_loc = loc.dot(Field::oldLayout);
1188 const auto &vuid = GetImageBarrierVUID(layout_loc, ImageError::kRenderPassLayoutChange);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001189 skip |= LogError(cb_state->commandBuffer(), vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001190 "%s As the Image Barrier for %s is being executed within a render pass instance, oldLayout must "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001191 "equal newLayout yet they are %s and %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001192 layout_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001193 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(img_barrier.newLayout));
1194 } else {
1195 if (sub_image_found && sub_image_layout != img_barrier.oldLayout) {
1196 LogObjectList objlist(rp_handle);
1197 objlist.add(img_bar_image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001198 auto layout_loc = loc.dot(Field::oldLayout);
1199 const auto &vuid = GetImageBarrierVUID(layout_loc, ImageError::kRenderPassLayoutChange);
1200 skip |= LogError(objlist, vuid,
1201 "%s Barrier for %s is referenced by the VkSubpassDescription for active "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001202 "subpass (%d) of current %s as having layout %s, but image barrier has layout %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001203 layout_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(), active_subpass,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001204 report_data->FormatHandle(rp_handle).c_str(), string_VkImageLayout(sub_image_layout),
1205 string_VkImageLayout(img_barrier.oldLayout));
1206 }
1207 }
1208 return skip;
1209}
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001210// explictly instantiate so these can be used in core_validation.cpp
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001211template bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001212 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1213 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
1214 const VkImageMemoryBarrier &img_barrier,
1215 const CMD_BUFFER_STATE *primary_cb_state) const;
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001216template bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001217 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1218 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
1219 const VkImageMemoryBarrier2KHR &img_barrier,
1220 const CMD_BUFFER_STATE *primary_cb_state) const;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001221
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001222template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001223void CoreChecks::EnqueueSubmitTimeValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001224 const ImgBarrier &barrier) {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001225 // Secondary CBs can have null framebuffer so queue up validation in that case 'til FB is known
1226 if ((cb_state->activeRenderPass) && (VK_NULL_HANDLE == cb_state->activeFramebuffer) &&
1227 (VK_COMMAND_BUFFER_LEVEL_SECONDARY == cb_state->createInfo.level)) {
1228 const auto active_subpass = cb_state->activeSubpass;
1229 const auto rp_state = cb_state->activeRenderPass;
1230 const auto &sub_desc = rp_state->createInfo.pSubpasses[active_subpass];
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001231 // Secondary CB case w/o FB specified delay validation
1232 auto *this_ptr = this; // Required for older compilers with c++20 compatibility
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001233 core_error::LocationCapture loc_capture(loc);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001234 const auto render_pass = rp_state->renderPass();
John Zulaufb4438f02021-02-20 20:22:16 -07001235 cb_state->cmd_execute_commands_functions.emplace_back(
Jeremy Gebben057f9d52021-11-05 14:12:31 -06001236 [this_ptr, loc_capture, active_subpass, sub_desc, render_pass, barrier](
1237 const CMD_BUFFER_STATE &secondary_cb, const CMD_BUFFER_STATE *primary_cb, const FRAMEBUFFER_STATE *fb) {
1238 return this_ptr->ValidateImageBarrierAttachment(loc_capture.Get(), &secondary_cb, fb, active_subpass, sub_desc,
John Zulaufb4438f02021-02-20 20:22:16 -07001239 render_pass, barrier, primary_cb);
1240 });
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001241 }
1242}
1243
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001244void CoreChecks::RecordBarriers(Func func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001245 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1246 const VkImageMemoryBarrier *pImageMemBarriers) {
1247 for (uint32_t i = 0; i < bufferBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001248 Location loc(func_name, Struct::VkBufferMemoryBarrier, Field::pBufferMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001249 RecordBarrierValidationInfo(loc, cb_state, pBufferMemBarriers[i], cb_state->qfo_transfer_buffer_barriers);
1250 }
1251 for (uint32_t i = 0; i < imageMemBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001252 Location loc(func_name, Struct::VkImageMemoryBarrier, Field::pImageMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001253 const auto &img_barrier = pImageMemBarriers[i];
1254 RecordBarrierValidationInfo(loc, cb_state, img_barrier, cb_state->qfo_transfer_image_barriers);
1255 EnqueueSubmitTimeValidateImageBarrierAttachment(loc, cb_state, img_barrier);
1256 }
1257}
1258
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001259void CoreChecks::RecordBarriers(Func func_name, CMD_BUFFER_STATE *cb_state, const VkDependencyInfoKHR &dep_info) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001260 for (uint32_t i = 0; i < dep_info.bufferMemoryBarrierCount; i++) {
Tony-LunarG279601c2021-11-16 10:50:51 -07001261 Location loc(func_name, Struct::VkBufferMemoryBarrier2, Field::pBufferMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001262 RecordBarrierValidationInfo(loc, cb_state, dep_info.pBufferMemoryBarriers[i], cb_state->qfo_transfer_buffer_barriers);
1263 }
1264 for (uint32_t i = 0; i < dep_info.imageMemoryBarrierCount; i++) {
Tony-LunarG279601c2021-11-16 10:50:51 -07001265 Location loc(func_name, Struct::VkImageMemoryBarrier2, Field::pImageMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001266 const auto &img_barrier = dep_info.pImageMemoryBarriers[i];
1267 RecordBarrierValidationInfo(loc, cb_state, img_barrier, cb_state->qfo_transfer_image_barriers);
1268 EnqueueSubmitTimeValidateImageBarrierAttachment(loc, cb_state, img_barrier);
1269 }
1270}
1271
1272template <typename TransferBarrier, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001273bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001274 const char *operation, const TransferBarrier &barrier,
1275 Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001276 // Record to the scoreboard or report that we have a duplication
1277 bool skip = false;
Jeremy Gebbencbf22862021-03-03 12:01:22 -07001278 auto inserted = scoreboard->emplace(barrier, cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001279 if (!inserted.second && inserted.first->second != cb_state) {
1280 // 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 -06001281 LogObjectList objlist(cb_state->commandBuffer());
Mark Lobodzinskiea561582020-03-16 18:13:56 -06001282 objlist.add(barrier.handle);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001283 objlist.add(inserted.first->second->commandBuffer());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001284 skip = LogWarning(objlist, TransferBarrier::ErrMsgDuplicateQFOInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001285 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1286 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001287 "vkQueueSubmit()", TransferBarrier::BarrierName(), operation, TransferBarrier::HandleName(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001288 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001289 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer()).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001290 }
1291 return skip;
1292}
1293
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001294template <typename TransferBarrier>
1295bool CoreChecks::ValidateQueuedQFOTransferBarriers(
1296 const CMD_BUFFER_STATE *cb_state, QFOTransferCBScoreboards<TransferBarrier> *scoreboards,
1297 const GlobalQFOTransferBarrierMap<TransferBarrier> &global_release_barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001298 bool skip = false;
Jeremy Gebben159b3cc2021-06-03 09:09:03 -06001299 const auto &cb_barriers = cb_state->GetQFOBarrierSets(TransferBarrier());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001300 const char *barrier_name = TransferBarrier::BarrierName();
1301 const char *handle_name = TransferBarrier::HandleName();
John Zulauf6b4aae82018-05-09 13:03:36 -06001302 // No release should have an extant duplicate (WARNING)
1303 for (const auto &release : cb_barriers.release) {
1304 // Check the global pending release barriers
1305 const auto set_it = global_release_barriers.find(release.handle);
1306 if (set_it != global_release_barriers.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001307 const QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001308 const auto found = set_for_handle.find(release);
1309 if (found != set_for_handle.cend()) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001310 skip |= LogWarning(cb_state->commandBuffer(), TransferBarrier::ErrMsgDuplicateQFOSubmitted(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001311 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1312 " to dstQueueFamilyIndex %" PRIu32
1313 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1314 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1315 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001316 }
1317 }
1318 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1319 }
1320 // Each acquire must have a matching release (ERROR)
1321 for (const auto &acquire : cb_barriers.acquire) {
1322 const auto set_it = global_release_barriers.find(acquire.handle);
1323 bool matching_release_found = false;
1324 if (set_it != global_release_barriers.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001325 const QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001326 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1327 }
1328 if (!matching_release_found) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001329 skip |= LogError(cb_state->commandBuffer(), TransferBarrier::ErrMsgMissingQFOReleaseInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001330 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1331 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1332 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1333 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001334 }
1335 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1336 }
1337 return skip;
1338}
1339
John Zulauf3b04ebd2019-07-18 14:08:11 -06001340bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001341 QFOTransferCBScoreboards<QFOImageTransferBarrier> *qfo_image_scoreboards,
1342 QFOTransferCBScoreboards<QFOBufferTransferBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001343 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001344 skip |=
1345 ValidateQueuedQFOTransferBarriers<QFOImageTransferBarrier>(cb_state, qfo_image_scoreboards, qfo_release_image_barrier_map);
1346 skip |= ValidateQueuedQFOTransferBarriers<QFOBufferTransferBarrier>(cb_state, qfo_buffer_scoreboards,
1347 qfo_release_buffer_barrier_map);
John Zulauf6b4aae82018-05-09 13:03:36 -06001348 return skip;
1349}
1350
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001351template <typename TransferBarrier>
1352void RecordQueuedQFOTransferBarriers(QFOTransferBarrierSets<TransferBarrier> &cb_barriers,
1353 GlobalQFOTransferBarrierMap<TransferBarrier> &global_release_barriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001354 // Add release barriers from this submit to the global map
1355 for (const auto &release : cb_barriers.release) {
1356 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
Jeremy Gebben51499ca2022-01-11 08:36:13 -07001357 // NOTE: vl_concurrent_ordered_map::find() makes a thread safe copy of the result, so we must
1358 // copy back after updating.
1359 auto iter = global_release_barriers.find(release.handle);
1360 iter->second.insert(release);
1361 global_release_barriers.insert_or_assign(release.handle, iter->second);
John Zulauf6b4aae82018-05-09 13:03:36 -06001362 }
1363
1364 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1365 for (const auto &acquire : cb_barriers.acquire) {
1366 // NOTE: We're not using [] because we don't want to create entries for missing releases
1367 auto set_it = global_release_barriers.find(acquire.handle);
1368 if (set_it != global_release_barriers.end()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001369 QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001370 set_for_handle.erase(acquire);
1371 if (set_for_handle.size() == 0) { // Clean up empty sets
Jeremy Gebben51499ca2022-01-11 08:36:13 -07001372 global_release_barriers.erase(acquire.handle);
1373 } else {
1374 // NOTE: vl_concurrent_ordered_map::find() makes a thread safe copy of the result, so we must
1375 // copy back after updating.
1376 global_release_barriers.insert_or_assign(acquire.handle, set_for_handle);
John Zulauf6b4aae82018-05-09 13:03:36 -06001377 }
1378 }
1379 }
1380}
1381
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001382void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001383 RecordQueuedQFOTransferBarriers<QFOImageTransferBarrier>(cb_state->qfo_transfer_image_barriers, qfo_release_image_barrier_map);
1384 RecordQueuedQFOTransferBarriers<QFOBufferTransferBarrier>(cb_state->qfo_transfer_buffer_barriers,
1385 qfo_release_buffer_barrier_map);
John Zulauf6b4aae82018-05-09 13:03:36 -06001386}
1387
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001388template <typename ImgBarrier>
1389void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count, const ImgBarrier *barriers) {
1390 // For ownership transfers, the barrier is specified twice; as a release
1391 // operation on the yielding queue family, and as an acquire operation
1392 // on the acquiring queue family. This barrier may also include a layout
1393 // transition, which occurs 'between' the two operations. For validation
1394 // purposes it doesn't seem important which side performs the layout
1395 // transition, but it must not be performed twice. We'll arbitrarily
1396 // choose to perform it as part of the acquire operation.
1397 //
1398 // However, we still need to record initial layout for the "initial layout" validation
1399 for (uint32_t i = 0; i < barrier_count; i++) {
1400 const auto &mem_barrier = barriers[i];
Jeremy Gebbenefead332021-06-18 08:22:44 -06001401 const bool is_release_op = cb_state->IsReleaseOp(mem_barrier);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001402 auto image_state = Get<IMAGE_STATE>(mem_barrier.image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001403 if (image_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06001404 RecordTransitionImageLayout(cb_state, image_state.get(), mem_barrier, is_release_op);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001405 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001406 }
1407}
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001408// explictly instantiate this template so it can be used in core_validation.cpp
1409template void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1410 const VkImageMemoryBarrier *barrier);
1411template void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1412 const VkImageMemoryBarrier2KHR *barrier);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001413
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001414VkImageLayout NormalizeSynchronization2Layout(const VkImageAspectFlags aspect_mask, VkImageLayout layout);
1415
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001416template <typename ImgBarrier>
unknown86bcb3a2019-07-11 13:05:36 -06001417void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001418 const ImgBarrier &mem_barrier, bool is_release_op) {
Tony-LunarG273f32f2021-09-28 08:56:30 -06001419 if (enabled_features.core13.synchronization2) {
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001420 if (mem_barrier.oldLayout == mem_barrier.newLayout) {
1421 return;
1422 }
1423 }
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06001424 auto normalized_isr = image_state->NormalizeSubresourceRange(mem_barrier.subresourceRange);
unknown86bcb3a2019-07-11 13:05:36 -06001425
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001426 VkImageLayout initial_layout = NormalizeSynchronization2Layout(mem_barrier.subresourceRange.aspectMask, mem_barrier.oldLayout);
1427 VkImageLayout new_layout = NormalizeSynchronization2Layout(mem_barrier.subresourceRange.aspectMask, mem_barrier.newLayout);
Michael Spang8af7c102020-05-03 20:50:09 -04001428
1429 // Layout transitions in external instance are not tracked, so don't validate initial layout.
John Zulaufcea64cb2020-06-10 17:17:27 -06001430 if (QueueFamilyIsExternal(mem_barrier.srcQueueFamilyIndex)) {
Michael Spang8af7c102020-05-03 20:50:09 -04001431 initial_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1432 }
1433
John Zulauf2be3fe02019-12-30 09:48:02 -07001434 if (is_release_op) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06001435 cb_state->SetImageInitialLayout(*image_state, normalized_isr, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001436 } else {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06001437 cb_state->SetImageLayout(*image_state, normalized_isr, new_layout, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001438 }
unknown86bcb3a2019-07-11 13:05:36 -06001439}
1440
John Zulauf15578df2022-06-02 13:50:03 -06001441template <typename RangeFactory>
1442bool CoreChecks::VerifyImageLayoutRange(const CMD_BUFFER_STATE &cb_node, const IMAGE_STATE &image_state,
1443 VkImageAspectFlags aspect_mask, VkImageLayout explicit_layout,
1444 const RangeFactory &range_factory, const char *caller, const char *layout_mismatch_msg_code,
1445 bool *error) const {
1446 bool skip = false;
1447 const auto *subresource_map = cb_node.GetImageSubresourceLayoutMap(image_state);
1448 if (!subresource_map) return skip;
1449
1450 LayoutUseCheckAndMessage layout_check(explicit_layout, aspect_mask);
1451 skip |= subresource_map->AnyInRange(
Jeremy Gebbencb13f0f2022-07-15 15:48:05 -06001452 range_factory(*subresource_map), [this, subresource_map, &cb_node, &image_state, &layout_check, layout_mismatch_msg_code,
1453 caller, error](const LayoutRange &range, const LayoutEntry &state) {
John Zulauf15578df2022-06-02 13:50:03 -06001454 bool subres_skip = false;
1455 if (!layout_check.Check(state)) {
1456 *error = true;
Jeremy Gebbencb13f0f2022-07-15 15:48:05 -06001457 auto subres = subresource_map->Decode(range.begin);
John Zulauf15578df2022-06-02 13:50:03 -06001458 subres_skip |= LogError(cb_node.commandBuffer(), layout_mismatch_msg_code,
1459 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1460 "%s layout %s.",
1461 caller, report_data->FormatHandle(image_state.Handle()).c_str(), subres.arrayLayer,
1462 subres.mipLevel, string_VkImageLayout(layout_check.expected_layout), layout_check.message,
1463 string_VkImageLayout(layout_check.layout));
1464 }
1465 return subres_skip;
1466 });
1467
1468 return skip;
1469}
1470
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001471bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE &cb_node, const IMAGE_STATE &image_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001472 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1473 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1474 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06001475 if (disabled[image_layout_validation]) return false;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001476 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001477
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001478 VkImageSubresourceRange normalized_isr = image_state.NormalizeSubresourceRange(range);
John Zulauf15578df2022-06-02 13:50:03 -06001479 auto range_factory = [&normalized_isr](const ImageSubresourceLayoutMap &map) {
1480 return map.RangeGen(normalized_isr);
1481 };
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001482 skip |= VerifyImageLayoutRange(cb_node, image_state, aspect_mask, explicit_layout, range_factory, caller,
John Zulauf15578df2022-06-02 13:50:03 -06001483 layout_mismatch_msg_code, error);
John Zulauff660ad62019-03-23 07:16:05 -06001484
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001485 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1486 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1487 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001488 if (image_state.createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001489 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001490 skip |= LogPerformanceWarning(cb_node.commandBuffer(), kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001491 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001492 report_data->FormatHandle(image_state.Handle()).c_str(),
Jeremy Gebben6335df62021-11-01 10:50:13 -06001493 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001494 }
sfricke-samsung45996a42021-09-16 13:45:27 -07001495 } else if (IsExtEnabled(device_extensions.vk_khr_shared_presentable_image)) {
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001496 if (image_state.shared_presentable) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001497 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001498 skip |=
1499 LogError(device, layout_invalid_msg_code,
1500 "%s: Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1501 caller, string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001502 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001503 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001504 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001505 *error = true;
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001506 skip |= LogError(cb_node.commandBuffer(), layout_invalid_msg_code,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001507 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001508 report_data->FormatHandle(image_state.Handle()).c_str(), string_VkImageLayout(explicit_layout),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001509 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001510 }
1511 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001512 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001513}
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001514bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE &cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001515 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1516 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001517 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001518 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1519 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1520}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001521
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001522bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE &cb_node, const IMAGE_VIEW_STATE &image_view_state,
Jeremy Gebbene7b99fc2022-06-02 08:44:33 -06001523 VkImageLayout explicit_layout, const char *caller, const char *layout_mismatch_msg_code,
1524 bool *error) const {
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -06001525 if (disabled[image_layout_validation]) return false;
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001526 assert(image_view_state.image_state);
1527 auto range_factory = [&image_view_state](const ImageSubresourceLayoutMap &map) {
1528 return image_layout_map::RangeGenerator(image_view_state.range_generator);
John Zulauf15578df2022-06-02 13:50:03 -06001529 };
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -06001530
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001531 return VerifyImageLayoutRange(cb_node, *image_view_state.image_state, image_view_state.create_info.subresourceRange.aspectMask,
1532 explicit_layout, range_factory, caller, layout_mismatch_msg_code, error);
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -06001533}
1534
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001535void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001536 FRAMEBUFFER_STATE *framebuffer_state) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001537 auto render_pass = Get<RENDER_PASS_STATE>(pRenderPassBegin->renderPass);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001538 if (!render_pass) return;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001539
Mike Schuchardt2df08912020-12-15 16:28:09 -08001540 const VkRenderPassCreateInfo2 *render_pass_info = render_pass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001541 if (framebuffer_state) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001542 for (uint32_t i = 0; i < render_pass_info->attachmentCount; ++i) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06001543 auto *view_state = pCB->GetActiveAttachmentImageViewState(i);
John Zulauf8e308292018-09-21 11:34:37 -06001544 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001545 VkImageLayout stencil_layout = kInvalidLayout;
1546 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001547 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(render_pass_info->pAttachments[i].pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -07001548 if (attachment_description_stencil_layout) {
1549 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1550 }
Jeremy Gebben1ec89332021-08-05 13:51:49 -06001551 pCB->SetImageViewLayout(*view_state, render_pass_info->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001552 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001553 }
1554 }
1555}
Dave Houltone19e20d2018-02-02 16:32:41 -07001556
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001557#ifdef VK_USE_PLATFORM_ANDROID_KHR
1558// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1559// This could also move into a seperate core_validation_android.cpp file... ?
1560
1561//
1562// AHB-specific validation within non-AHB APIs
1563//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001564bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001565 bool skip = false;
1566
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001567 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(create_info->pNext);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001568 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001569 if (0 != ext_fmt_android->externalFormat) {
1570 if (VK_FORMAT_UNDEFINED != create_info->format) {
1571 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001572 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1573 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1574 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001575 }
1576
1577 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001578 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1579 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1580 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001581 }
1582
1583 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001584 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1585 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06001586 "non-zero externalFormat, but usage includes bits (0x%" PRIx32 ") other than VK_IMAGE_USAGE_SAMPLED_BIT.",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001587 create_info->usage);
Dave Houltond9611312018-11-19 17:03:36 -07001588 }
1589
1590 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001591 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1592 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1593 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001594 }
1595 }
1596
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001597 if ((0 != ext_fmt_android->externalFormat) &&
1598 (ahb_ext_formats_map.find(ext_fmt_android->externalFormat) == ahb_ext_formats_map.end())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001599 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001600 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat (%" PRIu64
1601 ") which has "
1602 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().",
1603 ext_fmt_android->externalFormat);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001604 }
1605 }
1606
Dave Houltond9611312018-11-19 17:03:36 -07001607 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001608 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001609 skip |=
1610 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1611 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1612 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001613 }
1614 }
1615
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001616 const VkExternalMemoryImageCreateInfo *emici = LvlFindInChain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001617 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1618 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001619 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001620 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1621 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1622 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1623 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001624 }
1625
1626 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001627 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1628 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1629 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1630 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1631 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001632 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001633 }
1634
1635 return skip;
1636}
1637
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001638bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001639 bool skip = false;
Jeremy Gebbenf4449392022-01-28 10:09:10 -07001640 auto image_state = Get<IMAGE_STATE>(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001641
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06001642 if (image_state->HasAHBFormat()) {
Dave Houltond9611312018-11-19 17:03:36 -07001643 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001644 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1645 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001646 "format member is %s and must be VK_FORMAT_UNDEFINED.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001647 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001648 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001649
Dave Houltond9611312018-11-19 17:03:36 -07001650 // Chain must include a compatible ycbcr conversion
1651 bool conv_found = false;
1652 uint64_t external_format = 0;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001653 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = LvlFindInChain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001654 if (ycbcr_conv_info != nullptr) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001655 auto ycbcr_state = Get<SAMPLER_YCBCR_CONVERSION_STATE>(ycbcr_conv_info->conversion);
Jeremy Gebbenf4fb2a02021-07-08 09:57:46 -06001656 if (ycbcr_state) {
Dave Houltond9611312018-11-19 17:03:36 -07001657 conv_found = true;
Jeremy Gebbenf4fb2a02021-07-08 09:57:46 -06001658 external_format = ycbcr_state->external_format;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001659 }
Dave Houltond9611312018-11-19 17:03:36 -07001660 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001661 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001662 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001663 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1664 "an externalFormat (%" PRIu64
1665 ") but needs a chained VkSamplerYcbcrConversionInfo struct with a VkSamplerYcbcrConversion created "
1666 "with the same external format.",
1667 image_state->ahb_format);
Dave Houltond9611312018-11-19 17:03:36 -07001668 }
1669
1670 // Errors in create_info swizzles
sfricke-samsungbd0e8052020-06-06 01:36:39 -07001671 if (IsIdentitySwizzle(create_info->components) == false) {
1672 skip |= LogError(
1673 create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1674 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1675 "includes one or more non-identity component swizzles, r swizzle = %s, g swizzle = %s, b swizzle = %s, a swizzle "
1676 "= %s.",
1677 string_VkComponentSwizzle(create_info->components.r), string_VkComponentSwizzle(create_info->components.g),
1678 string_VkComponentSwizzle(create_info->components.b), string_VkComponentSwizzle(create_info->components.a));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001679 }
1680 }
Dave Houltond9611312018-11-19 17:03:36 -07001681
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001682 return skip;
1683}
1684
John Zulaufa26d3c82019-08-14 16:09:08 -06001685bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001686 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001687
Jeremy Gebbenf4449392022-01-28 10:09:10 -07001688 auto image_state = Get<IMAGE_STATE>(image);
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001689 if (image_state != nullptr) {
Aitor Camacho3294edd2022-05-16 22:34:19 +02001690 if (image_state->IsExternalAHB() && (0 == image_state->GetBoundMemoryStates().size())) {
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001691 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1692 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1693 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1694 "bound to memory.");
1695 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001696 }
1697 return skip;
1698}
1699
1700#else
1701
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001702bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001703 return false;
1704}
1705
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001706bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001707
John Zulaufa26d3c82019-08-14 16:09:08 -06001708bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001709
1710#endif // VK_USE_PLATFORM_ANDROID_KHR
1711
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001712bool CoreChecks::ValidateImageFormatFeatures(const VkImageCreateInfo *pCreateInfo) const {
1713 bool skip = false;
1714
1715 // validates based on imageCreateFormatFeatures from vkspec.html#resources-image-creation-limits
Lionel Landwerlin21719f62021-12-09 11:40:09 +02001716 VkFormatFeatureFlags2KHR tiling_features = 0;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001717 const VkImageTiling image_tiling = pCreateInfo->tiling;
1718 const VkFormat image_format = pCreateInfo->format;
1719
1720 if (image_format == VK_FORMAT_UNDEFINED) {
1721 // VU 01975 states format can't be undefined unless an android externalFormat
1722#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001723 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001724 if ((image_tiling == VK_IMAGE_TILING_OPTIMAL) && (ext_fmt_android != nullptr) && (0 != ext_fmt_android->externalFormat)) {
1725 auto it = ahb_ext_formats_map.find(ext_fmt_android->externalFormat);
1726 if (it != ahb_ext_formats_map.end()) {
1727 tiling_features = it->second;
1728 }
1729 }
1730#endif
1731 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
Lionel Landwerlin1da35792021-12-14 16:54:13 +02001732 layer_data::unordered_set<uint64_t> drm_format_modifiers;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001733 const VkImageDrmFormatModifierExplicitCreateInfoEXT *drm_explicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001734 LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001735 const VkImageDrmFormatModifierListCreateInfoEXT *drm_implicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001736 LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001737
1738 if (drm_explicit != nullptr) {
Lionel Landwerlin1da35792021-12-14 16:54:13 +02001739 drm_format_modifiers.insert(drm_explicit->drmFormatModifier);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001740 } else {
1741 // VUID 02261 makes sure its only explict or implict in parameter checking
1742 assert(drm_implicit != nullptr);
1743 for (uint32_t i = 0; i < drm_implicit->drmFormatModifierCount; i++) {
Lionel Landwerlin1da35792021-12-14 16:54:13 +02001744 drm_format_modifiers.insert(drm_implicit->pDrmFormatModifiers[i]);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001745 }
1746 }
1747
Lionel Landwerlin1da35792021-12-14 16:54:13 +02001748 auto fmt_drm_props = LvlInitStruct<VkDrmFormatModifierPropertiesListEXT>();
1749 auto fmt_props_2 = LvlInitStruct<VkFormatProperties2>(&fmt_drm_props);
1750 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &fmt_props_2);
Lionel Landwerlin09351a72020-06-22 18:15:59 +03001751 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
Lionel Landwerlin1da35792021-12-14 16:54:13 +02001752 drm_properties.resize(fmt_drm_props.drmFormatModifierCount);
1753 fmt_drm_props.pDrmFormatModifierProperties = drm_properties.data();
1754 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &fmt_props_2);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001755
Lionel Landwerlin1da35792021-12-14 16:54:13 +02001756 for (uint32_t i = 0; i < fmt_drm_props.drmFormatModifierCount; i++) {
1757 if (drm_format_modifiers.find(fmt_drm_props.pDrmFormatModifierProperties[i].drmFormatModifier) !=
1758 drm_format_modifiers.end()) {
1759 tiling_features |= fmt_drm_props.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001760 }
1761 }
1762 } else {
Lionel Landwerlin21719f62021-12-09 11:40:09 +02001763 VkFormatProperties3KHR format_properties = GetPDFormatProperties(image_format);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001764 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
1765 : format_properties.optimalTilingFeatures;
1766 }
1767
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001768 // Lack of disjoint format feature support while using the flag
1769 if (FormatIsMultiplane(image_format) && ((pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT) != 0) &&
Lionel Landwerlin21719f62021-12-09 11:40:09 +02001770 ((tiling_features & VK_FORMAT_FEATURE_2_DISJOINT_BIT_KHR) == 0)) {
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001771 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateFormatFeatures-02260",
1772 "vkCreateImage(): can't use VK_IMAGE_CREATE_DISJOINT_BIT because %s doesn't support "
1773 "VK_FORMAT_FEATURE_DISJOINT_BIT based on imageCreateFormatFeatures.",
1774 string_VkFormat(pCreateInfo->format));
1775 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001776
1777 return skip;
1778}
1779
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001780bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001781 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001782 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001783
sfricke-samsung45996a42021-09-16 13:45:27 -07001784 if (IsExtEnabled(device_extensions.vk_android_external_memory_android_hardware_buffer)) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001785 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001786 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1787 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001788 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1789 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001790 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001791 }
1792
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001793 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1794 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001795 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1796 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1797 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001798 }
Dave Houlton130c0212018-01-29 13:39:56 -07001799 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001800
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001801 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001802 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1803 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1804 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001805 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001806 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width (%u) exceeds "
1807 "device maxFramebufferWidth (%u).",
1808 pCreateInfo->extent.width, device_limits->maxFramebufferWidth);
Dave Houlton130c0212018-01-29 13:39:56 -07001809 }
1810
1811 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001812 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001813 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height (%u) exceeds "
1814 "device maxFramebufferHeight (%u).",
1815 pCreateInfo->extent.height, device_limits->maxFramebufferHeight);
Dave Houlton130c0212018-01-29 13:39:56 -07001816 }
1817
ziga-lunarg44cba6e2021-07-13 17:58:06 +02001818 VkImageCreateFlags sparseFlags =
1819 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
1820 if ((pCreateInfo->flags & sparseFlags) && (pCreateInfo->usage & VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT)) {
1821 skip |= LogError(
1822 device, "VUID-VkImageCreateInfo-None-01925",
1823 "vkCreateImage(): images using sparse memory cannot have VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT set");
1824 }
1825
Agarwal, Arpit78509112022-02-17 15:29:05 -07001826 if (!enabled_features.fragment_density_map_offset_features.fragmentDensityMapOffset) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001827 uint32_t ceiling_width = static_cast<uint32_t>(ceil(
1828 static_cast<float>(device_limits->maxFramebufferWidth) /
1829 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001830 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1831 skip |=
Agarwal, Arpit78509112022-02-17 15:29:05 -07001832 LogError(device, "VUID-VkImageCreateInfo-fragmentDensityMapOffset-06514",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001833 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1834 "ceiling of device "
1835 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1836 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1837 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001838 }
1839
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001840 uint32_t ceiling_height = static_cast<uint32_t>(ceil(
1841 static_cast<float>(device_limits->maxFramebufferHeight) /
1842 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001843 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1844 skip |=
Agarwal, Arpit78509112022-02-17 15:29:05 -07001845 LogError(device, "VUID-VkImageCreateInfo-fragmentDensityMapOffset-06515",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001846 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1847 "ceiling of device "
1848 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1849 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1850 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001851 }
1852 }
1853
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001854 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001855 VkResult result = VK_SUCCESS;
1856 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1857 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1858 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1859 &format_limits);
1860 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001861 auto modifier_list = LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1862 auto explicit_modifier = LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001863 if (modifier_list) {
1864 for (uint32_t i = 0; i < modifier_list->drmFormatModifierCount; i++) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001865 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001866 drm_format_modifier.drmFormatModifier = modifier_list->pDrmFormatModifiers[i];
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001867 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001868 image_format_info.type = pCreateInfo->imageType;
1869 image_format_info.format = pCreateInfo->format;
1870 image_format_info.tiling = pCreateInfo->tiling;
1871 image_format_info.usage = pCreateInfo->usage;
1872 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001873 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001874
1875 result =
1876 DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1877 format_limits = image_format_properties.imageFormatProperties;
1878
1879 /* The application gives a list of modifier and the driver
1880 * selects one. If one is wrong, stop there.
1881 */
1882 if (result != VK_SUCCESS) break;
1883 }
1884 } else if (explicit_modifier) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001885 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001886 drm_format_modifier.drmFormatModifier = explicit_modifier->drmFormatModifier;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001887 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001888 image_format_info.type = pCreateInfo->imageType;
1889 image_format_info.format = pCreateInfo->format;
1890 image_format_info.tiling = pCreateInfo->tiling;
1891 image_format_info.usage = pCreateInfo->usage;
1892 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001893 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001894
1895 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1896 format_limits = image_format_properties.imageFormatProperties;
1897 }
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001898 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001899
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001900 // 1. vkGetPhysicalDeviceImageFormatProperties[2] only success code is VK_SUCCESS
1901 // 2. If call returns an error, then "imageCreateImageFormatPropertiesList" is defined to be the empty list
1902 // 3. All values in 02251 are undefined if "imageCreateImageFormatPropertiesList" is empty.
1903 if (result != VK_SUCCESS) {
1904 // External memory will always have a "imageCreateImageFormatPropertiesList" so skip
Lockee87f87c2019-04-23 17:53:10 -06001905#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001906 if (!LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext)) {
Lockee87f87c2019-04-23 17:53:10 -06001907#endif // VK_USE_PLATFORM_ANDROID_KHR
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001908 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateMaxMipLevels-02251",
Spencer Frickec46fc6d2020-04-16 06:23:05 -07001909 "vkCreateImage(): Format %s is not supported for this combination of parameters and "
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001910 "VkGetPhysicalDeviceImageFormatProperties returned back %s.",
1911 string_VkFormat(pCreateInfo->format), string_VkResult(result));
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001912#ifdef VK_USE_PLATFORM_ANDROID_KHR
1913 }
1914#endif // VK_USE_PLATFORM_ANDROID_KHR
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001915 } else {
1916 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1917 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001918 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1919 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1920 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001921 }
Dave Houlton130c0212018-01-29 13:39:56 -07001922
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001923 uint64_t texel_count = static_cast<uint64_t>(pCreateInfo->extent.width) *
1924 static_cast<uint64_t>(pCreateInfo->extent.height) *
1925 static_cast<uint64_t>(pCreateInfo->extent.depth) * static_cast<uint64_t>(pCreateInfo->arrayLayers) *
1926 static_cast<uint64_t>(pCreateInfo->samples);
Dave Houlton130c0212018-01-29 13:39:56 -07001927
sfricke-samsung2e827212021-09-28 07:52:08 -07001928 // Depth/Stencil formats size can't be accurately calculated
1929 if (!FormatIsDepthAndStencil(pCreateInfo->format)) {
1930 uint64_t total_size =
1931 static_cast<uint64_t>(std::ceil(FormatTexelSize(pCreateInfo->format) * static_cast<double>(texel_count)));
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001932
sfricke-samsung2e827212021-09-28 07:52:08 -07001933 // Round up to imageGranularity boundary
1934 VkDeviceSize image_granularity = phys_dev_props.limits.bufferImageGranularity;
1935 uint64_t ig_mask = image_granularity - 1;
1936 total_size = (total_size + ig_mask) & ~ig_mask;
1937
1938 if (total_size > format_limits.maxResourceSize) {
1939 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
1940 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1941 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1942 total_size, format_limits.maxResourceSize);
1943 }
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001944 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001945
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001946 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001947 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
1948 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1949 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001950 }
1951
1952 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001953 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
1954 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
1955 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001956 }
sfricke-samsung612f3622020-06-20 20:42:46 -07001957
1958 if (pCreateInfo->extent.width > format_limits.maxExtent.width) {
1959 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02252",
1960 "vkCreateImage(): extent.width %u exceeds allowable maximum image extent width %u.",
1961 pCreateInfo->extent.width, format_limits.maxExtent.width);
1962 }
1963
1964 if (pCreateInfo->extent.height > format_limits.maxExtent.height) {
1965 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02253",
1966 "vkCreateImage(): extent.height %u exceeds allowable maximum image extent height %u.",
1967 pCreateInfo->extent.height, format_limits.maxExtent.height);
1968 }
1969
1970 if (pCreateInfo->extent.depth > format_limits.maxExtent.depth) {
1971 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02254",
1972 "vkCreateImage(): extent.depth %u exceeds allowable maximum image extent depth %u.",
1973 pCreateInfo->extent.depth, format_limits.maxExtent.depth);
1974 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001975 }
1976
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001977 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsung10b35ce2021-09-29 08:50:20 -07001978 if (FormatRequiresYcbcrConversionExplicitly(pCreateInfo->format)) {
sfricke-samsungcead0802020-01-30 22:20:10 -08001979 if (pCreateInfo->mipLevels != 1) {
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07001980 skip |= LogError(device, "VUID-VkImageCreateInfo-format-06410",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001981 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
tmerilehtica733542022-04-13 14:00:29 +03001982 pCreateInfo->mipLevels);
sfricke-samsungcead0802020-01-30 22:20:10 -08001983 }
1984
1985 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001986 skip |= LogError(
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07001987 device, "VUID-VkImageCreateInfo-format-06411",
sfricke-samsungcead0802020-01-30 22:20:10 -08001988 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
1989 string_VkSampleCountFlagBits(pCreateInfo->samples));
1990 }
1991
1992 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001993 skip |= LogError(
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07001994 device, "VUID-VkImageCreateInfo-format-06412",
sfricke-samsungcead0802020-01-30 22:20:10 -08001995 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
1996 string_VkImageType(pCreateInfo->imageType));
1997 }
1998 }
1999
sfricke-samsung45996a42021-09-16 13:45:27 -07002000 if (IsExtEnabled(device_extensions.vk_khr_maintenance2)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07002001 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
sfricke-samsung08796682021-09-13 07:47:20 -07002002 if (!FormatIsCompressed(pCreateInfo->format)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07002003 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01572",
2004 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
sfricke-samsung08796682021-09-13 07:47:20 -07002005 "format must be a compressed image format, but is %s",
Spencer Fricke48db59b2020-03-23 10:31:46 -07002006 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06002007 }
2008 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07002009 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01573",
2010 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
2011 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06002012 }
2013 }
2014 }
2015
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07002016 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
sfricke-samsung45996a42021-09-16 13:45:27 -07002017 const char *vuid = IsExtEnabled(device_extensions.vk_khr_get_physical_device_properties2)
2018 ? "VUID-VkImageCreateInfo-sharingMode-01420"
2019 : "VUID-VkImageCreateInfo-sharingMode-01392";
Mark Lobodzinski314b9162020-07-16 15:33:08 -06002020 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
ziga-lunarge2e283d2021-08-01 09:55:04 +02002021 "vkCreateImage", "pCreateInfo->pQueueFamilyIndices", vuid);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07002022 }
2023
unknown2c877272019-07-11 12:56:50 -06002024 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
2025 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
2026 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002027 LogError(device, "VUID-VkImageCreateInfo-format-01577",
2028 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
2029 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06002030 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002031
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07002032 const auto swapchain_create_info = LvlFindInChain<VkImageSwapchainCreateInfoKHR>(pCreateInfo->pNext);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002033 if (swapchain_create_info != nullptr) {
2034 if (swapchain_create_info->swapchain != VK_NULL_HANDLE) {
Jeremy Gebbenf4449392022-01-28 10:09:10 -07002035 auto swapchain_state = Get<SWAPCHAIN_NODE>(swapchain_create_info->swapchain);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002036 const VkSwapchainCreateFlagsKHR swapchain_flags = swapchain_state->createInfo.flags;
2037
2038 // Validate rest of Swapchain Image create check that require swapchain state
2039 const char *vuid = "VUID-VkImageSwapchainCreateInfoKHR-swapchain-00995";
2040 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR) != 0) &&
2041 ((pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) == 0)) {
2042 skip |= LogError(
2043 device, vuid,
2044 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR flag so "
2045 "all swapchain images must have the VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT flag set.");
2046 }
2047 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR) != 0) &&
2048 ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) == 0)) {
2049 skip |= LogError(device, vuid,
2050 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR flag so all "
2051 "swapchain images must have the VK_IMAGE_CREATE_PROTECTED_BIT flag set.");
2052 }
Mike Schuchardt2df08912020-12-15 16:28:09 -08002053 const VkImageCreateFlags mutable_flags = (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT | VK_IMAGE_CREATE_EXTENDED_USAGE_BIT);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002054 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR) != 0) &&
2055 ((pCreateInfo->flags & mutable_flags) != mutable_flags)) {
2056 skip |= LogError(device, vuid,
2057 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR flag so "
2058 "all swapchain images must have the VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT and "
Mike Schuchardt2df08912020-12-15 16:28:09 -08002059 "VK_IMAGE_CREATE_EXTENDED_USAGE_BIT flags both set.");
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002060 }
2061 }
2062 }
2063
sfricke-samsungedce77a2020-07-03 22:35:13 -07002064 if ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) != 0) {
2065 if (enabled_features.core11.protectedMemory == VK_FALSE) {
2066 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01890",
2067 "vkCreateImage(): the protectedMemory device feature is disabled: Images cannot be created with the "
2068 "VK_IMAGE_CREATE_PROTECTED_BIT set.");
2069 }
2070 const VkImageCreateFlags invalid_flags =
2071 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
2072 if ((pCreateInfo->flags & invalid_flags) != 0) {
2073 skip |= LogError(device, "VUID-VkImageCreateInfo-None-01891",
2074 "vkCreateImage(): VK_IMAGE_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at same "
2075 "time (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | "
2076 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT).");
2077 }
2078 }
2079
Tony-LunarG24838772022-07-19 14:07:12 -06002080 if ((pCreateInfo->flags & VK_IMAGE_CREATE_MULTISAMPLED_RENDER_TO_SINGLE_SAMPLED_BIT_EXT) != 0) {
2081 if (!(enabled_features.multisampled_render_to_single_sampled_features.multisampledRenderToSingleSampled)) {
2082 skip |= LogError(
2083 device, "VUID-VkImageCreateInfo-multisampledRenderToSingleSampled-06882",
2084 "vkCreateImage(): pCreateInfo.flags contains VK_IMAGE_CREATE_MULTISAMPLED_RENDER_TO_SINGLE_SAMPLED_BIT_EXT "
2085 "but the multisampledRenderToSingleSampled feature is not enabled");
2086 }
2087 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
2088 skip |= LogError(
2089 device, "VUID-VkImageCreateInfo-flags-06883",
2090 "vkCreateImage(): pCreateInfo.flags contains VK_IMAGE_CREATE_MULTISAMPLED_RENDER_TO_SINGLE_SAMPLED_BIT_EXT "
2091 "but samples (%s) is not equal to VK_SAMPLE_COUNT_1_BIT",
2092 string_VkSampleCountFlagBits(pCreateInfo->samples));
2093 }
2094 }
2095
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002096 skip |= ValidateImageFormatFeatures(pCreateInfo);
2097
Nathaniel Cesarioc02c2512020-11-13 12:04:24 -07002098 // Check compatibility with VK_KHR_portability_subset
sfricke-samsung45996a42021-09-16 13:45:27 -07002099 if (IsExtEnabled(device_extensions.vk_khr_portability_subset)) {
Nathaniel Cesarioc02c2512020-11-13 12:04:24 -07002100 if (VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT & pCreateInfo->flags &&
2101 VK_FALSE == enabled_features.portability_subset_features.imageView2DOn3DImage) {
2102 skip |= LogError(device, "VUID-VkImageCreateInfo-imageView2DOn3DImage-04459",
2103 "vkCreateImage (portability error): VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT is not supported.");
2104 }
2105 if ((VK_SAMPLE_COUNT_1_BIT != pCreateInfo->samples) && (1 != pCreateInfo->arrayLayers) &&
2106 (VK_FALSE == enabled_features.portability_subset_features.multisampleArrayImage)) {
2107 skip |=
2108 LogError(device, "VUID-VkImageCreateInfo-multisampleArrayImage-04460",
2109 "vkCreateImage (portability error): Cannot create an image with samples/texel > 1 && arrayLayers != 1");
2110 }
2111 }
2112
ziga-lunarg63f8d7a2021-07-20 22:10:31 +02002113 const auto external_memory_create_info_nv = LvlFindInChain<VkExternalMemoryImageCreateInfoNV>(pCreateInfo->pNext);
ziga-lunarg62aa24f2021-10-09 11:58:30 +02002114 const auto external_memory_create_info = LvlFindInChain<VkExternalMemoryImageCreateInfo>(pCreateInfo->pNext);
2115 if (external_memory_create_info_nv != nullptr && external_memory_create_info != nullptr) {
2116 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-00988",
2117 "vkCreateImage(): VkImageCreateInfo struct has both VkExternalMemoryImageCreateInfoNV and "
2118 "VkExternalMemoryImageCreateInfo chained structs.");
2119 }
2120 if (external_memory_create_info) {
2121 if (external_memory_create_info->handleTypes != 0 && pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_UNDEFINED) {
2122 skip |= LogError(
2123 device, "VUID-VkImageCreateInfo-pNext-01443",
2124 "vkCreateImage: VkImageCreateInfo pNext chain includes VkExternalMemoryImageCreateInfo with handleTypes %" PRIu32
2125 " but pCreateInfo->initialLayout is %s.",
2126 external_memory_create_info->handleTypes, string_VkImageLayout(pCreateInfo->initialLayout));
2127 }
2128 } else if (external_memory_create_info_nv) {
2129 if (external_memory_create_info_nv->handleTypes != 0 && pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_UNDEFINED) {
2130 skip |= LogError(
2131 device, "VUID-VkImageCreateInfo-pNext-01443",
2132 "vkCreateImage: VkImageCreateInfo pNext chain includes VkExternalMemoryImageCreateInfoNV with handleTypes %" PRIu32
2133 " but pCreateInfo->initialLayout is %s.",
2134 external_memory_create_info_nv->handleTypes, string_VkImageLayout(pCreateInfo->initialLayout));
ziga-lunarg63f8d7a2021-07-20 22:10:31 +02002135 }
2136 }
2137
ziga-lunarg374fd9a2021-07-18 10:32:52 +02002138 if (device_group_create_info.physicalDeviceCount == 1) {
2139 if (pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) {
2140 skip |= LogError(device, "VUID-VkImageCreateInfo-physicalDeviceCount-01421",
2141 "vkCreateImage: Device was created with VkDeviceGroupDeviceCreateInfo::physicalDeviceCount 1, but "
2142 "flags contain VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT bit.");
2143 }
2144 }
2145
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002146 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002147}
2148
John Zulauf7eeb6f72019-06-17 11:56:36 -06002149void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
2150 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
2151 if (VK_SUCCESS != result) return;
2152
2153 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
Jeremy Gebben4a8881f2022-01-10 17:04:30 -07002154 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) != 0) {
2155 // non-sparse images set up their layout maps when memory is bound
2156 auto image_state = Get<IMAGE_STATE>(*pImage);
2157 image_state->SetInitialLayoutMap();
2158 }
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07002159}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002160
Jeff Bolz5c801d12019-10-09 10:38:45 -05002161bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeremy Gebbenf4449392022-01-28 10:09:10 -07002162 auto image_state = Get<IMAGE_STATE>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002163 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07002164 if (image_state) {
paul-lunarg4820fd12022-07-12 11:08:01 -06002165 if (image_state->IsSwapchainImage() && image_state->owned_by_swapchain) {
sfricke-samsung73452522021-06-17 08:44:46 -07002166 skip |= LogError(device, "VUID-vkDestroyImage-image-04882",
sfricke-samsung9056cc12021-04-18 22:51:00 -07002167 "vkDestroyImage(): %s is a presentable image and it is controlled by the implementation and is "
2168 "destroyed with vkDestroySwapchainKHR.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002169 report_data->FormatHandle(image_state->image()).c_str());
sfricke-samsung9056cc12021-04-18 22:51:00 -07002170 }
Jeremy Gebben9f537102021-10-05 16:37:12 -06002171 skip |= ValidateObjectNotInUse(image_state.get(), "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002172 }
2173 return skip;
2174}
2175
John Zulauf7eeb6f72019-06-17 11:56:36 -06002176void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
2177 // Clean up validation specific data
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002178 auto image_state = Get<IMAGE_STATE>(image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07002179 qfo_release_image_barrier_map.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06002180 // Clean up generic image state
2181 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002182}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002183
sfricke-samsungcd924d92020-05-20 23:51:17 -07002184bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range,
2185 const char *param_name) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002186 bool skip = false;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002187 const VkImage image = image_state->image();
sfricke-samsungcd924d92020-05-20 23:51:17 -07002188 const VkFormat format = image_state->createInfo.format;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002189
2190 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002191 skip |= LogError(image, "VUID-vkCmdClearColorImage-aspectMask-02498",
2192 "vkCmdClearColorImage(): %s.aspectMasks must only be set to VK_IMAGE_ASPECT_COLOR_BIT.", param_name);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002193 }
2194
sfricke-samsungcd924d92020-05-20 23:51:17 -07002195 if (FormatIsDepthOrStencil(format)) {
2196 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2197 "vkCmdClearColorImage(): %s called with image %s which has a depth/stencil format (%s).", param_name,
2198 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
2199 } else if (FormatIsCompressed(format)) {
2200 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2201 "vkCmdClearColorImage(): %s called with image %s which has a compressed format (%s).", param_name,
2202 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002203 }
2204
2205 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002206 skip |=
2207 LogError(image, "VUID-vkCmdClearColorImage-image-00002",
2208 "vkCmdClearColorImage() %s called with image %s which was created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.",
2209 param_name, report_data->FormatHandle(image).c_str());
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002210 }
2211 return skip;
2212}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002213
John Zulauf07288512019-07-05 11:09:50 -06002214bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
2215 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
2216 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002217 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002218 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2219 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002220 skip |= LogError(image_state->image(), "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002221 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2222 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002223 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002224
2225 } else {
2226 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
sfricke-samsung45996a42021-09-16 13:45:27 -07002227 if (!IsExtEnabled(device_extensions.vk_khr_shared_presentable_image)) {
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002228 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002229 skip |= LogError(image_state->image(), "VUID-vkCmdClearColorImage-imageLayout-00005",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002230 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2231 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002232 }
2233 } else {
2234 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
2235 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002236 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002237 image_state->image(), "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002238 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
2239 func_name, string_VkImageLayout(dest_image_layout));
2240 }
2241 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002242 }
2243
John Zulauff660ad62019-03-23 07:16:05 -06002244 // Cast to const to prevent creation at validate time.
Jeremy Gebben6335df62021-11-01 10:50:13 -06002245 const auto *subresource_map = cb_node->GetImageSubresourceLayoutMap(*image_state);
John Zulauff660ad62019-03-23 07:16:05 -06002246 if (subresource_map) {
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -06002247 LayoutUseCheckAndMessage layout_check(dest_image_layout);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002248 auto normalized_isr = image_state->NormalizeSubresourceRange(range);
Tony Barbour55688172020-09-23 15:19:50 -07002249 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
2250 // the next "constant value" range
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -06002251 skip |= subresource_map->AnyInRange(
Jeremy Gebbencb13f0f2022-07-15 15:48:05 -06002252 normalized_isr, [this, cb_node, &layout_check, func_name](const LayoutRange &range, const LayoutEntry &state) {
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -06002253 bool subres_skip = false;
2254 if (!layout_check.Check(state)) {
2255 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
2256 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2257 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
2258 } else {
2259 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
2260 }
2261 subres_skip |= LogError(cb_node->commandBuffer(), error_code,
2262 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
2263 func_name, string_VkImageLayout(layout_check.expected_layout), layout_check.message,
2264 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002265 }
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -06002266 return subres_skip;
2267 });
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002268 }
2269
2270 return skip;
2271}
2272
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002273bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2274 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002275 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002276 bool skip = false;
2277 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07002278 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07002279 auto image_state = Get<IMAGE_STATE>(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002280 if (cb_node && image_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06002281 skip |= ValidateMemoryIsBoundToImage(image_state.get(), "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
2282 skip |= ValidateCmd(cb_node.get(), CMD_CLEARCOLORIMAGE);
sfricke-samsung45996a42021-09-16 13:45:27 -07002283 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Lionel Landwerlin21719f62021-12-09 11:40:09 +02002284 skip |= ValidateImageFormatFeatureFlags(image_state.get(), VK_FORMAT_FEATURE_2_TRANSFER_DST_BIT_KHR,
2285 "vkCmdClearColorImage", "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04002286 }
Jeremy Gebben9f537102021-10-05 16:37:12 -06002287 skip |= ValidateProtectedImage(cb_node.get(), image_state.get(), "vkCmdClearColorImage()",
2288 "VUID-vkCmdClearColorImage-commandBuffer-01805");
2289 skip |= ValidateUnprotectedImage(cb_node.get(), image_state.get(), "vkCmdClearColorImage()",
sfricke-samsung022fa252020-07-24 03:26:16 -07002290 "VUID-vkCmdClearColorImage-commandBuffer-01806");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002291 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002292 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Jeremy Gebben9f537102021-10-05 16:37:12 -06002293 skip |= ValidateCmdClearColorSubresourceRange(image_state.get(), pRanges[i], param_name.c_str());
2294 skip |= ValidateImageAttributes(image_state.get(), pRanges[i], param_name.c_str());
2295 skip |= VerifyClearImageLayout(cb_node.get(), image_state.get(), pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002296 }
sfricke-samsunge775d492020-02-28 09:02:25 -08002297 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsung10b35ce2021-09-29 08:50:20 -07002298 if (FormatRequiresYcbcrConversionExplicitly(image_state->createInfo.format)) {
sfricke-samsunge775d492020-02-28 09:02:25 -08002299 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
2300 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
2301 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
2302 string_VkFormat(image_state->createInfo.format));
2303 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002304 }
2305 return skip;
2306}
2307
John Zulaufeabb4462019-07-05 14:13:03 -06002308void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2309 const VkClearColorValue *pColor, uint32_t rangeCount,
2310 const VkImageSubresourceRange *pRanges) {
2311 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
2312
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07002313 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002314 auto image_state = Get<IMAGE_STATE>(image);
John Zulaufeabb4462019-07-05 14:13:03 -06002315 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002316 for (uint32_t i = 0; i < rangeCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06002317 cb_node->SetImageInitialLayout(image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002318 }
2319 }
2320}
2321
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002322bool CoreChecks::ValidateClearDepthStencilValue(VkCommandBuffer commandBuffer, VkClearDepthStencilValue clearValue,
2323 const char *apiName) const {
2324 bool skip = false;
2325
2326 // 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 -07002327 if (!IsExtEnabled(device_extensions.vk_ext_depth_range_unrestricted)) {
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002328 if (!(clearValue.depth >= 0.0) || !(clearValue.depth <= 1.0)) {
2329 // Also VUID-VkClearDepthStencilValue-depth-00022
2330 skip |= LogError(commandBuffer, "VUID-VkClearDepthStencilValue-depth-02506",
2331 "%s: VK_EXT_depth_range_unrestricted extension is not enabled and VkClearDepthStencilValue::depth "
2332 "(=%f) is not within the [0.0, 1.0] range.",
2333 apiName, clearValue.depth);
2334 }
2335 }
2336
2337 return skip;
2338}
2339
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002340bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2341 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002342 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002343 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002344
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002345 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07002346 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07002347 auto image_state = Get<IMAGE_STATE>(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002348 if (cb_node && image_state) {
sfricke-samsung30e325a2020-07-25 12:56:13 -07002349 const VkFormat image_format = image_state->createInfo.format;
Jeremy Gebben9f537102021-10-05 16:37:12 -06002350 skip |= ValidateMemoryIsBoundToImage(image_state.get(), "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002351 "VUID-vkCmdClearDepthStencilImage-image-00010");
Jeremy Gebben9f537102021-10-05 16:37:12 -06002352 skip |= ValidateCmd(cb_node.get(), CMD_CLEARDEPTHSTENCILIMAGE);
sfricke-samsung45996a42021-09-16 13:45:27 -07002353 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Lionel Landwerlin21719f62021-12-09 11:40:09 +02002354 skip |= ValidateImageFormatFeatureFlags(image_state.get(), VK_FORMAT_FEATURE_2_TRANSFER_DST_BIT_KHR,
Jeremy Gebben9f537102021-10-05 16:37:12 -06002355 "vkCmdClearDepthStencilImage", "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04002356 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002357 skip |= ValidateClearDepthStencilValue(commandBuffer, *pDepthStencil, "vkCmdClearDepthStencilImage()");
Jeremy Gebben9f537102021-10-05 16:37:12 -06002358 skip |= ValidateProtectedImage(cb_node.get(), image_state.get(), "vkCmdClearDepthStencilImage()",
sfricke-samsung022fa252020-07-24 03:26:16 -07002359 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01807");
Jeremy Gebben9f537102021-10-05 16:37:12 -06002360 skip |= ValidateUnprotectedImage(cb_node.get(), image_state.get(), "vkCmdClearDepthStencilImage()",
sfricke-samsung022fa252020-07-24 03:26:16 -07002361 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01808");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002362
2363 bool any_include_aspect_depth_bit = false;
2364 bool any_include_aspect_stencil_bit = false;
2365
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002366 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002367 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Jeremy Gebben9f537102021-10-05 16:37:12 -06002368 skip |= ValidateCmdClearDepthSubresourceRange(image_state.get(), pRanges[i], param_name.c_str());
2369 skip |=
2370 VerifyClearImageLayout(cb_node.get(), image_state.get(), pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002371 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06002372 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
2373 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002374 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-aspectMask-02824",
2375 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask can only be VK_IMAGE_ASPECT_DEPTH_BIT "
2376 "and/or VK_IMAGE_ASPECT_STENCIL_BIT.",
2377 i);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002378 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002379 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
2380 any_include_aspect_depth_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002381 if (FormatHasDepth(image_format) == false) {
2382 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02826",
2383 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_DEPTH_BIT but %s "
2384 "doesn't have a depth component.",
2385 i, string_VkFormat(image_format));
2386 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002387 }
2388 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
2389 any_include_aspect_stencil_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002390 if (FormatHasStencil(image_format) == false) {
2391 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02825",
2392 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_STENCIL_BIT but "
2393 "%s doesn't have a stencil component.",
2394 i, string_VkFormat(image_format));
2395 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002396 }
2397 }
2398 if (any_include_aspect_stencil_bit) {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07002399 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05002400 if (image_stencil_struct != nullptr) {
2401 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
2402 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002403 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
2404 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
2405 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
2406 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002407 }
2408 } else {
2409 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002410 skip |= LogError(
2411 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05002412 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
2413 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
2414 "in VkImageCreateInfo::usage used to create image");
2415 }
2416 }
2417 }
2418 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002419 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
2420 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
2421 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002422 }
sfricke-samsung30e325a2020-07-25 12:56:13 -07002423 if (image_state && !FormatIsDepthOrStencil(image_format)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002424 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014",
2425 "vkCmdClearDepthStencilImage(): called with image %s which doesn't have a depth/stencil format (%s).",
sfricke-samsung30e325a2020-07-25 12:56:13 -07002426 report_data->FormatHandle(image).c_str(), string_VkFormat(image_format));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002427 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002428 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002429 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009",
2430 "vkCmdClearDepthStencilImage(): called with image %s which was not created with the "
2431 "VK_IMAGE_USAGE_TRANSFER_DST_BIT set.",
2432 report_data->FormatHandle(image).c_str());
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002433 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002434 }
2435 return skip;
2436}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002437
John Zulaufeabb4462019-07-05 14:13:03 -06002438void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2439 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
2440 const VkImageSubresourceRange *pRanges) {
2441 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07002442
2443 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002444 auto image_state = Get<IMAGE_STATE>(image);
John Zulaufeabb4462019-07-05 14:13:03 -06002445 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002446 for (uint32_t i = 0; i < rangeCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06002447 cb_node->SetImageInitialLayout(image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002448 }
2449 }
2450}
2451
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002452// Returns true if [x, xoffset] and [y, yoffset] overlap
2453static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
2454 bool result = false;
2455 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
2456 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
2457
2458 if (intersection_max > intersection_min) {
2459 result = true;
2460 }
2461 return result;
2462}
2463
Aitor Camacho82c1a7a2022-07-05 22:21:19 +02002464// Returns true if source area of first vkImageCopy/vkImageCopy2KHR region intersects dest area of second region
2465// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
2466template <typename RegionType>
2467static bool RegionIntersects(const RegionType *region0, const RegionType *region1, VkImageType type, bool is_multiplane) {
2468 bool result = false;
2469
2470 // Separate planes within a multiplane image cannot intersect
2471 if (is_multiplane && (region0->srcSubresource.aspectMask != region1->dstSubresource.aspectMask)) {
2472 return result;
2473 }
2474
2475 if ((region0->srcSubresource.mipLevel == region1->dstSubresource.mipLevel) &&
2476 (RangesIntersect(region0->srcSubresource.baseArrayLayer, region0->srcSubresource.layerCount,
2477 region1->dstSubresource.baseArrayLayer, region1->dstSubresource.layerCount))) {
2478 result = true;
2479 switch (type) {
2480 case VK_IMAGE_TYPE_3D:
2481 result &= RangesIntersect(region0->srcOffset.z, region0->extent.depth, region1->dstOffset.z, region1->extent.depth);
2482 // fall through
2483 case VK_IMAGE_TYPE_2D:
2484 result &=
2485 RangesIntersect(region0->srcOffset.y, region0->extent.height, region1->dstOffset.y, region1->extent.height);
2486 // fall through
2487 case VK_IMAGE_TYPE_1D:
2488 result &= RangesIntersect(region0->srcOffset.x, region0->extent.width, region1->dstOffset.x, region1->extent.width);
2489 break;
2490 default:
2491 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2492 assert(false);
2493 }
2494 }
2495 return result;
2496}
2497
aitor-lunarg607fe732022-03-31 22:00:08 +02002498template <typename RegionType>
2499static bool RegionIntersectsBlit(const RegionType *region0, const RegionType *region1, VkImageType type, bool is_multiplane) {
2500 bool result = false;
2501
2502 // Separate planes within a multiplane image cannot intersect
2503 if (is_multiplane && (region0->srcSubresource.aspectMask != region1->dstSubresource.aspectMask)) {
2504 return result;
2505 }
2506
2507 if ((region0->srcSubresource.mipLevel == region1->dstSubresource.mipLevel) &&
2508 (RangesIntersect(region0->srcSubresource.baseArrayLayer, region0->srcSubresource.layerCount,
2509 region1->dstSubresource.baseArrayLayer, region1->dstSubresource.layerCount))) {
2510 result = true;
2511 switch (type) {
2512 case VK_IMAGE_TYPE_3D:
2513 result &= RangesIntersect(region0->srcOffsets[0].z, region0->srcOffsets[1].z - region0->srcOffsets[0].z,
2514 region1->dstOffsets[0].z, region1->dstOffsets[1].z - region1->dstOffsets[0].z);
2515 // fall through
2516 case VK_IMAGE_TYPE_2D:
2517 result &= RangesIntersect(region0->srcOffsets[0].y, region0->srcOffsets[1].y - region0->srcOffsets[0].y,
2518 region1->dstOffsets[0].y, region1->dstOffsets[1].y - region1->dstOffsets[0].y);
2519 // fall through
2520 case VK_IMAGE_TYPE_1D:
2521 result &= RangesIntersect(region0->srcOffsets[0].x, region0->srcOffsets[1].x - region0->srcOffsets[0].x,
2522 region1->dstOffsets[0].x, region1->dstOffsets[1].x - region1->dstOffsets[0].x);
2523 break;
2524 default:
2525 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2526 assert(false);
2527 }
2528 }
2529 return result;
2530}
2531
Dave Houltonfc1a4052017-04-27 14:32:45 -06002532// Returns non-zero if offset and extent exceed image extents
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002533static const uint32_t kXBit = 1;
2534static const uint32_t kYBit = 2;
2535static const uint32_t kZBit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002536static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002537 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002538 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002539 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2540 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002541 result |= kZBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002542 }
2543 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2544 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002545 result |= kYBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002546 }
2547 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2548 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002549 result |= kXBit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002550 }
2551 return result;
2552}
2553
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002554// Test if two VkExtent3D structs are equivalent
2555static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2556 bool result = true;
2557 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2558 (extent->depth != other_extent->depth)) {
2559 result = false;
2560 }
2561 return result;
2562}
2563
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002564// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002565static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002566 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2567}
2568
2569// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002570VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002571 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2572 VkExtent3D granularity = {0, 0, 0};
Jeremy Gebbencd7fa282021-10-27 10:25:32 -06002573 const auto pool = cb_node->command_pool;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002574 if (pool) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002575 granularity = physical_device_state->queue_family_properties[pool->queueFamilyIndex].minImageTransferGranularity;
sfricke-samsung01da6312021-10-20 07:51:32 -07002576 if (FormatIsBlockedImage(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002577 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002578 granularity.width *= block_size.width;
2579 granularity.height *= block_size.height;
2580 }
2581 }
2582 return granularity;
2583}
2584
2585// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2586static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2587 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002588 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2589 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002590 valid = false;
2591 }
2592 return valid;
2593}
2594
2595// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002596bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002597 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002598 bool skip = false;
2599 VkExtent3D offset_extent = {};
2600 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2601 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2602 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002603 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002604 // 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 -07002605 if (IsExtentAllZeroes(&offset_extent) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002606 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002607 "%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 "
2608 "image transfer granularity is (w=0, h=0, d=0).",
2609 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002610 }
2611 } else {
2612 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2613 // integer multiples of the image transfer granularity.
2614 if (IsExtentAligned(&offset_extent, granularity) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002615 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002616 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2617 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2618 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2619 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002620 }
2621 }
2622 return skip;
2623}
2624
2625// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002626bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002627 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002628 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002629 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002630 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002631 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2632 // subresource extent.
2633 if (IsExtentEqual(extent, subresource_extent) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002634 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002635 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2636 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2637 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2638 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002639 }
2640 } else {
2641 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2642 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2643 // subresource extent dimensions.
2644 VkExtent3D offset_extent_sum = {};
2645 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2646 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2647 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002648 bool x_ok = true;
2649 bool y_ok = true;
2650 bool z_ok = true;
2651 switch (image_type) {
2652 case VK_IMAGE_TYPE_3D:
2653 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2654 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002655 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002656 case VK_IMAGE_TYPE_2D:
2657 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2658 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002659 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002660 case VK_IMAGE_TYPE_1D:
2661 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2662 (subresource_extent->width == offset_extent_sum.width));
2663 break;
2664 default:
2665 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2666 assert(false);
2667 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002668 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002669 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002670 LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002671 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2672 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2673 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2674 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2675 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2676 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002677 }
2678 }
2679 return skip;
2680}
2681
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002682bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002683 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002684 bool skip = false;
2685 if (mip_level >= img->createInfo.mipLevels) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002686 skip |= LogError(cb_node->commandBuffer(), vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2687 function, i, member, mip_level, report_data->FormatHandle(img->image()).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002688 }
2689 return skip;
2690}
2691
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002692bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002693 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002694 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002695 bool skip = false;
2696 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2697 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002698 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002699 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2700 "%u, but provided %s has %u array layers.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002701 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image()).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002702 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002703 }
2704 return skip;
2705}
2706
Tony Barbour845d29b2021-11-09 11:43:14 -07002707// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy/VkBufferImageCopy2 structure
sfricke-samsung71f04e32022-03-16 01:21:21 -05002708template <typename RegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002709bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
sfricke-samsung71f04e32022-03-16 01:21:21 -05002710 const RegionType *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002711 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002712 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002713 VkExtent3D granularity = GetScaledItg(cb_node, img);
2714 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002715 VkExtent3D subresource_extent = img->GetSubresourceExtent(region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002716 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002717 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002718 return skip;
2719}
2720
Jeff Leger178b1e52020-10-05 12:22:23 -04002721// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy/VkImageCopy2KHR structure
2722template <typename RegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002723bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002724 const IMAGE_STATE *dst_img, const RegionType *region,
2725 const uint32_t i, const char *function,
Tony-LunarGb61514a2021-11-02 12:36:51 -06002726 CMD_TYPE cmd_type) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002727 bool skip = false;
Tony-LunarGb61514a2021-11-02 12:36:51 -06002728 const bool is_2 = (cmd_type == CMD_COPYIMAGE2KHR || cmd_type == CMD_COPYIMAGE2);
Jeff Leger178b1e52020-10-05 12:22:23 -04002729 const char *vuid;
2730
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002731 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002732 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
Tony-LunarGb61514a2021-11-02 12:36:51 -06002733 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
Jeff Leger178b1e52020-10-05 12:22:23 -04002734 skip |= CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", vuid);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002735 VkExtent3D subresource_extent = src_img->GetSubresourceExtent(region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002736 const VkExtent3D extent = region->extent;
Tony-LunarGb61514a2021-11-02 12:36:51 -06002737 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002738 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04002739 i, function, "extent", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002740
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002741 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002742 granularity = GetScaledItg(cb_node, dst_img);
Tony-LunarGb61514a2021-11-02 12:36:51 -06002743 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
Jeff Leger178b1e52020-10-05 12:22:23 -04002744 skip |= CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", vuid);
Dave Houltonee281a52017-12-08 13:51:02 -07002745 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002746 const VkExtent3D dest_effective_extent =
2747 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002748 subresource_extent = dst_img->GetSubresourceExtent(region->dstSubresource);
Tony-LunarGb61514a2021-11-02 12:36:51 -06002749 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002750 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Jeff Leger178b1e52020-10-05 12:22:23 -04002751 dst_img->createInfo.imageType, i, function, "extent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002752 return skip;
2753}
2754
Jeff Leger178b1e52020-10-05 12:22:23 -04002755// Validate contents of a VkImageCopy or VkImageCopy2KHR struct
sfricke-samsung71f04e32022-03-16 01:21:21 -05002756template <typename RegionType>
2757bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const RegionType *pRegions, const IMAGE_STATE *src_state,
2758 const IMAGE_STATE *dst_state, CMD_TYPE cmd_type) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002759 bool skip = false;
Tony-LunarGb61514a2021-11-02 12:36:51 -06002760 const bool is_2 = (cmd_type == CMD_COPYIMAGE2KHR || cmd_type == CMD_COPYIMAGE2);
2761 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04002762 const char *vuid;
Dave Houlton6f9059e2017-05-02 17:15:13 -06002763
2764 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05002765 const RegionType region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002766
2767 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002768 const VkExtent3D src_copy_extent = region.extent;
2769 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002770 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2771
Dave Houlton6f9059e2017-05-02 17:15:13 -06002772 bool slice_override = false;
2773 uint32_t depth_slices = 0;
2774
2775 // Special case for copying between a 1D/2D array and a 3D image
2776 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2777 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002778 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002779 slice_override = (depth_slices != 1);
2780 } 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 -07002781 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002782 slice_override = (depth_slices != 1);
2783 }
2784
2785 // Do all checks on source image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002786 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002787 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002788 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-00146" : "VUID-vkCmdCopyImage-srcImage-00146";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002789 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002790 "%s: pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2791 "be 0 and 1, respectively.",
2792 func_name, i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002793 }
2794 }
2795
Dave Houlton533be9f2018-03-26 17:08:30 -06002796 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 -06002797 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01785" : "VUID-vkCmdCopyImage-srcImage-01785";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002798 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002799 "%s: pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002800 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002801 func_name, i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002802 }
2803
Dave Houlton533be9f2018-03-26 17:08:30 -06002804 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002805 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01787" : "VUID-vkCmdCopyImage-srcImage-01787";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002806 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 -04002807 func_name, i, region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002808 }
2809
sfricke-samsung01da6312021-10-20 07:51:32 -07002810 // Source checks that apply only to "blocked images"
2811 if (FormatIsBlockedImage(src_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002812 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002813 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002814 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2815 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2816 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002817 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01727" : "VUID-vkCmdCopyImage-srcImage-01727";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002818 skip |= LogError(src_state->image(), vuid,
sfricke-samsung01da6312021-10-20 07:51:32 -07002819 "%s: pRegion[%d] srcOffset (%d, %d) must be multiples of the blocked image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002820 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002821 func_name, i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002822 }
2823
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002824 const VkExtent3D mip_extent = src_state->GetSubresourceExtent(region.srcSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07002825 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2826 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002827 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01728" : "VUID-vkCmdCopyImage-srcImage-01728";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002828 skip |= LogError(src_state->image(), vuid,
sfricke-samsung01da6312021-10-20 07:51:32 -07002829 "%s: pRegion[%d] extent width (%d) must be a multiple of the blocked texture block "
Jeff Leger178b1e52020-10-05 12:22:23 -04002830 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2831 func_name, i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002832 }
2833
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002834 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002835 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2836 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002837 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01729" : "VUID-vkCmdCopyImage-srcImage-01729";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002838 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002839 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2840 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2841 func_name, i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002842 }
2843
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002844 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002845 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2846 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002847 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01730" : "VUID-vkCmdCopyImage-srcImage-01730";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002848 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002849 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2850 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2851 func_name, i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002852 }
2853 } // Compressed
2854
2855 // Do all checks on dest image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002856 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002857 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002858 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-00152" : "VUID-vkCmdCopyImage-dstImage-00152";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002859 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002860 "%s: pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002861 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002862 func_name, i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002863 }
2864 }
2865
Dave Houlton533be9f2018-03-26 17:08:30 -06002866 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 -06002867 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01786" : "VUID-vkCmdCopyImage-dstImage-01786";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002868 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002869 "%s: pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2870 "and 1, respectively.",
2871 func_name, i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002872 }
2873
Dave Houlton533be9f2018-03-26 17:08:30 -06002874 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002875 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01788" : "VUID-vkCmdCopyImage-dstImage-01788";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002876 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 -04002877 func_name, i, region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002878 }
2879
sfricke-samsung30b094c2020-05-30 11:42:11 -07002880 // Handle difference between Maintenance 1
sfricke-samsung45996a42021-09-16 13:45:27 -07002881 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002882 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2883 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002884 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-04443" : "VUID-vkCmdCopyImage-srcImage-04443";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002885 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002886 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2887 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2888 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002889 }
2890 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002891 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002892 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002893 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-04444" : "VUID-vkCmdCopyImage-dstImage-04444";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002894 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002895 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2896 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2897 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002898 }
2899 }
2900 } else { // Pre maint 1
2901 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002902 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002903 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002904 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002905 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and "
sfricke-samsung30b094c2020-05-30 11:42:11 -07002906 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2907 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002908 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002909 }
Dave Houltonee281a52017-12-08 13:51:02 -07002910 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002911 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002912 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002913 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002914 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2915 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002916 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002917 }
2918 }
2919 }
2920
sfricke-samsung01da6312021-10-20 07:51:32 -07002921 // Dest checks that apply only to "blocked images"
2922 if (FormatIsBlockedImage(dst_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002923 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002924
2925 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002926 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2927 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2928 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002929 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01731" : "VUID-vkCmdCopyImage-dstImage-01731";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002930 skip |= LogError(dst_state->image(), vuid,
sfricke-samsung01da6312021-10-20 07:51:32 -07002931 "%s: pRegion[%d] dstOffset (%d, %d) must be multiples of the blocked image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002932 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002933 func_name, i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002934 }
2935
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002936 const VkExtent3D mip_extent = dst_state->GetSubresourceExtent(region.dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07002937 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2938 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002939 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01732" : "VUID-vkCmdCopyImage-dstImage-01732";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002940 skip |= LogError(dst_state->image(), vuid,
sfricke-samsung01da6312021-10-20 07:51:32 -07002941 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the blocked texture "
Jeff Leger178b1e52020-10-05 12:22:23 -04002942 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2943 func_name, i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002944 }
2945
Dave Houltonee281a52017-12-08 13:51:02 -07002946 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2947 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2948 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002949 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01733" : "VUID-vkCmdCopyImage-dstImage-01733";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002950 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002951 "%s: pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002952 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2953 "height (%d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002954 func_name, i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002955 }
2956
Dave Houltonee281a52017-12-08 13:51:02 -07002957 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2958 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2959 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002960 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01734" : "VUID-vkCmdCopyImage-dstImage-01734";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002961 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002962 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2963 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2964 func_name, i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002965 }
2966 } // Compressed
2967 }
2968 return skip;
2969}
2970
Jeff Leger178b1e52020-10-05 12:22:23 -04002971template <typename RegionType>
2972bool CoreChecks::ValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2973 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Tony-LunarGb61514a2021-11-02 12:36:51 -06002974 const RegionType *pRegions, CMD_TYPE cmd_type) const {
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07002975 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07002976 auto src_image_state = Get<IMAGE_STATE>(srcImage);
2977 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Aitor Camacho82c1a7a2022-07-05 22:21:19 +02002978 const VkFormat src_format = src_image_state->createInfo.format;
2979 const VkFormat dst_format = dst_image_state->createInfo.format;
2980 const bool is_2 = (cmd_type == CMD_COPYIMAGE2KHR || cmd_type == CMD_COPYIMAGE2);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002981 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002982
sfricke-samsung85584a72021-09-30 21:43:38 -07002983 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04002984 const char *vuid;
Tony-LunarGb61514a2021-11-02 12:36:51 -06002985 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state.get(), dst_image_state.get(), cmd_type);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002986
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002987 VkCommandBuffer command_buffer = cb_node->commandBuffer();
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002988
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002989 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002990 const RegionType region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002991
2992 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2993 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08002994 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07002995
Dave Houlton6f9059e2017-05-02 17:15:13 -06002996 bool slice_override = false;
2997 uint32_t depth_slices = 0;
2998
2999 // Special case for copying between a 1D/2D array and a 3D image
3000 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
3001 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
3002 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07003003 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06003004 slice_override = (depth_slices != 1);
3005 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
3006 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07003007 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06003008 slice_override = (depth_slices != 1);
3009 }
3010
Jeremy Gebben9f537102021-10-05 16:37:12 -06003011 skip |= ValidateImageSubresourceLayers(cb_node.get(), &region.srcSubresource, func_name, "srcSubresource", i);
3012 skip |= ValidateImageSubresourceLayers(cb_node.get(), &region.dstSubresource, func_name, "dstSubresource", i);
Tony-LunarGb61514a2021-11-02 12:36:51 -06003013 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcSubresource-01696" : "VUID-vkCmdCopyImage-srcSubresource-01696";
3014 skip |=
3015 ValidateImageMipLevel(cb_node.get(), src_image_state.get(), region.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
3016 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstSubresource-01697" : "VUID-vkCmdCopyImage-dstSubresource-01697";
3017 skip |=
3018 ValidateImageMipLevel(cb_node.get(), dst_image_state.get(), region.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
3019 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcSubresource-01698" : "VUID-vkCmdCopyImage-srcSubresource-01698";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003020 skip |= ValidateImageArrayLayerRange(cb_node.get(), src_image_state.get(), region.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003021 region.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
Tony-LunarGb61514a2021-11-02 12:36:51 -06003022 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstSubresource-01699" : "VUID-vkCmdCopyImage-dstSubresource-01699";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003023 skip |= ValidateImageArrayLayerRange(cb_node.get(), dst_image_state.get(), region.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003024 region.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003025
sfricke-samsung45996a42021-09-16 13:45:27 -07003026 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06003027 // No chance of mismatch if we're overriding depth slice count
3028 if (!slice_override) {
3029 // The number of depth slices in srcSubresource and dstSubresource must match
3030 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
3031 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07003032 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
3033 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003034 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07003035 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
3036 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003037 if (src_slices != dst_slices) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003038 vuid = is_2 ? "VUID-VkImageCopy2-extent-00140" : "VUID-VkImageCopy-extent-00140";
Jeff Leger178b1e52020-10-05 12:22:23 -04003039 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003040 "%s: number of depth slices in source (%u) and destination (%u) subresources for pRegions[%u] "
3041 "do not match.",
3042 func_name, src_slices, dst_slices, i);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003043 }
3044 }
3045 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06003046 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07003047 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003048 vuid = is_2 ? "VUID-VkImageCopy2-layerCount-00138" : "VUID-VkImageCopy-layerCount-00138";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003049 skip |=
3050 LogError(command_buffer, vuid,
3051 "%s: number of layers in source (%u) and destination (%u) subresources for pRegions[%u] do not match",
3052 func_name, region.srcSubresource.layerCount, region.dstSubresource.layerCount, i);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06003053 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003054 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003055
Dave Houltonc991cc92018-03-06 11:08:51 -07003056 // Do multiplane-specific checks, if extension enabled
sfricke-samsung45996a42021-09-16 13:45:27 -07003057 if (IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)) {
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003058 if ((!FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format))) {
3059 // If neither image is multi-plane the aspectMask member of src and dst must match
3060 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003061 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01551" : "VUID-vkCmdCopyImage-srcImage-01551";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003062 skip |= LogError(command_buffer, vuid,
3063 "%s: Copy between non-multiplane images with differing aspectMasks in pRegions[%u] with "
3064 "source (0x%x) destination (0x%x).",
3065 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
3066 }
3067 } else {
3068 // Source image multiplane checks
3069 uint32_t planes = FormatPlaneCount(src_format);
3070 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
3071 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003072 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01552" : "VUID-vkCmdCopyImage-srcImage-01552";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003073 skip |= LogError(command_buffer, vuid,
3074 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
3075 i, aspect);
3076 }
3077 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
3078 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003079 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01553" : "VUID-vkCmdCopyImage-srcImage-01553";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003080 skip |= LogError(command_buffer, vuid,
3081 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
3082 i, aspect);
3083 }
3084 // Single-plane to multi-plane
3085 if ((!FormatIsMultiplane(src_format)) && (FormatIsMultiplane(dst_format)) &&
3086 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003087 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01557" : "VUID-vkCmdCopyImage-dstImage-01557";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003088 skip |= LogError(command_buffer, vuid,
3089 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
3090 func_name, i, aspect);
3091 }
Dave Houltonc991cc92018-03-06 11:08:51 -07003092
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003093 // Dest image multiplane checks
3094 planes = FormatPlaneCount(dst_format);
3095 aspect = region.dstSubresource.aspectMask;
3096 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003097 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01554" : "VUID-vkCmdCopyImage-dstImage-01554";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003098 skip |= LogError(command_buffer, vuid,
3099 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
3100 i, aspect);
3101 }
3102 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
3103 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003104 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01555" : "VUID-vkCmdCopyImage-dstImage-01555";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003105 skip |= LogError(command_buffer, vuid,
3106 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
3107 i, aspect);
3108 }
3109 // Multi-plane to single-plane
3110 if ((FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format)) &&
3111 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003112 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01556" : "VUID-vkCmdCopyImage-srcImage-01556";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003113 skip |= LogError(command_buffer, vuid,
3114 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
3115 func_name, i, aspect);
3116 }
3117 }
3118 } else {
3119 // !vk_khr_sampler_ycbcr_conversion
Dave Houltonf5217612018-02-02 16:18:52 -07003120 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
3121 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003122 vuid = is_2 ? "VUID-VkImageCopy2-aspectMask-00137" : "VUID-VkImageCopy-aspectMask-00137";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003123 skip |= LogError(
3124 command_buffer, vuid,
3125 "%s: Copy between images with differing aspectMasks in pRegions[%u] with source (0x%x) destination (0x%x).",
3126 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
Dave Houltonf5217612018-02-02 16:18:52 -07003127 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003128 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003129
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003130 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08003131 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003132 vuid = is_2 ? "VUID-VkCopyImageInfo2-aspectMask-00142" : "VUID-vkCmdCopyImage-aspectMask-00142";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003133 skip |=
3134 LogError(command_buffer, vuid,
3135 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) cannot specify aspects not present in source image.",
3136 func_name, i, region.srcSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003137 }
3138
3139 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08003140 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003141 vuid = is_2 ? "VUID-VkCopyImageInfo2-aspectMask-00143" : "VUID-vkCmdCopyImage-aspectMask-00143";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003142 skip |= LogError(
3143 command_buffer, vuid,
3144 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) cannot specify aspects not present in destination image.",
3145 func_name, i, region.dstSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003146 }
3147
sfricke-samsung5f11b0e2022-03-22 14:12:15 -05003148 // Make sure not a empty region
3149 if (src_copy_extent.width == 0) {
3150 vuid = is_2 ? "VUID-VkImageCopy2-extent-06668" : "VUID-VkImageCopy-extent-06668";
3151 skip |=
3152 LogError(command_buffer, vuid,
3153 "%s: pRegion[%" PRIu32 "] extent.width must not be zero as empty copies are not allowed.", func_name, i);
3154 }
3155 if (src_copy_extent.height == 0) {
3156 vuid = is_2 ? "VUID-VkImageCopy2-extent-06669" : "VUID-VkImageCopy-extent-06669";
3157 skip |=
3158 LogError(command_buffer, vuid,
3159 "%s: pRegion[%" PRIu32 "] extent.height must not be zero as empty copies are not allowed.", func_name, i);
3160 }
3161 if (src_copy_extent.depth == 0) {
3162 vuid = is_2 ? "VUID-VkImageCopy2-extent-06670" : "VUID-VkImageCopy-extent-06670";
3163 skip |=
3164 LogError(command_buffer, vuid,
3165 "%s: pRegion[%" PRIu32 "] extent.depth must not be zero as empty copies are not allowed.", func_name, i);
3166 }
3167
Dave Houltonfc1a4052017-04-27 14:32:45 -06003168 // Each dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003169 VkExtent3D subresource_extent = src_image_state->GetSubresourceExtent(region.srcSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07003170 if (slice_override) src_copy_extent.depth = depth_slices;
3171 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003172 if (extent_check & kXBit) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003173 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcOffset-00144" : "VUID-vkCmdCopyImage-srcOffset-00144";
Jeff Leger178b1e52020-10-05 12:22:23 -04003174 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003175 "%s: Source image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003176 "width [%1d].",
3177 func_name, i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003178 }
3179
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003180 if (extent_check & kYBit) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003181 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcOffset-00145" : "VUID-vkCmdCopyImage-srcOffset-00145";
Jeff Leger178b1e52020-10-05 12:22:23 -04003182 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003183 "%s: Source image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003184 "height [%1d].",
3185 func_name, i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003186 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003187 if (extent_check & kZBit) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003188 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcOffset-00147" : "VUID-vkCmdCopyImage-srcOffset-00147";
Jeff Leger178b1e52020-10-05 12:22:23 -04003189 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003190 "%s: Source image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003191 "depth [%1d].",
3192 func_name, i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003193 }
3194
Dave Houltonee281a52017-12-08 13:51:02 -07003195 // Adjust dest extent if necessary
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003196 subresource_extent = dst_image_state->GetSubresourceExtent(region.dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07003197 if (slice_override) dst_copy_extent.depth = depth_slices;
3198
3199 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003200 if (extent_check & kXBit) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003201 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstOffset-00150" : "VUID-vkCmdCopyImage-dstOffset-00150";
Jeff Leger178b1e52020-10-05 12:22:23 -04003202 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003203 "%s: Dest image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003204 "width [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003205 func_name, i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003206 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003207 if (extent_check & kYBit) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003208 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstOffset-00151" : "VUID-vkCmdCopyImage-dstOffset-00151";
Jeff Leger178b1e52020-10-05 12:22:23 -04003209 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003210 "%s): Dest image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003211 "height [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003212 func_name, i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003213 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003214 if (extent_check & kZBit) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003215 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstOffset-00153" : "VUID-vkCmdCopyImage-dstOffset-00153";
Jeff Leger178b1e52020-10-05 12:22:23 -04003216 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003217 "%s: Dest image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003218 "depth [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003219 func_name, i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003220 }
3221
Aitor Camacho82c1a7a2022-07-05 22:21:19 +02003222 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
3223 // must not overlap in memory
3224 if (src_image_state->image() == dst_image_state->image()) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003225 for (uint32_t j = 0; j < regionCount; j++) {
Aitor Camacho82c1a7a2022-07-05 22:21:19 +02003226 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
3227 FormatIsMultiplane(src_format))) {
3228 vuid = is_2 ? "VUID-VkCopyImageInfo2-pRegions-00124" : "VUID-vkCmdCopyImage-pRegions-00124";
3229 skip |= LogError(command_buffer, vuid, "%s: pRegion[%u] src overlaps with pRegions[%u].", func_name, i, j);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003230 }
3231 }
3232 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08003233
3234 // 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 -07003235 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
sfricke-samsung48172ca2020-02-13 23:38:11 -08003236 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3237 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3238 (src_copy_extent.depth != 1)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003239 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01790" : "VUID-vkCmdCopyImage-srcImage-01790";
Jeff Leger178b1e52020-10-05 12:22:23 -04003240 skip |= LogError(command_buffer, vuid,
3241 "%s: pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1",
3242 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003243 }
3244 } else {
3245 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
3246 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3247 (src_copy_extent.depth != 1)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003248 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01789" : "VUID-vkCmdCopyImage-srcImage-01789";
Jeff Leger178b1e52020-10-05 12:22:23 -04003249 skip |= LogError(command_buffer, vuid,
3250 "%s: pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1",
3251 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003252 }
3253 }
3254
3255 // Check if 2D with 3D and depth not equal to 2D layerCount
3256 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3257 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
3258 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003259 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01791" : "VUID-vkCmdCopyImage-srcImage-01791";
Jeff Leger178b1e52020-10-05 12:22:23 -04003260 skip |= LogError(command_buffer, vuid,
3261 "%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 -08003262 "srcSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003263 func_name, i, src_copy_extent.depth, region.srcSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003264 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
3265 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
3266 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003267 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01792" : "VUID-vkCmdCopyImage-dstImage-01792";
Jeff Leger178b1e52020-10-05 12:22:23 -04003268 skip |= LogError(command_buffer, vuid,
3269 "%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 -08003270 "dstSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003271 func_name, i, src_copy_extent.depth, region.dstSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003272 }
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003273
3274 // Check for multi-plane format compatiblity
3275 if (FormatIsMultiplane(src_format) || FormatIsMultiplane(dst_format)) {
sfricke-samsung73e755c2021-09-30 08:34:57 -07003276 const VkFormat src_plane_format = FormatIsMultiplane(src_format)
3277 ? FindMultiplaneCompatibleFormat(src_format, region.srcSubresource.aspectMask)
3278 : src_format;
3279 const VkFormat dst_plane_format = FormatIsMultiplane(dst_format)
3280 ? FindMultiplaneCompatibleFormat(dst_format, region.dstSubresource.aspectMask)
3281 : dst_format;
3282 const size_t src_format_size = FormatElementSize(src_plane_format);
3283 const size_t dst_format_size = FormatElementSize(dst_plane_format);
3284
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003285 // If size is still zero, then format is invalid and will be caught in another VU
3286 if ((src_format_size != dst_format_size) && (src_format_size != 0) && (dst_format_size != 0)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003287 vuid = is_2 ? "VUID-VkCopyImageInfo2-None-01549" : "VUID-vkCmdCopyImage-None-01549";
Jeff Leger178b1e52020-10-05 12:22:23 -04003288 skip |= LogError(command_buffer, vuid,
3289 "%s: pRegions[%u] called with non-compatible image formats. "
3290 "The src format %s with aspectMask %s is not compatible with dst format %s aspectMask %s.",
3291 func_name, i, string_VkFormat(src_format),
3292 string_VkImageAspectFlags(region.srcSubresource.aspectMask).c_str(), string_VkFormat(dst_format),
3293 string_VkImageAspectFlags(region.dstSubresource.aspectMask).c_str());
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003294 }
3295 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003296 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003297
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003298 // The formats of non-multiplane src_image and dst_image must be compatible. Formats are considered compatible if their texel
3299 // size in bytes is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT
3300 // because because both texels are 4 bytes in size.
3301 if (!FormatIsMultiplane(src_format) && !FormatIsMultiplane(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003302 const char *compatible_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003303 IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
Tony-LunarGb61514a2021-11-02 12:36:51 -06003304 ? (is_2 ? "VUID-VkCopyImageInfo2-srcImage-01548" : "VUID-vkCmdCopyImage-srcImage-01548")
3305 : (is_2 ? "VUID-VkCopyImageInfo2-srcImage-00135" : "VUID-vkCmdCopyImage-srcImage-00135");
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003306 // Depth/stencil formats must match exactly.
3307 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3308 if (src_format != dst_format) {
3309 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003310 "%s: Depth/stencil formats must match exactly for src (%s) and dst (%s).", func_name,
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003311 string_VkFormat(src_format), string_VkFormat(dst_format));
3312 }
3313 } else {
Jeff Leger178b1e52020-10-05 12:22:23 -04003314 if (FormatElementSize(src_format) != FormatElementSize(dst_format)) {
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003315 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003316 "%s: Unmatched image format sizes. "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06003317 "The src format %s has size of %" PRIu32 " and dst format %s has size of %" PRIu32 ".",
Jeff Leger178b1e52020-10-05 12:22:23 -04003318 func_name, string_VkFormat(src_format), FormatElementSize(src_format), string_VkFormat(dst_format),
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003319 FormatElementSize(dst_format));
3320 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003321 }
3322 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003323
Dave Houlton33c22b72017-02-28 13:16:02 -07003324 // Source and dest image sample counts must match
3325 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003326 std::stringstream ss;
3327 ss << func_name << " called on image pair with non-identical sample counts.";
Tony-LunarGb61514a2021-11-02 12:36:51 -06003328 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-00136" : "VUID-vkCmdCopyImage-srcImage-00136";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003329 skip |=
3330 LogError(command_buffer, vuid, "%s: The src image sample count (%s) dose not match the dst image sample count (%s).",
3331 func_name, string_VkSampleCountFlagBits(src_image_state->createInfo.samples),
3332 string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Dave Houlton33c22b72017-02-28 13:16:02 -07003333 }
3334
Aitor Camacho82c1a7a2022-07-05 22:21:19 +02003335 vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
3336 ? (is_2 ? "VUID-VkCopyImageInfo2-srcImage-01546" : "VUID-vkCmdCopyImage-srcImage-01546")
3337 : (is_2 ? "VUID-VkCopyImageInfo2-srcImage-00127" : "VUID-vkCmdCopyImage-srcImage-00127");
3338 skip |= ValidateMemoryIsBoundToImage(src_image_state.get(), func_name, vuid);
3339 vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
3340 ? (is_2 ? "VUID-VkCopyImageInfo2-dstImage-01547" : "VUID-vkCmdCopyImage-dstImage-01547")
3341 : (is_2 ? "VUID-VkCopyImageInfo2-dstImage-00132" : "VUID-vkCmdCopyImage-dstImage-00132");
3342 skip |= ValidateMemoryIsBoundToImage(dst_image_state.get(), func_name, vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003343 // Validate that SRC & DST images have correct usage flags set
Tony-LunarGb61514a2021-11-02 12:36:51 -06003344 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-00126" : "VUID-vkCmdCopyImage-srcImage-00126";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003345 skip |= ValidateImageUsageFlags(src_image_state.get(), VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04003346 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tony-LunarGb61514a2021-11-02 12:36:51 -06003347 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-00131" : "VUID-vkCmdCopyImage-dstImage-00131";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003348 skip |= ValidateImageUsageFlags(dst_image_state.get(), VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04003349 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Tony-LunarGb61514a2021-11-02 12:36:51 -06003350 vuid = is_2 ? "VUID-vkCmdCopyImage2-commandBuffer-01825" : "VUID-vkCmdCopyImage-commandBuffer-01825";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003351 skip |= ValidateProtectedImage(cb_node.get(), src_image_state.get(), func_name, vuid);
Tony-LunarGb61514a2021-11-02 12:36:51 -06003352 vuid = is_2 ? "VUID-vkCmdCopyImage2-commandBuffer-01826" : "VUID-vkCmdCopyImage-commandBuffer-01826";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003353 skip |= ValidateProtectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
Tony-LunarGb61514a2021-11-02 12:36:51 -06003354 vuid = is_2 ? "VUID-vkCmdCopyImage2-commandBuffer-01827" : "VUID-vkCmdCopyImage-commandBuffer-01827";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003355 skip |= ValidateUnprotectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003356
3357 // Validation for VK_EXT_fragment_density_map
3358 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003359 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
Jeff Leger178b1e52020-10-05 12:22:23 -04003360 skip |=
3361 LogError(command_buffer, vuid,
3362 "%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 +02003363 }
3364 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003365 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
Jeff Leger178b1e52020-10-05 12:22:23 -04003366 skip |=
3367 LogError(command_buffer, vuid,
3368 "%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 +02003369 }
3370
sfricke-samsung45996a42021-09-16 13:45:27 -07003371 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003372 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01995" : "VUID-vkCmdCopyImage-srcImage-01995";
3373 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(), VK_FORMAT_FEATURE_2_TRANSFER_SRC_BIT, func_name, vuid);
3374 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01996" : "VUID-vkCmdCopyImage-dstImage-01996";
3375 skip |= ValidateImageFormatFeatureFlags(dst_image_state.get(), VK_FORMAT_FEATURE_2_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003376 }
Jeremy Gebben9f537102021-10-05 16:37:12 -06003377 skip |= ValidateCmd(cb_node.get(), cmd_type);
Tobin Ehlisc8266452017-04-07 12:20:30 -06003378 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04003379
3380 const char *invalid_src_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003381 (src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Tony-LunarGb61514a2021-11-02 12:36:51 -06003382 ? (is_2 ? "VUID-VkCopyImageInfo2-srcImageLayout-01917" : "VUID-vkCmdCopyImage-srcImageLayout-01917")
3383 : (is_2 ? "VUID-VkCopyImageInfo2-srcImageLayout-00129" : "VUID-vkCmdCopyImage-srcImageLayout-00129");
Jeff Leger178b1e52020-10-05 12:22:23 -04003384 const char *invalid_dst_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003385 (dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Tony-LunarGb61514a2021-11-02 12:36:51 -06003386 ? (is_2 ? "VUID-VkCopyImageInfo2-dstImageLayout-01395" : "VUID-vkCmdCopyImage-dstImageLayout-01395")
3387 : (is_2 ? "VUID-VkCopyImageInfo2-dstImageLayout-00134" : "VUID-vkCmdCopyImage-dstImageLayout-00134");
Jeff Leger178b1e52020-10-05 12:22:23 -04003388
aitor-lunargd0d85e12022-01-28 16:56:49 +01003389 bool same_image = (src_image_state == dst_image_state);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003390 for (uint32_t i = 0; i < regionCount; ++i) {
aitor-lunargd0d85e12022-01-28 16:56:49 +01003391 // When performing copy from and to same subresource, VK_IMAGE_LAYOUT_GENERAL is the only option
sfricke-samsung71f04e32022-03-16 01:21:21 -05003392 const RegionType region = pRegions[i];
3393 const auto &src_sub = region.srcSubresource;
3394 const auto &dst_sub = region.dstSubresource;
aitor-lunargd0d85e12022-01-28 16:56:49 +01003395 bool same_subresource =
3396 (same_image && (src_sub.mipLevel == dst_sub.mipLevel) && (src_sub.baseArrayLayer == dst_sub.baseArrayLayer));
3397 VkImageLayout source_optimal = (same_subresource ? VK_IMAGE_LAYOUT_GENERAL : VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL);
3398 VkImageLayout destination_optimal = (same_subresource ? VK_IMAGE_LAYOUT_GENERAL : VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL);
Tony-LunarGb61514a2021-11-02 12:36:51 -06003399 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImageLayout-00128" : "VUID-vkCmdCopyImage-srcImageLayout-00128";
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06003400 skip |= VerifyImageLayout(*cb_node, *src_image_state, region.srcSubresource, srcImageLayout, source_optimal, func_name,
3401 invalid_src_layout_vuid, vuid, &hit_error);
Tony-LunarGb61514a2021-11-02 12:36:51 -06003402 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImageLayout-00133" : "VUID-vkCmdCopyImage-dstImageLayout-00133";
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06003403 skip |= VerifyImageLayout(*cb_node, *dst_image_state, region.dstSubresource, dstImageLayout, destination_optimal, func_name,
3404 invalid_dst_layout_vuid, vuid, &hit_error);
Jeremy Gebben9f537102021-10-05 16:37:12 -06003405 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node.get(), src_image_state.get(), dst_image_state.get(),
sfricke-samsung71f04e32022-03-16 01:21:21 -05003406 &region, i, func_name, cmd_type);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003407 }
3408
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003409 return skip;
3410}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003411
Jeff Leger178b1e52020-10-05 12:22:23 -04003412bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3413 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3414 const VkImageCopy *pRegions) const {
3415 return ValidateCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
Tony-LunarGb61514a2021-11-02 12:36:51 -06003416 CMD_COPYIMAGE);
Jeff Leger178b1e52020-10-05 12:22:23 -04003417}
3418
3419bool CoreChecks::PreCallValidateCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) const {
3420 return ValidateCmdCopyImage(commandBuffer, pCopyImageInfo->srcImage, pCopyImageInfo->srcImageLayout, pCopyImageInfo->dstImage,
3421 pCopyImageInfo->dstImageLayout, pCopyImageInfo->regionCount, pCopyImageInfo->pRegions,
Tony-LunarGb61514a2021-11-02 12:36:51 -06003422 CMD_COPYIMAGE2KHR);
3423}
3424
3425bool CoreChecks::PreCallValidateCmdCopyImage2(VkCommandBuffer commandBuffer, const VkCopyImageInfo2 *pCopyImageInfo) const {
3426 return ValidateCmdCopyImage(commandBuffer, pCopyImageInfo->srcImage, pCopyImageInfo->srcImageLayout, pCopyImageInfo->dstImage,
3427 pCopyImageInfo->dstImageLayout, pCopyImageInfo->regionCount, pCopyImageInfo->pRegions,
3428 CMD_COPYIMAGE2);
Jeff Leger178b1e52020-10-05 12:22:23 -04003429}
3430
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003431void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3432 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3433 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003434 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3435 pRegions);
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07003436 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003437 auto src_image_state = Get<IMAGE_STATE>(srcImage);
3438 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003439
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003440 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003441 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06003442 cb_node->SetImageInitialLayout(*src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3443 cb_node->SetImageInitialLayout(*dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003444 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003445}
3446
Aitor Camacho82c1a7a2022-07-05 22:21:19 +02003447void CoreChecks::RecordCmdCopyImage2(VkCommandBuffer commandBuffer, const VkCopyImageInfo2 *pCopyImageInfo) {
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07003448 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003449 auto src_image_state = Get<IMAGE_STATE>(pCopyImageInfo->srcImage);
3450 auto dst_image_state = Get<IMAGE_STATE>(pCopyImageInfo->dstImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04003451
3452 // Make sure that all image slices are updated to correct layout
3453 for (uint32_t i = 0; i < pCopyImageInfo->regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06003454 cb_node->SetImageInitialLayout(*src_image_state, pCopyImageInfo->pRegions[i].srcSubresource,
3455 pCopyImageInfo->srcImageLayout);
3456 cb_node->SetImageInitialLayout(*dst_image_state, pCopyImageInfo->pRegions[i].dstSubresource,
3457 pCopyImageInfo->dstImageLayout);
Jeff Leger178b1e52020-10-05 12:22:23 -04003458 }
3459}
3460
Tony-LunarGb61514a2021-11-02 12:36:51 -06003461void CoreChecks::PreCallRecordCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) {
3462 StateTracker::PreCallRecordCmdCopyImage2KHR(commandBuffer, pCopyImageInfo);
Aitor Camacho82c1a7a2022-07-05 22:21:19 +02003463 RecordCmdCopyImage2(commandBuffer, pCopyImageInfo);
Tony-LunarGb61514a2021-11-02 12:36:51 -06003464}
3465
3466void CoreChecks::PreCallRecordCmdCopyImage2(VkCommandBuffer commandBuffer, const VkCopyImageInfo2 *pCopyImageInfo) {
3467 StateTracker::PreCallRecordCmdCopyImage2(commandBuffer, pCopyImageInfo);
Aitor Camacho82c1a7a2022-07-05 22:21:19 +02003468 RecordCmdCopyImage2(commandBuffer, pCopyImageInfo);
Tony-LunarGb61514a2021-11-02 12:36:51 -06003469}
3470
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003471// Returns true if sub_rect is entirely contained within rect
3472static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
3473 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 -07003474 (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 -07003475 return false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003476 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003477 return true;
3478}
3479
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003480bool CoreChecks::ValidateClearAttachmentExtent(const CMD_BUFFER_STATE &cb_node, uint32_t attachment_index,
amhagana448ea52021-11-02 14:09:14 -04003481 const IMAGE_VIEW_STATE* image_view_state,
3482 const VkRect2D &render_area, uint32_t rect_count, const VkClearRect *clear_rects) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07003483 bool skip = false;
John Zulauf3a548ef2019-02-01 16:14:07 -07003484
3485 for (uint32_t j = 0; j < rect_count; j++) {
3486 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003487 skip |= LogError(cb_node.Handle(), "VUID-vkCmdClearAttachments-pRects-00016",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003488 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
3489 "the current render pass instance.",
3490 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07003491 }
3492
3493 if (image_view_state) {
3494 // The layers specified by a given element of pRects must be contained within every attachment that
3495 // pAttachments refers to
ziga-lunargff6485c2021-10-08 18:18:32 +02003496 const uint32_t attachment_layer_count = image_view_state->GetAttachmentLayerCount();
John Zulauf3a548ef2019-02-01 16:14:07 -07003497 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
3498 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003499 skip |= LogError(cb_node.Handle(), "VUID-vkCmdClearAttachments-pRects-00017",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003500 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
3501 "of pAttachment[%d].",
3502 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07003503 }
3504 }
3505 }
3506 return skip;
3507}
3508
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003509bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3510 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003511 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003512 bool skip = false;
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07003513 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Petr Kraus2dffb382019-08-10 02:52:12 +02003514 if (!cb_node) return skip;
3515
Jeremy Gebben9f537102021-10-05 16:37:12 -06003516 skip |= ValidateCmd(cb_node.get(), CMD_CLEARATTACHMENTS);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003517
3518 // Validate that attachment is in reference list of active subpass
3519 if (cb_node->activeRenderPass) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08003520 const VkRenderPassCreateInfo2 *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07003521 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Mike Schuchardt2df08912020-12-15 16:28:09 -08003522 const VkSubpassDescription2 *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
locke-lunargaecf2152020-05-12 17:15:41 -06003523 const auto *framebuffer = cb_node->activeFramebuffer.get();
Aaron Hagan1656b2b2021-12-21 11:52:41 -05003524 const auto &render_area = (cb_node->activeRenderPass->use_dynamic_rendering) ?
3525 cb_node->activeRenderPass->dynamic_rendering_begin_rendering_info.renderArea :
3526 cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003527
John Zulauf3a548ef2019-02-01 16:14:07 -07003528 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3529 auto clear_desc = &pAttachments[attachment_index];
3530 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003531 const VkImageAspectFlags aspect_mask = clear_desc->aspectMask;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003532
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003533 if (aspect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
3534 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020",
3535 "vkCmdClearAttachments() pAttachments[%u] mask contains VK_IMAGE_ASPECT_METADATA_BIT",
3536 attachment_index);
3537 } else if (aspect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
3538 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
3539 skip |=
3540 LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-02246",
3541 "vkCmdClearAttachments() pAttachments[%u] mask contains a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit",
3542 attachment_index);
3543 } else if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07003544 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
Aaron Haganc6bafff2021-11-29 23:30:07 -05003545 if (subpass_desc) {
amhagana448ea52021-11-02 14:09:14 -04003546 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
3547 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3548 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
3549 skip |= LogError(
3550 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3551 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
3552 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
3553 attachment_index, clear_desc->colorAttachment,
3554 report_data->FormatHandle(cb_node->activeRenderPass->renderPass()).c_str(), cb_node->activeSubpass,
3555 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07003556
amhagana448ea52021-11-02 14:09:14 -04003557 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
3558 }
3559 } else {
3560 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3561 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
3562 " subpass %u. colorAttachmentCount=%u",
3563 attachment_index, clear_desc->colorAttachment,
3564 report_data->FormatHandle(cb_node->activeRenderPass->renderPass()).c_str(),
3565 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
John Zulauff2582972019-02-09 14:53:30 -07003566 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003567 }
John Zulauff2582972019-02-09 14:53:30 -07003568 fb_attachment = color_attachment;
3569
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003570 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
3571 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
3572 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019",
3573 "vkCmdClearAttachments() pAttachments[%u] aspectMask must set only VK_IMAGE_ASPECT_COLOR_BIT "
3574 "of a color attachment.",
3575 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003576 }
3577 } else { // Must be depth and/or stencil
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003578 bool subpass_depth = false;
3579 bool subpass_stencil = false;
amhagana448ea52021-11-02 14:09:14 -04003580 if (subpass_desc) {
3581 if (subpass_desc->pDepthStencilAttachment &&
3582 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3583 auto index = subpass_desc->pDepthStencilAttachment->attachment;
3584 subpass_depth = FormatHasDepth(renderpass_create_info->pAttachments[index].format);
3585 subpass_stencil = FormatHasStencil(renderpass_create_info->pAttachments[index].format);
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003586 }
amhagana448ea52021-11-02 14:09:14 -04003587 if (!subpass_desc->pDepthStencilAttachment ||
3588 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3589 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) && !subpass_depth) {
3590 skip |= LogError(
3591 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02502",
3592 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_DEPTH_BIT but there is no "
3593 "depth attachment in subpass",
3594 attachment_index);
3595 }
3596 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) && !subpass_stencil) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003597 skip |= LogError(
3598 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02503",
3599 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_STENCIL_BIT but there is no "
amhagana448ea52021-11-02 14:09:14 -04003600 "stencil attachment in subpass",
3601 attachment_index);
3602 }
3603 } else {
3604 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003605 }
amhagana448ea52021-11-02 14:09:14 -04003606 if (subpass_depth) {
3607 skip |= ValidateClearDepthStencilValue(commandBuffer, clear_desc->clearValue.depthStencil,
3608 "vkCmdClearAttachments()");
3609 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08003610 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003611 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003612 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
amhagana448ea52021-11-02 14:09:14 -04003613 const IMAGE_VIEW_STATE* image_view_state = nullptr;
3614 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
3615 image_view_state = cb_node->GetActiveAttachmentImageViewState(fb_attachment);
3616 }
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003617 skip |= ValidateClearAttachmentExtent(*cb_node, attachment_index, image_view_state, render_area,
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003618 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06003619 }
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003620
3621 // Once the framebuffer attachment is found, can get the image view state
3622 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) &&
3623 (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003624 const auto *image_view_state = cb_node->GetActiveAttachmentImageViewState(fb_attachment);
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003625 if (image_view_state != nullptr) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06003626 skip |= ValidateProtectedImage(cb_node.get(), image_view_state->image_state.get(), "vkCmdClearAttachments()",
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003627 "VUID-vkCmdClearAttachments-commandBuffer-02504");
Jeremy Gebben9f537102021-10-05 16:37:12 -06003628 skip |= ValidateUnprotectedImage(cb_node.get(), image_view_state->image_state.get(), "vkCmdClearAttachments()",
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003629 "VUID-vkCmdClearAttachments-commandBuffer-02505");
3630 }
3631 }
ziga-lunargfa335aa2021-08-05 16:59:39 +02003632
amhagana448ea52021-11-02 14:09:14 -04003633 // When a subpass uses a non-zero view mask, multiview functionality is considered to be enabled
3634 if (subpass_desc && (subpass_desc->viewMask > 0)) {
3635 for (uint32_t i = 0; i < rectCount; ++i) {
3636 if (pRects[i].baseArrayLayer != 0 || pRects[i].layerCount != 1) {
3637 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-baseArrayLayer-00018",
3638 "vkCmdClearAttachments(): pRects[%" PRIu32 "] baseArrayLayer is %" PRIu32
3639 " and layerCount is %" PRIu32 ", but the render pass instance uses multiview.",
3640 i, pRects[i].baseArrayLayer, pRects[i].layerCount);
3641 }
ziga-lunargfa335aa2021-08-05 16:59:39 +02003642 }
3643 }
3644 }
John Zulauf441558b2019-08-12 11:47:39 -06003645 }
3646 return skip;
3647}
3648
3649void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3650 const VkClearAttachment *pAttachments, uint32_t rectCount,
3651 const VkClearRect *pRects) {
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07003652 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
John Zulauf441558b2019-08-12 11:47:39 -06003653 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
John Zulauf441558b2019-08-12 11:47:39 -06003654 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
Aaron Haganc6bafff2021-11-29 23:30:07 -05003655 if (cb_node->activeRenderPass->use_dynamic_rendering_inherited) {
3656 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3657 const auto clear_desc = &pAttachments[attachment_index];
3658 auto colorAttachmentCount = cb_node->activeRenderPass->inheritance_rendering_info.colorAttachmentCount;
3659 int image_index = -1;
3660 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3661 (clear_desc->colorAttachment < colorAttachmentCount)) {
3662 image_index = cb_node->GetDynamicColorAttachmentImageIndex(clear_desc->colorAttachment);
3663 }
3664 else if (clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT)) {
3665 image_index = cb_node->GetDynamicDepthAttachmentImageIndex();
3666 }
3667 else if (clear_desc->aspectMask & (VK_IMAGE_ASPECT_STENCIL_BIT)) {
3668 image_index = cb_node->GetDynamicStencilAttachmentImageIndex();
3669 }
amhagana448ea52021-11-02 14:09:14 -04003670
Aaron Haganc6bafff2021-11-29 23:30:07 -05003671 if (image_index != -1) {
3672 if (!clear_rect_copy) {
3673 // We need a copy of the clear rectangles that will persist until the last lambda executes
3674 // but we want to create it as lazily as possible
3675 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
amhagana448ea52021-11-02 14:09:14 -04003676 }
Aaron Haganc6bafff2021-11-29 23:30:07 -05003677 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3678 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
3679 auto val_fn = [this, attachment_index, image_index, rectCount, clear_rect_copy](
3680 const CMD_BUFFER_STATE &secondary, const CMD_BUFFER_STATE *prim_cb,
3681 const FRAMEBUFFER_STATE *fb) {
3682 assert(rectCount == clear_rect_copy->size());
3683 bool skip = false;
3684 const IMAGE_VIEW_STATE* image_view_state = nullptr;
3685 if (image_index != -1) {
3686 image_view_state = (*prim_cb->active_attachments)[image_index];
3687 }
3688 skip = ValidateClearAttachmentExtent(secondary, attachment_index, image_view_state,
3689 prim_cb->activeRenderPass->dynamic_rendering_begin_rendering_info.renderArea,
3690 rectCount, clear_rect_copy->data());
3691 return skip;
3692 };
3693 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003694 }
amhagana448ea52021-11-02 14:09:14 -04003695 }
3696 }
Aaron Haganc6bafff2021-11-29 23:30:07 -05003697 else if (cb_node->activeRenderPass->use_dynamic_rendering == false)
amhagana448ea52021-11-02 14:09:14 -04003698 {
3699 const VkRenderPassCreateInfo2* renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3700 const VkSubpassDescription2* subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
sfricke-samsung21286f82021-11-16 08:21:46 -08003701
amhagana448ea52021-11-02 14:09:14 -04003702 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3703 const auto clear_desc = &pAttachments[attachment_index];
3704 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3705 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3706 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3707 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3708 }
3709 else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3710 subpass_desc->pDepthStencilAttachment) {
3711 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3712 }
3713 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
3714 if (!clear_rect_copy) {
3715 // We need a copy of the clear rectangles that will persist until the last lambda executes
3716 // but we want to create it as lazily as possible
3717 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
3718 }
3719 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3720 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003721 auto val_fn = [this, attachment_index, fb_attachment, rectCount, clear_rect_copy](
3722 const CMD_BUFFER_STATE &secondary, const CMD_BUFFER_STATE *prim_cb,
3723 const FRAMEBUFFER_STATE *fb) {
amhagana448ea52021-11-02 14:09:14 -04003724 assert(rectCount == clear_rect_copy->size());
3725 const auto& render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3726 bool skip = false;
3727 const IMAGE_VIEW_STATE* image_view_state = nullptr;
3728 if (fb && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < fb->createInfo.attachmentCount)) {
3729 image_view_state = prim_cb->GetActiveAttachmentImageViewState(fb_attachment);
3730 }
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003731 skip = ValidateClearAttachmentExtent(secondary, attachment_index, image_view_state, render_area, rectCount,
3732 clear_rect_copy->data());
amhagana448ea52021-11-02 14:09:14 -04003733 return skip;
3734 };
3735 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
3736 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003737 }
3738 }
3739 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003740}
3741
Jeff Leger178b1e52020-10-05 12:22:23 -04003742template <typename RegionType>
3743bool CoreChecks::ValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3744 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Tony-LunarG562fc102021-11-12 13:58:35 -07003745 const RegionType *pRegions, CMD_TYPE cmd_type) const {
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07003746 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07003747 auto src_image_state = Get<IMAGE_STATE>(srcImage);
3748 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Tony-LunarG562fc102021-11-12 13:58:35 -07003749 const bool is_2 = (cmd_type == CMD_RESOLVEIMAGE2KHR || cmd_type == CMD_RESOLVEIMAGE2);
sfricke-samsung85584a72021-09-30 21:43:38 -07003750 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04003751 const char *vuid;
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003752
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003753 bool skip = false;
3754 if (cb_node && src_image_state && dst_image_state) {
Tony-LunarG562fc102021-11-12 13:58:35 -07003755 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-00256" : "VUID-vkCmdResolveImage-srcImage-00256";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003756 skip |= ValidateMemoryIsBoundToImage(src_image_state.get(), func_name, vuid);
Tony-LunarG562fc102021-11-12 13:58:35 -07003757 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-00258" : "VUID-vkCmdResolveImage-dstImage-00258";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003758 skip |= ValidateMemoryIsBoundToImage(dst_image_state.get(), func_name, vuid);
3759 skip |= ValidateCmd(cb_node.get(), cmd_type);
Tony-LunarG562fc102021-11-12 13:58:35 -07003760 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-02003" : "VUID-vkCmdResolveImage-dstImage-02003";
3761 skip |= ValidateImageFormatFeatureFlags(dst_image_state.get(), VK_FORMAT_FEATURE_2_COLOR_ATTACHMENT_BIT, func_name, vuid);
3762 vuid = is_2 ? "VUID-vkCmdResolveImage2-commandBuffer-01837" : "VUID-vkCmdResolveImage-commandBuffer-01837";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003763 skip |= ValidateProtectedImage(cb_node.get(), src_image_state.get(), func_name, vuid);
Tony-LunarG562fc102021-11-12 13:58:35 -07003764 vuid = is_2 ? "VUID-vkCmdResolveImage2-commandBuffer-01838" : "VUID-vkCmdResolveImage-commandBuffer-01838";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003765 skip |= ValidateProtectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
Tony-LunarG562fc102021-11-12 13:58:35 -07003766 vuid = is_2 ? "VUID-vkCmdResolveImage2-commandBuffer-01839" : "VUID-vkCmdResolveImage-commandBuffer-01839";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003767 skip |= ValidateUnprotectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
ziga-lunarg73154fd2022-05-18 14:36:33 +02003768 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-06762" : "VUID-vkCmdResolveImage-srcImage-06762";
3769 skip |= ValidateImageUsageFlags(src_image_state.get(), VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3770 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3771 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-06763" : "VUID-vkCmdResolveImage-srcImage-06763";
3772 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(), VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
3773 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-06764" : "VUID-vkCmdResolveImage-dstImage-06764";
3774 skip |= ValidateImageUsageFlags(dst_image_state.get(), VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3775 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3776 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-06765" : "VUID-vkCmdResolveImage-dstImage-06765";
3777 skip |= ValidateImageFormatFeatureFlags(dst_image_state.get(), VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003778
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003779 // Validation for VK_EXT_fragment_density_map
3780 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony-LunarG562fc102021-11-12 13:58:35 -07003781 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003782 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003783 "%s: srcImage must not have been created with flags containing "
3784 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3785 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003786 }
3787 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony-LunarG562fc102021-11-12 13:58:35 -07003788 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003789 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003790 "%s: dstImage must not have been created with flags containing "
3791 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3792 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003793 }
3794
Cort Stratton7df30962018-05-17 19:45:57 -07003795 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003796 const char *invalid_src_layout_vuid =
Tony-LunarG562fc102021-11-12 13:58:35 -07003797 is_2 ? ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
3798 ? "VUID-VkResolveImageInfo2-srcImageLayout-01400"
3799 : "VUID-VkResolveImageInfo2-srcImageLayout-00261")
sfricke-samsung45996a42021-09-16 13:45:27 -07003800 : ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003801 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3802 : "VUID-vkCmdResolveImage-srcImageLayout-00261");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003803 const char *invalid_dst_layout_vuid =
Tony-LunarG562fc102021-11-12 13:58:35 -07003804 is_2 ? ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
3805 ? "VUID-VkResolveImageInfo2-dstImageLayout-01401"
3806 : "VUID-VkResolveImageInfo2-dstImageLayout-00263")
sfricke-samsung45996a42021-09-16 13:45:27 -07003807 : ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003808 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3809 : "VUID-vkCmdResolveImage-dstImageLayout-00263");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003810 // For each region, the number of layers in the image subresource should not be zero
3811 // For each region, src and dest image aspect must be color only
3812 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003813 const RegionType region = pRegions[i];
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003814 const VkImageSubresourceLayers src_subresource = region.srcSubresource;
3815 const VkImageSubresourceLayers dst_subresource = region.dstSubresource;
Tony-LunarG562fc102021-11-12 13:58:35 -07003816
Jeremy Gebben9f537102021-10-05 16:37:12 -06003817 skip |= ValidateImageSubresourceLayers(cb_node.get(), &src_subresource, func_name, "srcSubresource", i);
3818 skip |= ValidateImageSubresourceLayers(cb_node.get(), &dst_subresource, func_name, "dstSubresource", i);
Tony-LunarG562fc102021-11-12 13:58:35 -07003819 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImageLayout-00260" : "VUID-vkCmdResolveImage-srcImageLayout-00260";
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06003820 skip |= VerifyImageLayout(*cb_node, *src_image_state, src_subresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003821 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
Tony-LunarG562fc102021-11-12 13:58:35 -07003822 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImageLayout-00262" : "VUID-vkCmdResolveImage-dstImageLayout-00262";
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06003823 skip |= VerifyImageLayout(*cb_node, *dst_image_state, dst_subresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003824 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
Tony-LunarG562fc102021-11-12 13:58:35 -07003825 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcSubresource-01709" : "VUID-vkCmdResolveImage-srcSubresource-01709";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003826 skip |= ValidateImageMipLevel(cb_node.get(), src_image_state.get(), src_subresource.mipLevel, i, func_name,
3827 "srcSubresource", vuid);
Tony-LunarG562fc102021-11-12 13:58:35 -07003828 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstSubresource-01710" : "VUID-vkCmdResolveImage-dstSubresource-01710";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003829 skip |= ValidateImageMipLevel(cb_node.get(), dst_image_state.get(), dst_subresource.mipLevel, i, func_name,
3830 "dstSubresource", vuid);
Tony-LunarG562fc102021-11-12 13:58:35 -07003831 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcSubresource-01711" : "VUID-vkCmdResolveImage-srcSubresource-01711";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003832 skip |= ValidateImageArrayLayerRange(cb_node.get(), src_image_state.get(), src_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003833 src_subresource.layerCount, i, func_name, "srcSubresource", vuid);
Tony-LunarG562fc102021-11-12 13:58:35 -07003834 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstSubresource-01712" : "VUID-vkCmdResolveImage-dstSubresource-01712";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003835 skip |= ValidateImageArrayLayerRange(cb_node.get(), dst_image_state.get(), dst_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003836 dst_subresource.layerCount, i, func_name, "srcSubresource", vuid);
Cort Stratton7df30962018-05-17 19:45:57 -07003837
3838 // layer counts must match
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003839 if (src_subresource.layerCount != dst_subresource.layerCount) {
Tony-LunarG562fc102021-11-12 13:58:35 -07003840 vuid = is_2 ? "VUID-VkImageResolve2-layerCount-00267" : "VUID-VkImageResolve-layerCount-00267";
Jeff Leger178b1e52020-10-05 12:22:23 -04003841 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003842 LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003843 "%s: layerCount in source and destination subresource of pRegions[%u] does not match.", func_name, i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003844 }
Cort Stratton7df30962018-05-17 19:45:57 -07003845 // For each region, src and dest image aspect must be color only
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003846 if ((src_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3847 (dst_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
Tony-LunarG562fc102021-11-12 13:58:35 -07003848 vuid = is_2 ? "VUID-VkImageResolve2-aspectMask-00266" : "VUID-VkImageResolve-aspectMask-00266";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003849 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003850 "%s: src and dest aspectMasks for pRegions[%u] must specify only VK_IMAGE_ASPECT_COLOR_BIT.",
3851 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003852 }
3853
3854 const VkImageType src_image_type = src_image_state->createInfo.imageType;
3855 const VkImageType dst_image_type = dst_image_state->createInfo.imageType;
3856
3857 if ((VK_IMAGE_TYPE_3D == src_image_type) || (VK_IMAGE_TYPE_3D == dst_image_type)) {
Shannon McPherson74b341c2020-09-08 15:43:05 -06003858 if ((0 != src_subresource.baseArrayLayer) || (1 != src_subresource.layerCount)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003859 LogObjectList objlist(cb_node->commandBuffer());
3860 objlist.add(src_image_state->image());
3861 objlist.add(dst_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003862 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-04446" : "VUID-vkCmdResolveImage-srcImage-04446";
Jeff Leger178b1e52020-10-05 12:22:23 -04003863 skip |= LogError(objlist, vuid,
3864 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
Shannon McPherson74b341c2020-09-08 15:43:05 -06003865 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003866 func_name, i);
Shannon McPherson74b341c2020-09-08 15:43:05 -06003867 }
3868 if ((0 != dst_subresource.baseArrayLayer) || (1 != dst_subresource.layerCount)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003869 LogObjectList objlist(cb_node->commandBuffer());
3870 objlist.add(src_image_state->image());
3871 objlist.add(dst_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003872 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-04447" : "VUID-vkCmdResolveImage-srcImage-04447";
Jeff Leger178b1e52020-10-05 12:22:23 -04003873 skip |= LogError(objlist, vuid,
3874 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003875 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003876 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003877 }
3878 }
3879
3880 if (VK_IMAGE_TYPE_1D == src_image_type) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05003881 if ((region.srcOffset.y != 0) || (region.extent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003882 LogObjectList objlist(cb_node->commandBuffer());
3883 objlist.add(src_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003884 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-00271" : "VUID-vkCmdResolveImage-srcImage-00271";
Jeff Leger178b1e52020-10-05 12:22:23 -04003885 skip |= LogError(objlist, vuid,
3886 "%s: srcImage (%s) is 1D but pRegions[%u] srcOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003887 "extent.height (%u) is not 1.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05003888 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.y,
3889 region.extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003890 }
3891 }
3892 if ((VK_IMAGE_TYPE_1D == src_image_type) || (VK_IMAGE_TYPE_2D == src_image_type)) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05003893 if ((region.srcOffset.z != 0) || (region.extent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003894 LogObjectList objlist(cb_node->commandBuffer());
3895 objlist.add(src_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003896 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-00273" : "VUID-vkCmdResolveImage-srcImage-00273";
Jeff Leger178b1e52020-10-05 12:22:23 -04003897 skip |= LogError(objlist, vuid,
3898 "%s: srcImage (%s) is 2D but pRegions[%u] srcOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003899 "extent.depth (%u) is not 1.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05003900 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.z,
3901 region.extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003902 }
3903 }
3904
3905 if (VK_IMAGE_TYPE_1D == dst_image_type) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05003906 if ((region.dstOffset.y != 0) || (region.extent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003907 LogObjectList objlist(cb_node->commandBuffer());
3908 objlist.add(dst_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003909 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-00276" : "VUID-vkCmdResolveImage-dstImage-00276";
Jeff Leger178b1e52020-10-05 12:22:23 -04003910 skip |= LogError(objlist, vuid,
3911 "%s: dstImage (%s) is 1D but pRegions[%u] dstOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003912 "extent.height (%u) is not 1.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05003913 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.dstOffset.y,
3914 region.extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003915 }
3916 }
3917 if ((VK_IMAGE_TYPE_1D == dst_image_type) || (VK_IMAGE_TYPE_2D == dst_image_type)) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05003918 if ((region.dstOffset.z != 0) || (region.extent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003919 LogObjectList objlist(cb_node->commandBuffer());
3920 objlist.add(dst_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003921 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-00278" : "VUID-vkCmdResolveImage-dstImage-00278";
Jeff Leger178b1e52020-10-05 12:22:23 -04003922 skip |= LogError(objlist, vuid,
3923 "%s: dstImage (%s) is 2D but pRegions[%u] dstOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003924 "extent.depth (%u) is not 1.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05003925 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.dstOffset.z,
3926 region.extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003927 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003928 }
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003929
3930 // Each srcImage dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003931 VkExtent3D subresource_extent = src_image_state->GetSubresourceExtent(src_subresource);
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003932 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3933 // developer
3934 if (src_subresource.mipLevel < src_image_state->createInfo.mipLevels) {
3935 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003936 if ((extent_check & kXBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003937 LogObjectList objlist(cb_node->commandBuffer());
3938 objlist.add(src_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003939 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcOffset-00269" : "VUID-vkCmdResolveImage-srcOffset-00269";
Jeff Leger178b1e52020-10-05 12:22:23 -04003940 skip |= LogError(objlist, vuid,
3941 "%s: srcImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003942 "exceeds subResource width [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003943 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003944 region.extent.width, subresource_extent.width);
3945 }
3946
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003947 if ((extent_check & kYBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003948 LogObjectList objlist(cb_node->commandBuffer());
3949 objlist.add(src_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003950 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcOffset-00270" : "VUID-vkCmdResolveImage-srcOffset-00270";
Jeff Leger178b1e52020-10-05 12:22:23 -04003951 skip |= LogError(objlist, vuid,
3952 "%s: srcImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003953 "exceeds subResource height [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003954 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003955 region.extent.height, subresource_extent.height);
3956 }
3957
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003958 if ((extent_check & kZBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003959 LogObjectList objlist(cb_node->commandBuffer());
3960 objlist.add(src_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003961 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcOffset-00272" : "VUID-vkCmdResolveImage-srcOffset-00272";
Jeff Leger178b1e52020-10-05 12:22:23 -04003962 skip |= LogError(objlist, vuid,
3963 "%s: srcImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003964 "exceeds subResource depth [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003965 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003966 region.extent.depth, subresource_extent.depth);
3967 }
3968 }
3969
3970 // Each dstImage dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003971 subresource_extent = dst_image_state->GetSubresourceExtent(dst_subresource);
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003972 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3973 // developer
3974 if (dst_subresource.mipLevel < dst_image_state->createInfo.mipLevels) {
3975 uint32_t extent_check = ExceedsBounds(&(region.dstOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003976 if ((extent_check & kXBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003977 LogObjectList objlist(cb_node->commandBuffer());
3978 objlist.add(dst_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003979 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstOffset-00274" : "VUID-vkCmdResolveImage-dstOffset-00274";
Jeff Leger178b1e52020-10-05 12:22:23 -04003980 skip |= LogError(objlist, vuid,
3981 "%s: dstImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003982 "exceeds subResource width [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003983 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003984 region.extent.width, subresource_extent.width);
3985 }
3986
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003987 if ((extent_check & kYBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003988 LogObjectList objlist(cb_node->commandBuffer());
3989 objlist.add(dst_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003990 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstOffset-00275" : "VUID-vkCmdResolveImage-dstOffset-00275";
Jeff Leger178b1e52020-10-05 12:22:23 -04003991 skip |= LogError(objlist, vuid,
3992 "%s: dstImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003993 "exceeds subResource height [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003994 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003995 region.extent.height, subresource_extent.height);
3996 }
3997
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003998 if ((extent_check & kZBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003999 LogObjectList objlist(cb_node->commandBuffer());
4000 objlist.add(dst_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07004001 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstOffset-00277" : "VUID-vkCmdResolveImage-dstOffset-00277";
Jeff Leger178b1e52020-10-05 12:22:23 -04004002 skip |= LogError(objlist, vuid,
4003 "%s: dstImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07004004 "exceeds subResource depth [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004005 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07004006 region.extent.depth, subresource_extent.depth);
4007 }
4008 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07004009 }
4010
4011 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
Tony-LunarG562fc102021-11-12 13:58:35 -07004012 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-01386" : "VUID-vkCmdResolveImage-srcImage-01386";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004013 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 -04004014 func_name, string_VkFormat(src_image_state->createInfo.format),
4015 string_VkFormat(dst_image_state->createInfo.format));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07004016 }
4017 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004018 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_MismatchedImageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04004019 "%s: srcImage type (%s) and dstImage type (%s) are not the same.", func_name,
sfricke-samsungc26350e2020-05-30 12:31:31 -07004020 string_VkImageType(src_image_state->createInfo.imageType),
4021 string_VkImageType(dst_image_state->createInfo.imageType));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07004022 }
4023 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
Tony-LunarG562fc102021-11-12 13:58:35 -07004024 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-00257" : "VUID-vkCmdResolveImage-srcImage-00257";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004025 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 -07004026 }
4027 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
Tony-LunarG562fc102021-11-12 13:58:35 -07004028 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-00259" : "VUID-vkCmdResolveImage-dstImage-00259";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004029 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 -04004030 func_name, string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07004031 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004032 } else {
4033 assert(0);
4034 }
4035 return skip;
4036}
4037
Jeff Leger178b1e52020-10-05 12:22:23 -04004038bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4039 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4040 const VkImageResolve *pRegions) const {
4041 return ValidateCmdResolveImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
Tony-LunarG562fc102021-11-12 13:58:35 -07004042 CMD_RESOLVEIMAGE);
Jeff Leger178b1e52020-10-05 12:22:23 -04004043}
4044
4045bool CoreChecks::PreCallValidateCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
4046 const VkResolveImageInfo2KHR *pResolveImageInfo) const {
4047 return ValidateCmdResolveImage(commandBuffer, pResolveImageInfo->srcImage, pResolveImageInfo->srcImageLayout,
4048 pResolveImageInfo->dstImage, pResolveImageInfo->dstImageLayout, pResolveImageInfo->regionCount,
Tony-LunarG562fc102021-11-12 13:58:35 -07004049 pResolveImageInfo->pRegions, CMD_RESOLVEIMAGE2KHR);
4050}
4051
4052bool CoreChecks::PreCallValidateCmdResolveImage2(VkCommandBuffer commandBuffer,
4053 const VkResolveImageInfo2 *pResolveImageInfo) const {
4054 return ValidateCmdResolveImage(commandBuffer, pResolveImageInfo->srcImage, pResolveImageInfo->srcImageLayout,
4055 pResolveImageInfo->dstImage, pResolveImageInfo->dstImageLayout, pResolveImageInfo->regionCount,
4056 pResolveImageInfo->pRegions, CMD_RESOLVEIMAGE2);
Jeff Leger178b1e52020-10-05 12:22:23 -04004057}
4058
4059template <typename RegionType>
4060bool CoreChecks::ValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4061 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Tony-LunarG542ae912021-11-04 16:06:44 -06004062 const RegionType *pRegions, VkFilter filter, CMD_TYPE cmd_type) const {
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07004063 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07004064 auto src_image_state = Get<IMAGE_STATE>(srcImage);
4065 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Tony-LunarG542ae912021-11-04 16:06:44 -06004066 const bool is_2 = (cmd_type == CMD_BLITIMAGE2KHR || cmd_type == CMD_BLITIMAGE2);
sfricke-samsung85584a72021-09-30 21:43:38 -07004067 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04004068
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004069 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07004070 if (cb_node) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06004071 skip |= ValidateCmd(cb_node.get(), cmd_type);
John Zulauf5c2750c2018-01-30 15:04:56 -07004072 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004073 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004074 const char *vuid;
Tony-LunarG542ae912021-11-04 16:06:44 -06004075 std::string loc_head = std::string(func_name);
4076 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00233" : "VUID-vkCmdBlitImage-srcImage-00233";
4077 const char *location1 = is_2 ? loc_head.append("(): pBlitImageInfo->srcImage").c_str() : "vkCmdBlitImage(): srcImage";
4078 skip |= ValidateImageSampleCount(src_image_state.get(), VK_SAMPLE_COUNT_1_BIT, location1, vuid);
4079 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-00234" : "VUID-vkCmdBlitImage-dstImage-00234";
4080 loc_head = std::string(func_name);
4081 const char *location2 = is_2 ? loc_head.append("(): pBlitImageInfo->dstImage").c_str() : "vkCmdBlitImage(): dstImage";
4082 skip |= ValidateImageSampleCount(dst_image_state.get(), VK_SAMPLE_COUNT_1_BIT, location2, vuid);
4083 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00220" : "VUID-vkCmdBlitImage-srcImage-00220";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004084 skip |= ValidateMemoryIsBoundToImage(src_image_state.get(), func_name, vuid);
Tony-LunarG542ae912021-11-04 16:06:44 -06004085 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-00225" : "VUID-vkCmdBlitImage-dstImage-00225";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004086 skip |= ValidateMemoryIsBoundToImage(dst_image_state.get(), func_name, vuid);
Tony-LunarG542ae912021-11-04 16:06:44 -06004087 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00219" : "VUID-vkCmdBlitImage-srcImage-00219";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004088 skip |= ValidateImageUsageFlags(src_image_state.get(), VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04004089 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tony-LunarG542ae912021-11-04 16:06:44 -06004090 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-00224" : "VUID-vkCmdBlitImage-dstImage-00224";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004091 skip |= ValidateImageUsageFlags(dst_image_state.get(), VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04004092 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Jeremy Gebben9f537102021-10-05 16:37:12 -06004093 skip |= ValidateCmd(cb_node.get(), cmd_type);
Tony-LunarG542ae912021-11-04 16:06:44 -06004094 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-01999" : "VUID-vkCmdBlitImage-srcImage-01999";
4095 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(), VK_FORMAT_FEATURE_2_BLIT_SRC_BIT, func_name, vuid);
4096 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-02000" : "VUID-vkCmdBlitImage-dstImage-02000";
4097 skip |= ValidateImageFormatFeatureFlags(dst_image_state.get(), VK_FORMAT_FEATURE_2_BLIT_DST_BIT, func_name, vuid);
4098 vuid = is_2 ? "VUID-vkCmdBlitImage2-commandBuffer-01834" : "VUID-vkCmdBlitImage-commandBuffer-01834";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004099 skip |= ValidateProtectedImage(cb_node.get(), src_image_state.get(), func_name, vuid);
Tony-LunarG542ae912021-11-04 16:06:44 -06004100 vuid = is_2 ? "VUID-vkCmdBlitImage2-commandBuffer-01835" : "VUID-vkCmdBlitImage-commandBuffer-01835";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004101 skip |= ValidateProtectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
Tony-LunarG542ae912021-11-04 16:06:44 -06004102 vuid = is_2 ? "VUID-vkCmdBlitImage2-commandBuffer-01836" : "VUID-vkCmdBlitImage-commandBuffer-01836";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004103 skip |= ValidateUnprotectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
sfricke-samsung022fa252020-07-24 03:26:16 -07004104
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02004105 // Validation for VK_EXT_fragment_density_map
4106 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004107 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004108 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004109 "%s: srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
4110 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02004111 }
4112 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004113 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004114 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004115 "%s: dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
4116 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02004117 }
4118
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06004119 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004120
Dave Houlton33c2d252017-06-09 17:08:32 -06004121 VkFormat src_format = src_image_state->createInfo.format;
4122 VkFormat dst_format = dst_image_state->createInfo.format;
4123 VkImageType src_type = src_image_state->createInfo.imageType;
4124 VkImageType dst_type = dst_image_state->createInfo.imageType;
4125
Cort Stratton186b1a22018-05-01 20:18:06 -04004126 if (VK_FILTER_LINEAR == filter) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004127 vuid = is_2 ? "VUID-VkBlitImageInfo2-filter-02001" : "VUID-vkCmdBlitImage-filter-02001";
4128 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(), VK_FORMAT_FEATURE_2_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Jeremy Gebben9f537102021-10-05 16:37:12 -06004129 func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04004130 } else if (VK_FILTER_CUBIC_IMG == filter) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004131 vuid = is_2 ? "VUID-VkBlitImageInfo2-filter-02002" : "VUID-vkCmdBlitImage-filter-02002";
4132 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(), VK_FORMAT_FEATURE_2_SAMPLED_IMAGE_FILTER_CUBIC_BIT,
Jeff Leger178b1e52020-10-05 12:22:23 -04004133 func_name, vuid);
Dave Houlton33c2d252017-06-09 17:08:32 -06004134 }
4135
sfricke-samsung10b35ce2021-09-29 08:50:20 -07004136 if (FormatRequiresYcbcrConversionExplicitly(src_format)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004137 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-06421" : "VUID-vkCmdBlitImage-srcImage-06421";
Jeff Leger178b1e52020-10-05 12:22:23 -04004138 skip |= LogError(device, vuid,
4139 "%s: srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004140 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04004141 func_name, string_VkFormat(src_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004142 }
4143
sfricke-samsung10b35ce2021-09-29 08:50:20 -07004144 if (FormatRequiresYcbcrConversionExplicitly(dst_format)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004145 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-06422" : "VUID-vkCmdBlitImage-dstImage-06422";
Jeff Leger178b1e52020-10-05 12:22:23 -04004146 skip |= LogError(device, vuid,
4147 "%s: dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004148 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04004149 func_name, string_VkFormat(dst_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004150 }
4151
ziga-lunarg52604a12021-09-09 16:02:05 +02004152 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_2D != src_type)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004153 vuid = is_2 ? "VUID-VkBlitImageInfo2-filter-00237" : "VUID-vkCmdBlitImage-filter-00237";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004154 skip |= LogError(cb_node->commandBuffer(), vuid,
ziga-lunarg52604a12021-09-09 16:02:05 +02004155 "%s: source image type must be VK_IMAGE_TYPE_2D when cubic filtering is specified.", func_name);
Dave Houlton33c2d252017-06-09 17:08:32 -06004156 }
4157
Dave Houlton33c2d252017-06-09 17:08:32 -06004158 // Validate consistency for unsigned formats
sfricke-samsunge3086292021-11-18 23:02:35 -08004159 if (FormatIsUINT(src_format) != FormatIsUINT(dst_format)) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004160 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004161 ss << func_name << ": If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06004162 << "the other one must also have unsigned integer format. "
4163 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Tony-LunarG542ae912021-11-04 16:06:44 -06004164 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00230" : "VUID-vkCmdBlitImage-srcImage-00230";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004165 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004166 }
4167
4168 // Validate consistency for signed formats
sfricke-samsunge3086292021-11-18 23:02:35 -08004169 if (FormatIsSINT(src_format) != FormatIsSINT(dst_format)) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004170 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004171 ss << func_name << ": If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06004172 << "the other one must also have signed integer format. "
4173 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Tony-LunarG542ae912021-11-04 16:06:44 -06004174 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00229" : "VUID-vkCmdBlitImage-srcImage-00229";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004175 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004176 }
4177
4178 // Validate filter for Depth/Stencil formats
4179 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
4180 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004181 ss << func_name << ": If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06004182 << "then filter must be VK_FILTER_NEAREST.";
Tony-LunarG542ae912021-11-04 16:06:44 -06004183 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00232" : "VUID-vkCmdBlitImage-srcImage-00232";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004184 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004185 }
4186
4187 // Validate aspect bits and formats for depth/stencil images
4188 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
4189 if (src_format != dst_format) {
4190 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004191 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 -06004192 << "stencil, the other one must have exactly the same format. "
4193 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
4194 << string_VkFormat(dst_format);
Tony-LunarG542ae912021-11-04 16:06:44 -06004195 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00231" : "VUID-vkCmdBlitImage-srcImage-00231";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004196 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004197 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004198 } // Depth or Stencil
4199
4200 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004201 const char *invalid_src_layout_vuid =
Tony-LunarG542ae912021-11-04 16:06:44 -06004202 is_2 ? ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
4203 ? "VUID-VkBlitImageInfo2-srcImageLayout-01398"
4204 : "VUID-VkBlitImageInfo2-srcImageLayout-00222")
sfricke-samsung45996a42021-09-16 13:45:27 -07004205 : ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04004206 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
4207 : "VUID-vkCmdBlitImage-srcImageLayout-00222");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004208 const char *invalid_dst_layout_vuid =
Tony-LunarG542ae912021-11-04 16:06:44 -06004209 is_2 ? ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
4210 ? "VUID-VkBlitImageInfo2-dstImageLayout-01399"
4211 : "VUID-VkBlitImageInfo2-dstImageLayout-00227")
sfricke-samsung45996a42021-09-16 13:45:27 -07004212 : ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04004213 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
4214 : "VUID-vkCmdBlitImage-dstImageLayout-00227");
Aitor Camachoc22c3602022-06-07 20:45:50 +02004215
4216 bool same_image = (src_image_state == dst_image_state);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004217 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05004218 const RegionType region = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004219 bool hit_error = false;
Tony-LunarG542ae912021-11-04 16:06:44 -06004220
Aitor Camachoc22c3602022-06-07 20:45:50 +02004221 // When performing blit from and to same subresource, VK_IMAGE_LAYOUT_GENERAL is the only option
4222 const auto &src_sub = pRegions[i].srcSubresource;
4223 const auto &dst_sub = pRegions[i].dstSubresource;
4224 bool same_subresource =
4225 (same_image && (src_sub.mipLevel == dst_sub.mipLevel) && (src_sub.baseArrayLayer == dst_sub.baseArrayLayer));
4226 VkImageLayout source_optimal = (same_subresource ? VK_IMAGE_LAYOUT_GENERAL : VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL);
4227 VkImageLayout destination_optimal = (same_subresource ? VK_IMAGE_LAYOUT_GENERAL : VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL);
4228
Tony-LunarG542ae912021-11-04 16:06:44 -06004229 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImageLayout-00221" : "VUID-vkCmdBlitImage-srcImageLayout-00221";
Aitor Camachoc22c3602022-06-07 20:45:50 +02004230 skip |= VerifyImageLayout(*cb_node, *src_image_state, region.srcSubresource, srcImageLayout, source_optimal, func_name,
4231 invalid_src_layout_vuid, vuid, &hit_error);
Tony-LunarG542ae912021-11-04 16:06:44 -06004232 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImageLayout-00226" : "VUID-vkCmdBlitImage-dstImageLayout-00226";
Aitor Camachoc22c3602022-06-07 20:45:50 +02004233 skip |= VerifyImageLayout(*cb_node, *dst_image_state, region.dstSubresource, dstImageLayout, destination_optimal,
4234 func_name, invalid_dst_layout_vuid, vuid, &hit_error);
sfricke-samsung71f04e32022-03-16 01:21:21 -05004235 skip |= ValidateImageSubresourceLayers(cb_node.get(), &region.srcSubresource, func_name, "srcSubresource", i);
4236 skip |= ValidateImageSubresourceLayers(cb_node.get(), &region.dstSubresource, func_name, "dstSubresource", i);
Tony-LunarG542ae912021-11-04 16:06:44 -06004237 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcSubresource-01705" : "VUID-vkCmdBlitImage-srcSubresource-01705";
sfricke-samsung71f04e32022-03-16 01:21:21 -05004238 skip |= ValidateImageMipLevel(cb_node.get(), src_image_state.get(), region.srcSubresource.mipLevel, i, func_name,
Jeremy Gebben9f537102021-10-05 16:37:12 -06004239 "srcSubresource", vuid);
Tony-LunarG542ae912021-11-04 16:06:44 -06004240 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstSubresource-01706" : "VUID-vkCmdBlitImage-dstSubresource-01706";
sfricke-samsung71f04e32022-03-16 01:21:21 -05004241 skip |= ValidateImageMipLevel(cb_node.get(), dst_image_state.get(), region.dstSubresource.mipLevel, i, func_name,
Jeremy Gebben9f537102021-10-05 16:37:12 -06004242 "dstSubresource", vuid);
Tony-LunarG542ae912021-11-04 16:06:44 -06004243 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcSubresource-01707" : "VUID-vkCmdBlitImage-srcSubresource-01707";
sfricke-samsung71f04e32022-03-16 01:21:21 -05004244 skip |= ValidateImageArrayLayerRange(cb_node.get(), src_image_state.get(), region.srcSubresource.baseArrayLayer,
4245 region.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
Tony-LunarG542ae912021-11-04 16:06:44 -06004246 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstSubresource-01708" : "VUID-vkCmdBlitImage-dstSubresource-01708";
sfricke-samsung71f04e32022-03-16 01:21:21 -05004247 skip |= ValidateImageArrayLayerRange(cb_node.get(), dst_image_state.get(), region.dstSubresource.baseArrayLayer,
4248 region.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004249 // Warn for zero-sized regions
sfricke-samsung71f04e32022-03-16 01:21:21 -05004250 if ((region.srcOffsets[0].x == region.srcOffsets[1].x) || (region.srcOffsets[0].y == region.srcOffsets[1].y) ||
4251 (region.srcOffsets[0].z == region.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004252 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004253 ss << func_name << ": pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004254 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004255 }
sfricke-samsung71f04e32022-03-16 01:21:21 -05004256 if ((region.dstOffsets[0].x == region.dstOffsets[1].x) || (region.dstOffsets[0].y == region.dstOffsets[1].y) ||
4257 (region.dstOffsets[0].z == region.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004258 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004259 ss << func_name << ": pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004260 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004261 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004262
4263 // Check that src/dst layercounts match
sfricke-samsung71f04e32022-03-16 01:21:21 -05004264 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004265 vuid = is_2 ? "VUID-VkImageBlit2-layerCount-00239" : "VUID-VkImageBlit-layerCount-00239";
Jeff Leger178b1e52020-10-05 12:22:23 -04004266 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004267 LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004268 "%s: layerCount in source and destination subresource of pRegions[%d] does not match.", func_name, i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004269 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07004270
sfricke-samsung71f04e32022-03-16 01:21:21 -05004271 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004272 vuid = is_2 ? "VUID-VkImageBlit2-aspectMask-00238" : "VUID-VkImageBlit-aspectMask-00238";
Jeff Leger178b1e52020-10-05 12:22:23 -04004273 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004274 LogError(cb_node->commandBuffer(), vuid, "%s: aspectMask members for pRegion[%d] do not match.", func_name, i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07004275 }
Dave Houlton48989f32017-05-26 15:01:46 -06004276
sfricke-samsung71f04e32022-03-16 01:21:21 -05004277 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004278 vuid = is_2 ? "VUID-VkBlitImageInfo2-aspectMask-00241" : "VUID-vkCmdBlitImage-aspectMask-00241";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004279 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004280 "%s: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004281 "image format %s.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004282 func_name, i, region.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004283 }
4284
sfricke-samsung71f04e32022-03-16 01:21:21 -05004285 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004286 vuid = is_2 ? "VUID-VkBlitImageInfo2-aspectMask-00242" : "VUID-vkCmdBlitImage-aspectMask-00242";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004287 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004288 "%s: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004289 func_name, i, region.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004290 }
4291
Dave Houlton48989f32017-05-26 15:01:46 -06004292 // Validate source image offsets
sfricke-samsung71f04e32022-03-16 01:21:21 -05004293 VkExtent3D src_extent = src_image_state->GetSubresourceExtent(region.srcSubresource);
Dave Houlton33c2d252017-06-09 17:08:32 -06004294 if (VK_IMAGE_TYPE_1D == src_type) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05004295 if ((0 != region.srcOffsets[0].y) || (1 != region.srcOffsets[1].y)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004296 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00245" : "VUID-vkCmdBlitImage-srcImage-00245";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004297 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004298 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
4299 "of (%1d, %1d). These must be (0, 1).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004300 func_name, i, region.srcOffsets[0].y, region.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004301 }
4302 }
4303
Dave Houlton33c2d252017-06-09 17:08:32 -06004304 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05004305 if ((0 != region.srcOffsets[0].z) || (1 != region.srcOffsets[1].z)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004306 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00247" : "VUID-vkCmdBlitImage-srcImage-00247";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004307 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004308 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
4309 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004310 func_name, i, region.srcOffsets[0].z, region.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004311 }
4312 }
4313
Dave Houlton33c2d252017-06-09 17:08:32 -06004314 bool oob = false;
sfricke-samsung71f04e32022-03-16 01:21:21 -05004315 if ((region.srcOffsets[0].x < 0) || (region.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
4316 (region.srcOffsets[1].x < 0) || (region.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004317 oob = true;
Tony-LunarG542ae912021-11-04 16:06:44 -06004318 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcOffset-00243" : "VUID-vkCmdBlitImage-srcOffset-00243";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004319 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004320 "%s: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004321 func_name, i, region.srcOffsets[0].x, region.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004322 }
sfricke-samsung71f04e32022-03-16 01:21:21 -05004323 if ((region.srcOffsets[0].y < 0) || (region.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
4324 (region.srcOffsets[1].y < 0) || (region.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004325 oob = true;
Tony-LunarG542ae912021-11-04 16:06:44 -06004326 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcOffset-00244" : "VUID-vkCmdBlitImage-srcOffset-00244";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004327 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004328 "%s: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004329 func_name, i, region.srcOffsets[0].y, region.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004330 }
sfricke-samsung71f04e32022-03-16 01:21:21 -05004331 if ((region.srcOffsets[0].z < 0) || (region.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
4332 (region.srcOffsets[1].z < 0) || (region.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004333 oob = true;
Tony-LunarG542ae912021-11-04 16:06:44 -06004334 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcOffset-00246" : "VUID-vkCmdBlitImage-srcOffset-00246";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004335 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004336 "%s: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004337 func_name, i, region.srcOffsets[0].z, region.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004338 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004339 if (oob) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004340 vuid = is_2 ? "VUID-VkBlitImageInfo2-pRegions-00215" : "VUID-vkCmdBlitImage-pRegions-00215";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004341 skip |= LogError(cb_node->commandBuffer(), vuid, "%s: region [%d] source image blit region exceeds image dimensions.",
Jeff Leger178b1e52020-10-05 12:22:23 -04004342 func_name, i);
Dave Houlton33c2d252017-06-09 17:08:32 -06004343 }
Dave Houlton48989f32017-05-26 15:01:46 -06004344
4345 // Validate dest image offsets
sfricke-samsung71f04e32022-03-16 01:21:21 -05004346 VkExtent3D dst_extent = dst_image_state->GetSubresourceExtent(region.dstSubresource);
Dave Houlton33c2d252017-06-09 17:08:32 -06004347 if (VK_IMAGE_TYPE_1D == dst_type) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05004348 if ((0 != region.dstOffsets[0].y) || (1 != region.dstOffsets[1].y)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004349 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-00250" : "VUID-vkCmdBlitImage-dstImage-00250";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004350 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004351 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
4352 "(%1d, %1d). These must be (0, 1).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004353 func_name, i, region.dstOffsets[0].y, region.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004354 }
4355 }
4356
Dave Houlton33c2d252017-06-09 17:08:32 -06004357 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05004358 if ((0 != region.dstOffsets[0].z) || (1 != region.dstOffsets[1].z)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004359 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-00252" : "VUID-vkCmdBlitImage-dstImage-00252";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004360 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004361 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004362 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004363 func_name, i, region.dstOffsets[0].z, region.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004364 }
4365 }
4366
Dave Houlton33c2d252017-06-09 17:08:32 -06004367 oob = false;
sfricke-samsung71f04e32022-03-16 01:21:21 -05004368 if ((region.dstOffsets[0].x < 0) || (region.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
4369 (region.dstOffsets[1].x < 0) || (region.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004370 oob = true;
Tony-LunarG542ae912021-11-04 16:06:44 -06004371 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstOffset-00248" : "VUID-vkCmdBlitImage-dstOffset-00248";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004372 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004373 "%s: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004374 func_name, i, region.dstOffsets[0].x, region.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004375 }
sfricke-samsung71f04e32022-03-16 01:21:21 -05004376 if ((region.dstOffsets[0].y < 0) || (region.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
4377 (region.dstOffsets[1].y < 0) || (region.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004378 oob = true;
Tony-LunarG542ae912021-11-04 16:06:44 -06004379 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstOffset-00249" : "VUID-vkCmdBlitImage-dstOffset-00249";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004380 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004381 "%s: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004382 func_name, i, region.dstOffsets[0].y, region.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004383 }
sfricke-samsung71f04e32022-03-16 01:21:21 -05004384 if ((region.dstOffsets[0].z < 0) || (region.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
4385 (region.dstOffsets[1].z < 0) || (region.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004386 oob = true;
Tony-LunarG542ae912021-11-04 16:06:44 -06004387 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstOffset-00251" : "VUID-vkCmdBlitImage-dstOffset-00251";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004388 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004389 "%s: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004390 func_name, i, region.dstOffsets[0].z, region.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004391 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004392 if (oob) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004393 vuid = is_2 ? "VUID-VkBlitImageInfo2-pRegions-00216" : "VUID-vkCmdBlitImage-pRegions-00216";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004394 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004395 "%s: region [%d] destination image blit region exceeds image dimensions.", func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004396 }
4397
Dave Houlton33c2d252017-06-09 17:08:32 -06004398 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05004399 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount) ||
4400 (0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004401 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00240" : "VUID-vkCmdBlitImage-srcImage-00240";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004402 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004403 "%s: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
4404 "layerCount other than 1.",
4405 func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004406 }
4407 }
aitor-lunarg607fe732022-03-31 22:00:08 +02004408
4409 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
4410 // must not overlap in memory
4411 if (srcImage == dstImage) {
4412 for (uint32_t j = 0; j < regionCount; j++) {
4413 if (RegionIntersectsBlit(&region, &pRegions[j], src_image_state->createInfo.imageType,
4414 FormatIsMultiplane(src_format))) {
4415 vuid = is_2 ? "VUID-VkBlitImageInfo2-pRegions-00217" : "VUID-vkCmdBlitImage-pRegions-00217";
4416 skip |= LogError(cb_node->commandBuffer(), vuid,
4417 "%s: pRegion[%" PRIu32 "] src overlaps with pRegions[%" PRIu32 "] dst.", func_name, i, j);
4418 }
4419 }
4420 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004421 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004422 } else {
4423 assert(0);
4424 }
4425 return skip;
4426}
4427
Jeff Leger178b1e52020-10-05 12:22:23 -04004428bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4429 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4430 const VkImageBlit *pRegions, VkFilter filter) const {
4431 return ValidateCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter,
Tony-LunarG542ae912021-11-04 16:06:44 -06004432 CMD_BLITIMAGE);
Jeff Leger178b1e52020-10-05 12:22:23 -04004433}
4434
4435bool CoreChecks::PreCallValidateCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) const {
4436 return ValidateCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4437 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
Tony-LunarG542ae912021-11-04 16:06:44 -06004438 pBlitImageInfo->filter, CMD_BLITIMAGE2KHR);
4439}
4440
4441bool CoreChecks::PreCallValidateCmdBlitImage2(VkCommandBuffer commandBuffer, const VkBlitImageInfo2 *pBlitImageInfo) const {
4442 return ValidateCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4443 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4444 pBlitImageInfo->filter, CMD_BLITIMAGE2);
Jeff Leger178b1e52020-10-05 12:22:23 -04004445}
4446
4447template <typename RegionType>
4448void CoreChecks::RecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
4449 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
4450 VkFilter filter) {
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07004451 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06004452 auto src_image_state = Get<IMAGE_STATE>(srcImage);
4453 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004454
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004455 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004456 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06004457 cb_node->SetImageInitialLayout(*src_image_state, pRegions[i].srcSubresource, srcImageLayout);
4458 cb_node->SetImageInitialLayout(*dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004459 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004460}
4461
Jeff Leger178b1e52020-10-05 12:22:23 -04004462void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4463 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4464 const VkImageBlit *pRegions, VkFilter filter) {
4465 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
4466 pRegions, filter);
4467 RecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter);
4468}
4469
4470void CoreChecks::PreCallRecordCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) {
4471 StateTracker::PreCallRecordCmdBlitImage2KHR(commandBuffer, pBlitImageInfo);
4472 RecordCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4473 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4474 pBlitImageInfo->filter);
4475}
4476
Tony-LunarG542ae912021-11-04 16:06:44 -06004477void CoreChecks::PreCallRecordCmdBlitImage2(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) {
4478 StateTracker::PreCallRecordCmdBlitImage2(commandBuffer, pBlitImageInfo);
4479 RecordCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4480 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4481 pBlitImageInfo->filter);
4482}
4483
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004484GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap &map, const IMAGE_STATE &image_state) {
John Zulauf2076e812020-01-08 14:55:54 -07004485 // This approach allows for a single hash lookup or/create new
Jeremy Gebben6335df62021-11-01 10:50:13 -06004486 auto &layout_map = map[&image_state];
John Zulauf17708d02021-02-22 11:20:58 -07004487 if (!layout_map) {
4488 layout_map.emplace(image_state.subresource_encoder.SubresourceCount());
John Zulauf2076e812020-01-08 14:55:54 -07004489 }
John Zulauf17708d02021-02-22 11:20:58 -07004490 return &layout_map;
John Zulauf2076e812020-01-08 14:55:54 -07004491}
4492
Jeremy Gebben6335df62021-11-01 10:50:13 -06004493const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, const IMAGE_STATE &image_state) {
4494 auto it = map.find(&image_state);
John Zulauf2076e812020-01-08 14:55:54 -07004495 if (it != map.end()) {
John Zulauf17708d02021-02-22 11:20:58 -07004496 return &it->second;
John Zulauf2076e812020-01-08 14:55:54 -07004497 }
4498 return nullptr;
4499}
4500
Jeremy Gebben53631302021-04-13 16:46:37 -06004501// Helper to update the Global or Overlay layout map
4502struct GlobalLayoutUpdater {
4503 bool update(VkImageLayout &dst, const image_layout_map::ImageSubresourceLayoutMap::LayoutEntry &src) const {
4504 if (src.current_layout != image_layout_map::kInvalidLayout && dst != src.current_layout) {
4505 dst = src.current_layout;
4506 return true;
4507 }
4508 return false;
4509 }
4510
4511 layer_data::optional<VkImageLayout> insert(const image_layout_map::ImageSubresourceLayoutMap::LayoutEntry &src) const {
4512 layer_data::optional<VkImageLayout> result;
4513 if (src.current_layout != image_layout_map::kInvalidLayout) {
4514 result.emplace(src.current_layout);
4515 }
4516 return result;
4517 }
4518};
4519
Shannon McPherson449fa9c2018-10-25 11:51:07 -06004520// 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 -07004521bool CoreChecks::ValidateCmdBufImageLayouts(const Location &loc, const CMD_BUFFER_STATE *pCB,
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004522 GlobalImageLayoutMap &overlayLayoutMap) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06004523 if (disabled[image_layout_validation]) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004524 bool skip = false;
John Zulauff660ad62019-03-23 07:16:05 -06004525 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07004526 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06004527 for (const auto &layout_map_entry : pCB->image_layout_map) {
Jeremy Gebben6335df62021-11-01 10:50:13 -06004528 const auto *image_state = layout_map_entry.first;
unknown089cdb82019-07-11 12:58:43 -06004529 const auto &subres_map = layout_map_entry.second;
Jeremy Gebben53631302021-04-13 16:46:37 -06004530 const auto &layout_map = subres_map->GetLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06004531 // Validate the initial_uses for each subresource referenced
Jeremy Gebben53631302021-04-13 16:46:37 -06004532 if (layout_map.empty()) continue;
John Zulauf2076e812020-01-08 14:55:54 -07004533
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004534 auto *overlay_map = GetLayoutRangeMap(overlayLayoutMap, *image_state);
Jeremy Gebben4a8881f2022-01-10 17:04:30 -07004535 const auto *global_map = image_state->layout_range_map.get();
4536 assert(global_map);
4537 auto global_map_guard = global_map->ReadLock();
John Zulauf2076e812020-01-08 14:55:54 -07004538
4539 // Note: don't know if it would matter
4540 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
4541
Jeremy Gebben53631302021-04-13 16:46:37 -06004542 auto pos = layout_map.begin();
4543 const auto end = layout_map.end();
4544 sparse_container::parallel_iterator<const GlobalImageLayoutRangeMap> current_layout(*overlay_map, *global_map,
4545 pos->first.begin);
John Zulauf2076e812020-01-08 14:55:54 -07004546 while (pos != end) {
Jeremy Gebben53631302021-04-13 16:46:37 -06004547 VkImageLayout initial_layout = pos->second.initial_layout;
4548 assert(initial_layout != image_layout_map::kInvalidLayout);
4549 if (initial_layout == image_layout_map::kInvalidLayout) {
4550 continue;
4551 }
4552
John Zulauf2076e812020-01-08 14:55:54 -07004553 VkImageLayout image_layout = kInvalidLayout;
Jeremy Gebben53631302021-04-13 16:46:37 -06004554
John Zulauf2076e812020-01-08 14:55:54 -07004555 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 -07004556 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004557 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07004558 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004559 image_layout = current_layout->pos_B->lower_bound->second;
4560 }
4561 const auto intersected_range = pos->first & current_layout->range;
4562 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
4563 // TODO: Set memory invalid which is in mem_tracker currently
4564 } else if (image_layout != initial_layout) {
Hans-Kristian Arntzen6cb03492021-07-05 16:57:31 +02004565 const auto aspect_mask = image_state->subresource_encoder.Decode(intersected_range.begin).aspectMask;
4566 bool matches = ImageLayoutMatches(aspect_mask, image_layout, initial_layout);
John Zulauf2076e812020-01-08 14:55:54 -07004567 if (!matches) {
John Zulauf2076e812020-01-08 14:55:54 -07004568 // We can report all the errors for the intersected range directly
4569 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
locke-lunarg296a3c92020-03-25 01:04:29 -06004570 const auto subresource = image_state->subresource_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004571 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004572 pCB->commandBuffer(), kVUID_Core_DrawState_InvalidImageLayout,
sfricke-samsung6b447aa2021-07-26 09:42:26 -07004573 "%s command buffer %s expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004574 "to be in layout %s--instead, current layout is %s.",
sfricke-samsung6b447aa2021-07-26 09:42:26 -07004575 loc.Message().c_str(), report_data->FormatHandle(pCB->commandBuffer()).c_str(),
Jeremy Gebben6335df62021-11-01 10:50:13 -06004576 report_data->FormatHandle(image_state->Handle()).c_str(), subresource.aspectMask, subresource.arrayLayer,
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004577 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
John Zulaufb61ed972019-04-09 16:12:35 -06004578 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004579 }
4580 }
John Zulauf2076e812020-01-08 14:55:54 -07004581 if (pos->first.includes(intersected_range.end)) {
4582 current_layout.seek(intersected_range.end);
4583 } else {
4584 ++pos;
4585 if (pos != end) {
4586 current_layout.seek(pos->first.begin);
4587 }
4588 }
John Zulauff660ad62019-03-23 07:16:05 -06004589 }
locke-lunargf155ccf2020-02-18 11:34:15 -07004590 // Update all layout set operations (which will be a subset of the initial_layouts)
Jeremy Gebben53631302021-04-13 16:46:37 -06004591 sparse_container::splice(*overlay_map, subres_map->GetLayoutMap(), GlobalLayoutUpdater());
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004592 }
John Zulauff660ad62019-03-23 07:16:05 -06004593
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004594 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004595}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07004596
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004597void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06004598 for (const auto &layout_map_entry : pCB->image_layout_map) {
Jeremy Gebben6335df62021-11-01 10:50:13 -06004599 const auto *image_state = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07004600 const auto &subres_map = layout_map_entry.second;
Jeremy Gebben4a8881f2022-01-10 17:04:30 -07004601 auto guard = image_state->layout_range_map->WriteLock();
4602 sparse_container::splice(*image_state->layout_range_map, subres_map->GetLayoutMap(), GlobalLayoutUpdater());
Tony Barbourdf013b92017-01-25 12:53:48 -07004603 }
4604}
4605
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004606// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004607// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
4608// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004609bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
4610 const VkImageLayout first_layout, const uint32_t attachment,
Mike Schuchardt2df08912020-12-15 16:28:09 -08004611 const VkAttachmentDescription2 &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004612 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004613 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
4614
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004615 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
sfricke-samsung55f01952020-03-24 08:16:41 -07004616 // for both loadOp and stencilLoaOp rp2 has it in 1 VU while rp1 has it in 2 VU with half behind Maintenance2 extension
4617 // Each is VUID is below in following order: rp2 -> rp1 with Maintenance2 -> rp1 with no extenstion
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004618 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07004619 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4620 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4621 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004622 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004623 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004624 string_VkImageLayout(first_layout));
sfricke-samsung45996a42021-09-16 13:45:27 -07004625 } else if ((use_rp2 == false) && IsExtEnabled(device_extensions.vk_khr_maintenance2) &&
sfricke-samsung55f01952020-03-24 08:16:41 -07004626 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL)) {
4627 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01566",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004628 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004629 string_VkImageLayout(first_layout));
4630 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4631 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004632 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004633 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004634 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004635 }
4636 }
sfricke-samsung55f01952020-03-24 08:16:41 -07004637
4638 // Same as above for loadOp, but for stencilLoadOp
4639 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
4640 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4641 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4642 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL))) {
4643 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02523",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004644 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004645 string_VkImageLayout(first_layout));
sfricke-samsung45996a42021-09-16 13:45:27 -07004646 } else if ((use_rp2 == false) && IsExtEnabled(device_extensions.vk_khr_maintenance2) &&
sfricke-samsung55f01952020-03-24 08:16:41 -07004647 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL)) {
4648 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01567",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004649 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004650 string_VkImageLayout(first_layout));
4651 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4652 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
4653 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-02511",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004654 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004655 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02004656 }
4657 }
4658
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004659 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004660}
4661
Mark Lobodzinski96210742017-02-09 10:33:46 -07004662// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4663// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004664template <typename T1>
4665bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
4666 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
4667 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004668 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004669 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004670 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004671 if (strict) {
4672 correct_usage = ((actual & desired) == desired);
4673 } else {
4674 correct_usage = ((actual & desired) != 0);
4675 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004676
Mark Lobodzinski96210742017-02-09 10:33:46 -07004677 if (!correct_usage) {
sfricke-samsungbb971942020-09-10 22:11:56 -07004678 // All callers should have a valid VUID
4679 assert(msgCode != kVUIDUndefined);
4680 skip =
4681 LogError(object, msgCode, "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4682 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004683 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004684 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004685}
4686
4687// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4688// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004689bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004690 char const *func_name, char const *usage_string) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004691 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image(),
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06004692 image_state->Handle(), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004693}
4694
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004695bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags2KHR desired,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004696 char const *func_name, const char *vuid) const {
Cort Stratton186b1a22018-05-01 20:18:06 -04004697 bool skip = false;
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004698 const VkFormatFeatureFlags2KHR image_format_features = image_state->format_features;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004699 if ((image_format_features & desired) != desired) {
4700 // Same error, but more details if it was an AHB external format
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06004701 if (image_state->HasAHBFormat()) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004702 skip |= LogError(image_state->image(), vuid,
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004703 "In %s, VkFormatFeatureFlags (0x%" PRIxLEAST64 ") does not support required feature %s for the external format "
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004704 "found in VkAndroidHardwareBufferFormatPropertiesANDROID::formatFeatures used by %s.",
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004705 func_name, image_format_features, string_VkFormatFeatureFlags2KHR(desired).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004706 report_data->FormatHandle(image_state->image()).c_str());
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004707 } else {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004708 skip |= LogError(image_state->image(), vuid,
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004709 "In %s, VkFormatFeatureFlags (0x%" PRIxLEAST64 ") does not support required feature %s for format %u used by %s "
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004710 "with tiling %s.",
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004711 func_name, image_format_features, string_VkFormatFeatureFlags2KHR(desired).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004712 image_state->createInfo.format, report_data->FormatHandle(image_state->image()).c_str(),
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004713 string_VkImageTiling(image_state->createInfo.tiling));
Cort Stratton186b1a22018-05-01 20:18:06 -04004714 }
4715 }
4716 return skip;
4717}
4718
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004719bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004720 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004721 bool skip = false;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004722 const VkImageAspectFlags apsect_mask = subresource_layers->aspectMask;
Cort Strattond619a302018-05-17 19:46:32 -07004723 // layerCount must not be zero
4724 if (subresource_layers->layerCount == 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004725 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-layerCount-01700",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004726 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004727 }
4728 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004729 if (apsect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004730 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-00168",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004731 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004732 }
4733 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004734 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 -06004735 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-00167",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004736 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4737 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4738 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004739 }
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004740 // aspectMask must not contain VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT
4741 if (apsect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
4742 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004743 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-02247",
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004744 "In %s, pRegions[%u].%s.aspectMask has a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit set.", func_name, i,
4745 member);
4746 }
Cort Strattond619a302018-05-17 19:46:32 -07004747 return skip;
4748}
4749
Mark Lobodzinski96210742017-02-09 10:33:46 -07004750// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4751// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004752bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004753 char const *func_name, char const *usage_string) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004754 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer(),
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06004755 buffer_state->Handle(), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004756}
4757
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004758bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004759 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004760 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004761
4762 const VkDeviceSize &range = pCreateInfo->range;
4763 if (range != VK_WHOLE_SIZE) {
4764 // Range must be greater than 0
4765 if (range <= 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004766 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00928",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004767 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004768 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4769 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004770 }
4771 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004772 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4773 if (SafeModulo(range, format_size) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004774 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00929",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004775 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004776 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4777 "(%" PRIu32 ").",
4778 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004779 }
4780 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004781 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004782 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00930",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004783 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004784 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4785 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4786 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004787 }
4788 // The sum of range and offset must be less than or equal to the size of buffer
4789 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004790 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-offset-00931",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004791 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004792 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4793 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4794 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004795 }
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004796 } else {
4797 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4798
4799 // Size of buffer - offset, divided by the element size of format must be less than or equal to
4800 // VkPhysicalDeviceLimits::maxTexelBufferElements
4801 if (SafeDivision(buffer_state->createInfo.size - pCreateInfo->offset, format_size) >
4802 device_limits->maxTexelBufferElements) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004803 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-04059",
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004804 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
4805 ") equals VK_WHOLE_SIZE, the buffer's size (%" PRIuLEAST64 ") minus the offset (%" PRIuLEAST64
4806 "), divided by the element size of the format (%" PRIu32
4807 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4808 range, buffer_state->createInfo.size, pCreateInfo->offset, format_size,
4809 device_limits->maxTexelBufferElements);
4810 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004811 }
4812 return skip;
4813}
4814
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004815bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004816 bool skip = false;
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004817 const VkFormatProperties3KHR format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004818 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004819 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_2_UNIFORM_TEXEL_BUFFER_BIT_KHR)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004820 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-00933",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004821 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004822 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format (%s) must "
4823 "be supported for uniform texel buffers",
4824 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004825 }
4826 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004827 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_2_STORAGE_TEXEL_BUFFER_BIT_KHR)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004828 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-00934",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004829 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004830 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format (%s) must "
4831 "be supported for storage texel buffers",
4832 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004833 }
4834 return skip;
4835}
4836
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004837bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004838 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004839 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004840
Dave Houltond8ed0212018-05-16 17:18:24 -06004841 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004842
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004843 auto chained_devaddr_struct = LvlFindInChain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
Jeff Bolz87697532019-01-11 22:54:00 -06004844 if (chained_devaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004845 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz87697532019-01-11 22:54:00 -06004846 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004847 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4848 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004849 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004850 }
4851 }
4852
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004853 auto chained_opaqueaddr_struct = LvlFindInChain<VkBufferOpaqueCaptureAddressCreateInfo>(pCreateInfo->pNext);
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004854 if (chained_opaqueaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004855 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004856 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004857 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
Mike Schuchardt2df08912020-12-15 16:28:09 -08004858 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfo::opaqueCaptureAddress"
4859 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004860 }
4861 }
4862
ziga-lunarg2e2be1e2021-07-18 23:09:15 +02004863 auto dedicated_allocation_buffer = LvlFindInChain<VkDedicatedAllocationBufferCreateInfoNV>(pCreateInfo->pNext);
4864 if (dedicated_allocation_buffer && dedicated_allocation_buffer->dedicatedAllocation == VK_TRUE) {
4865 if (pCreateInfo->flags &
4866 (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT)) {
4867 skip |= LogError(device, "VUID-VkBufferCreateInfo-pNext-01571",
4868 "vkCreateBuffer(): pCreateInfos->flags must not include VK_BUFFER_CREATE_SPARSE_BINDING_BIT, "
4869 "VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT, or VK_BUFFER_CREATE_SPARSE_ALIASED_BIT when "
4870 "VkDedicatedAllocationBufferCreateInfoNV is in pNext chain with dedicatedAllocation VK_TRUE.");
4871 }
4872 }
4873
Mike Schuchardt2df08912020-12-15 16:28:09 -08004874 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz33fc6722020-03-31 12:58:16 -05004875 !enabled_features.core12.bufferDeviceAddressCaptureReplay &&
sfricke-samsung828e59d2021-08-22 23:20:49 -07004876 !enabled_features.buffer_device_address_ext_features.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004877 skip |= LogError(
4878 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004879 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004880 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT set.");
Jeff Bolz87697532019-01-11 22:54:00 -06004881 }
4882
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004883 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
sfricke-samsung45996a42021-09-16 13:45:27 -07004884 const char *vuid = IsExtEnabled(device_extensions.vk_khr_get_physical_device_properties2)
4885 ? "VUID-VkBufferCreateInfo-sharingMode-01419"
4886 : "VUID-VkBufferCreateInfo-sharingMode-01391";
Mark Lobodzinski314b9162020-07-16 15:33:08 -06004887 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
ziga-lunarga0b4f8a2021-07-28 13:23:02 +02004888 "vkCreateBuffer", "pCreateInfo->pQueueFamilyIndices", vuid);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004889 }
4890
sfricke-samsungedce77a2020-07-03 22:35:13 -07004891 if ((pCreateInfo->flags & VK_BUFFER_CREATE_PROTECTED_BIT) != 0) {
4892 if (enabled_features.core11.protectedMemory == VK_FALSE) {
4893 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-01887",
4894 "vkCreateBuffer(): the protectedMemory device feature is disabled: Buffers cannot be created with the "
4895 "VK_BUFFER_CREATE_PROTECTED_BIT set.");
4896 }
4897 const VkBufferCreateFlags invalid_flags =
4898 VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT;
4899 if ((pCreateInfo->flags & invalid_flags) != 0) {
4900 skip |= LogError(device, "VUID-VkBufferCreateInfo-None-01888",
4901 "vkCreateBuffer(): VK_BUFFER_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at "
4902 "same time (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | "
4903 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT).");
4904 }
4905 }
4906
ziga-lunargfe74b8d2022-04-18 17:37:46 +02004907 if ((pCreateInfo->usage & (VK_BUFFER_USAGE_VIDEO_DECODE_SRC_BIT_KHR | VK_BUFFER_USAGE_VIDEO_DECODE_DST_BIT_KHR)) > 0) {
4908 bool has_decode_codec_operation = false;
Mike Schuchardt0e558a52022-08-18 15:14:51 -07004909 const auto* video_profiles = LvlFindInChain<VkVideoProfileListInfoKHR>(pCreateInfo->pNext);
ziga-lunargfe74b8d2022-04-18 17:37:46 +02004910 if (video_profiles) {
4911 for (uint32_t i = 0; i < video_profiles->profileCount; ++i) {
4912 if (video_profiles->pProfiles[i].videoCodecOperation &
4913 (VK_VIDEO_CODEC_OPERATION_DECODE_H264_BIT_EXT | VK_VIDEO_CODEC_OPERATION_DECODE_H265_BIT_EXT)) {
4914 has_decode_codec_operation = true;
4915 break;
4916 }
4917 }
4918 }
4919 if (!has_decode_codec_operation) {
4920 skip |= LogError(device, "VUID-VkBufferCreateInfo-usage-04813",
Mike Schuchardt0e558a52022-08-18 15:14:51 -07004921 "vkCreateBuffer(): pCreateInfo->usage is %s, but pNext chain does not include VkVideoProfileListInfoKHR with "
ziga-lunargfe74b8d2022-04-18 17:37:46 +02004922 "a decode codec-operation.",
4923 string_VkBufferUsageFlags(pCreateInfo->usage).c_str());
4924 }
4925 }
4926 if ((pCreateInfo->usage & (VK_BUFFER_USAGE_VIDEO_ENCODE_SRC_BIT_KHR | VK_BUFFER_USAGE_VIDEO_ENCODE_DST_BIT_KHR)) > 0) {
4927 bool has_encode_codec_operation = false;
Mike Schuchardt0e558a52022-08-18 15:14:51 -07004928 const auto *video_profiles = LvlFindInChain<VkVideoProfileListInfoKHR>(pCreateInfo->pNext);
ziga-lunargfe74b8d2022-04-18 17:37:46 +02004929 if (video_profiles) {
4930 for (uint32_t i = 0; i < video_profiles->profileCount; ++i) {
4931 if (video_profiles->pProfiles[i].videoCodecOperation &
4932 (VK_VIDEO_CODEC_OPERATION_ENCODE_H264_BIT_EXT | VK_VIDEO_CODEC_OPERATION_ENCODE_H265_BIT_EXT)) {
4933 has_encode_codec_operation = true;
4934 break;
4935 }
4936 }
4937 }
4938 if (!has_encode_codec_operation) {
4939 skip |= LogError(device, "VUID-VkBufferCreateInfo-usage-04814",
Mike Schuchardt0e558a52022-08-18 15:14:51 -07004940 "vkCreateBuffer(): pCreateInfo->usage is %s, but pNext chain does not include VkVideoProfileListInfoKHR with "
ziga-lunargfe74b8d2022-04-18 17:37:46 +02004941 "an encode codec-operation.",
4942 string_VkBufferUsageFlags(pCreateInfo->usage).c_str());
4943 }
4944 }
4945
Mark Lobodzinski96210742017-02-09 10:33:46 -07004946 return skip;
4947}
4948
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004949bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004950 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004951 bool skip = false;
Jeremy Gebbenf4449392022-01-28 10:09:10 -07004952 auto buffer_state = Get<BUFFER_STATE>(pCreateInfo->buffer);
sfricke-samsung2e827212021-09-28 07:52:08 -07004953
4954 if (FormatIsDepthOrStencil(pCreateInfo->format)) {
4955 // Should never hopefully get here, but there are known driver advertising the wrong feature flags
4956 // see https://gitlab.khronos.org/vulkan/vulkan/-/merge_requests/4849
4957 skip |= LogError(device, kVUID_Core_invalidDepthStencilFormat,
4958 "vkCreateBufferView(): format is a depth/stencil format (%s) but depth/stencil formats do not have a "
4959 "defined sizes for alignment, replace with a color format.",
4960 string_VkFormat(pCreateInfo->format));
4961 }
4962
Mark Lobodzinski96210742017-02-09 10:33:46 -07004963 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4964 if (buffer_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06004965 skip |=
4966 ValidateMemoryIsBoundToBuffer(buffer_state.get(), "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004967 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4968 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Jeremy Gebben9f537102021-10-05 16:37:12 -06004969 skip |= ValidateBufferUsageFlags(buffer_state.get(),
Dave Houltond8ed0212018-05-16 17:18:24 -06004970 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4971 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4972 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004973
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004974 // Buffer view offset must be less than the size of buffer
4975 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004976 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-offset-00925",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004977 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004978 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4979 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004980 }
4981
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004982 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004983 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4984 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4985 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
sfricke-samsung45996a42021-09-16 13:45:27 -07004986 const char *vuid = IsExtEnabled(device_extensions.vk_ext_texel_buffer_alignment)
4987 ? "VUID-VkBufferViewCreateInfo-offset-02749"
4988 : "VUID-VkBufferViewCreateInfo-offset-00926";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004989 skip |= LogError(buffer_state->buffer(), vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004990 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004991 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4992 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004993 }
4994
4995 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004996 VkDeviceSize element_size = FormatElementSize(pCreateInfo->format);
4997 if ((element_size % 3) == 0) {
4998 element_size /= 3;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004999 }
5000 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005001 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05005002 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
5003 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005004 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05005005 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005006 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005007 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005008 buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-02750",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07005009 "vkCreateBufferView(): If buffer was created with usage containing "
5010 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05005011 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
5012 ") must be a multiple of the lesser of "
5013 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
5014 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
5015 "(%" PRId32
5016 ") is VK_TRUE, the size of a texel of the requested format. "
5017 "If the size of a texel is a multiple of three bytes, then the size of a "
5018 "single component of format is used instead",
5019 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
5020 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
5021 }
5022 }
5023 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005024 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05005025 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
5026 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005027 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05005028 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005029 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005030 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005031 buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-02751",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07005032 "vkCreateBufferView(): If buffer was created with usage containing "
5033 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05005034 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
5035 ") must be a multiple of the lesser of "
5036 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
5037 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
5038 "(%" PRId32
5039 ") is VK_TRUE, the size of a texel of the requested format. "
5040 "If the size of a texel is a multiple of three bytes, then the size of a "
5041 "single component of format is used instead",
5042 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
5043 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
5044 }
5045 }
5046 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06005047
Jeremy Gebben9f537102021-10-05 16:37:12 -06005048 skip |= ValidateBufferViewRange(buffer_state.get(), pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06005049
Jeremy Gebben9f537102021-10-05 16:37:12 -06005050 skip |= ValidateBufferViewBuffer(buffer_state.get(), pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07005051 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07005052 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07005053}
5054
Mark Lobodzinski602de982017-02-09 11:01:33 -07005055// For the given format verify that the aspect masks make sense
Aitor Camachoeb35fed2022-06-07 14:07:42 +02005056bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, bool is_image_disjoint,
5057 const char *func_name, const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005058 bool skip = false;
sfricke-samsung79b00482020-04-01 21:15:50 -07005059 // checks color format and (single-plane or non-disjoint)
5060 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
Aitor Camachoeb35fed2022-06-07 14:07:42 +02005061 if ((FormatIsColor(format)) && ((FormatIsMultiplane(format) == false) || (is_image_disjoint == false))) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005062 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08005063 skip |= LogError(
5064 image, vuid,
5065 "%s: Using format (%s) with aspect flags (%s) but color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.",
5066 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005067 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08005068 skip |= LogError(image, vuid,
5069 "%s: Using format (%s) with aspect flags (%s) but color image formats must have ONLY the "
5070 "VK_IMAGE_ASPECT_COLOR_BIT set.",
5071 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005072 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06005073 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005074 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005075 skip |= LogError(image, vuid,
sfricke-samsung7687a482021-01-29 23:19:22 -08005076 "%s: Using format (%s) with aspect flags (%s) but depth/stencil image formats must have at least one "
5077 "of VK_IMAGE_ASPECT_DEPTH_BIT and VK_IMAGE_ASPECT_STENCIL_BIT set.",
5078 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005079 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005080 skip |= LogError(image, vuid,
sfricke-samsung7687a482021-01-29 23:19:22 -08005081 "%s: Using format (%s) with aspect flags (%s) but combination depth/stencil image formats can have "
5082 "only the VK_IMAGE_ASPECT_DEPTH_BIT and VK_IMAGE_ASPECT_STENCIL_BIT set.",
5083 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005084 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06005085 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005086 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08005087 skip |= LogError(image, vuid,
5088 "%s: Using format (%s) with aspect flags (%s) but depth-only image formats must have the "
5089 "VK_IMAGE_ASPECT_DEPTH_BIT set.",
5090 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005091 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08005092 skip |= LogError(image, vuid,
5093 "%s: Using format (%s) with aspect flags (%s) but depth-only image formats can have only the "
5094 "VK_IMAGE_ASPECT_DEPTH_BIT set.",
5095 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005096 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06005097 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005098 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08005099 skip |= LogError(image, vuid,
5100 "%s: Using format (%s) with aspect flags (%s) but stencil-only image formats must have the "
5101 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
5102 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005103 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08005104 skip |= LogError(image, vuid,
5105 "%s: Using format (%s) with aspect flags (%s) but stencil-only image formats can have only the "
5106 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
5107 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005108 }
Dave Houlton501b15b2018-03-30 15:07:41 -06005109 } else if (FormatIsMultiplane(format)) {
5110 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
5111 if (3 == FormatPlaneCount(format)) {
5112 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
5113 }
5114 if ((aspect_mask & valid_flags) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08005115 skip |= LogError(image, vuid,
5116 "%s: Using format (%s) with aspect flags (%s) but multi-plane image formats may have only "
5117 "VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs set, where n = [0, 1, 2].",
5118 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Dave Houlton501b15b2018-03-30 15:07:41 -06005119 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005120 }
5121 return skip;
5122}
5123
ziga-lunarg69aa72f2022-03-29 15:24:35 +02005124bool CoreChecks::ValidateImageAcquired(IMAGE_STATE const &image_state, const char *func_name) const {
ziga-lunarg04e94b32021-10-03 01:42:37 +02005125 bool skip = false;
5126
ziga-lunarg04e94b32021-10-03 01:42:37 +02005127 return skip;
5128}
5129
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005130bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
5131 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005132 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
Jeremy Gebben5573a8c2021-06-04 08:55:10 -06005133 const SubresourceRangeErrorCodes &errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005134 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02005135
5136 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02005137 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005138 skip |= LogError(image, errorCodes.base_mip_err,
5139 "%s: %s.baseMipLevel (= %" PRIu32
5140 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
5141 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02005142 }
Petr Kraus4d718682017-05-18 03:38:41 +02005143
Petr Krausffa94af2017-08-08 21:46:02 +02005144 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
5145 if (subresourceRange.levelCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07005146 skip |=
5147 LogError(image, "VUID-VkImageSubresourceRange-levelCount-01720", "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02005148 } else {
5149 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02005150
Petr Krausffa94af2017-08-08 21:46:02 +02005151 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005152 skip |= LogError(image, errorCodes.mip_count_err,
5153 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
5154 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
5155 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
5156 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02005157 }
Petr Kraus4d718682017-05-18 03:38:41 +02005158 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005159 }
Petr Kraus4d718682017-05-18 03:38:41 +02005160
5161 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02005162 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005163 skip |= LogError(image, errorCodes.base_layer_err,
5164 "%s: %s.baseArrayLayer (= %" PRIu32
5165 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
5166 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02005167 }
Petr Kraus4d718682017-05-18 03:38:41 +02005168
Petr Krausffa94af2017-08-08 21:46:02 +02005169 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
5170 if (subresourceRange.layerCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07005171 skip |=
5172 LogError(image, "VUID-VkImageSubresourceRange-layerCount-01721", "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02005173 } else {
5174 const uint64_t necessary_layer_count =
5175 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02005176
Petr Krausffa94af2017-08-08 21:46:02 +02005177 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005178 skip |= LogError(image, errorCodes.layer_count_err,
5179 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
5180 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
5181 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
5182 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02005183 }
Petr Kraus4d718682017-05-18 03:38:41 +02005184 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005185 }
Petr Kraus4d718682017-05-18 03:38:41 +02005186
ziga-lunargb4e90752021-08-02 13:58:29 +02005187 if (subresourceRange.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
5188 if (subresourceRange.aspectMask &
5189 (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT)) {
5190 skip |= LogError(image, "VUID-VkImageSubresourceRange-aspectMask-01670",
5191 "%s: aspectMask includes both VK_IMAGE_ASPECT_COLOR_BIT and one of VK_IMAGE_ASPECT_PLANE_0_BIT, "
5192 "VK_IMAGE_ASPECT_PLANE_1_BIT, or VK_IMAGE_ASPECT_PLANE_2_BIT.",
5193 cmd_name);
5194 }
5195 }
5196
Mark Lobodzinski602de982017-02-09 11:01:33 -07005197 return skip;
5198}
5199
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005200bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005201 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07005202 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Tony-LunarGbe956362022-04-05 13:34:31 -06005203 bool is_2d_compatible = (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT) ? true : false;
5204 if (device_extensions.vk_ext_image_2d_view_of_3d)
5205 is_2d_compatible |= (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_VIEW_COMPATIBLE_BIT_EXT) ? true : false;
5206 bool is_image_slicable =
5207 (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) && is_2d_compatible;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005208 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 +02005209
David McFarland2853f2f2020-11-30 15:50:39 -04005210 uint32_t image_layer_count;
5211
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005212 if (is_3_d_to_2_d_map) {
David McFarland2853f2f2020-11-30 15:50:39 -04005213 const auto layers = LayersFromRange(subresourceRange);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06005214 const auto extent = image_state->GetSubresourceExtent(layers);
David McFarland2853f2f2020-11-30 15:50:39 -04005215 image_layer_count = extent.depth;
5216 } else {
5217 image_layer_count = image_state->createInfo.arrayLayers;
5218 }
5219
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005220 const auto image_layer_count_var_name = is_3_d_to_2_d_map ? "extent.depth" : "arrayLayers";
Petr Krausffa94af2017-08-08 21:46:02 +02005221
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005222 SubresourceRangeErrorCodes subresource_range_error_codes = {};
5223 subresource_range_error_codes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
5224 subresource_range_error_codes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
5225 subresource_range_error_codes.base_layer_err =
5226 is_khr_maintenance1
Tony-LunarGbe956362022-04-05 13:34:31 -06005227 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-image-02724"
5228 : (device_extensions.vk_ext_image_2d_view_of_3d ? "VUID-VkImageViewCreateInfo-image-06724"
5229 : "VUID-VkImageViewCreateInfo-image-01482"))
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005230 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
Tony-LunarGbe956362022-04-05 13:34:31 -06005231 subresource_range_error_codes.layer_count_err =
5232 is_khr_maintenance1
5233 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
5234 : (device_extensions.vk_ext_image_2d_view_of_3d ? "VUID-VkImageViewCreateInfo-subresourceRange-06725"
5235 : "VUID-VkImageViewCreateInfo-subresourceRange-01483"))
5236 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02005237
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005238 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02005239 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005240 image_state->image(), subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02005241}
5242
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005243bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06005244 const VkImageSubresourceRange &subresourceRange,
5245 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005246 SubresourceRangeErrorCodes subresource_range_error_codes = {};
5247 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
5248 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
5249 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
5250 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02005251
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005252 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005253 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image(),
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005254 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02005255}
5256
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005257bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06005258 const VkImageSubresourceRange &subresourceRange,
5259 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005260 SubresourceRangeErrorCodes subresource_range_error_codes = {};
5261 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
5262 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
5263 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
5264 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02005265
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005266 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005267 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image(),
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005268 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02005269}
5270
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005271bool CoreChecks::ValidateImageBarrierSubresourceRange(const Location &loc, const IMAGE_STATE *image_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005272 const VkImageSubresourceRange &subresourceRange) const {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005273 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005274 loc.StringFunc().c_str(), loc.StringField().c_str(), "arrayLayers", image_state->image(),
Jeremy Gebbenbb845612021-02-18 18:16:05 -07005275 sync_vuid_maps::GetSubResourceVUIDs(loc));
Petr Krausffa94af2017-08-08 21:46:02 +02005276}
5277
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005278namespace barrier_queue_families {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005279using sync_vuid_maps::GetBarrierQueueVUID;
5280using sync_vuid_maps::kQueueErrorSummary;
5281using sync_vuid_maps::QueueError;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005282
5283class ValidatorState {
5284 public:
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005285 ValidatorState(const ValidationStateTracker *device_data, LogObjectList &&obj, const core_error::Location &location,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005286 const VulkanTypedHandle &barrier_handle, const VkSharingMode sharing_mode)
5287 : device_data_(device_data),
John Zulaufbea70432021-02-23 07:03:12 -07005288 objects_(std::move(obj)),
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005289 loc_(location),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005290 barrier_handle_(barrier_handle),
5291 sharing_mode_(sharing_mode),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005292 limit_(static_cast<uint32_t>(device_data->physical_device_state->queue_family_properties.size())),
5293 mem_ext_(IsExtEnabled(device_data->device_extensions.vk_khr_external_memory)) {}
5294
5295 // Log the messages using boilerplate from object state, and Vu specific information from the template arg
5296 // 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 -07005297 bool LogMsg(QueueError vu_index, uint32_t family, const char *param_name) const {
5298 const std::string val_code = GetBarrierQueueVUID(loc_, vu_index);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005299 const char *annotation = GetFamilyAnnotation(family);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005300 return device_data_->LogError(objects_, val_code, "%s Barrier using %s %s created with sharingMode %s, has %s %u%s. %s",
5301 loc_.Message().c_str(), GetTypeString(),
5302 device_data_->report_data->FormatHandle(barrier_handle_).c_str(), GetModeString(), param_name,
5303 family, annotation, kQueueErrorSummary.at(vu_index).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005304 }
5305
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005306 bool LogMsg(QueueError vu_index, uint32_t src_family, uint32_t dst_family) const {
5307 const std::string val_code = GetBarrierQueueVUID(loc_, vu_index);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005308 const char *src_annotation = GetFamilyAnnotation(src_family);
5309 const char *dst_annotation = GetFamilyAnnotation(dst_family);
5310 return device_data_->LogError(
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005311 objects_, val_code,
5312 "%s Barrier using %s %s created with sharingMode %s, has srcQueueFamilyIndex %u%s and dstQueueFamilyIndex %u%s. %s",
5313 loc_.Message().c_str(), GetTypeString(), device_data_->report_data->FormatHandle(barrier_handle_).c_str(),
5314 GetModeString(), src_family, src_annotation, dst_family, dst_annotation, kQueueErrorSummary.at(vu_index).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005315 }
5316
5317 // This abstract Vu can only be tested at submit time, thus we need a callback from the closure containing the needed
5318 // data. Note that the mem_barrier is copied to the closure as the lambda lifespan exceed the guarantees of validity for
5319 // application input.
5320 static bool ValidateAtQueueSubmit(const QUEUE_STATE *queue_state, const ValidationStateTracker *device_data,
5321 uint32_t src_family, uint32_t dst_family, const ValidatorState &val) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005322 auto error_code = QueueError::kSubmitQueueMustMatchSrcOrDst;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005323 uint32_t queue_family = queue_state->queueFamilyIndex;
5324 if ((src_family != queue_family) && (dst_family != queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005325 const std::string val_code = GetBarrierQueueVUID(val.loc_, error_code);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005326 const char *src_annotation = val.GetFamilyAnnotation(src_family);
5327 const char *dst_annotation = val.GetFamilyAnnotation(dst_family);
5328 return device_data->LogError(
Jeremy Gebben63f3cb02021-09-07 15:16:32 -06005329 queue_state->Handle(), val_code,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005330 "%s Barrier submitted to queue with family index %u, using %s %s created with sharingMode %s, has "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005331 "srcQueueFamilyIndex %u%s and dstQueueFamilyIndex %u%s. %s",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005332 val.loc_.Message().c_str(), queue_family, val.GetTypeString(),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005333 device_data->report_data->FormatHandle(val.barrier_handle_).c_str(), val.GetModeString(), src_family,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005334 src_annotation, dst_family, dst_annotation, kQueueErrorSummary.at(error_code).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005335 }
5336 return false;
5337 }
5338 // Logical helpers for semantic clarity
5339 inline bool KhrExternalMem() const { return mem_ext_; }
5340 inline bool IsValid(uint32_t queue_family) const { return (queue_family < limit_); }
5341 inline bool IsValidOrSpecial(uint32_t queue_family) const {
5342 return IsValid(queue_family) || (mem_ext_ && QueueFamilyIsExternal(queue_family));
5343 }
5344
5345 // Helpers for LogMsg
5346 const char *GetModeString() const { return string_VkSharingMode(sharing_mode_); }
5347
5348 // Descriptive text for the various types of queue family index
5349 const char *GetFamilyAnnotation(uint32_t family) const {
5350 const char *external = " (VK_QUEUE_FAMILY_EXTERNAL)";
5351 const char *foreign = " (VK_QUEUE_FAMILY_FOREIGN_EXT)";
5352 const char *ignored = " (VK_QUEUE_FAMILY_IGNORED)";
5353 const char *valid = " (VALID)";
5354 const char *invalid = " (INVALID)";
5355 switch (family) {
5356 case VK_QUEUE_FAMILY_EXTERNAL:
5357 return external;
5358 case VK_QUEUE_FAMILY_FOREIGN_EXT:
5359 return foreign;
5360 case VK_QUEUE_FAMILY_IGNORED:
5361 return ignored;
5362 default:
5363 if (IsValid(family)) {
5364 return valid;
5365 }
5366 return invalid;
5367 };
5368 }
5369 const char *GetTypeString() const { return object_string[barrier_handle_.type]; }
5370 VkSharingMode GetSharingMode() const { return sharing_mode_; }
5371
5372 protected:
5373 const ValidationStateTracker *device_data_;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005374 const LogObjectList objects_;
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005375 const core_error::Location loc_;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005376 const VulkanTypedHandle barrier_handle_;
5377 const VkSharingMode sharing_mode_;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005378 const uint32_t limit_;
5379 const bool mem_ext_;
5380};
5381
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005382bool Validate(const CoreChecks *device_data, const CMD_BUFFER_STATE *cb_state, const ValidatorState &val,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005383 const uint32_t src_queue_family, const uint32_t dst_queue_family) {
5384 bool skip = false;
5385
5386 const bool mode_concurrent = val.GetSharingMode() == VK_SHARING_MODE_CONCURRENT;
5387 const bool src_ignored = QueueFamilyIsIgnored(src_queue_family);
5388 const bool dst_ignored = QueueFamilyIsIgnored(dst_queue_family);
5389 if (val.KhrExternalMem()) {
5390 if (mode_concurrent) {
Tony-LunarG273f32f2021-09-28 08:56:30 -06005391 bool sync2 = device_data->enabled_features.core13.synchronization2 != 0;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005392 // this requirement is removed by VK_KHR_synchronization2
5393 if (!(src_ignored || dst_ignored) && !sync2) {
5394 skip |= val.LogMsg(QueueError::kSrcOrDstMustBeIgnore, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005395 }
5396 if ((src_ignored && !(dst_ignored || QueueFamilyIsExternal(dst_queue_family))) ||
5397 (dst_ignored && !(src_ignored || QueueFamilyIsExternal(src_queue_family)))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005398 skip |= val.LogMsg(QueueError::kSpecialOrIgnoreOnly, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005399 }
5400 } else {
5401 // VK_SHARING_MODE_EXCLUSIVE
5402 if (src_queue_family != dst_queue_family) {
5403 if (!val.IsValidOrSpecial(dst_queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005404 skip |= val.LogMsg(QueueError::kSrcAndDstValidOrSpecial, dst_queue_family, "dstQueueFamilyIndex");
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005405 }
5406 if (!val.IsValidOrSpecial(src_queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005407 skip |= val.LogMsg(QueueError::kSrcAndDstValidOrSpecial, src_queue_family, "srcQueueFamilyIndex");
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005408 }
5409 }
5410 }
5411 } else {
5412 // No memory extension
5413 if (mode_concurrent) {
Tony-LunarG273f32f2021-09-28 08:56:30 -06005414 bool sync2 = device_data->enabled_features.core13.synchronization2 != 0;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005415 // this requirement is removed by VK_KHR_synchronization2
5416 if ((!src_ignored || !dst_ignored) && !sync2) {
5417 skip |= val.LogMsg(QueueError::kSrcAndDestMustBeIgnore, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005418 }
5419 } else {
5420 // VK_SHARING_MODE_EXCLUSIVE
5421 if ((src_queue_family != dst_queue_family) && !(val.IsValid(src_queue_family) && val.IsValid(dst_queue_family))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005422 skip |= val.LogMsg(QueueError::kSrcAndDstBothValid, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005423 }
5424 }
5425 }
5426 return skip;
5427}
5428} // namespace barrier_queue_families
5429
Jeremy Gebbene5361dd2021-11-18 14:23:56 -07005430bool CoreChecks::ValidateConcurrentBarrierAtSubmit(const Location &loc, const ValidationStateTracker &state_data,
5431 const QUEUE_STATE &queue_state, const CMD_BUFFER_STATE &cb_state,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005432 const VulkanTypedHandle &typed_handle, uint32_t src_queue_family,
5433 uint32_t dst_queue_family) {
5434 using barrier_queue_families::ValidatorState;
Jeremy Gebbene5361dd2021-11-18 14:23:56 -07005435 ValidatorState val(&state_data, LogObjectList(cb_state.Handle()), loc, typed_handle, VK_SHARING_MODE_CONCURRENT);
5436 return ValidatorState::ValidateAtQueueSubmit(&queue_state, &state_data, src_queue_family, dst_queue_family, val);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005437}
5438
5439// Type specific wrapper for image barriers
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005440template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005441bool CoreChecks::ValidateBarrierQueueFamilies(const Location &loc, const CMD_BUFFER_STATE *cb_state, const ImgBarrier &barrier,
5442 const IMAGE_STATE *state_data) const {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005443 // State data is required
5444 if (!state_data) {
5445 return false;
5446 }
5447
5448 // Create the validator state from the image state
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005449 barrier_queue_families::ValidatorState val(this, LogObjectList(cb_state->commandBuffer()), loc,
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06005450 state_data->Handle(), state_data->createInfo.sharingMode);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005451 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
5452 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005453 return barrier_queue_families::Validate(this, cb_state, val, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005454}
5455
5456// Type specific wrapper for buffer barriers
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005457template <typename BufBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005458bool CoreChecks::ValidateBarrierQueueFamilies(const Location &loc, const CMD_BUFFER_STATE *cb_state, const BufBarrier &barrier,
5459 const BUFFER_STATE *state_data) const {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005460 // State data is required
5461 if (!state_data) {
5462 return false;
5463 }
5464
5465 // Create the validator state from the buffer state
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005466 barrier_queue_families::ValidatorState val(this, LogObjectList(cb_state->commandBuffer()), loc,
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06005467 state_data->Handle(), state_data->createInfo.sharingMode);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005468 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
5469 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005470 return barrier_queue_families::Validate(this, cb_state, val, src_queue_family, dst_queue_family);
5471}
5472
5473template <typename Barrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005474bool CoreChecks::ValidateBufferBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005475 const Barrier &mem_barrier) const {
5476 using sync_vuid_maps::BufferError;
5477 using sync_vuid_maps::GetBufferBarrierVUID;
5478
5479 bool skip = false;
5480
5481 skip |= ValidateQFOTransferBarrierUniqueness(loc, cb_state, mem_barrier, cb_state->qfo_transfer_buffer_barriers);
5482
5483 // Validate buffer barrier queue family indices
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06005484 auto buffer_state = Get<BUFFER_STATE>(mem_barrier.buffer);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005485 if (buffer_state) {
5486 auto buf_loc = loc.dot(Field::buffer);
5487 const auto &mem_vuid = GetBufferBarrierVUID(buf_loc, BufferError::kNoMemory);
Jeremy Gebben9f537102021-10-05 16:37:12 -06005488 skip |= ValidateMemoryIsBoundToBuffer(buffer_state.get(), loc.StringFunc().c_str(), mem_vuid.c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005489
Jeremy Gebben9f537102021-10-05 16:37:12 -06005490 skip |= ValidateBarrierQueueFamilies(buf_loc, cb_state, mem_barrier, buffer_state.get());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005491
5492 auto buffer_size = buffer_state->createInfo.size;
5493 if (mem_barrier.offset >= buffer_size) {
5494 auto offset_loc = loc.dot(Field::offset);
5495 const auto &vuid = GetBufferBarrierVUID(offset_loc, BufferError::kOffsetTooBig);
5496
5497 skip |= LogError(objects, vuid, "%s %s has offset 0x%" PRIx64 " which is not less than total size 0x%" PRIx64 ".",
5498 offset_loc.Message().c_str(), report_data->FormatHandle(mem_barrier.buffer).c_str(),
5499 HandleToUint64(mem_barrier.offset), HandleToUint64(buffer_size));
5500 } else if (mem_barrier.size != VK_WHOLE_SIZE && (mem_barrier.offset + mem_barrier.size > buffer_size)) {
5501 auto size_loc = loc.dot(Field::size);
5502 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kSizeOutOfRange);
5503 skip |= LogError(objects, vuid,
5504 "%s %s has offset 0x%" PRIx64 " and size 0x%" PRIx64 " whose sum is greater than total size 0x%" PRIx64
5505 ".",
5506 size_loc.Message().c_str(), report_data->FormatHandle(mem_barrier.buffer).c_str(),
5507 HandleToUint64(mem_barrier.offset), HandleToUint64(mem_barrier.size), HandleToUint64(buffer_size));
5508 }
5509 if (mem_barrier.size == 0) {
5510 auto size_loc = loc.dot(Field::size);
5511 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kSizeZero);
5512 skip |= LogError(objects, vuid, "%s %s has a size of 0.", loc.Message().c_str(),
5513 report_data->FormatHandle(mem_barrier.buffer).c_str());
5514 }
5515 }
ziga-lunarg8e2506c2022-04-18 20:06:00 +02005516
5517 if (mem_barrier.srcQueueFamilyIndex == VK_QUEUE_FAMILY_EXTERNAL &&
5518 mem_barrier.dstQueueFamilyIndex == VK_QUEUE_FAMILY_EXTERNAL) {
5519 auto size_loc = loc.dot(Field::srcQueueFamilyIndex);
5520 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kQueueFamilyExternal);
5521 skip |= LogError(objects, vuid, "Both srcQueueFamilyIndex and dstQueueFamilyIndex are VK_QUEUE_FAMILY_EXTERNAL.");
5522 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005523 return skip;
5524}
5525
5526template <typename Barrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005527bool CoreChecks::ValidateImageBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005528 const Barrier &mem_barrier) const {
5529 bool skip = false;
5530
5531 skip |= ValidateQFOTransferBarrierUniqueness(loc, cb_state, mem_barrier, cb_state->qfo_transfer_image_barriers);
5532
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005533 bool is_ilt = true;
Tony-LunarG273f32f2021-09-28 08:56:30 -06005534 if (enabled_features.core13.synchronization2) {
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005535 is_ilt = mem_barrier.oldLayout != mem_barrier.newLayout;
5536 }
5537
5538 if (is_ilt) {
5539 if (mem_barrier.newLayout == VK_IMAGE_LAYOUT_UNDEFINED || mem_barrier.newLayout == VK_IMAGE_LAYOUT_PREINITIALIZED) {
5540 auto layout_loc = loc.dot(Field::newLayout);
5541 const auto &vuid = sync_vuid_maps::GetImageBarrierVUID(loc, sync_vuid_maps::ImageError::kBadLayout);
5542 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005543 LogError(cb_state->commandBuffer(), vuid, "%s Image Layout cannot be transitioned to UNDEFINED or PREINITIALIZED.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005544 layout_loc.Message().c_str());
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005545 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005546 }
5547
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06005548 auto image_data = Get<IMAGE_STATE>(mem_barrier.image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005549 if (image_data) {
5550 auto image_loc = loc.dot(Field::image);
5551
Jeremy Gebben9f537102021-10-05 16:37:12 -06005552 skip |= ValidateMemoryIsBoundToImage(image_data.get(), loc);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005553
Jeremy Gebben9f537102021-10-05 16:37:12 -06005554 skip |= ValidateBarrierQueueFamilies(image_loc, cb_state, mem_barrier, image_data.get());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005555
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005556 skip |= ValidateImageAspectMask(image_data->image(), image_data->createInfo.format, mem_barrier.subresourceRange.aspectMask,
Aitor Camachoeb35fed2022-06-07 14:07:42 +02005557 image_data->disjoint, loc.StringFunc().c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005558
Jeremy Gebben9f537102021-10-05 16:37:12 -06005559 skip |=
5560 ValidateImageBarrierSubresourceRange(loc.dot(Field::subresourceRange), image_data.get(), mem_barrier.subresourceRange);
ziga-lunarg69aa72f2022-03-29 15:24:35 +02005561 skip |= ValidateImageAcquired(*image_data, loc.StringFunc().c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005562 }
5563 return skip;
5564}
5565
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005566bool CoreChecks::ValidateBarriers(const Location &outer_loc, const CMD_BUFFER_STATE *cb_state, VkPipelineStageFlags src_stage_mask,
5567 VkPipelineStageFlags dst_stage_mask, uint32_t memBarrierCount,
5568 const VkMemoryBarrier *pMemBarriers, uint32_t bufferBarrierCount,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005569 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
5570 const VkImageMemoryBarrier *pImageMemBarriers) const {
5571 bool skip = false;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005572 LogObjectList objects(cb_state->commandBuffer());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005573
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005574 for (uint32_t i = 0; i < memBarrierCount; ++i) {
5575 const auto &mem_barrier = pMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005576 auto loc = outer_loc.dot(Struct::VkMemoryBarrier, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005577 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005578 }
5579 for (uint32_t i = 0; i < imageMemBarrierCount; ++i) {
5580 const auto &mem_barrier = pImageMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005581 auto loc = outer_loc.dot(Struct::VkImageMemoryBarrier, Field::pImageMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005582 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005583 skip |= ValidateImageBarrier(objects, loc, cb_state, mem_barrier);
5584 }
5585 {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005586 Location loc(outer_loc.function, Struct::VkImageMemoryBarrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005587 skip |= ValidateBarriersToImages(loc, cb_state, imageMemBarrierCount, pImageMemBarriers);
5588 }
5589 for (uint32_t i = 0; i < bufferBarrierCount; ++i) {
5590 const auto &mem_barrier = pBufferMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005591 auto loc = outer_loc.dot(Struct::VkBufferMemoryBarrier, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005592 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005593 skip |= ValidateBufferBarrier(objects, loc, cb_state, mem_barrier);
5594 }
5595 return skip;
5596}
5597
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005598bool CoreChecks::ValidateDependencyInfo(const LogObjectList &objects, const Location &outer_loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbenefead332021-06-18 08:22:44 -06005599 const VkDependencyInfoKHR *dep_info) const {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005600 bool skip = false;
5601
5602 if (cb_state->activeRenderPass) {
5603 skip |= ValidateRenderPassPipelineBarriers(outer_loc, cb_state, dep_info);
5604 if (skip) return true; // Early return to avoid redundant errors from below calls
5605 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005606 for (uint32_t i = 0; i < dep_info->memoryBarrierCount; ++i) {
5607 const auto &mem_barrier = dep_info->pMemoryBarriers[i];
Tony-LunarG279601c2021-11-16 10:50:51 -07005608 auto loc = outer_loc.dot(Struct::VkMemoryBarrier2, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005609 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005610 }
5611 for (uint32_t i = 0; i < dep_info->imageMemoryBarrierCount; ++i) {
5612 const auto &mem_barrier = dep_info->pImageMemoryBarriers[i];
Tony-LunarG279601c2021-11-16 10:50:51 -07005613 auto loc = outer_loc.dot(Struct::VkImageMemoryBarrier2, Field::pImageMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005614 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005615 skip |= ValidateImageBarrier(objects, loc, cb_state, mem_barrier);
5616 }
5617 {
Tony-LunarG279601c2021-11-16 10:50:51 -07005618 Location loc(outer_loc.function, Struct::VkImageMemoryBarrier2);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005619 skip |= ValidateBarriersToImages(loc, cb_state, dep_info->imageMemoryBarrierCount, dep_info->pImageMemoryBarriers);
5620 }
5621
5622 for (uint32_t i = 0; i < dep_info->bufferMemoryBarrierCount; ++i) {
5623 const auto &mem_barrier = dep_info->pBufferMemoryBarriers[i];
Tony-LunarG279601c2021-11-16 10:50:51 -07005624 auto loc = outer_loc.dot(Struct::VkBufferMemoryBarrier2, Field::pBufferMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005625 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005626 skip |= ValidateBufferBarrier(objects, loc, cb_state, mem_barrier);
5627 }
5628
5629 return skip;
5630}
5631
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005632// template to check all original barrier structures
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005633template <typename Barrier>
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005634bool CoreChecks::ValidateMemoryBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
5635 const Barrier &barrier, VkPipelineStageFlags src_stage_mask,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005636 VkPipelineStageFlags dst_stage_mask) const {
5637 bool skip = false;
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005638 assert(cb_state);
5639 auto queue_flags = cb_state->GetQueueFlags();
5640
5641 if (!cb_state->IsAcquireOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005642 skip |= ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), queue_flags, barrier.srcAccessMask, src_stage_mask);
5643 }
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005644 if (!cb_state->IsReleaseOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005645 skip |= ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), queue_flags, barrier.dstAccessMask, dst_stage_mask);
5646 }
5647 return skip;
5648}
5649
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005650// template to check all synchronization2 barrier structures
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005651template <typename Barrier>
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005652bool CoreChecks::ValidateMemoryBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
5653 const Barrier &barrier) const {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005654 bool skip = false;
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005655 assert(cb_state);
5656 auto queue_flags = cb_state->GetQueueFlags();
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005657
Jeremy Gebbenefead332021-06-18 08:22:44 -06005658 skip |= ValidatePipelineStage(objects, loc.dot(Field::srcStageMask), queue_flags, barrier.srcStageMask);
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005659 if (!cb_state->IsAcquireOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005660 skip |=
5661 ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), queue_flags, barrier.srcAccessMask, barrier.srcStageMask);
5662 }
Jeremy Gebbenefead332021-06-18 08:22:44 -06005663
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005664 skip |= ValidatePipelineStage(objects, loc.dot(Field::dstStageMask), queue_flags, barrier.dstStageMask);
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005665 if (!cb_state->IsReleaseOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005666 skip |=
5667 ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), queue_flags, barrier.dstAccessMask, barrier.dstStageMask);
5668 }
5669 return skip;
5670}
5671
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005672// VkSubpassDependency validation happens when vkCreateRenderPass() is called.
5673// Dependencies between subpasses can only use pipeline stages compatible with VK_QUEUE_GRAPHICS_BIT,
5674// for external subpasses we don't have a yet command buffer so we have to assume all of them are valid.
5675static inline VkQueueFlags SubpassToQueueFlags(uint32_t subpass) {
5676 return subpass == VK_SUBPASS_EXTERNAL ? sync_utils::kAllQueueTypes : static_cast<VkQueueFlags>(VK_QUEUE_GRAPHICS_BIT);
5677}
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005678
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005679bool CoreChecks::ValidateSubpassDependency(const LogObjectList &objects, const Location &in_loc,
5680 const VkSubpassDependency2 &dependency) const {
5681 bool skip = false;
5682 Location loc = in_loc;
5683 VkMemoryBarrier2KHR converted_barrier;
5684 const auto *mem_barrier = LvlFindInChain<VkMemoryBarrier2KHR>(dependency.pNext);
5685
Tony-LunarG273f32f2021-09-28 08:56:30 -06005686 if (mem_barrier && enabled_features.core13.synchronization2) {
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005687 if (dependency.srcAccessMask != 0) {
5688 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-srcAccessMask",
5689 "%s is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5690 loc.dot(Field::srcAccessMask).Message().c_str());
5691 }
5692 if (dependency.dstAccessMask != 0) {
5693 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-dstAccessMask",
5694 "%s dstAccessMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5695 loc.dot(Field::dstAccessMask).Message().c_str());
5696 }
5697 if (dependency.srcStageMask != 0) {
5698 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-srcStageMask",
5699 "%s srcStageMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5700 loc.dot(Field::srcStageMask).Message().c_str());
5701 }
5702 if (dependency.dstStageMask != 0) {
5703 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-dstStageMask",
5704 "%s dstStageMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5705 loc.dot(Field::dstStageMask).Message().c_str());
5706 }
5707 loc = in_loc.dot(Field::pNext);
5708 converted_barrier = *mem_barrier;
5709 } else {
5710 if (mem_barrier) {
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005711 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-pNext",
5712 "%s a VkMemoryBarrier2KHR is present in pNext but synchronization2 is not enabled.",
5713 loc.Message().c_str());
5714 }
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005715 // use the subpass dependency flags, upconverted into wider synchronization2 fields.
5716 converted_barrier.srcStageMask = dependency.srcStageMask;
5717 converted_barrier.dstStageMask = dependency.dstStageMask;
5718 converted_barrier.srcAccessMask = dependency.srcAccessMask;
5719 converted_barrier.dstAccessMask = dependency.dstAccessMask;
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005720 }
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005721 auto src_queue_flags = SubpassToQueueFlags(dependency.srcSubpass);
5722 skip |= ValidatePipelineStage(objects, loc.dot(Field::srcStageMask), src_queue_flags, converted_barrier.srcStageMask);
5723 skip |= ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), src_queue_flags, converted_barrier.srcAccessMask,
5724 converted_barrier.srcStageMask);
5725
5726 auto dst_queue_flags = SubpassToQueueFlags(dependency.dstSubpass);
5727 skip |= ValidatePipelineStage(objects, loc.dot(Field::dstStageMask), dst_queue_flags, converted_barrier.dstStageMask);
5728 skip |= ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), dst_queue_flags, converted_barrier.dstAccessMask,
5729 converted_barrier.dstStageMask);
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005730 return skip;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005731}
5732
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005733bool CoreChecks::ValidateImageViewFormatFeatures(const IMAGE_STATE *image_state, const VkFormat view_format,
5734 const VkImageUsageFlags image_usage) const {
5735 // Pass in image_usage here instead of extracting it from image_state in case there's a chained VkImageViewUsageCreateInfo
5736 bool skip = false;
5737
Lionel Landwerlin21719f62021-12-09 11:40:09 +02005738 VkFormatFeatureFlags2KHR tiling_features = 0;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005739 const VkImageTiling image_tiling = image_state->createInfo.tiling;
5740
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06005741 if (image_state->HasAHBFormat()) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005742 // AHB image view and image share same feature sets
5743 tiling_features = image_state->format_features;
5744 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5745 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
sfricke-samsung45996a42021-09-16 13:45:27 -07005746 assert(IsExtEnabled(device_extensions.vk_ext_image_drm_format_modifier));
sjfrickee9b39372022-05-22 13:02:17 +09005747 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = LvlInitStruct<VkImageDrmFormatModifierPropertiesEXT>();
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005748 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image_state->image(), &drm_format_properties);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005749
Lionel Landwerlin1da35792021-12-14 16:54:13 +02005750 auto fmt_drm_props = LvlInitStruct<VkDrmFormatModifierPropertiesListEXT>();
5751 auto fmt_props_2 = LvlInitStruct<VkFormatProperties2>(&fmt_drm_props);
5752 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &fmt_props_2);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005753
nyorain38a9d232021-03-06 13:06:12 +01005754 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
Lionel Landwerlin1da35792021-12-14 16:54:13 +02005755 drm_properties.resize(fmt_drm_props.drmFormatModifierCount);
5756 fmt_drm_props.pDrmFormatModifierProperties = drm_properties.data();
nyorain38a9d232021-03-06 13:06:12 +01005757
Lionel Landwerlin1da35792021-12-14 16:54:13 +02005758 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &fmt_props_2);
nyorain38a9d232021-03-06 13:06:12 +01005759
Lionel Landwerlin1da35792021-12-14 16:54:13 +02005760 for (uint32_t i = 0; i < fmt_drm_props.drmFormatModifierCount; i++) {
5761 if (fmt_drm_props.pDrmFormatModifierProperties[i].drmFormatModifier == drm_format_properties.drmFormatModifier) {
5762 tiling_features = fmt_drm_props.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
5763 break;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005764 }
5765 }
5766 } else {
Lionel Landwerlin21719f62021-12-09 11:40:09 +02005767 VkFormatProperties3KHR format_properties = GetPDFormatProperties(view_format);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005768 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
5769 : format_properties.optimalTilingFeatures;
5770 }
5771
5772 if (tiling_features == 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005773 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-None-02273",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005774 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
5775 "physical device.",
5776 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5777 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005778 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02274",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005779 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5780 "VK_IMAGE_USAGE_SAMPLED_BIT.",
5781 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5782 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005783 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02275",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005784 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5785 "VK_IMAGE_USAGE_STORAGE_BIT.",
5786 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5787 } 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 -06005788 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02276",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005789 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5790 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
5791 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5792 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
5793 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005794 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02277",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005795 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5796 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5797 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5798 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
5799 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005800 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02652",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005801 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5802 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5803 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Tobias Hector6663c9b2020-11-05 10:18:02 +00005804 } else if ((image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) &&
5805 !(tiling_features & VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR)) {
5806 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005807 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-04550",
Tobias Hector6663c9b2020-11-05 10:18:02 +00005808 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5809 "VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR.",
5810 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5811 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005812 }
5813
5814 return skip;
5815}
5816
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005817bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005818 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005819 bool skip = false;
Jeremy Gebbenf4449392022-01-28 10:09:10 -07005820 auto image_state = Get<IMAGE_STATE>(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005821 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005822 skip |=
Jeremy Gebben9f537102021-10-05 16:37:12 -06005823 ValidateImageUsageFlags(image_state.get(),
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005824 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
5825 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
sfricke-samsungbb971942020-09-10 22:11:56 -07005826 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV |
5827 VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
5828 false, "VUID-VkImageViewCreateInfo-image-04441", "vkCreateImageView()",
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005829 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
sfricke-samsungbb971942020-09-10 22:11:56 -07005830 "TRANSIENT_ATTACHMENT|SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005831 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Jeremy Gebben9f537102021-10-05 16:37:12 -06005832 skip |= ValidateMemoryIsBoundToImage(image_state.get(), "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005833 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02005834 skip |= ValidateCreateImageViewSubresourceRange(
Jeremy Gebben9f537102021-10-05 16:37:12 -06005835 image_state.get(),
5836 pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005837 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005838
5839 VkImageCreateFlags image_flags = image_state->createInfo.flags;
5840 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005841 VkImageUsageFlags image_usage = image_state->createInfo.usage;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005842 VkFormat view_format = pCreateInfo->format;
5843 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06005844 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005845 VkImageViewType view_type = pCreateInfo->viewType;
sfricke-samsung20a8a372021-07-14 06:12:17 -07005846 uint32_t layer_count = pCreateInfo->subresourceRange.layerCount;
Mark Lobodzinski602de982017-02-09 11:01:33 -07005847
Dave Houltonbd2e2622018-04-10 16:41:14 -06005848 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005849 auto chained_ivuci_struct = LvlFindInChain<VkImageViewUsageCreateInfo>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06005850 if (chained_ivuci_struct) {
sfricke-samsung45996a42021-09-16 13:45:27 -07005851 if (IsExtEnabled(device_extensions.vk_khr_maintenance2)) {
5852 if (!IsExtEnabled(device_extensions.vk_ext_separate_stencil_usage)) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05005853 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005854 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
5855 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
5856 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05005857 }
5858 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005859 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05005860 if (image_stencil_struct == nullptr) {
5861 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005862 skip |= LogError(
5863 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005864 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
5865 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
5866 "any bits that were not set in VkImageCreateInfo::usage used to create image");
5867 }
5868 } else {
5869 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
5870 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
5871 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005872 skip |= LogError(
5873 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005874 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5875 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5876 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
5877 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
5878 }
5879 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
5880 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005881 skip |= LogError(
5882 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005883 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5884 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5885 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
5886 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
5887 }
5888 }
5889 }
5890 }
5891
Dave Houltonbd2e2622018-04-10 16:41:14 -06005892 image_usage = chained_ivuci_struct->usage;
5893 }
5894
sfricke-samsungf60b6c82021-04-05 22:59:20 -07005895 // If image used VkImageFormatListCreateInfo need to make sure a format from list is used
5896 const auto format_list_info = LvlFindInChain<VkImageFormatListCreateInfo>(image_state->createInfo.pNext);
5897 if (format_list_info && (format_list_info->viewFormatCount > 0)) {
5898 bool foundFormat = false;
5899 for (uint32_t i = 0; i < format_list_info->viewFormatCount; i++) {
5900 if (format_list_info->pViewFormats[i] == view_format) {
5901 foundFormat = true;
5902 break;
5903 }
5904 }
5905 if (foundFormat == false) {
5906 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-01585",
5907 "vkCreateImageView(): image was created with a VkImageFormatListCreateInfo in pNext of "
5908 "vkImageCreateInfo, but none of the formats match the VkImageViewCreateInfo::format (%s).",
5909 string_VkFormat(view_format));
5910 }
5911 }
5912
Dave Houlton6f5f20a2018-05-04 12:37:44 -06005913 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
5914 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005915 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01005916 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06005917 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01005918 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06005919 std::stringstream ss;
5920 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01005921 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06005922 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005923 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005924 }
sjfricke7e0d07c2022-07-14 14:44:05 +09005925 } else if (!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT)) {
5926 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
5927 auto image_class = FormatCompatibilityClass(image_format);
5928 auto view_class = FormatCompatibilityClass(view_format);
5929 // Need to only check if one is NONE to handle edge case both are NONE
5930 if ((image_class != view_class) || (image_class == FORMAT_COMPATIBILITY_CLASS::NONE)) {
5931 const char *error_vuid;
5932 if ((!IsExtEnabled(device_extensions.vk_khr_maintenance2)) &&
5933 (!IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion))) {
5934 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
5935 } else if ((IsExtEnabled(device_extensions.vk_khr_maintenance2)) &&
5936 (!IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion))) {
5937 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
5938 } else if ((!IsExtEnabled(device_extensions.vk_khr_maintenance2)) &&
5939 (IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion))) {
5940 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
5941 } else {
5942 // both enabled
5943 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
Dave Houltonc7988072018-04-16 11:46:56 -06005944 }
sjfricke7e0d07c2022-07-14 14:44:05 +09005945 std::stringstream ss;
5946 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
5947 << " is not in the same format compatibility class as "
5948 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
5949 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
5950 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
5951 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Lenny Komowb79f04a2017-09-18 17:07:00 -06005952 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005953 }
5954 } else {
5955 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07005956 // Unless it is a multi-planar color bit aspect
5957 if ((image_format != view_format) &&
5958 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
sfricke-samsung45996a42021-09-16 13:45:27 -07005959 const char *vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
5960 ? "VUID-VkImageViewCreateInfo-image-01762"
5961 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07005962 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06005963 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07005964 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07005965 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07005966 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005967 }
5968 }
5969
ziga-lunargebb32de2021-08-29 21:24:30 +02005970 if (image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT && view_type != VK_IMAGE_VIEW_TYPE_2D &&
5971 view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5972 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04972",
5973 "vkCreateImageView(): image was created with sample count %s, but pCreateInfo->viewType is %s.",
5974 string_VkSampleCountFlagBits(image_state->createInfo.samples), string_VkImageViewType(view_type));
5975 }
5976
Mark Lobodzinski602de982017-02-09 11:01:33 -07005977 // Validate correct image aspect bits for desired formats and format consistency
Aitor Camachoeb35fed2022-06-07 14:07:42 +02005978 skip |=
5979 ValidateImageAspectMask(image_state->image(), image_format, aspect_mask, image_state->disjoint, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06005980
sfricke-samsung20a8a372021-07-14 06:12:17 -07005981 // Valdiate Image/ImageView type compatibility #resources-image-views-compatibility
Jeremy Kniager846ab732017-07-10 13:12:04 -06005982 switch (image_type) {
5983 case VK_IMAGE_TYPE_1D:
5984 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005985 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5986 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5987 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005988 }
5989 break;
5990 case VK_IMAGE_TYPE_2D:
5991 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5992 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
5993 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005994 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
5995 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5996 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005997 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005998 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5999 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
6000 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06006001 }
6002 }
6003 break;
6004 case VK_IMAGE_TYPE_3D:
sfricke-samsung45996a42021-09-16 13:45:27 -07006005 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06006006 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
6007 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
Tony-LunarGbe956362022-04-05 13:34:31 -06006008 if (device_extensions.vk_ext_image_2d_view_of_3d) {
6009 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT)) {
6010 if (view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
6011 skip |= LogError(
6012 pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-06723",
6013 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type "
6014 "%s since the image doesn't have VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT flag set.",
6015 string_VkImageViewType(view_type), string_VkImageType(image_type));
6016 } else if (view_type == VK_IMAGE_VIEW_TYPE_2D &&
6017 !(image_flags & VK_IMAGE_CREATE_2D_VIEW_COMPATIBLE_BIT_EXT)) {
6018 skip |= LogError(
6019 pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-06728",
6020 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type "
6021 "%s since the image doesn't have VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT or "
6022 "VK_IMAGE_CREATE_2D_VIEW_COMPATIBLE_BIT_EXT flag set.",
6023 string_VkImageViewType(view_type), string_VkImageType(image_type));
6024 }
6025 }
6026 } else if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT) &&
6027 (view_type == VK_IMAGE_VIEW_TYPE_2D)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06006028 skip |=
Tony-LunarGbe956362022-04-05 13:34:31 -06006029 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-06727",
6030 "vkCreateImageView(): pCreateInfo->viewType VK_IMAGE_VIEW_TYPE_2D is not compatible "
6031 "with image type "
sfricke-samsungd9b3e122021-07-15 22:50:00 -07006032 "%s since the image doesn't have VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT flag set.",
Tony-LunarGbe956362022-04-05 13:34:31 -06006033 string_VkImageType(image_type));
6034 }
6035 if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
Jeremy Kniager846ab732017-07-10 13:12:04 -06006036 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006037 skip |= LogError(
sfricke-samsungd9b3e122021-07-15 22:50:00 -07006038 pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04971",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006039 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
6040 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
6041 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
6042 string_VkImageViewType(view_type), string_VkImageType(image_type));
sfricke-samsungd9b3e122021-07-15 22:50:00 -07006043 } else if (pCreateInfo->subresourceRange.levelCount != 1) {
6044 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04970",
6045 "vkCreateImageView(): pCreateInfo->viewType %s is with image type %s must have a "
6046 "levelCount of 1 but it is %u.",
6047 string_VkImageViewType(view_type), string_VkImageType(image_type),
6048 pCreateInfo->subresourceRange.levelCount);
Jeremy Kniager846ab732017-07-10 13:12:04 -06006049 }
6050 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006051 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
6052 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
6053 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06006054 }
6055 }
6056 } else {
6057 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
sfricke-samsungd9b3e122021-07-15 22:50:00 -07006058 // Help point to VK_KHR_maintenance1
6059 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
6060 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
6061 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
6062 "without VK_KHR_maintenance1 enabled which was promoted in Vulkan 1.0.",
6063 string_VkImageViewType(view_type), string_VkImageType(image_type));
6064 } else {
6065 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
6066 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
6067 string_VkImageViewType(view_type), string_VkImageType(image_type));
6068 }
Jeremy Kniager846ab732017-07-10 13:12:04 -06006069 }
6070 }
6071 break;
6072 default:
6073 break;
6074 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06006075
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006076 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
sfricke-samsung45996a42021-09-16 13:45:27 -07006077 if (IsExtEnabled(device_extensions.vk_android_external_memory_android_hardware_buffer)) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07006078 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06006079 }
6080
Jeremy Gebben9f537102021-10-05 16:37:12 -06006081 skip |= ValidateImageViewFormatFeatures(image_state.get(), view_format, image_usage);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006082
sfricke-samsung828e59d2021-08-22 23:20:49 -07006083 if (enabled_features.shading_rate_image_features.shadingRateImage) {
Tobias Hector6663c9b2020-11-05 10:18:02 +00006084 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
6085 if (view_format != VK_FORMAT_R8_UINT) {
6086 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
6087 "vkCreateImageView() If image was created with usage containing "
6088 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
6089 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05006090 }
Tobias Hector6663c9b2020-11-05 10:18:02 +00006091 }
6092
sfricke-samsung828e59d2021-08-22 23:20:49 -07006093 if (enabled_features.shading_rate_image_features.shadingRateImage ||
Tobias Hector6663c9b2020-11-05 10:18:02 +00006094 enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
6095 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) {
6096 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
6097 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
6098 "vkCreateImageView() If image was created with usage containing "
6099 "VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR, viewType must be "
6100 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
6101 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05006102 }
6103 }
Jeff Bolz99e3f632020-03-24 22:59:22 -05006104
Tobias Hector6663c9b2020-11-05 10:18:02 +00006105 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate &&
6106 !phys_dev_ext_props.fragment_shading_rate_props.layeredShadingRateAttachments &&
sfricke-samsung20a8a372021-07-14 06:12:17 -07006107 image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR && layer_count != 1) {
Tobias Hector6663c9b2020-11-05 10:18:02 +00006108 skip |= LogError(device, "VUID-VkImageViewCreateInfo-usage-04551",
6109 "vkCreateImageView(): subresourceRange.layerCount is %u for a shading rate attachment image view.",
sfricke-samsung20a8a372021-07-14 06:12:17 -07006110 layer_count);
Tobias Hector6663c9b2020-11-05 10:18:02 +00006111 }
6112
sfricke-samsung20a8a372021-07-14 06:12:17 -07006113 if (layer_count == VK_REMAINING_ARRAY_LAYERS) {
6114 const uint32_t remaining_layers = image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer;
6115 if (view_type == VK_IMAGE_VIEW_TYPE_CUBE && remaining_layers != 6) {
Jeff Bolz99e3f632020-03-24 22:59:22 -05006116 skip |= LogError(device, "VUID-VkImageViewCreateInfo-viewType-02962",
6117 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be 6",
sfricke-samsung20a8a372021-07-14 06:12:17 -07006118 remaining_layers);
Jeff Bolz99e3f632020-03-24 22:59:22 -05006119 }
sfricke-samsung20a8a372021-07-14 06:12:17 -07006120 if (view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY && ((remaining_layers) % 6) != 0) {
Jeff Bolz99e3f632020-03-24 22:59:22 -05006121 skip |= LogError(
6122 device, "VUID-VkImageViewCreateInfo-viewType-02963",
6123 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be a multiple of 6",
sfricke-samsung20a8a372021-07-14 06:12:17 -07006124 remaining_layers);
6125 }
6126 if ((remaining_layers != 1) && ((view_type == VK_IMAGE_VIEW_TYPE_1D) || (view_type == VK_IMAGE_VIEW_TYPE_2D) ||
6127 (view_type == VK_IMAGE_VIEW_TYPE_3D))) {
6128 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-imageViewType-04974",
6129 "vkCreateImageView(): Using pCreateInfo->viewType %s and the subresourceRange.layerCount "
6130 "VK_REMAINING_ARRAY_LAYERS=(%d) and must 1 (try looking into VK_IMAGE_VIEW_TYPE_*_ARRAY).",
6131 string_VkImageViewType(view_type), remaining_layers);
6132 }
6133 } else {
6134 if ((layer_count != 1) && ((view_type == VK_IMAGE_VIEW_TYPE_1D) || (view_type == VK_IMAGE_VIEW_TYPE_2D) ||
6135 (view_type == VK_IMAGE_VIEW_TYPE_3D))) {
6136 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-imageViewType-04973",
ziga-lunargc9d29f72022-05-15 19:55:08 +02006137 "vkCreateImageView(): subresourceRange.layerCount (%" PRIu32
6138 ") must be 1 when using viewType %s (try looking into VK_IMAGE_VIEW_TYPE_*_ARRAY).",
6139 layer_count, string_VkImageViewType(view_type));
Jeff Bolz99e3f632020-03-24 22:59:22 -05006140 }
6141 }
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006142
6143 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
ziga-lunarga77a2832022-05-03 11:12:00 +02006144 const auto normalized_subresource_range = image_state->NormalizeSubresourceRange(pCreateInfo->subresourceRange);
6145 if (normalized_subresource_range.levelCount != 1) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06006146 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02571",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006147 "vkCreateImageView(): If image was created with usage containing "
6148 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, subresourceRange.levelCount (%d) must: be 1",
6149 pCreateInfo->subresourceRange.levelCount);
6150 }
6151 }
6152 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
6153 if (!enabled_features.fragment_density_map_features.fragmentDensityMapDynamic) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06006154 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-02572",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006155 "vkCreateImageView(): If the fragmentDensityMapDynamic feature is not enabled, "
6156 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
6157 }
6158 } else {
6159 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
6160 if (image_flags & (VK_IMAGE_CREATE_PROTECTED_BIT | VK_IMAGE_CREATE_SPARSE_BINDING_BIT |
6161 VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT)) {
Shannon McPherson8d0d1f92020-07-06 11:58:21 -06006162 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-04116",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006163 "vkCreateImageView(): If image was created with usage containing "
6164 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT flags must not contain any of "
6165 "VK_IMAGE_CREATE_PROTECTED_BIT, VK_IMAGE_CREATE_SPARSE_BINDING_BIT, "
6166 "VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or VK_IMAGE_CREATE_SPARSE_ALIASED_BIT");
6167 }
6168 }
6169 }
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07006170
ziga-lunarg966ac0e2021-07-18 11:51:44 +02006171 if (image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
6172 if (pCreateInfo->subresourceRange.levelCount != 1) {
6173 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01584",
6174 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit, "
6175 "but subresourcesRange.levelCount (%" PRIu32 ") is not 1.",
6176 pCreateInfo->subresourceRange.levelCount);
6177 }
6178 if (pCreateInfo->subresourceRange.layerCount != 1) {
6179 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01584",
6180 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit, "
6181 "but subresourcesRange.layerCount (%" PRIu32 ") is not 1.",
6182 pCreateInfo->subresourceRange.layerCount);
6183 }
ziga-lunarg966ac0e2021-07-18 11:51:44 +02006184
sfricke-samsungd750f812022-02-04 10:23:34 -08006185 if (!FormatIsCompressed(view_format) && pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_3D) {
6186 skip |=
6187 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04739",
ziga-lunargc290c7f2021-07-31 22:01:46 +02006188 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit and "
6189 "non-compressed format (%s), but pCreateInfo->viewType is VK_IMAGE_VIEW_TYPE_3D.",
6190 string_VkFormat(image_format));
sfricke-samsungd750f812022-02-04 10:23:34 -08006191 }
6192
6193 const bool class_compatible = FormatCompatibilityClass(view_format) == FormatCompatibilityClass(image_format);
6194 // "uncompressed format that is size-compatible" so if compressed, same as not being compatible
6195 const bool size_compatible =
6196 FormatIsCompressed(view_format) ? false : FormatElementSize(view_format) == FormatElementSize(image_format);
6197 if (!class_compatible && !size_compatible) {
6198 skip |=
6199 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01583",
6200 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit and "
6201 "format (%s), but pCreateInfo->format (%s) are not compatible.",
6202 string_VkFormat(image_format), string_VkFormat(view_format));
6203 }
ziga-lunargc290c7f2021-07-31 22:01:46 +02006204 }
6205
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02006206 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT) {
6207 if (!enabled_features.fragment_density_map2_features.fragmentDensityMapDeferred) {
6208 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03567",
6209 "vkCreateImageView(): If the fragmentDensityMapDeferred feature is not enabled, "
6210 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT");
6211 }
6212 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
6213 skip |=
6214 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03568",
6215 "vkCreateImageView(): If flags contains VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT, "
6216 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
6217 }
6218 }
sfricke-samsung45996a42021-09-16 13:45:27 -07006219 if (IsExtEnabled(device_extensions.vk_ext_fragment_density_map2)) {
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02006220 if ((image_flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) && (image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) &&
sfricke-samsung20a8a372021-07-14 06:12:17 -07006221 (layer_count > phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers)) {
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02006222 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-03569",
6223 "vkCreateImageView(): If image was created with flags containing "
6224 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT and usage containing VK_IMAGE_USAGE_SAMPLED_BIT "
6225 "subresourceRange.layerCount (%d) must: be less than or equal to maxSubsampledArrayLayers (%d)",
sfricke-samsung20a8a372021-07-14 06:12:17 -07006226 layer_count, phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers);
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02006227 }
6228 }
6229
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07006230 auto astc_decode_mode = LvlFindInChain<VkImageViewASTCDecodeModeEXT>(pCreateInfo->pNext);
sfricke-samsung45996a42021-09-16 13:45:27 -07006231 if (IsExtEnabled(device_extensions.vk_ext_astc_decode_mode) && (astc_decode_mode != nullptr)) {
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07006232 if ((enabled_features.astc_decode_features.decodeModeSharedExponent == VK_FALSE) &&
6233 (astc_decode_mode->decodeMode == VK_FORMAT_E5B9G9R9_UFLOAT_PACK32)) {
6234 skip |= LogError(device, "VUID-VkImageViewASTCDecodeModeEXT-decodeMode-02231",
6235 "vkCreateImageView(): decodeModeSharedExponent is not enabled but "
6236 "VkImageViewASTCDecodeModeEXT::decodeMode is VK_FORMAT_E5B9G9R9_UFLOAT_PACK32.");
6237 }
6238 }
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07006239
sfricke-samsung45996a42021-09-16 13:45:27 -07006240 if (IsExtEnabled(device_extensions.vk_khr_portability_subset)) {
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07006241 // If swizzling is disabled, make sure it isn't used
Nathaniel Cesario17d057e2021-06-21 22:58:45 -06006242 // NOTE: as of spec version 1.2.183, VUID 04465 states: "all elements of components _must_ be
6243 // VK_COMPONENT_SWIZZLE_IDENTITY."
6244 // However, issue https://github.com/KhronosGroup/Vulkan-Portability/issues/27 points out that the identity can
6245 // also be defined via R, G, B, A enums in the correct order.
6246 // Spec change is at https://gitlab.khronos.org/vulkan/vulkan/-/merge_requests/4600
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07006247 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatSwizzle) &&
Nathaniel Cesario17d057e2021-06-21 22:58:45 -06006248 !IsIdentitySwizzle(pCreateInfo->components)) {
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07006249 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatSwizzle-04465",
6250 "vkCreateImageView (portability error): swizzle is disabled for this device.");
6251 }
6252
6253 // Ensure ImageView's format has the same number of bits and components as Image's format if format reinterpretation is
6254 // disabled
6255 // TODO (ncesario): This is not correct for some cases (e.g., VK_FORMAT_B10G11R11_UFLOAT_PACK32 and
6256 // VK_FORMAT_E5B9G9R9_UFLOAT_PACK32), but requires additional information that should probably be generated from the
6257 // spec. See Github issue #2361.
6258 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatReinterpretation) &&
6259 ((FormatElementSize(pCreateInfo->format, VK_IMAGE_ASPECT_COLOR_BIT) !=
6260 FormatElementSize(image_state->createInfo.format, VK_IMAGE_ASPECT_COLOR_BIT)) ||
sfricke-samsunged028b02021-09-06 23:14:51 -07006261 (FormatComponentCount(pCreateInfo->format) != FormatComponentCount(image_state->createInfo.format)))) {
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07006262 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatReinterpretation-04466",
6263 "vkCreateImageView (portability error): ImageView format must have"
6264 " the same number of components and bits per component as the Image's format");
6265 }
6266 }
Tony-LunarG69604c42021-11-22 16:00:12 -07006267
6268 auto image_view_min_lod = LvlFindInChain<VkImageViewMinLodCreateInfoEXT>(pCreateInfo->pNext);
6269 if (image_view_min_lod) {
6270 if ((!enabled_features.image_view_min_lod_features.minLod) && (image_view_min_lod->minLod != 0)) {
6271 skip |= LogError(device, "VUID-VkImageViewMinLodCreateInfoEXT-minLod-06455",
6272 "vkCreateImageView(): VkImageViewMinLodCreateInfoEXT::minLod = %f, but the minLod feature is not "
6273 "enabled. If the minLod feature is not enabled, minLod must be 0.0",
6274 image_view_min_lod->minLod);
6275 }
6276 auto max_level = (pCreateInfo->subresourceRange.baseMipLevel + (pCreateInfo->subresourceRange.levelCount - 1));
6277 if (image_view_min_lod->minLod > max_level) {
6278 skip |= LogError(device, "VUID-VkImageViewMinLodCreateInfoEXT-minLod-06456",
6279 "vkCreateImageView(): minLod (%f) must be less or equal to the index of the last mipmap level "
6280 "accessible to the view (%" PRIu32 ")",
6281 image_view_min_lod->minLod, max_level);
6282 }
6283 }
sfricke-samsung0dae8952022-03-03 20:34:23 -06006284
6285 if (FormatRequiresYcbcrConversionExplicitly(view_format)) {
6286 const auto ycbcr_conversion = LvlFindInChain<VkSamplerYcbcrConversionInfo>(pCreateInfo->pNext);
6287 if (!ycbcr_conversion || ycbcr_conversion->conversion == VK_NULL_HANDLE) {
6288 skip |= LogError(
6289 device, "VUID-VkImageViewCreateInfo-format-06415",
6290 "vkCreateImageView(): Format %s requires a VkSamplerYcbcrConversion but one was not passed in the pNext chain.",
6291 string_VkFormat(view_format));
6292 }
6293 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07006294 }
6295 return skip;
6296}
6297
Jeff Leger178b1e52020-10-05 12:22:23 -04006298template <typename RegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006299bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
Tony-LunarGef035472021-11-02 10:23:33 -06006300 uint32_t regionCount, const RegionType *pRegions, CMD_TYPE cmd_type) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006301 bool skip = false;
Tony-LunarGef035472021-11-02 10:23:33 -06006302 const bool is_2 = (cmd_type == CMD_COPYBUFFER2KHR || cmd_type == CMD_COPYBUFFER2);
6303 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04006304 const char *vuid;
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006305
6306 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
6307 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
Aitor Camacho2542b9d2022-06-01 18:37:49 +02006308 bool are_buffers_sparse = src_buffer_state->sparse || dst_buffer_state->sparse;
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006309
6310 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006311 const RegionType region = pRegions[i];
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006312
6313 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
sfricke-samsung71f04e32022-03-16 01:21:21 -05006314 if (region.srcOffset >= src_buffer_size) {
Tony-LunarGef035472021-11-02 10:23:33 -06006315 vuid = is_2 ? "VUID-VkCopyBufferInfo2-srcOffset-00113" : "VUID-vkCmdCopyBuffer-srcOffset-00113";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006316 skip |= LogError(src_buffer_state->buffer(), vuid,
ziga-lunargd6b58ce2021-10-16 01:22:56 +02006317 "%s: pRegions[%" PRIu32 "].srcOffset (%" PRIuLEAST64
6318 ") is greater than size of srcBuffer (%" PRIuLEAST64 ").",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006319 func_name, i, region.srcOffset, src_buffer_size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006320 }
6321
6322 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
sfricke-samsung71f04e32022-03-16 01:21:21 -05006323 if (region.dstOffset >= dst_buffer_size) {
Tony-LunarGef035472021-11-02 10:23:33 -06006324 vuid = is_2 ? "VUID-VkCopyBufferInfo2-dstOffset-00114" : "VUID-vkCmdCopyBuffer-dstOffset-00114";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006325 skip |= LogError(dst_buffer_state->buffer(), vuid,
ziga-lunargd6b58ce2021-10-16 01:22:56 +02006326 "%s: pRegions[%" PRIu32 "].dstOffset (%" PRIuLEAST64
6327 ") is greater than size of dstBuffer (%" PRIuLEAST64 ").",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006328 func_name, i, region.dstOffset, dst_buffer_size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006329 }
6330
6331 // 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 -05006332 if (region.size > (src_buffer_size - region.srcOffset)) {
Tony-LunarGef035472021-11-02 10:23:33 -06006333 vuid = is_2 ? "VUID-VkCopyBufferInfo2-size-00115" : "VUID-vkCmdCopyBuffer-size-00115";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006334 skip |= LogError(src_buffer_state->buffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006335 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the source buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006336 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006337 func_name, i, region.size, src_buffer_size, i, region.srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006338 }
6339
6340 // 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 -05006341 if (region.size > (dst_buffer_size - region.dstOffset)) {
Tony-LunarGef035472021-11-02 10:23:33 -06006342 vuid = is_2 ? "VUID-VkCopyBufferInfo2-size-00116" : "VUID-vkCmdCopyBuffer-size-00116";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006343 skip |= LogError(dst_buffer_state->buffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006344 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the destination buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006345 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006346 func_name, i, region.size, dst_buffer_size, i, region.dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006347 }
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006348
ziga-lunargb94ff002022-03-23 23:30:19 +01006349 // 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 +02006350 if (!skip && !are_buffers_sparse) {
6351 auto src_region = sparse_container::range<VkDeviceSize>{region.srcOffset, region.srcOffset + region.size};
aitor-lunarg26fbbc22022-04-22 18:42:08 +02006352 for (uint32_t j = 0; j < regionCount; j++) {
Aitor Camacho2542b9d2022-06-01 18:37:49 +02006353 auto dst_region =
6354 sparse_container::range<VkDeviceSize>{pRegions[j].dstOffset, pRegions[j].dstOffset + pRegions[j].size};
6355 if (src_buffer_state->DoesResourceMemoryOverlap(src_region, dst_buffer_state, dst_region)) {
aitor-lunarg26fbbc22022-04-22 18:42:08 +02006356 vuid = is_2 ? "VUID-VkCopyBufferInfo2-pRegions-00117" : "VUID-vkCmdCopyBuffer-pRegions-00117";
6357 skip |= LogError(src_buffer_state->buffer(), vuid,
6358 "%s: Detected overlap between source and dest regions in memory.", func_name);
6359 }
ziga-lunargb94ff002022-03-23 23:30:19 +01006360 }
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006361 }
6362 }
6363
6364 return skip;
6365}
sfricke-samsung11813ab2021-10-20 14:53:37 -07006366template <typename RegionType>
6367bool CoreChecks::ValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer, uint32_t regionCount,
Tony-LunarGef035472021-11-02 10:23:33 -06006368 const RegionType *pRegions, CMD_TYPE cmd_type) const {
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07006369 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07006370 auto src_buffer_state = Get<BUFFER_STATE>(srcBuffer);
6371 auto dst_buffer_state = Get<BUFFER_STATE>(dstBuffer);
Tony-LunarGef035472021-11-02 10:23:33 -06006372 const bool is_2 = (cmd_type == CMD_COPYBUFFER2KHR || cmd_type == CMD_COPYBUFFER2);
sfricke-samsung11813ab2021-10-20 14:53:37 -07006373 const char *func_name = CommandTypeString(cmd_type);
6374 const char *vuid;
6375
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006376 bool skip = false;
Tony-LunarGef035472021-11-02 10:23:33 -06006377 vuid = is_2 ? "VUID-VkCopyBufferInfo2-srcBuffer-00119" : "VUID-vkCmdCopyBuffer-srcBuffer-00119";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006378 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state.get(), func_name, vuid);
Tony-LunarGef035472021-11-02 10:23:33 -06006379 vuid = is_2 ? "VUID-VkCopyBufferInfo2-dstBuffer-00121" : "VUID-vkCmdCopyBuffer-dstBuffer-00121";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006380 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state.get(), func_name, vuid);
sfricke-samsung11813ab2021-10-20 14:53:37 -07006381
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006382 // Validate that SRC & DST buffers have correct usage flags set
Tony-LunarGef035472021-11-02 10:23:33 -06006383 vuid = is_2 ? "VUID-VkCopyBufferInfo2-srcBuffer-00118" : "VUID-vkCmdCopyBuffer-srcBuffer-00118";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006384 skip |= ValidateBufferUsageFlags(src_buffer_state.get(), VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
sfricke-samsung11813ab2021-10-20 14:53:37 -07006385 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Tony-LunarGef035472021-11-02 10:23:33 -06006386 vuid = is_2 ? "VUID-VkCopyBufferInfo2-dstBuffer-00120" : "VUID-vkCmdCopyBuffer-dstBuffer-00120";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006387 skip |= ValidateBufferUsageFlags(dst_buffer_state.get(), VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
sfricke-samsung11813ab2021-10-20 14:53:37 -07006388 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
6389
Jeremy Gebben9f537102021-10-05 16:37:12 -06006390 skip |= ValidateCmd(cb_node.get(), cmd_type);
Tony-LunarGef035472021-11-02 10:23:33 -06006391 skip |= ValidateCmdCopyBufferBounds(src_buffer_state.get(), dst_buffer_state.get(), regionCount, pRegions, cmd_type);
sfricke-samsung11813ab2021-10-20 14:53:37 -07006392
Tony-LunarGef035472021-11-02 10:23:33 -06006393 vuid = is_2 ? "VUID-vkCmdCopyBuffer2-commandBuffer-01822" : "VUID-vkCmdCopyBuffer-commandBuffer-01822";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006394 skip |= ValidateProtectedBuffer(cb_node.get(), src_buffer_state.get(), func_name, vuid);
Tony-LunarGef035472021-11-02 10:23:33 -06006395 vuid = is_2 ? "VUID-vkCmdCopyBuffer2-commandBuffer-01823" : "VUID-vkCmdCopyBuffer-commandBuffer-01823";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006396 skip |= ValidateProtectedBuffer(cb_node.get(), dst_buffer_state.get(), func_name, vuid);
Tony-LunarGef035472021-11-02 10:23:33 -06006397 vuid = is_2 ? "VUID-vkCmdCopyBuffer2-commandBuffer-01824" : "VUID-vkCmdCopyBuffer-commandBuffer-01824";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006398 skip |= ValidateUnprotectedBuffer(cb_node.get(), dst_buffer_state.get(), func_name, vuid);
Tony-LunarGef035472021-11-02 10:23:33 -06006399
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006400 return skip;
6401}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07006402
sfricke-samsung11813ab2021-10-20 14:53:37 -07006403bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
6404 uint32_t regionCount, const VkBufferCopy *pRegions) const {
Tony-LunarGef035472021-11-02 10:23:33 -06006405 return ValidateCmdCopyBuffer(commandBuffer, srcBuffer, dstBuffer, regionCount, pRegions, CMD_COPYBUFFER);
sfricke-samsung11813ab2021-10-20 14:53:37 -07006406}
6407
Jeff Leger178b1e52020-10-05 12:22:23 -04006408bool CoreChecks::PreCallValidateCmdCopyBuffer2KHR(VkCommandBuffer commandBuffer,
6409 const VkCopyBufferInfo2KHR *pCopyBufferInfos) const {
sfricke-samsung11813ab2021-10-20 14:53:37 -07006410 return ValidateCmdCopyBuffer(commandBuffer, pCopyBufferInfos->srcBuffer, pCopyBufferInfos->dstBuffer,
Tony-LunarGef035472021-11-02 10:23:33 -06006411 pCopyBufferInfos->regionCount, pCopyBufferInfos->pRegions, CMD_COPYBUFFER2KHR);
6412}
6413
6414bool CoreChecks::PreCallValidateCmdCopyBuffer2(VkCommandBuffer commandBuffer, const VkCopyBufferInfo2 *pCopyBufferInfos) const {
6415 return ValidateCmdCopyBuffer(commandBuffer, pCopyBufferInfos->srcBuffer, pCopyBufferInfos->dstBuffer,
6416 pCopyBufferInfos->regionCount, pCopyBufferInfos->pRegions, CMD_COPYBUFFER2);
Jeff Leger178b1e52020-10-05 12:22:23 -04006417}
6418
Aitor Camacho2542b9d2022-06-01 18:37:49 +02006419template <typename RegionType>
6420void CoreChecks::RecordCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer, uint32_t regionCount,
6421 const RegionType *pRegions, CMD_TYPE cmd_type) {
6422 const bool is_2 = (cmd_type == CMD_COPYBUFFER2KHR || cmd_type == CMD_COPYBUFFER2);
6423 const char *func_name = CommandTypeString(cmd_type);
6424 const char *vuid = is_2 ? "VUID-VkCopyBufferInfo2-pRegions-00117" : "VUID-vkCmdCopyBuffer-pRegions-00117";
6425
6426 auto src_buffer_state = Get<BUFFER_STATE>(srcBuffer);
6427 auto dst_buffer_state = Get<BUFFER_STATE>(dstBuffer);
6428 if (src_buffer_state->sparse || dst_buffer_state->sparse) {
6429 auto cb_node = Get<CMD_BUFFER_STATE>(commandBuffer);
6430
6431 std::vector<sparse_container::range<VkDeviceSize>> src_ranges;
6432 std::vector<sparse_container::range<VkDeviceSize>> dst_ranges;
6433
6434 for (uint32_t i = 0u; i < regionCount; ++i) {
6435 const RegionType &region = pRegions[i];
6436 src_ranges.emplace_back(sparse_container::range<VkDeviceSize>{region.srcOffset, region.srcOffset + region.size});
6437 dst_ranges.emplace_back(sparse_container::range<VkDeviceSize>{region.dstOffset, region.dstOffset + region.size});
6438 }
6439
6440 auto queue_submit_validation = [this, src_buffer_state, dst_buffer_state, src_ranges, dst_ranges, vuid, func_name](
6441 const ValidationStateTracker &device_data, const class QUEUE_STATE &queue_state,
6442 const CMD_BUFFER_STATE &cb_state) -> bool {
6443 bool skip = false;
6444 for (const auto &src : src_ranges) {
6445 for (const auto &dst : dst_ranges) {
6446 if (src_buffer_state->DoesResourceMemoryOverlap(src, dst_buffer_state.get(), dst)) {
6447 skip |= this->LogError(src_buffer_state->buffer(), vuid,
6448 "%s: Detected overlap between source and dest regions in memory.", func_name);
6449 }
6450 }
6451 }
6452
6453 return skip;
6454 };
6455
6456 cb_node->queue_submit_functions.emplace_back(queue_submit_validation);
6457 }
6458}
6459
6460void CoreChecks::PreCallRecordCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
6461 uint32_t regionCount, const VkBufferCopy *pRegions) {
6462 RecordCmdCopyBuffer(commandBuffer, srcBuffer, dstBuffer, regionCount, pRegions, CMD_COPYBUFFER);
6463}
6464
6465void CoreChecks::PreCallRecordCmdCopyBuffer2KHR(VkCommandBuffer commandBuffer, const VkCopyBufferInfo2KHR *pCopyBufferInfos) {
6466 RecordCmdCopyBuffer(commandBuffer, pCopyBufferInfos->srcBuffer, pCopyBufferInfos->dstBuffer, pCopyBufferInfos->regionCount,
6467 pCopyBufferInfos->pRegions, CMD_COPYBUFFER2KHR);
6468}
6469
6470void CoreChecks::PreCallRecordCmdCopyBuffer2(VkCommandBuffer commandBuffer, const VkCopyBufferInfo2 *pCopyBufferInfos) {
6471 RecordCmdCopyBuffer(commandBuffer, pCopyBufferInfos->srcBuffer, pCopyBufferInfos->dstBuffer, pCopyBufferInfos->regionCount,
6472 pCopyBufferInfos->pRegions, CMD_COPYBUFFER2);
6473}
6474
Jeff Bolz5c801d12019-10-09 10:38:45 -05006475bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
6476 const VkAllocationCallbacks *pAllocator) const {
Jeremy Gebbenf4449392022-01-28 10:09:10 -07006477 auto image_view_state = Get<IMAGE_VIEW_STATE>(imageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07006478
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006479 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07006480 if (image_view_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06006481 skip |= ValidateObjectNotInUse(image_view_state.get(), "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006482 }
6483 return skip;
6484}
6485
Jeff Bolz5c801d12019-10-09 10:38:45 -05006486bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Jeremy Gebben8afa7162022-08-03 19:29:10 -06006487 auto buffer_state = Get<BUFFER_STATE>(buffer);
6488
6489 bool skip = false;
6490 if (buffer_state) {
6491 skip |= ValidateObjectNotInUse(buffer_state.get(), "vkDestroyBuffer", "VUID-vkDestroyBuffer-buffer-00922");
6492 }
6493 return skip;
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006494}
6495
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006496bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006497 const VkAllocationCallbacks *pAllocator) const {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006498 auto buffer_view_state = Get<BUFFER_VIEW_STATE>(bufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006499 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07006500 if (buffer_view_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06006501 skip |= ValidateObjectNotInUse(buffer_view_state.get(), "vkDestroyBufferView", "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006502 }
6503 return skip;
6504}
6505
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006506bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006507 VkDeviceSize size, uint32_t data) const {
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07006508 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006509 auto buffer_state = Get<BUFFER_STATE>(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006510 bool skip = false;
Jeremy Gebben9f537102021-10-05 16:37:12 -06006511 skip |= ValidateMemoryIsBoundToBuffer(buffer_state.get(), "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
6512 skip |= ValidateCmd(cb_node.get(), CMD_FILLBUFFER);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006513 // Validate that DST buffer has correct usage flags set
Jeremy Gebben9f537102021-10-05 16:37:12 -06006514 skip |=
6515 ValidateBufferUsageFlags(buffer_state.get(), VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
6516 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006517
Jeremy Gebben9f537102021-10-05 16:37:12 -06006518 skip |=
6519 ValidateProtectedBuffer(cb_node.get(), buffer_state.get(), "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01811");
6520 skip |= ValidateUnprotectedBuffer(cb_node.get(), buffer_state.get(), "vkCmdFillBuffer()",
6521 "VUID-vkCmdFillBuffer-commandBuffer-01812");
sfricke-samsung022fa252020-07-24 03:26:16 -07006522
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006523 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006524 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
6525 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
6526 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
6527 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006528 }
6529
6530 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006531 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
6532 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
6533 ") minus dstOffset (0x%" PRIxLEAST64 ").",
6534 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006535 }
6536
sfricke-samsung45996a42021-09-16 13:45:27 -07006537 if (!IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06006538 skip |= ValidateCmdQueueFlags(cb_node.get(), "vkCmdFillBuffer()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
ziga-lunarg3c5c84e2021-08-04 15:18:56 +02006539 "VUID-vkCmdFillBuffer-commandBuffer-00030");
6540 }
6541
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006542 return skip;
6543}
6544
sfricke-samsung71f04e32022-03-16 01:21:21 -05006545template <typename RegionType>
6546bool CoreChecks::ValidateBufferImageCopyData(const CMD_BUFFER_STATE *cb_node, uint32_t regionCount, const RegionType *pRegions,
6547 const IMAGE_STATE *image_state, const char *function, CMD_TYPE cmd_type,
6548 bool image_to_buffer) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006549 bool skip = false;
Tony Barbour845d29b2021-11-09 11:43:14 -07006550 const bool is_2 = (cmd_type == CMD_COPYBUFFERTOIMAGE2KHR || cmd_type == CMD_COPYBUFFERTOIMAGE2);
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07006551 const char *vuid;
Jeff Leger178b1e52020-10-05 12:22:23 -04006552
sfricke-samsung125d2b42020-05-28 06:32:43 -07006553 assert(image_state != nullptr);
6554 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006555
6556 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006557 const RegionType region = pRegions[i];
6558 const VkImageAspectFlags region_aspect_mask = region.imageSubresource.aspectMask;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006559 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006560 if ((region.imageOffset.y != 0) || (region.imageExtent.height != 1)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006561 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00199", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006562 "%s: pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
6563 "and 1, respectively.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006564 function, i, region.imageOffset.y, region.imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006565 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006566 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006567
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006568 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006569 if ((region.imageOffset.z != 0) || (region.imageExtent.depth != 1)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006570 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00201", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006571 "%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 -07006572 "must be 0 and 1, respectively.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006573 function, i, region.imageOffset.z, region.imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006574 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006575 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006576
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006577 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006578 if ((0 != region.imageSubresource.baseArrayLayer) || (1 != region.imageSubresource.layerCount)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006579 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00213", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006580 "%s: pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006581 "For 3D images these must be 0 and 1, respectively.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006582 function, i, region.imageSubresource.baseArrayLayer, region.imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006583 }
6584 }
6585
6586 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07006587 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
sfricke-samsung73e755c2021-09-30 08:34:57 -07006588 const uint32_t element_size =
6589 FormatIsDepthOrStencil(image_format) ? 0 : FormatElementSize(image_format, region_aspect_mask);
sfricke-samsung71f04e32022-03-16 01:21:21 -05006590 const VkDeviceSize bufferOffset = region.bufferOffset;
Locke497739c2019-03-08 11:50:47 -07006591
sfricke-samsung8feecc12021-01-23 03:28:38 -08006592 if (FormatIsDepthOrStencil(image_format)) {
6593 if (SafeModulo(bufferOffset, 4) != 0) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006594 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("04053", image_to_buffer, is_2),
sfricke-samsung8feecc12021-01-23 03:28:38 -08006595 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6596 " must be a multiple 4 if using a depth/stencil format (%s).",
6597 function, i, bufferOffset, string_VkFormat(image_format));
6598 }
6599 } else {
6600 // If not depth/stencil and not multi-plane
6601 if (!FormatIsMultiplane(image_format) && (SafeModulo(bufferOffset, element_size) != 0)) {
sfricke-samsung45996a42021-09-16 13:45:27 -07006602 vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
Tony Barbour845d29b2021-11-09 11:43:14 -07006603 ? GetBufferImageCopyCommandVUID("01558", image_to_buffer, is_2)
6604 : GetBufferImageCopyCommandVUID("00193", image_to_buffer, is_2);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006605 skip |= LogError(image_state->image(), vuid,
sfricke-samsung8feecc12021-01-23 03:28:38 -08006606 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6607 " must be a multiple of this format's texel size (%" PRIu32 ").",
6608 function, i, bufferOffset, element_size);
6609 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006610 }
6611
sfricke-samsung5f11b0e2022-03-22 14:12:15 -05006612 // Make sure not a empty region
6613 if (region.imageExtent.width == 0) {
6614 vuid = is_2 ? "VUID-VkBufferImageCopy2-imageExtent-06659" : "VUID-VkBufferImageCopy-imageExtent-06659";
6615 LogObjectList objlist(cb_node->commandBuffer());
6616 objlist.add(image_state->image());
6617 skip |=
6618 LogError(objlist, vuid, "%s: pRegion[%" PRIu32 "] extent.width must not be zero as empty copies are not allowed.",
6619 function, i);
6620 }
6621 if (region.imageExtent.height == 0) {
6622 vuid = is_2 ? "VUID-VkBufferImageCopy2-imageExtent-06660" : "VUID-VkBufferImageCopy-imageExtent-06660";
6623 LogObjectList objlist(cb_node->commandBuffer());
6624 objlist.add(image_state->image());
6625 skip |=
6626 LogError(objlist, vuid, "%s: pRegion[%" PRIu32 "] extent.height must not be zero as empty copies are not allowed.",
6627 function, i);
6628 }
6629 if (region.imageExtent.depth == 0) {
6630 vuid = is_2 ? "VUID-VkBufferImageCopy2-imageExtent-06661" : "VUID-VkBufferImageCopy-imageExtent-06661";
6631 LogObjectList objlist(cb_node->commandBuffer());
6632 objlist.add(image_state->image());
6633 skip |=
6634 LogError(objlist, vuid, "%s: pRegion[%" PRIu32 "] extent.depth must not be zero as empty copies are not allowed.",
6635 function, i);
6636 }
6637
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006638 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
sfricke-samsung71f04e32022-03-16 01:21:21 -05006639 if ((region.bufferRowLength != 0) && (region.bufferRowLength < region.imageExtent.width)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006640 vuid = (is_2) ? "VUID-VkBufferImageCopy2-bufferRowLength-00195" : "VUID-VkBufferImageCopy-bufferRowLength-00195";
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06006641 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006642 LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006643 "%s: pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006644 function, i, region.bufferRowLength, region.imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006645 }
6646
6647 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
sfricke-samsung71f04e32022-03-16 01:21:21 -05006648 if ((region.bufferImageHeight != 0) && (region.bufferImageHeight < region.imageExtent.height)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006649 vuid = (is_2) ? "VUID-VkBufferImageCopy2-bufferImageHeight-00196" : "VUID-VkBufferImageCopy-bufferImageHeight-00196";
Jeff Leger178b1e52020-10-05 12:22:23 -04006650 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006651 LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006652 "%s: pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006653 function, i, region.bufferImageHeight, region.imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006654 }
6655
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006656 // Calculate adjusted image extent, accounting for multiplane image factors
sfricke-samsung71f04e32022-03-16 01:21:21 -05006657 VkExtent3D adjusted_image_extent = image_state->GetSubresourceExtent(region.imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006658 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
sfricke-samsung71f04e32022-03-16 01:21:21 -05006659 if ((region.imageOffset.x < 0) || (region.imageOffset.x > static_cast<int32_t>(adjusted_image_extent.width)) ||
6660 ((region.imageOffset.x + static_cast<int32_t>(region.imageExtent.width)) >
Mark Lobodzinski72b1a222020-03-18 11:36:10 -06006661 static_cast<int32_t>(adjusted_image_extent.width))) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006662 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00197", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006663 "%s: Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006664 "zero or <= image subresource width (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006665 function, i, region.imageOffset.x, (region.imageOffset.x + region.imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006666 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006667 }
6668
6669 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
sfricke-samsung71f04e32022-03-16 01:21:21 -05006670 if ((region.imageOffset.y < 0) || (region.imageOffset.y > static_cast<int32_t>(adjusted_image_extent.height)) ||
6671 ((region.imageOffset.y + static_cast<int32_t>(region.imageExtent.height)) >
Mark Lobodzinski72b1a222020-03-18 11:36:10 -06006672 static_cast<int32_t>(adjusted_image_extent.height))) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006673 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00198", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006674 "%s: Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006675 "zero or <= image subresource height (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006676 function, i, region.imageOffset.y, (region.imageOffset.y + region.imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006677 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006678 }
6679
6680 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
sfricke-samsung71f04e32022-03-16 01:21:21 -05006681 if ((region.imageOffset.z < 0) || (region.imageOffset.z > static_cast<int32_t>(adjusted_image_extent.depth)) ||
6682 ((region.imageOffset.z + static_cast<int32_t>(region.imageExtent.depth)) >
Mark Lobodzinski72b1a222020-03-18 11:36:10 -06006683 static_cast<int32_t>(adjusted_image_extent.depth))) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006684 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00200", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006685 "%s: Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006686 "zero or <= image subresource depth (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006687 function, i, region.imageOffset.z, (region.imageOffset.z + region.imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006688 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006689 }
6690
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006691 // subresource aspectMask must have exactly 1 bit set
6692 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
sfricke-samsung125d2b42020-05-28 06:32:43 -07006693 std::bitset<num_bits> aspect_mask_bits(region_aspect_mask);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006694 if (aspect_mask_bits.count() != 1) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006695 vuid = (is_2) ? "VUID-VkBufferImageCopy2-aspectMask-00212" : "VUID-VkBufferImageCopy-aspectMask-00212";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006696 skip |= LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006697 "%s: aspectMasks for imageSubresource in pRegion[%d] must have only a single bit set.", function, i);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006698 }
6699
6700 // image subresource aspect bit must match format
sfricke-samsung125d2b42020-05-28 06:32:43 -07006701 if (!VerifyAspectsPresent(region_aspect_mask, image_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006702 skip |=
Tony Barbour845d29b2021-11-09 11:43:14 -07006703 LogError(image_state->image(), GetBufferImageCopyCommandVUID("00211", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006704 "%s: pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
6705 function, i, region_aspect_mask, image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006706 }
6707
6708 // Checks that apply only to compressed images
sfricke-samsung01da6312021-10-20 07:51:32 -07006709 if (FormatIsBlockedImage(image_format)) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006710 auto block_size = FormatTexelBlockExtent(image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006711
6712 // BufferRowLength must be a multiple of block width
sfricke-samsung71f04e32022-03-16 01:21:21 -05006713 if (SafeModulo(region.bufferRowLength, block_size.width) != 0) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006714 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00203", image_to_buffer, is_2),
sfricke-samsung01da6312021-10-20 07:51:32 -07006715 "%s: pRegion[%d] bufferRowLength (%d) must be a multiple of the blocked image's texel width (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006716 function, i, region.bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006717 }
6718
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006719 // BufferRowHeight must be a multiple of block height
sfricke-samsung71f04e32022-03-16 01:21:21 -05006720 if (SafeModulo(region.bufferImageHeight, block_size.height) != 0) {
sfricke-samsung01da6312021-10-20 07:51:32 -07006721 skip |=
Tony Barbour845d29b2021-11-09 11:43:14 -07006722 LogError(image_state->image(), GetBufferImageCopyCommandVUID("00204", image_to_buffer, is_2),
sfricke-samsung01da6312021-10-20 07:51:32 -07006723 "%s: pRegion[%d] bufferImageHeight (%d) must be a multiple of the blocked image's texel height (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006724 function, i, region.bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006725 }
6726
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006727 // image offsets must be multiples of block dimensions
sfricke-samsung71f04e32022-03-16 01:21:21 -05006728 if ((SafeModulo(region.imageOffset.x, block_size.width) != 0) ||
6729 (SafeModulo(region.imageOffset.y, block_size.height) != 0) ||
6730 (SafeModulo(region.imageOffset.z, block_size.depth) != 0)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006731 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00205", image_to_buffer, is_2),
sfricke-samsung01da6312021-10-20 07:51:32 -07006732 "%s: pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the blocked image's texel "
Petr Krausb0d5e592021-05-21 23:37:11 +02006733 "width & height (%d, %d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006734 function, i, region.imageOffset.x, region.imageOffset.y, block_size.width, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006735 }
6736
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006737 // bufferOffset must be a multiple of block size (linear bytes)
sfricke-samsung73e755c2021-09-30 08:34:57 -07006738 if (SafeModulo(bufferOffset, element_size) != 0) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006739 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00206", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006740 "%s: pRegion[%d] bufferOffset (0x%" PRIxLEAST64
sfricke-samsung01da6312021-10-20 07:51:32 -07006741 ") must be a multiple of the blocked image's texel block size (%" PRIu32 ").",
sfricke-samsung73e755c2021-09-30 08:34:57 -07006742 function, i, bufferOffset, element_size);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006743 }
Dave Houlton67e9b532017-03-02 17:00:10 -07006744
6745 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
sfricke-samsung71f04e32022-03-16 01:21:21 -05006746 VkExtent3D mip_extent = image_state->GetSubresourceExtent(region.imageSubresource);
6747 if ((SafeModulo(region.imageExtent.width, block_size.width) != 0) &&
6748 (region.imageExtent.width + region.imageOffset.x != mip_extent.width)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006749 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00207", image_to_buffer, is_2),
sfricke-samsung01da6312021-10-20 07:51:32 -07006750 "%s: pRegion[%d] extent width (%d) must be a multiple of the blocked texture block width "
Petr Krausb0d5e592021-05-21 23:37:11 +02006751 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006752 function, i, region.imageExtent.width, block_size.width, region.imageOffset.x, mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07006753 }
6754
6755 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
sfricke-samsung71f04e32022-03-16 01:21:21 -05006756 if ((SafeModulo(region.imageExtent.height, block_size.height) != 0) &&
6757 (region.imageExtent.height + region.imageOffset.y != mip_extent.height)) {
6758 skip |=
6759 LogError(image_state->image(), GetBufferImageCopyCommandVUID("00208", image_to_buffer, is_2),
6760 "%s: pRegion[%d] extent height (%d) must be a multiple of the blocked texture block height "
6761 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d).",
6762 function, i, region.imageExtent.height, block_size.height, region.imageOffset.y, mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07006763 }
6764
6765 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
sfricke-samsung71f04e32022-03-16 01:21:21 -05006766 if ((SafeModulo(region.imageExtent.depth, block_size.depth) != 0) &&
6767 (region.imageExtent.depth + region.imageOffset.z != mip_extent.depth)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006768 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00209", image_to_buffer, is_2),
sfricke-samsung01da6312021-10-20 07:51:32 -07006769 "%s: pRegion[%d] extent width (%d) must be a multiple of the blocked texture block depth "
Petr Krausb0d5e592021-05-21 23:37:11 +02006770 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006771 function, i, region.imageExtent.depth, block_size.depth, region.imageOffset.z, mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07006772 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006773 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08006774
6775 // Checks that apply only to multi-planar format images
sfricke-samsung125d2b42020-05-28 06:32:43 -07006776 if (FormatIsMultiplane(image_format)) {
sfricke-samsung552d5e12020-01-07 22:00:20 -08006777 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
sfricke-samsung125d2b42020-05-28 06:32:43 -07006778 if ((FormatPlaneCount(image_format) < 3) && (region_aspect_mask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006779 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006780 "%s: pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006781 "format has three planes.",
6782 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08006783 }
6784
6785 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
sfricke-samsung125d2b42020-05-28 06:32:43 -07006786 if (0 ==
6787 (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 -07006788 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006789 "%s: pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006790 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
6791 function, i);
sfricke-samsung125d2b42020-05-28 06:32:43 -07006792 } else {
6793 // Know aspect mask is valid
6794 const VkFormat compatible_format = FindMultiplaneCompatibleFormat(image_format, region_aspect_mask);
6795 const uint32_t compatible_size = FormatElementSize(compatible_format);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006796 if (SafeModulo(bufferOffset, compatible_size) != 0) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006797 skip |= LogError(
Tony Barbour845d29b2021-11-09 11:43:14 -07006798 image_state->image(), GetBufferImageCopyCommandVUID("01559", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006799 "%s: pRegion[%d]->bufferOffset is 0x%" PRIxLEAST64
sfricke-samsung125d2b42020-05-28 06:32:43 -07006800 " 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 -08006801 function, i, bufferOffset, element_size, GetPlaneIndex(region_aspect_mask),
sfricke-samsung125d2b42020-05-28 06:32:43 -07006802 string_VkFormat(compatible_format));
6803 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08006804 }
6805 }
sfricke-samsung8feecc12021-01-23 03:28:38 -08006806
6807 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
Jeremy Gebbencd7fa282021-10-27 10:25:32 -06006808 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool;
sfricke-samsung8feecc12021-01-23 03:28:38 -08006809 assert(command_pool != nullptr);
6810 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006811 const VkQueueFlags queue_flags = physical_device_state->queue_family_properties[queue_family_index].queueFlags;
sfricke-samsung8feecc12021-01-23 03:28:38 -08006812 if (((queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT)) == 0) && (SafeModulo(bufferOffset, 4) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006813 LogObjectList objlist(cb_node->commandBuffer());
6814 objlist.add(command_pool->commandPool());
sfricke-samsung4389faa2022-03-23 01:19:42 -05006815 objlist.add(image_state->image());
6816 skip |= LogError(objlist, GetBufferImageCopyCommandVUID("04052", image_to_buffer, is_2),
sfricke-samsung8feecc12021-01-23 03:28:38 -08006817 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6818 " must be a multiple 4 because the command buffer %s was allocated from the command pool %s "
6819 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT or "
6820 "VK_QUEUE_COMPUTE_BIT flag.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006821 function, i, bufferOffset, report_data->FormatHandle(cb_node->commandBuffer()).c_str(),
6822 report_data->FormatHandle(command_pool->commandPool()).c_str(), queue_family_index);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006823 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006824 }
6825
6826 return skip;
6827}
6828
sfricke-samsung71f04e32022-03-16 01:21:21 -05006829template <typename RegionType>
6830bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount, const RegionType *pRegions,
6831 const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006832 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006833 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006834
6835 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006836 const RegionType region = pRegions[i];
6837 VkExtent3D extent = region.imageExtent;
6838 VkOffset3D offset = region.imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006839
sfricke-samsung71f04e32022-03-16 01:21:21 -05006840 VkExtent3D image_extent = image_state->GetSubresourceExtent(region.imageSubresource);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006841
sfricke-samsung01da6312021-10-20 07:51:32 -07006842 // If we're using a blocked image format, valid extent is rounded up to multiple of block size (per
6843 // vkspec.html#_common_operation)
6844 if (FormatIsBlockedImage(image_info->format)) {
Dave Houltona585d132019-01-18 13:05:42 -07006845 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006846 if (image_extent.width % block_extent.width) {
6847 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
6848 }
6849 if (image_extent.height % block_extent.height) {
6850 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
6851 }
6852 if (image_extent.depth % block_extent.depth) {
6853 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
6854 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006855 }
6856
Dave Houltonfc1a4052017-04-27 14:32:45 -06006857 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Petr Krausb0d5e592021-05-21 23:37:11 +02006858 skip |= LogError(image_state->image(), msg_code, "%s: pRegion[%d] exceeds image bounds.", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006859 }
6860 }
6861
6862 return skip;
6863}
6864
sfricke-samsung71f04e32022-03-16 01:21:21 -05006865template <typename RegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006866bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
sfricke-samsung71f04e32022-03-16 01:21:21 -05006867 const RegionType *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006868 bool skip = false;
6869
sfricke-samsung11d15ba2021-09-30 09:19:56 -07006870 const VkDeviceSize buffer_size = buff_state->createInfo.size;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006871
6872 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006873 const RegionType region = pRegions[i];
6874 const VkDeviceSize buffer_copy_size = GetBufferSizeFromCopyImage(region, image_state->createInfo.format);
sfricke-samsung11d15ba2021-09-30 09:19:56 -07006875 // This blocks against invalid VkBufferCopyImage that already have been caught elsewhere
6876 if (buffer_copy_size != 0) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006877 const VkDeviceSize max_buffer_copy = buffer_copy_size + region.bufferOffset;
sfricke-samsung11d15ba2021-09-30 09:19:56 -07006878 if (buffer_size < max_buffer_copy) {
6879 skip |= LogError(device, msg_code,
6880 "%s: pRegion[%" PRIu32 "] is trying to copy %" PRIu64 " bytes plus %" PRIu64
6881 " offset to/from the VkBuffer (%s) which exceeds the VkBuffer total size of %" PRIu64 " bytes.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006882 func_name, i, buffer_copy_size, region.bufferOffset,
sfricke-samsung11d15ba2021-09-30 09:19:56 -07006883 report_data->FormatHandle(buff_state->buffer()).c_str(), buffer_size);
6884 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006885 }
6886 }
6887
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006888 return skip;
6889}
6890
sfricke-samsung71f04e32022-03-16 01:21:21 -05006891template <typename RegionType>
Jeff Leger178b1e52020-10-05 12:22:23 -04006892bool CoreChecks::ValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
sfricke-samsung71f04e32022-03-16 01:21:21 -05006893 VkBuffer dstBuffer, uint32_t regionCount, const RegionType *pRegions,
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006894
6895 CMD_TYPE cmd_type) const {
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07006896 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07006897 auto src_image_state = Get<IMAGE_STATE>(srcImage);
6898 auto dst_buffer_state = Get<BUFFER_STATE>(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006899
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006900 const bool is_2 = (cmd_type == CMD_COPYIMAGETOBUFFER2KHR || cmd_type == CMD_COPYIMAGETOBUFFER2);
sfricke-samsung85584a72021-09-30 21:43:38 -07006901 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04006902 const char *vuid;
6903
Tony Barbour845d29b2021-11-09 11:43:14 -07006904 bool skip = ValidateBufferImageCopyData(cb_node.get(), regionCount, pRegions, src_image_state.get(), func_name, cmd_type, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006905
6906 // Validate command buffer state
Jeremy Gebben9f537102021-10-05 16:37:12 -06006907 skip |= ValidateCmd(cb_node.get(), cmd_type);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006908
6909 // Command pool must support graphics, compute, or transfer operations
Jeremy Gebbencd7fa282021-10-27 10:25:32 -06006910 const auto pool = cb_node->command_pool;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006911
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006912 VkQueueFlags queue_flags = physical_device_state->queue_family_properties[pool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07006913
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006914 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006915 vuid = is_2 ? "VUID-vkCmdCopyImageToBuffer2-commandBuffer-cmdpool" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool";
Jeff Leger178b1e52020-10-05 12:22:23 -04006916 skip |= LogError(cb_node->createInfo.commandPool, vuid,
6917 "Cannot call %s on a command buffer allocated from a pool without graphics, compute, "
6918 "or transfer capabilities.",
6919 func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006920 }
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006921
6922 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-pRegions-00182" : "VUID-vkCmdCopyImageToBuffer-pRegions-06220";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006923 skip |= ValidateImageBounds(src_image_state.get(), regionCount, pRegions, func_name, vuid);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006924 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-pRegions-00183" : "VUID-vkCmdCopyImageToBuffer-pRegions-00183";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006925 skip |= ValidateBufferBounds(src_image_state.get(), dst_buffer_state.get(), regionCount, pRegions, func_name, vuid);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006926
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006927 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImage-00188" : "VUID-vkCmdCopyImageToBuffer-srcImage-00188";
6928 std::string location = func_name;
6929 location.append("() : srcImage");
6930 skip |= ValidateImageSampleCount(src_image_state.get(), VK_SAMPLE_COUNT_1_BIT, location.c_str(), vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04006931
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006932 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImage-00187" : "VUID-vkCmdCopyImageToBuffer-srcImage-00187";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006933 skip |= ValidateMemoryIsBoundToImage(src_image_state.get(), func_name, vuid);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006934 vuid = is_2 ? "vkCmdCopyImageToBuffer-dstBuffer2-00192" : "vkCmdCopyImageToBuffer dstBuffer-00192";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006935 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state.get(), func_name, vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006936
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006937 // Validate that SRC image & DST buffer have correct usage flags set
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006938 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImage-00186" : "VUID-vkCmdCopyImageToBuffer-srcImage-00186";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006939 skip |= ValidateImageUsageFlags(src_image_state.get(), VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006940 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006941 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-dstBuffer-00191" : "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006942 skip |= ValidateBufferUsageFlags(dst_buffer_state.get(), VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006943 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006944 vuid = is_2 ? "VUID-vkCmdCopyImageToBuffer2-commandBuffer-01831" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01831";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006945 skip |= ValidateProtectedImage(cb_node.get(), src_image_state.get(), func_name, vuid);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006946 vuid = is_2 ? "VUID-vkCmdCopyImageToBuffer2-commandBuffer-01832" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01832";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006947 skip |= ValidateProtectedBuffer(cb_node.get(), dst_buffer_state.get(), func_name, vuid);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006948 vuid = is_2 ? "VUID-vkCmdCopyImageToBuffer2-commandBuffer-01833" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01833";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006949 skip |= ValidateUnprotectedBuffer(cb_node.get(), dst_buffer_state.get(), func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006950
6951 // Validation for VK_EXT_fragment_density_map
6952 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006953 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImage-02544" : "VUID-vkCmdCopyImageToBuffer-srcImage-02544";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006954 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006955 "%s: srcImage must not have been created with flags containing "
6956 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
6957 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006958 }
6959
sfricke-samsung45996a42021-09-16 13:45:27 -07006960 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006961 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImage-01998" : "VUID-vkCmdCopyImageToBuffer-srcImage-01998";
6962 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(), VK_FORMAT_FEATURE_2_TRANSFER_SRC_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04006963 }
Tobin Ehlisc8266452017-04-07 12:20:30 -06006964 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04006965
sfricke-samsung45996a42021-09-16 13:45:27 -07006966 const char *src_invalid_layout_vuid =
6967 (src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006968 ? (vuid =
6969 is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImageLayout-01397" : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397")
6970 : (vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImageLayout-00190"
6971 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190");
Jeff Leger178b1e52020-10-05 12:22:23 -04006972
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006973 for (uint32_t i = 0; i < regionCount; ++i) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006974 const RegionType region = pRegions[i];
6975 skip |= ValidateImageSubresourceLayers(cb_node.get(), &region.imageSubresource, func_name, "imageSubresource", i);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006976 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImageLayout-00189" : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189";
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06006977 skip |= VerifyImageLayout(*cb_node, *src_image_state, region.imageSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04006978 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, src_invalid_layout_vuid, vuid, &hit_error);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006979 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-imageOffset-01794" : "VUID-vkCmdCopyImageToBuffer-imageOffset-01794";
sfricke-samsung71f04e32022-03-16 01:21:21 -05006980 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node.get(), src_image_state.get(), &region, i, func_name,
6981 vuid);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006982 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-imageSubresource-01703" : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703";
sfricke-samsung71f04e32022-03-16 01:21:21 -05006983 skip |= ValidateImageMipLevel(cb_node.get(), src_image_state.get(), region.imageSubresource.mipLevel, i, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04006984 "imageSubresource", vuid);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006985 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-imageSubresource-01704" : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704";
sfricke-samsung71f04e32022-03-16 01:21:21 -05006986 skip |= ValidateImageArrayLayerRange(cb_node.get(), src_image_state.get(), region.imageSubresource.baseArrayLayer,
6987 region.imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006988 }
6989 return skip;
6990}
6991
Jeff Leger178b1e52020-10-05 12:22:23 -04006992bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6993 VkBuffer dstBuffer, uint32_t regionCount,
6994 const VkBufferImageCopy *pRegions) const {
6995 return ValidateCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions,
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006996 CMD_COPYIMAGETOBUFFER);
Jeff Leger178b1e52020-10-05 12:22:23 -04006997}
6998
6999bool CoreChecks::PreCallValidateCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
7000 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) const {
7001 return ValidateCmdCopyImageToBuffer(commandBuffer, pCopyImageToBufferInfo->srcImage, pCopyImageToBufferInfo->srcImageLayout,
7002 pCopyImageToBufferInfo->dstBuffer, pCopyImageToBufferInfo->regionCount,
Tony-LunarGaf3632a2021-11-10 15:51:57 -07007003 pCopyImageToBufferInfo->pRegions, CMD_COPYIMAGETOBUFFER2KHR);
Jeff Leger178b1e52020-10-05 12:22:23 -04007004}
7005
Tony Barbour845d29b2021-11-09 11:43:14 -07007006bool CoreChecks::PreCallValidateCmdCopyImageToBuffer2(VkCommandBuffer commandBuffer,
7007 const VkCopyImageToBufferInfo2 *pCopyImageToBufferInfo) const {
7008 return ValidateCmdCopyImageToBuffer(commandBuffer, pCopyImageToBufferInfo->srcImage, pCopyImageToBufferInfo->srcImageLayout,
7009 pCopyImageToBufferInfo->dstBuffer, pCopyImageToBufferInfo->regionCount,
Tony-LunarGaf3632a2021-11-10 15:51:57 -07007010 pCopyImageToBufferInfo->pRegions, CMD_COPYIMAGETOBUFFER2);
Tony Barbour845d29b2021-11-09 11:43:14 -07007011}
7012
John Zulauf1686f232019-07-09 16:27:11 -06007013void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
7014 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
7015 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
7016
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07007017 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06007018 auto src_image_state = Get<IMAGE_STATE>(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06007019 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07007020 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06007021 cb_node->SetImageInitialLayout(*src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06007022 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07007023}
7024
Jeff Leger178b1e52020-10-05 12:22:23 -04007025void CoreChecks::PreCallRecordCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
7026 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) {
7027 StateTracker::PreCallRecordCmdCopyImageToBuffer2KHR(commandBuffer, pCopyImageToBufferInfo);
7028
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07007029 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06007030 auto src_image_state = Get<IMAGE_STATE>(pCopyImageToBufferInfo->srcImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04007031 // Make sure that all image slices record referenced layout
7032 for (uint32_t i = 0; i < pCopyImageToBufferInfo->regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06007033 cb_node->SetImageInitialLayout(*src_image_state, pCopyImageToBufferInfo->pRegions[i].imageSubresource,
7034 pCopyImageToBufferInfo->srcImageLayout);
Jeff Leger178b1e52020-10-05 12:22:23 -04007035 }
7036}
7037
Tony-LunarGaf3632a2021-11-10 15:51:57 -07007038void CoreChecks::PreCallRecordCmdCopyImageToBuffer2(VkCommandBuffer commandBuffer,
7039 const VkCopyImageToBufferInfo2 *pCopyImageToBufferInfo) {
7040 StateTracker::PreCallRecordCmdCopyImageToBuffer2(commandBuffer, pCopyImageToBufferInfo);
7041
7042 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
7043 auto src_image_state = Get<IMAGE_STATE>(pCopyImageToBufferInfo->srcImage);
7044 // Make sure that all image slices record referenced layout
7045 for (uint32_t i = 0; i < pCopyImageToBufferInfo->regionCount; ++i) {
7046 cb_node->SetImageInitialLayout(*src_image_state, pCopyImageToBufferInfo->pRegions[i].imageSubresource,
7047 pCopyImageToBufferInfo->srcImageLayout);
7048 }
7049}
7050
Jeff Leger178b1e52020-10-05 12:22:23 -04007051template <typename RegionType>
7052bool CoreChecks::ValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
7053 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
Tony Barbour845d29b2021-11-09 11:43:14 -07007054 CMD_TYPE cmd_type) const {
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07007055 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07007056 auto src_buffer_state = Get<BUFFER_STATE>(srcBuffer);
7057 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07007058
Tony Barbour845d29b2021-11-09 11:43:14 -07007059 const bool is_2 = (cmd_type == CMD_COPYBUFFERTOIMAGE2KHR || cmd_type == CMD_COPYBUFFERTOIMAGE2);
sfricke-samsung85584a72021-09-30 21:43:38 -07007060 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04007061 const char *vuid;
7062
Tony Barbour845d29b2021-11-09 11:43:14 -07007063 bool skip =
7064 ValidateBufferImageCopyData(cb_node.get(), regionCount, pRegions, dst_image_state.get(), func_name, cmd_type, false);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07007065
7066 // Validate command buffer state
Jeremy Gebben9f537102021-10-05 16:37:12 -06007067 skip |= ValidateCmd(cb_node.get(), cmd_type);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07007068
Tony Barbour845d29b2021-11-09 11:43:14 -07007069 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-pRegions-00172" : "VUID-vkCmdCopyBufferToImage-pRegions-06217";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007070 skip |= ValidateImageBounds(dst_image_state.get(), regionCount, pRegions, func_name, vuid);
Tony Barbour845d29b2021-11-09 11:43:14 -07007071 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-pRegions-00171" : "VUID-vkCmdCopyBufferToImage-pRegions-00171";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007072 skip |= ValidateBufferBounds(dst_image_state.get(), src_buffer_state.get(), regionCount, pRegions, func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04007073
Tony Barbour845d29b2021-11-09 11:43:14 -07007074 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImage-00179" : "VUID-vkCmdCopyBufferToImage-dstImage-00179";
7075 std::string location = func_name;
7076 location.append("() : dstImage");
7077 skip |= ValidateImageSampleCount(dst_image_state.get(), VK_SAMPLE_COUNT_1_BIT, location.c_str(), vuid);
7078 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-srcBuffer-00176" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00176";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007079 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state.get(), func_name, vuid);
Tony Barbour845d29b2021-11-09 11:43:14 -07007080 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImage-00178" : "VUID-vkCmdCopyBufferToImage-dstImage-00178";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007081 skip |= ValidateMemoryIsBoundToImage(dst_image_state.get(), func_name, vuid);
Tony Barbour845d29b2021-11-09 11:43:14 -07007082 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-srcBuffer-00174" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00174";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007083 skip |= ValidateBufferUsageFlags(src_buffer_state.get(), VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06007084 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Tony Barbour845d29b2021-11-09 11:43:14 -07007085 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImage-00177" : "VUID-vkCmdCopyBufferToImage-dstImage-00177";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007086 skip |= ValidateImageUsageFlags(dst_image_state.get(), VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06007087 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Tony Barbour845d29b2021-11-09 11:43:14 -07007088 vuid = is_2 ? "VUID-vkCmdCopyBufferToImage2-commandBuffer-01828" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01828";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007089 skip |= ValidateProtectedBuffer(cb_node.get(), src_buffer_state.get(), func_name, vuid);
Tony Barbour845d29b2021-11-09 11:43:14 -07007090 vuid = is_2 ? "VUID-vkCmdCopyBufferToImage2-commandBuffer-01829" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01829";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007091 skip |= ValidateProtectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
Tony Barbour845d29b2021-11-09 11:43:14 -07007092 vuid = is_2 ? "VUID-vkCmdCopyBufferToImage-commandBuffer-01830" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01830";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007093 skip |= ValidateUnprotectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02007094
7095 // Validation for VK_EXT_fragment_density_map
7096 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony Barbour845d29b2021-11-09 11:43:14 -07007097 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImage-02543" : "VUID-vkCmdCopyBufferToImage-dstImage-02543";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06007098 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04007099 "%s: dstImage must not have been created with flags containing "
7100 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
7101 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02007102 }
7103
sfricke-samsung45996a42021-09-16 13:45:27 -07007104 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07007105 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImage-01997" : "VUID-vkCmdCopyBufferToImage-dstImage-01997";
7106 skip |= ValidateImageFormatFeatureFlags(dst_image_state.get(), VK_FORMAT_FEATURE_2_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04007107 }
Tobin Ehlisc8266452017-04-07 12:20:30 -06007108 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04007109
sfricke-samsung45996a42021-09-16 13:45:27 -07007110 const char *dst_invalid_layout_vuid =
7111 (dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Tony Barbour845d29b2021-11-09 11:43:14 -07007112 ? (is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImageLayout-01396"
sfricke-samsung45996a42021-09-16 13:45:27 -07007113 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396")
Tony Barbour845d29b2021-11-09 11:43:14 -07007114 : (is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImageLayout-00181"
sfricke-samsung45996a42021-09-16 13:45:27 -07007115 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181");
Jeff Leger178b1e52020-10-05 12:22:23 -04007116
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07007117 for (uint32_t i = 0; i < regionCount; ++i) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05007118 const RegionType region = pRegions[i];
7119 skip |= ValidateImageSubresourceLayers(cb_node.get(), &region.imageSubresource, func_name, "imageSubresource", i);
Tony Barbour845d29b2021-11-09 11:43:14 -07007120 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImageLayout-00180" : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180";
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06007121 skip |= VerifyImageLayout(*cb_node, *dst_image_state, region.imageSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04007122 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, dst_invalid_layout_vuid, vuid, &hit_error);
Tony Barbour845d29b2021-11-09 11:43:14 -07007123 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-imageOffset-01793" : "VUID-vkCmdCopyBufferToImage-imageOffset-01793";
sfricke-samsung71f04e32022-03-16 01:21:21 -05007124 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node.get(), dst_image_state.get(), &region, i, func_name,
7125 vuid);
Tony Barbour845d29b2021-11-09 11:43:14 -07007126 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-imageSubresource-01701" : "VUID-vkCmdCopyBufferToImage-imageSubresource-01701";
sfricke-samsung71f04e32022-03-16 01:21:21 -05007127 skip |= ValidateImageMipLevel(cb_node.get(), dst_image_state.get(), region.imageSubresource.mipLevel, i, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04007128 "imageSubresource", vuid);
Tony Barbour845d29b2021-11-09 11:43:14 -07007129 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-imageSubresource-01702" : "VUID-vkCmdCopyBufferToImage-imageSubresource-01702";
sfricke-samsung71f04e32022-03-16 01:21:21 -05007130 skip |= ValidateImageArrayLayerRange(cb_node.get(), dst_image_state.get(), region.imageSubresource.baseArrayLayer,
7131 region.imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
sfricke-samsungea4fd142020-10-17 23:51:59 -07007132
7133 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
Jeremy Gebbencd7fa282021-10-27 10:25:32 -06007134 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool;
sfricke-samsungea4fd142020-10-17 23:51:59 -07007135 assert(command_pool != nullptr);
7136 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06007137 const VkQueueFlags queue_flags = physical_device_state->queue_family_properties[queue_family_index].queueFlags;
sfricke-samsung71f04e32022-03-16 01:21:21 -05007138 const VkImageAspectFlags region_aspect_mask = region.imageSubresource.aspectMask;
sfricke-samsungea4fd142020-10-17 23:51:59 -07007139 if (((queue_flags & VK_QUEUE_GRAPHICS_BIT) == 0) &&
7140 ((region_aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06007141 LogObjectList objlist(cb_node->commandBuffer());
7142 objlist.add(command_pool->commandPool());
sfricke-samsung4389faa2022-03-23 01:19:42 -05007143 objlist.add(dst_image_state->image());
Tony Barbour845d29b2021-11-09 11:43:14 -07007144 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-commandBuffer-04477"
sfricke-samsungea4fd142020-10-17 23:51:59 -07007145 : "VUID-vkCmdCopyBufferToImage-commandBuffer-04477";
sfricke-samsung4389faa2022-03-23 01:19:42 -05007146 skip |= LogError(objlist, vuid,
sfricke-samsungea4fd142020-10-17 23:51:59 -07007147 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies VK_IMAGE_ASPECT_DEPTH_BIT or "
7148 "VK_IMAGE_ASPECT_STENCIL_BIT but the command buffer %s was allocated from the command pool %s "
7149 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT flag.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06007150 func_name, i, region_aspect_mask, report_data->FormatHandle(cb_node->commandBuffer()).c_str(),
7151 report_data->FormatHandle(command_pool->commandPool()).c_str(), queue_family_index);
sfricke-samsungea4fd142020-10-17 23:51:59 -07007152 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07007153 }
7154 return skip;
7155}
7156
Jeff Leger178b1e52020-10-05 12:22:23 -04007157bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
7158 VkImageLayout dstImageLayout, uint32_t regionCount,
7159 const VkBufferImageCopy *pRegions) const {
7160 return ValidateCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions,
Tony Barbour845d29b2021-11-09 11:43:14 -07007161 CMD_COPYBUFFERTOIMAGE);
Jeff Leger178b1e52020-10-05 12:22:23 -04007162}
7163
7164bool CoreChecks::PreCallValidateCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
7165 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo) const {
7166 return ValidateCmdCopyBufferToImage(commandBuffer, pCopyBufferToImageInfo->srcBuffer, pCopyBufferToImageInfo->dstImage,
7167 pCopyBufferToImageInfo->dstImageLayout, pCopyBufferToImageInfo->regionCount,
Tony Barbour845d29b2021-11-09 11:43:14 -07007168 pCopyBufferToImageInfo->pRegions, CMD_COPYBUFFERTOIMAGE2KHR);
7169}
7170
7171bool CoreChecks::PreCallValidateCmdCopyBufferToImage2(VkCommandBuffer commandBuffer,
7172 const VkCopyBufferToImageInfo2 *pCopyBufferToImageInfo) const {
7173 return ValidateCmdCopyBufferToImage(commandBuffer, pCopyBufferToImageInfo->srcBuffer, pCopyBufferToImageInfo->dstImage,
7174 pCopyBufferToImageInfo->dstImageLayout, pCopyBufferToImageInfo->regionCount,
7175 pCopyBufferToImageInfo->pRegions, CMD_COPYBUFFERTOIMAGE2);
Jeff Leger178b1e52020-10-05 12:22:23 -04007176}
7177
John Zulauf1686f232019-07-09 16:27:11 -06007178void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
7179 VkImageLayout dstImageLayout, uint32_t regionCount,
7180 const VkBufferImageCopy *pRegions) {
7181 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
7182
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07007183 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06007184 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06007185 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07007186 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06007187 cb_node->SetImageInitialLayout(*dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06007188 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07007189}
Mike Weiblen672b58b2017-02-21 14:32:53 -07007190
Jeff Leger178b1e52020-10-05 12:22:23 -04007191void CoreChecks::PreCallRecordCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
7192 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo2KHR) {
7193 StateTracker::PreCallRecordCmdCopyBufferToImage2KHR(commandBuffer, pCopyBufferToImageInfo2KHR);
7194
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07007195 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06007196 auto dst_image_state = Get<IMAGE_STATE>(pCopyBufferToImageInfo2KHR->dstImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04007197 // Make sure that all image slices are record referenced layout
7198 for (uint32_t i = 0; i < pCopyBufferToImageInfo2KHR->regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06007199 cb_node->SetImageInitialLayout(*dst_image_state, pCopyBufferToImageInfo2KHR->pRegions[i].imageSubresource,
7200 pCopyBufferToImageInfo2KHR->dstImageLayout);
Jeff Leger178b1e52020-10-05 12:22:23 -04007201 }
7202}
Tony Barbour845d29b2021-11-09 11:43:14 -07007203
7204void CoreChecks::PreCallRecordCmdCopyBufferToImage2(VkCommandBuffer commandBuffer,
7205 const VkCopyBufferToImageInfo2 *pCopyBufferToImageInfo) {
7206 StateTracker::PreCallRecordCmdCopyBufferToImage2(commandBuffer, pCopyBufferToImageInfo);
7207
7208 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
7209 auto dst_image_state = Get<IMAGE_STATE>(pCopyBufferToImageInfo->dstImage);
7210 // Make sure that all image slices are record referenced layout
7211 for (uint32_t i = 0; i < pCopyBufferToImageInfo->regionCount; ++i) {
7212 cb_node->SetImageInitialLayout(*dst_image_state, pCopyBufferToImageInfo->pRegions[i].imageSubresource,
7213 pCopyBufferToImageInfo->dstImageLayout);
7214 }
7215}
7216
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07007217bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05007218 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07007219 bool skip = false;
7220 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
7221
Dave Houlton1d960ff2018-01-19 12:17:05 -07007222 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07007223 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
7224 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
7225 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07007226 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
7227 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07007228 }
7229
Jeremy Gebbenf4449392022-01-28 10:09:10 -07007230 auto image_entry = Get<IMAGE_STATE>(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07007231 if (!image_entry) {
7232 return skip;
7233 }
7234
Mark Lobodzinski6f358172019-10-02 11:09:12 -06007235 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
sfricke-samsung45996a42021-09-16 13:45:27 -07007236 if (IsExtEnabled(device_extensions.vk_ext_image_drm_format_modifier)) {
Mark Lobodzinski6f358172019-10-02 11:09:12 -06007237 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
7238 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07007239 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
7240 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
7241 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06007242 }
7243 } else {
7244 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07007245 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
7246 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06007247 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07007248 }
7249
Dave Houlton1d960ff2018-01-19 12:17:05 -07007250 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07007251 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07007252 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
7253 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
7254 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07007255 }
7256
Dave Houlton1d960ff2018-01-19 12:17:05 -07007257 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07007258 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07007259 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
7260 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
7261 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07007262 }
7263
Dave Houlton1d960ff2018-01-19 12:17:05 -07007264 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07007265 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06007266 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
7267 if (FormatIsMultiplane(img_format)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08007268 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06007269 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
7270 if (FormatPlaneCount(img_format) > 2u) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08007271 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06007272 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
7273 }
7274 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07007275 skip |= LogError(image, vuid,
7276 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
7277 ") must be a single-plane specifier flag.",
7278 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06007279 }
7280 } else if (FormatIsColor(img_format)) {
7281 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
ziga-lunargcc568bc2021-09-05 13:45:45 +02007282 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04461",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07007283 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
7284 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06007285 }
7286 } else if (FormatIsDepthOrStencil(img_format)) {
Nathaniel Cesario8c80f352021-07-15 15:06:48 -06007287 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06007288 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07007289 }
ziga-lunarg4ecbd5b2021-07-15 20:48:30 +02007290 if (!FormatIsDepthAndStencil(img_format) && !FormatIsDepthOnly(img_format)) {
7291 if (sub_aspect & VK_IMAGE_ASPECT_DEPTH_BIT) {
7292 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04464",
7293 "vkGetImageSubresourceLayout(): Image format (%s) does not contain a depth component, "
7294 "but VkImageSubresource.aspectMask contains VK_IMAGE_ASPECT_DEPTH_BIT.",
7295 string_VkFormat(img_format));
7296 }
7297 } else {
7298 if ((sub_aspect & VK_IMAGE_ASPECT_DEPTH_BIT) == 0) {
7299 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04462",
7300 "vkGetImageSubresourceLayout(): Image format (%s) contains a depth component, "
7301 "but VkImageSubresource.aspectMask does not contain VK_IMAGE_ASPECT_DEPTH_BIT.",
7302 string_VkFormat(img_format));
7303 }
7304 }
7305 if (!FormatIsDepthAndStencil(img_format) && !FormatIsStencilOnly(img_format)) {
7306 if (sub_aspect & VK_IMAGE_ASPECT_STENCIL_BIT) {
7307 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04464",
7308 "vkGetImageSubresourceLayout(): Image format (%s) does not contain a stencil component, "
7309 "but VkImageSubresource.aspectMask contains VK_IMAGE_ASPECT_STENCIL_BIT.",
7310 string_VkFormat(img_format));
7311 }
7312 } else {
7313 if ((sub_aspect & VK_IMAGE_ASPECT_STENCIL_BIT) == 0) {
7314 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04463",
7315 "vkGetImageSubresourceLayout(): Image format (%s) contains a stencil component, "
7316 "but VkImageSubresource.aspectMask does not contain VK_IMAGE_ASPECT_STENCIL_BIT.",
7317 string_VkFormat(img_format));
7318 }
7319 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06007320 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
7321 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
7322 (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 +02007323 skip |= LogError(
7324 image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
7325 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask (%s) must be VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.",
7326 string_VkImageAspectFlags(sub_aspect).c_str());
7327 } else {
7328 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
7329 assert(IsExtEnabled(device_extensions.vk_ext_image_drm_format_modifier));
7330 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = LvlInitStruct<VkImageDrmFormatModifierPropertiesEXT>();
7331 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image, &drm_format_properties);
7332
7333 auto fmt_drm_props = LvlInitStruct<VkDrmFormatModifierPropertiesListEXT>();
7334 auto fmt_props_2 = LvlInitStruct<VkFormatProperties2>(&fmt_drm_props);
7335 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_entry->createInfo.format, &fmt_props_2);
7336 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties{fmt_drm_props.drmFormatModifierCount};
7337 fmt_drm_props.pDrmFormatModifierProperties = drm_properties.data();
7338 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_entry->createInfo.format, &fmt_props_2);
7339
7340 uint32_t max_plane_count = 0u;
7341
7342 for (auto const &drm_property : drm_properties) {
7343 if (drm_format_properties.drmFormatModifier == drm_property.drmFormatModifier) {
7344 max_plane_count = drm_property.drmFormatModifierPlaneCount;
7345 break;
7346 }
7347 }
7348
7349 VkImageAspectFlagBits allowed_plane_indices[] = {
7350 VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT, VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT,
7351 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT, VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT};
7352
7353 bool is_valid = false;
7354
7355 for (uint32_t i = 0u; i < max_plane_count; ++i) {
7356 if (sub_aspect == allowed_plane_indices[i]) {
7357 is_valid = true;
7358 break;
7359 }
7360 }
7361
7362 if (!is_valid) {
7363 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
7364 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask (%s) must be "
7365 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT, with i being less than the "
7366 "VkDrmFormatModifierPropertiesEXT::drmFormatModifierPlaneCount (%" PRIu32
7367 ") associated with the image's format (%s) and "
7368 "VkImageDrmFormatModifierPropertiesEXT::drmFormatModifier (%" PRIu64 ").",
7369 string_VkImageAspectFlags(sub_aspect).c_str(), max_plane_count,
7370 string_VkFormat(image_entry->createInfo.format), drm_format_properties.drmFormatModifier);
7371 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07007372 }
7373 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06007374
sfricke-samsung45996a42021-09-16 13:45:27 -07007375 if (IsExtEnabled(device_extensions.vk_android_external_memory_android_hardware_buffer)) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07007376 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06007377 }
7378
Mike Weiblen672b58b2017-02-21 14:32:53 -07007379 return skip;
7380}
sfricke-samsung022fa252020-07-24 03:26:16 -07007381
7382// Validates the image is allowed to be protected
7383bool CoreChecks::ValidateProtectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06007384 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07007385 bool skip = false;
sfricke-samsung21286f82021-11-16 08:21:46 -08007386
7387 // if driver supports protectedNoFault the operation is valid, just has undefined values
7388 if ((!phys_dev_props_core11.protectedNoFault) && (cb_state->unprotected == true) && (image_state->unprotected == false)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06007389 LogObjectList objlist(cb_state->commandBuffer());
7390 objlist.add(image_state->image());
locke-lunarg351c9d82020-10-23 14:43:21 -06007391 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 -06007392 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
7393 report_data->FormatHandle(image_state->image()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07007394 }
7395 return skip;
7396}
7397
7398// Validates the image is allowed to be unprotected
7399bool CoreChecks::ValidateUnprotectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06007400 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07007401 bool skip = false;
sfricke-samsung21286f82021-11-16 08:21:46 -08007402
7403 // if driver supports protectedNoFault the operation is valid, just has undefined values
7404 if ((!phys_dev_props_core11.protectedNoFault) && (cb_state->unprotected == false) && (image_state->unprotected == true)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06007405 LogObjectList objlist(cb_state->commandBuffer());
7406 objlist.add(image_state->image());
locke-lunarg351c9d82020-10-23 14:43:21 -06007407 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 -06007408 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
7409 report_data->FormatHandle(image_state->image()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07007410 }
7411 return skip;
7412}
7413
7414// Validates the buffer is allowed to be protected
7415bool CoreChecks::ValidateProtectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06007416 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07007417 bool skip = false;
sfricke-samsung21286f82021-11-16 08:21:46 -08007418
7419 // if driver supports protectedNoFault the operation is valid, just has undefined values
7420 if ((!phys_dev_props_core11.protectedNoFault) && (cb_state->unprotected == true) && (buffer_state->unprotected == false)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06007421 LogObjectList objlist(cb_state->commandBuffer());
7422 objlist.add(buffer_state->buffer());
locke-lunarg351c9d82020-10-23 14:43:21 -06007423 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 -06007424 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
7425 report_data->FormatHandle(buffer_state->buffer()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07007426 }
7427 return skip;
7428}
7429
7430// Validates the buffer is allowed to be unprotected
7431bool CoreChecks::ValidateUnprotectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06007432 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07007433 bool skip = false;
sfricke-samsung21286f82021-11-16 08:21:46 -08007434
7435 // if driver supports protectedNoFault the operation is valid, just has undefined values
7436 if ((!phys_dev_props_core11.protectedNoFault) && (cb_state->unprotected == false) && (buffer_state->unprotected == true)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06007437 LogObjectList objlist(cb_state->commandBuffer());
7438 objlist.add(buffer_state->buffer());
locke-lunarg351c9d82020-10-23 14:43:21 -06007439 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 -06007440 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
7441 report_data->FormatHandle(buffer_state->buffer()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07007442 }
7443 return skip;
7444}