blob: a22a99f1c5e6c0ba21fe6eb6b4527c0b0d154643 [file] [log] [blame]
Jeremy Gebben65975ed2021-10-29 11:16:10 -06001/* Copyright (c) 2015-2022 The Khronos Group Inc.
2 * Copyright (c) 2015-2022 Valve Corporation
3 * Copyright (c) 2015-2022 LunarG, Inc.
4 * Copyright (C) 2015-2022 Google Inc.
Aaron Hagan1656b2b2021-12-21 11:52:41 -05005 * Modifications Copyright (C) 2020-2022 Advanced Micro Devices, Inc. All rights reserved.
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -07006 *
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 *
19 * Author: Mark Lobodzinski <mark@lunarg.com>
Dave Houlton4eaaf3a2017-03-14 11:31:20 -060020 * Author: Dave Houlton <daveh@lunarg.com>
Shannon McPherson3ea65132018-12-05 10:37:39 -070021 * Shannon McPherson <shannon@lunarg.com>
Tobias Hector6663c9b2020-11-05 10:18:02 +000022 * Author: Tobias Hector <tobias.hector@amd.com>
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070023 */
24
Dave Houlton0d4ad6f2018-09-05 14:53:34 -060025#include <cmath>
26#include <set>
Mark Lobodzinski90224de2017-01-26 15:23:11 -070027#include <sstream>
Petr Kraus4d718682017-05-18 03:38:41 +020028#include <string>
Jeremy Gebben579aaca2021-02-15 13:36:18 -070029#include <iostream>
Mark Lobodzinski90224de2017-01-26 15:23:11 -070030
31#include "vk_enum_string_helper.h"
Petr Kraus5a01b472019-08-10 01:40:28 +020032#include "vk_format_utils.h"
Mark Lobodzinski90224de2017-01-26 15:23:11 -070033#include "vk_layer_data.h"
34#include "vk_layer_utils.h"
35#include "vk_layer_logging.h"
Dave Houltonbd2e2622018-04-10 16:41:14 -060036#include "vk_typemap_helper.h"
Mark Lobodzinski90224de2017-01-26 15:23:11 -070037
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -070038#include "chassis.h"
Mark Lobodzinski76d76662019-02-14 14:38:21 -070039#include "core_validation.h"
Jeremy Gebbene60d4172021-02-02 15:42:15 -070040#include "core_error_location.h"
Mark Lobodzinski76d76662019-02-14 14:38:21 -070041#include "shader_validation.h"
42#include "descriptor_sets.h"
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070043#include "buffer_validation.h"
Jeremy Gebben7ba56152021-06-18 10:40:10 -060044#include "sync_utils.h"
Jeremy Gebbene60d4172021-02-02 15:42:15 -070045#include "sync_vuid_maps.h"
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -070046
Jeremy Gebbencb13f0f2022-07-15 15:48:05 -060047using LayoutRange = image_layout_map::ImageSubresourceLayoutMap::RangeType;
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -060048using LayoutEntry = image_layout_map::ImageSubresourceLayoutMap::LayoutEntry;
49
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070050// All VUID from copy_bufferimage_to_imagebuffer_common.txt
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070051static const char *GetBufferImageCopyCommandVUID(std::string id, bool image_to_buffer, bool copy2) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070052 // clang-format off
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070053 static const std::map<std::string, std::array<const char *, 4>> copy_imagebuffer_vuid = {
54 {"00193", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070055 "VUID-vkCmdCopyBufferToImage-bufferOffset-00193", // !copy2 & !image_to_buffer
56 "VUID-vkCmdCopyImageToBuffer-bufferOffset-00193", // !copy2 & image_to_buffer
Tony Barbour845d29b2021-11-09 11:43:14 -070057 "VUID-VkCopyBufferToImageInfo2-bufferOffset-00193", // copy2 & !image_to_buffer
Tony-LunarGaf3632a2021-11-10 15:51:57 -070058 "VUID-VkCopyImageToBufferInfo2-bufferOffset-00193", // copy2 & image_to_buffer
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070059 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070060 {"01558", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070061 "VUID-vkCmdCopyBufferToImage-bufferOffset-01558",
62 "VUID-vkCmdCopyImageToBuffer-bufferOffset-01558",
Tony Barbour845d29b2021-11-09 11:43:14 -070063 "VUID-VkCopyBufferToImageInfo2-bufferOffset-01558",
Tony-LunarGaf3632a2021-11-10 15:51:57 -070064 "VUID-VkCopyImageToBufferInfo2-bufferOffset-01558",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070065 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070066 {"01559", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070067 "VUID-vkCmdCopyBufferToImage-bufferOffset-01559",
68 "VUID-vkCmdCopyImageToBuffer-bufferOffset-01559",
Tony Barbour845d29b2021-11-09 11:43:14 -070069 "VUID-VkCopyBufferToImageInfo2-bufferOffset-01559",
Tony-LunarGaf3632a2021-11-10 15:51:57 -070070 "VUID-VkCopyImageToBufferInfo2-bufferOffset-01559",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070071 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070072 {"00197", {
Mike Schuchardt7b152fa2021-08-03 16:30:27 -070073 "VUID-vkCmdCopyBufferToImage-pRegions-06218",
74 "VUID-vkCmdCopyImageToBuffer-pRegions-06221",
Tony Barbour845d29b2021-11-09 11:43:14 -070075 "VUID-VkCopyBufferToImageInfo2-pRegions-06223",
Tony-LunarGaf3632a2021-11-10 15:51:57 -070076 "VUID-VkCopyImageToBufferInfo2-imageOffset-00197",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070077 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070078 {"00198", {
Mike Schuchardt7b152fa2021-08-03 16:30:27 -070079 "VUID-vkCmdCopyBufferToImage-pRegions-06219",
80 "VUID-vkCmdCopyImageToBuffer-pRegions-06222",
Tony Barbour845d29b2021-11-09 11:43:14 -070081 "VUID-VkCopyBufferToImageInfo2-pRegions-06224",
Tony-LunarGaf3632a2021-11-10 15:51:57 -070082 "VUID-VkCopyImageToBufferInfo2-imageOffset-00198",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070083 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070084 {"00199", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070085 "VUID-vkCmdCopyBufferToImage-srcImage-00199",
86 "VUID-vkCmdCopyImageToBuffer-srcImage-00199",
Tony Barbour845d29b2021-11-09 11:43:14 -070087 "VUID-VkCopyBufferToImageInfo2-srcImage-00199",
Tony-LunarGaf3632a2021-11-10 15:51:57 -070088 "VUID-VkCopyImageToBufferInfo2-srcImage-00199",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070089 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070090 {"00200", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070091 "VUID-vkCmdCopyBufferToImage-imageOffset-00200",
92 "VUID-vkCmdCopyImageToBuffer-imageOffset-00200",
Tony Barbour845d29b2021-11-09 11:43:14 -070093 "VUID-VkCopyBufferToImageInfo2-imageOffset-00200",
Tony-LunarGaf3632a2021-11-10 15:51:57 -070094 "VUID-VkCopyImageToBufferInfo2-imageOffset-00200",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070095 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070096 {"00201", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070097 "VUID-vkCmdCopyBufferToImage-srcImage-00201",
98 "VUID-vkCmdCopyImageToBuffer-srcImage-00201",
Tony Barbour845d29b2021-11-09 11:43:14 -070099 "VUID-VkCopyBufferToImageInfo2-srcImage-00201",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700100 "VUID-VkCopyImageToBufferInfo2-srcImage-00201",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700101 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700102 {"00203", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700103 "VUID-vkCmdCopyBufferToImage-bufferRowLength-00203",
104 "VUID-vkCmdCopyImageToBuffer-bufferRowLength-00203",
Tony Barbour845d29b2021-11-09 11:43:14 -0700105 "VUID-VkCopyBufferToImageInfo2-bufferRowLength-00203",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700106 "VUID-VkCopyImageToBufferInfo2-bufferRowLength-00203",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700107 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700108 {"00204", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700109 "VUID-vkCmdCopyBufferToImage-bufferImageHeight-00204",
110 "VUID-vkCmdCopyImageToBuffer-bufferImageHeight-00204",
Tony Barbour845d29b2021-11-09 11:43:14 -0700111 "VUID-VkCopyBufferToImageInfo2-bufferImageHeight-00204",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700112 "VUID-VkCopyImageToBufferInfo2-bufferImageHeight-00204",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700113 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700114 {"00205", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700115 "VUID-vkCmdCopyBufferToImage-imageOffset-00205",
116 "VUID-vkCmdCopyImageToBuffer-imageOffset-00205",
Tony Barbour845d29b2021-11-09 11:43:14 -0700117 "VUID-VkCopyBufferToImageInfo2-imageOffset-00205",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700118 "VUID-VkCopyImageToBufferInfo2-imageOffset-00205",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700119 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700120 {"00206", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700121 "VUID-vkCmdCopyBufferToImage-bufferOffset-00206",
122 "VUID-vkCmdCopyImageToBuffer-bufferOffset-00206",
Tony Barbour845d29b2021-11-09 11:43:14 -0700123 "VUID-VkCopyBufferToImageInfo2-bufferOffset-00206",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700124 "VUID-VkCopyImageToBufferInfo2-bufferOffset-00206",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700125 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700126 {"00207", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700127 "VUID-vkCmdCopyBufferToImage-imageExtent-00207",
128 "VUID-vkCmdCopyImageToBuffer-imageExtent-00207",
Tony Barbour845d29b2021-11-09 11:43:14 -0700129 "VUID-VkCopyBufferToImageInfo2-imageExtent-00207",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700130 "VUID-VkCopyImageToBufferInfo2-imageExtent-00207",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700131 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700132 {"00208", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700133 "VUID-vkCmdCopyBufferToImage-imageExtent-00208",
134 "VUID-vkCmdCopyImageToBuffer-imageExtent-00208",
Tony Barbour845d29b2021-11-09 11:43:14 -0700135 "VUID-VkCopyBufferToImageInfo2-imageExtent-00208",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700136 "VUID-VkCopyImageToBufferInfo2-imageExtent-00208",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700137 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700138 {"00209", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700139 "VUID-vkCmdCopyBufferToImage-imageExtent-00209",
140 "VUID-vkCmdCopyImageToBuffer-imageExtent-00209",
Tony Barbour845d29b2021-11-09 11:43:14 -0700141 "VUID-VkCopyBufferToImageInfo2-imageExtent-00209",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700142 "VUID-VkCopyImageToBufferInfo2-imageExtent-00209",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700143 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700144 {"00211", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700145 "VUID-vkCmdCopyBufferToImage-aspectMask-00211",
146 "VUID-vkCmdCopyImageToBuffer-aspectMask-00211",
Tony Barbour845d29b2021-11-09 11:43:14 -0700147 "VUID-VkCopyBufferToImageInfo2-aspectMask-00211",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700148 "VUID-VkCopyImageToBufferInfo2-aspectMask-00211",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700149 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700150 {"01560", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700151 "VUID-vkCmdCopyBufferToImage-aspectMask-01560",
152 "VUID-vkCmdCopyImageToBuffer-aspectMask-01560",
Tony Barbour845d29b2021-11-09 11:43:14 -0700153 "VUID-VkCopyBufferToImageInfo2-aspectMask-01560",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700154 "VUID-VkCopyImageToBufferInfo2-aspectMask-01560",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700155 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700156 {"00213", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700157 "VUID-vkCmdCopyBufferToImage-baseArrayLayer-00213",
158 "VUID-vkCmdCopyImageToBuffer-baseArrayLayer-00213",
Tony Barbour845d29b2021-11-09 11:43:14 -0700159 "VUID-VkCopyBufferToImageInfo2-baseArrayLayer-00213",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700160 "VUID-VkCopyImageToBufferInfo2-baseArrayLayer-00213",
sfricke-samsung8feecc12021-01-23 03:28:38 -0800161 }},
162 {"04052", {
163 "VUID-vkCmdCopyBufferToImage-commandBuffer-04052",
164 "VUID-vkCmdCopyImageToBuffer-commandBuffer-04052",
Tony Barbour845d29b2021-11-09 11:43:14 -0700165 "VUID-VkCopyBufferToImageInfo2-commandBuffer-04052",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700166 "VUID-VkCopyImageToBufferInfo2-commandBuffer-04052",
sfricke-samsung8feecc12021-01-23 03:28:38 -0800167 }},
168 {"04053", {
169 "VUID-vkCmdCopyBufferToImage-srcImage-04053",
170 "VUID-vkCmdCopyImageToBuffer-srcImage-04053",
Tony Barbour845d29b2021-11-09 11:43:14 -0700171 "VUID-VkCopyBufferToImageInfo2-srcImage-04053",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700172 "VUID-VkCopyImageToBufferInfo2-srcImage-04053",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700173 }}
174 };
175 // clang-format on
176
177 uint8_t index = 0;
Artem Bolgar82d08362021-06-03 13:11:13 -0700178 index |= uint8_t((image_to_buffer) ? 0x1 : 0);
179 index |= uint8_t((copy2) ? 0x2 : 0);
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700180 return copy_imagebuffer_vuid.at(id).at(index);
181}
182
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700183static VkImageLayout NormalizeDepthImageLayout(VkImageLayout layout) {
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200184 switch (layout) {
185 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
186 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
187 return VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL;
188
189 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
190 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
191 return VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL;
192
193 default:
194 return layout;
195 }
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700196}
197
198static VkImageLayout NormalizeStencilImageLayout(VkImageLayout layout) {
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200199 switch (layout) {
200 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
201 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
202 return VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL;
203
204 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
205 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
206 return VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL;
207
208 default:
209 return layout;
210 }
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700211}
212
Jeremy Gebben579aaca2021-02-15 13:36:18 -0700213static VkImageLayout NormalizeSynchronization2Layout(const VkImageAspectFlags aspect_mask, VkImageLayout layout) {
214 if (layout == VK_IMAGE_LAYOUT_ATTACHMENT_OPTIMAL_KHR) {
215 if (aspect_mask == VK_IMAGE_ASPECT_COLOR_BIT) {
216 layout = VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL;
217 } else if (aspect_mask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
218 layout = VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL;
219 } else if (aspect_mask == VK_IMAGE_ASPECT_DEPTH_BIT) {
220 layout = VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL;
221 } else if (aspect_mask == VK_IMAGE_ASPECT_STENCIL_BIT) {
222 layout = VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL;
223 }
224 } else if (layout == VK_IMAGE_LAYOUT_READ_ONLY_OPTIMAL_KHR) {
225 if (aspect_mask == VK_IMAGE_ASPECT_COLOR_BIT) {
226 layout = VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL;
227 } else if (aspect_mask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
228 layout = VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL;
229 } else if (aspect_mask == VK_IMAGE_ASPECT_DEPTH_BIT) {
230 layout = VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL;
231 } else if (aspect_mask == VK_IMAGE_ASPECT_STENCIL_BIT) {
232 layout = VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL;
233 }
234 }
235 return layout;
236}
237
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700238static bool ImageLayoutMatches(const VkImageAspectFlags aspect_mask, VkImageLayout a, VkImageLayout b) {
239 bool matches = (a == b);
240 if (!matches) {
John Zulaufbea70432021-02-23 07:03:12 -0700241 a = NormalizeSynchronization2Layout(aspect_mask, a);
242 b = NormalizeSynchronization2Layout(aspect_mask, b);
243 matches = (a == b);
244 if (!matches) {
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200245 // Relaxed rules when referencing *only* the depth or stencil aspects.
246 // When accessing both, normalize layouts for aspects separately.
247 if (aspect_mask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
248 matches = NormalizeDepthImageLayout(a) == NormalizeDepthImageLayout(b) &&
249 NormalizeStencilImageLayout(a) == NormalizeStencilImageLayout(b);
250 } else if (aspect_mask == VK_IMAGE_ASPECT_DEPTH_BIT) {
John Zulaufbea70432021-02-23 07:03:12 -0700251 matches = NormalizeDepthImageLayout(a) == NormalizeDepthImageLayout(b);
252 } else if (aspect_mask == VK_IMAGE_ASPECT_STENCIL_BIT) {
253 matches = NormalizeStencilImageLayout(a) == NormalizeStencilImageLayout(b);
254 }
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700255 }
256 }
257 return matches;
258}
259
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600260// Utility type for checking Image layouts
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700261struct LayoutUseCheckAndMessage {
262 const static VkImageAspectFlags kDepthOrStencil = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600263 const VkImageLayout expected_layout;
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700264 const VkImageAspectFlags aspect_mask;
265 const char *message;
266 VkImageLayout layout;
267
268 LayoutUseCheckAndMessage() = delete;
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600269 LayoutUseCheckAndMessage(VkImageLayout expected, const VkImageAspectFlags aspect_mask_ = 0)
270 : expected_layout{expected}, aspect_mask{aspect_mask_}, message(nullptr), layout(kInvalidLayout) {}
271 bool Check(const LayoutEntry &layout_entry) {
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700272 message = nullptr;
273 layout = kInvalidLayout; // Success status
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600274 if (layout_entry.current_layout != kInvalidLayout) {
275 if (!ImageLayoutMatches(aspect_mask, expected_layout, layout_entry.current_layout)) {
276 message = "previous known";
277 layout = layout_entry.current_layout;
278 }
279 } else if (layout_entry.initial_layout != kInvalidLayout) {
280 if (!ImageLayoutMatches(aspect_mask, expected_layout, layout_entry.initial_layout)) {
281 assert(layout_entry.state); // If we have an initial layout, we better have a state for it
282 if (!((layout_entry.state->aspect_mask & kDepthOrStencil) &&
283 ImageLayoutMatches(layout_entry.state->aspect_mask, expected_layout, layout_entry.initial_layout))) {
284 message = "previously used";
285 layout = layout_entry.initial_layout;
286 }
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700287 }
288 }
289 return layout == kInvalidLayout;
290 }
291};
292
locke-lunarg540b2252020-08-03 13:23:36 -0600293bool IMAGE_VIEW_STATE::OverlapSubresource(const IMAGE_VIEW_STATE &compare_view) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600294 if (image_view() == compare_view.image_view()) {
locke-lunarg540b2252020-08-03 13:23:36 -0600295 return true;
296 }
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600297 if (image_state->image() != compare_view.image_state->image()) {
locke-lunargdc287022020-08-21 12:03:57 -0600298 return false;
299 }
locke-lunarg540b2252020-08-03 13:23:36 -0600300 if (normalized_subresource_range.aspectMask != compare_view.normalized_subresource_range.aspectMask) {
301 return false;
302 }
303
304 // compare if overlap mip level
locke-lunarg540b2252020-08-03 13:23:36 -0600305 if ((normalized_subresource_range.baseMipLevel < compare_view.normalized_subresource_range.baseMipLevel) &&
locke-lunargdc287022020-08-21 12:03:57 -0600306 ((normalized_subresource_range.baseMipLevel + normalized_subresource_range.levelCount) <=
locke-lunarg540b2252020-08-03 13:23:36 -0600307 compare_view.normalized_subresource_range.baseMipLevel)) {
locke-lunargdc287022020-08-21 12:03:57 -0600308 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600309 }
310
311 if ((normalized_subresource_range.baseMipLevel > compare_view.normalized_subresource_range.baseMipLevel) &&
locke-lunargdc287022020-08-21 12:03:57 -0600312 (normalized_subresource_range.baseMipLevel >=
locke-lunarg540b2252020-08-03 13:23:36 -0600313 (compare_view.normalized_subresource_range.baseMipLevel + compare_view.normalized_subresource_range.levelCount))) {
locke-lunargdc287022020-08-21 12:03:57 -0600314 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600315 }
316
317 // compare if overlap array layer
locke-lunarg540b2252020-08-03 13:23:36 -0600318 if ((normalized_subresource_range.baseArrayLayer < compare_view.normalized_subresource_range.baseArrayLayer) &&
locke-lunargdc287022020-08-21 12:03:57 -0600319 ((normalized_subresource_range.baseArrayLayer + normalized_subresource_range.layerCount) <=
locke-lunarg540b2252020-08-03 13:23:36 -0600320 compare_view.normalized_subresource_range.baseArrayLayer)) {
locke-lunargdc287022020-08-21 12:03:57 -0600321 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600322 }
323
324 if ((normalized_subresource_range.baseArrayLayer > compare_view.normalized_subresource_range.baseArrayLayer) &&
locke-lunargdc287022020-08-21 12:03:57 -0600325 (normalized_subresource_range.baseArrayLayer >=
locke-lunarg540b2252020-08-03 13:23:36 -0600326 (compare_view.normalized_subresource_range.baseArrayLayer + compare_view.normalized_subresource_range.layerCount))) {
locke-lunargdc287022020-08-21 12:03:57 -0600327 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600328 }
locke-lunargdc287022020-08-21 12:03:57 -0600329 return true;
locke-lunarg540b2252020-08-03 13:23:36 -0600330}
331
Dave Houltond9611312018-11-19 17:03:36 -0700332uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
333 // uint cast applies floor()
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700334 return 1u + static_cast<uint32_t>(log2(std::max({height, width, depth})));
Dave Houltond9611312018-11-19 17:03:36 -0700335}
336
337uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
338
339uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
340
John Zulauf2d60a452021-03-04 15:12:03 -0700341bool CoreChecks::FindLayouts(const IMAGE_STATE &image_state, std::vector<VkImageLayout> &layouts) const {
Jeremy Gebben4a8881f2022-01-10 17:04:30 -0700342 const auto *layout_range_map = image_state.layout_range_map.get();
John Zulauf2076e812020-01-08 14:55:54 -0700343 if (!layout_range_map) return false;
Jeremy Gebben4a8881f2022-01-10 17:04:30 -0700344
345 auto guard = layout_range_map->ReadLock();
locke-lunargf155ccf2020-02-18 11:34:15 -0700346 // TODO: FindLayouts function should mutate into a ValidatePresentableLayout with the loop wrapping the LogError
347 // from the caller. You can then use decode to add the subresource of the range::begin to the error message.
348
John Zulauf2076e812020-01-08 14:55:54 -0700349 // TODO: what is this test and what is it supposed to do?! -- the logic doesn't match the comment below?!
350
351 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
John Zulauf2d60a452021-03-04 15:12:03 -0700352 if (layout_range_map->size() >= (image_state.createInfo.arrayLayers * image_state.createInfo.mipLevels + 1)) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700353 return false;
354 }
locke-lunargcba7d5f2019-12-30 16:59:11 -0700355
John Zulauf79f06582021-02-27 18:38:39 -0700356 for (const auto &entry : *layout_range_map) {
John Zulauf2076e812020-01-08 14:55:54 -0700357 layouts.push_back(entry.second);
Tony Barbourdf013b92017-01-25 12:53:48 -0700358 }
359 return true;
360}
Tony-LunarG4f2cf2b2022-08-30 14:58:40 -0600361
Tony-LunarG0857f842022-08-23 10:32:16 -0600362bool CoreChecks::ValidateMultipassRenderedToSingleSampledSampleCount(RenderPassCreateVersion rp_version, VkFramebuffer framebuffer,
Tony-LunarG4f2cf2b2022-08-30 14:58:40 -0600363 VkRenderPass renderpass, uint32_t subpass,
364 IMAGE_STATE *image_state, VkSampleCountFlagBits msrtss_samples,
Tony-LunarG0857f842022-08-23 10:32:16 -0600365 uint32_t attachment_index, bool depth) const {
366 bool skip = false;
367 const char *function_name = (rp_version == RENDER_PASS_VERSION_2) ? "vkCmdBeginRenderPass2()" : "vkCmdBeginRenderPass()";
Tony-LunarG4f2cf2b2022-08-30 14:58:40 -0600368 const auto image_create_info = image_state->createInfo;
369 if (!image_state->image_format_properties.sampleCounts) {
370 skip |= GetPhysicalDeviceImageFormatProperties(*image_state, "VUID-VkRenderPassAttachmentBeginInfo-pAttachments-07010");
371 }
372 if (!(image_state->image_format_properties.sampleCounts & msrtss_samples)) {
373 std::stringstream msg;
374 if (depth) {
375 msg << "depth stencil attachment";
376 } else {
377 msg << "attachment " << attachment_index;
378 }
Tony-LunarG0857f842022-08-23 10:32:16 -0600379 skip |= LogError(device, "VUID-VkRenderPassAttachmentBeginInfo-pAttachments-07010",
Tony-LunarG0857f842022-08-23 10:32:16 -0600380 "%s(): Renderpass subpass %" PRIu32
381 " enables "
382 "multisampled-render-to-single-sampled and %s"
383 ", is specified with "
384 "VK_SAMPLE_COUNT_1_BIT samples, but image (%s) created with format %s imageType: %s, "
385 "tiling: %s, usage: %s, "
386 "flags: %s does not support a rasterizationSamples count of %s",
Tony-LunarG4f2cf2b2022-08-30 14:58:40 -0600387 function_name, subpass, msg.str().c_str(), report_data->FormatHandle(image_state->Handle()).c_str(),
Tony-LunarG0857f842022-08-23 10:32:16 -0600388 string_VkFormat(image_create_info.format), string_VkImageType(image_create_info.imageType),
389 string_VkImageTiling(image_create_info.tiling), string_VkImageUsageFlags(image_create_info.usage).c_str(),
390 string_VkImageCreateFlags(image_create_info.flags).c_str(), string_VkSampleCountFlagBits(msrtss_samples));
Tony-LunarG0857f842022-08-23 10:32:16 -0600391 }
392 return skip;
393}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700394
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700395bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600396 const IMAGE_VIEW_STATE &image_view_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700397 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600398 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100399 bool skip = false;
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600400 const auto &image_view = image_view_state.Handle();
401 const auto *image_state = image_view_state.image_state.get();
402 const auto &image = image_state->Handle();
Tobias Hectorbbb12282018-10-22 15:17:59 +0100403 const char *vuid;
404 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700405 const char *function_name = use_rp2 ? "vkCmdBeginRenderPass2()" : "vkCmdBeginRenderPass()";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100406
407 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600408 LogObjectList objlist(image);
409 objlist.add(renderpass);
410 objlist.add(framebuffer);
411 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700412 skip |=
sfricke-samsung4389faa2022-03-23 01:19:42 -0500413 LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700414 "%s: RenderPass %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
415 function_name, report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
416 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100417 return skip;
418 }
419
420 auto image_usage = image_state->createInfo.usage;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700421 const auto stencil_usage_info = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Ricardo Garcia3f5984c2020-04-09 10:56:34 +0200422 if (stencil_usage_info) {
423 image_usage |= stencil_usage_info->stencilUsage;
424 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100425
426 // Check for layouts that mismatch image usages in the framebuffer
427 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800428 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600429 LogObjectList objlist(image);
430 objlist.add(renderpass);
431 objlist.add(framebuffer);
432 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700433 skip |= LogError(objlist, vuid,
434 "%s: Layout/usage mismatch for attachment %u in %s"
435 " - the %s is %s but the image attached to %s via %s"
436 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
437 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
438 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
439 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100440 }
441
442 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
443 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800444 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600445 LogObjectList objlist(image);
446 objlist.add(renderpass);
447 objlist.add(framebuffer);
448 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700449 skip |= LogError(objlist, vuid,
450 "%s: Layout/usage mismatch for attachment %u in %s"
451 " - the %s is %s but the image attached to %s via %s"
452 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
453 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
454 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
455 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100456 }
457
458 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800459 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600460 LogObjectList objlist(image);
461 objlist.add(renderpass);
462 objlist.add(framebuffer);
463 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700464 skip |= LogError(objlist, vuid,
465 "%s: Layout/usage mismatch for attachment %u in %s"
466 " - the %s is %s but the image attached to %s via %s"
467 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
468 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
469 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
470 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100471 }
472
473 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800474 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600475 LogObjectList objlist(image);
476 objlist.add(renderpass);
477 objlist.add(framebuffer);
478 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700479 skip |= LogError(objlist, vuid,
480 "%s: Layout/usage mismatch for attachment %u in %s"
481 " - the %s is %s but the image attached to %s via %s"
482 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
483 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
484 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
485 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100486 }
487
Tony-LunarG10f54412022-08-12 11:43:40 -0600488 if (layout == VK_IMAGE_LAYOUT_ATTACHMENT_FEEDBACK_LOOP_OPTIMAL_EXT) {
489 if (((image_usage & (VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) == 0) ||
490 ((image_usage & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0)) {
491 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-07002" : "VUID-vkCmdBeginRenderPass-initialLayout-07000";
492 LogObjectList objlist(image);
493 objlist.add(renderpass);
494 objlist.add(framebuffer);
495 objlist.add(image_view);
496 skip |=
497 LogError(objlist, vuid,
498 "%s: Layout/usage mismatch for attachment %" PRIu32
499 " in %s"
500 " - the %s is %s but the image attached to %s via %s"
501 " was not created with either the VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT or "
502 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT usage bits, and the VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or "
503 "VK_IMAGE_USAGE_SAMPLED_BIT usage bits",
504 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
505 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
506 report_data->FormatHandle(image_view).c_str());
507 }
508 if (!(image_usage & VK_IMAGE_USAGE_ATTACHMENT_FEEDBACK_LOOP_BIT_EXT)) {
509 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-07003" : "VUID-vkCmdBeginRenderPass-initialLayout-07001";
510 LogObjectList objlist(image);
511 objlist.add(renderpass);
512 objlist.add(framebuffer);
513 objlist.add(image_view);
514 skip |= LogError(objlist, vuid,
515 "%s: Layout/usage mismatch for attachment %" PRIu32
516 " in %s"
517 " - the %s is %s but the image attached to %s via %s"
518 " was not created with the VK_IMAGE_USAGE_ATTACHMENT_FEEDBACK_LOOP_BIT_EXT usage bit",
519 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
520 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
521 report_data->FormatHandle(image_view).c_str());
522 }
523 }
524
sfricke-samsung45996a42021-09-16 13:45:27 -0700525 if (IsExtEnabled(device_extensions.vk_khr_maintenance2)) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100526 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
527 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
528 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
529 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
530 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800531 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600532 LogObjectList objlist(image);
533 objlist.add(renderpass);
534 objlist.add(framebuffer);
535 objlist.add(image_view);
536 skip |= LogError(objlist, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700537 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700538 " - the %s is %s but the image attached to %s via %s"
539 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700540 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700541 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
542 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100543 }
544 } else {
545 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
546 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
547 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
548 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600549 LogObjectList objlist(image);
550 objlist.add(renderpass);
551 objlist.add(framebuffer);
552 objlist.add(image_view);
553 skip |= LogError(objlist, "VUID-vkCmdBeginRenderPass-initialLayout-00896",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700554 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700555 " - the %s is %s but the image attached to %s via %s"
556 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700557 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700558 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
559 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100560 }
561 }
562 return skip;
563}
564
John Zulauf17a01bb2019-08-09 16:41:19 -0600565bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700566 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600567 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600568 bool skip = false;
Jeremy Gebbenf4449392022-01-28 10:09:10 -0700569 auto render_pass_state = Get<RENDER_PASS_STATE>(pRenderPassBegin->renderPass);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600570 const auto *render_pass_info = render_pass_state->createInfo.ptr();
571 auto render_pass = render_pass_state->renderPass();
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700572 auto const &framebuffer_info = framebuffer_state->createInfo;
573 const VkImageView *attachments = framebuffer_info.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100574
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600575 auto framebuffer = framebuffer_state->framebuffer();
Tobias Hectorbbb12282018-10-22 15:17:59 +0100576
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700577 if (render_pass_info->attachmentCount != framebuffer_info.attachmentCount) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600578 skip |= LogError(pCB->commandBuffer(), kVUID_Core_DrawState_InvalidRenderpass,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700579 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700580 }
John Zulauf8e308292018-09-21 11:34:37 -0600581
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700582 const auto *attachment_info = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext);
Mike Schuchardt2df08912020-12-15 16:28:09 -0800583 if (((framebuffer_info.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) != 0) && attachment_info != nullptr) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700584 attachments = attachment_info->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100585 }
586
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600587 if (attachments == nullptr) {
588 return skip;
589 }
590 const auto *const_p_cb = static_cast<const CMD_BUFFER_STATE *>(pCB);
591 for (uint32_t i = 0; i < render_pass_info->attachmentCount && i < framebuffer_info.attachmentCount; ++i) {
592 auto image_view = attachments[i];
593 auto view_state = Get<IMAGE_VIEW_STATE>(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100594
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600595 if (!view_state) {
596 LogObjectList objlist(pRenderPassBegin->renderPass);
597 objlist.add(framebuffer_state->framebuffer());
598 objlist.add(image_view);
599 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
600 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
601 report_data->FormatHandle(framebuffer_state->framebuffer()).c_str(), i,
602 report_data->FormatHandle(image_view).c_str());
603 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100604 }
605
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600606 const VkImage image = view_state->create_info.image;
607 const auto *image_state = view_state->image_state.get();
Tobias Hectorbbb12282018-10-22 15:17:59 +0100608
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600609 if (!image_state) {
610 LogObjectList objlist(pRenderPassBegin->renderPass);
611 objlist.add(framebuffer_state->framebuffer());
612 objlist.add(image_view);
613 objlist.add(image);
614 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
615 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
616 report_data->FormatHandle(framebuffer_state->framebuffer()).c_str(), i,
617 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
618 continue;
619 }
620 auto attachment_initial_layout = render_pass_info->pAttachments[i].initialLayout;
621 auto final_layout = render_pass_info->pAttachments[i].finalLayout;
622
623 // Default to expecting stencil in the same layout.
624 auto attachment_stencil_initial_layout = attachment_initial_layout;
625
626 // If a separate layout is specified, look for that.
627 const auto *attachment_description_stencil_layout =
628 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(render_pass_info->pAttachments[i].pNext);
629 if (attachment_description_stencil_layout) {
630 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
631 }
632
633 const ImageSubresourceLayoutMap *subresource_map = nullptr;
634 bool has_queried_map = false;
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600635
636 for (uint32_t aspect_index = 0; aspect_index < 32; aspect_index++) {
637 VkImageAspectFlags test_aspect = 1u << aspect_index;
638 if ((view_state->normalized_subresource_range.aspectMask & test_aspect) == 0) {
639 continue;
640 }
641
642 // Allow for differing depth and stencil layouts
643 VkImageLayout check_layout = attachment_initial_layout;
644 if (test_aspect == VK_IMAGE_ASPECT_STENCIL_BIT) {
645 check_layout = attachment_stencil_initial_layout;
646 }
647
648 // If no layout information for image yet, will be checked at QueueSubmit time
649 if (check_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
650 continue;
651 }
652 if (!has_queried_map) {
653 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to
654 // something in common with the non-const version.) The lookup is expensive, so cache it.
655 subresource_map = const_p_cb->GetImageSubresourceLayoutMap(*image_state);
656 has_queried_map = true;
657 }
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600658 if (!subresource_map) {
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600659 // If no layout information for image yet, will be checked at QueueSubmit time
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600660 continue;
661 }
662 auto normalized_range = view_state->normalized_subresource_range;
663 normalized_range.aspectMask = test_aspect;
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600664 LayoutUseCheckAndMessage layout_check(check_layout, test_aspect);
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600665
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600666 skip |= subresource_map->AnyInRange(
Jeremy Gebbencb13f0f2022-07-15 15:48:05 -0600667 normalized_range, [this, &layout_check, i](const LayoutRange &range, const LayoutEntry &state) {
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600668 bool subres_skip = false;
669 if (!layout_check.Check(state)) {
670 subres_skip = LogError(device, kVUID_Core_DrawState_InvalidRenderpass,
671 "You cannot start a render pass using attachment %u where the render pass initial "
672 "layout is %s "
673 "and the %s layout of the attachment is %s. The layouts must match, or the render "
674 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
675 i, string_VkImageLayout(layout_check.expected_layout), layout_check.message,
676 string_VkImageLayout(layout_check.layout));
677 }
678 return subres_skip;
679 });
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600680 }
Tony-LunarG6cc4c562022-08-24 14:55:28 -0600681 skip |= ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, *view_state,
682 framebuffer, render_pass, i, "initial layout");
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600683
Tony-LunarG6cc4c562022-08-24 14:55:28 -0600684 skip |= ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, *view_state, framebuffer,
685 render_pass, i, "final layout");
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600686 }
687
688 for (uint32_t j = 0; j < render_pass_info->subpassCount; ++j) {
689 auto &subpass = render_pass_info->pSubpasses[j];
Tony-LunarG0857f842022-08-23 10:32:16 -0600690 const auto *ms_rendered_to_single_sampled =
691 LvlFindInChain<VkMultisampledRenderToSingleSampledInfoEXT>(render_pass_info->pSubpasses[j].pNext);
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600692 for (uint32_t k = 0; k < render_pass_info->pSubpasses[j].inputAttachmentCount; ++k) {
693 auto &attachment_ref = subpass.pInputAttachments[k];
694 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
695 auto image_view = attachments[attachment_ref.attachment];
696 auto view_state = Get<IMAGE_VIEW_STATE>(image_view);
Tony-LunarG0857f842022-08-23 10:32:16 -0600697
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600698 if (view_state) {
Tony-LunarG6cc4c562022-08-24 14:55:28 -0600699 skip |= ValidateRenderPassLayoutAgainstFramebufferImageUsage(
700 rp_version, attachment_ref.layout, *view_state, framebuffer, render_pass, attachment_ref.attachment,
701 "input attachment layout");
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600702 }
Tony-LunarG0857f842022-08-23 10:32:16 -0600703 if (ms_rendered_to_single_sampled && ms_rendered_to_single_sampled->multisampledRenderToSingleSampledEnable) {
704 if (render_pass_info->pAttachments[attachment_ref.attachment].samples == VK_SAMPLE_COUNT_1_BIT) {
Tony-LunarG0857f842022-08-23 10:32:16 -0600705 skip |= ValidateMultipassRenderedToSingleSampledSampleCount(
Tony-LunarG4f2cf2b2022-08-30 14:58:40 -0600706 rp_version, framebuffer, render_pass, k, view_state->image_state.get(),
Tony-LunarG0857f842022-08-23 10:32:16 -0600707 ms_rendered_to_single_sampled->rasterizationSamples, attachment_ref.attachment);
708 }
709 }
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600710 }
711 }
712
713 for (uint32_t k = 0; k < render_pass_info->pSubpasses[j].colorAttachmentCount; ++k) {
714 auto &attachment_ref = subpass.pColorAttachments[k];
715 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
716 auto image_view = attachments[attachment_ref.attachment];
717 auto view_state = Get<IMAGE_VIEW_STATE>(image_view);
718
719 if (view_state) {
Tony-LunarG6cc4c562022-08-24 14:55:28 -0600720 skip |= ValidateRenderPassLayoutAgainstFramebufferImageUsage(
721 rp_version, attachment_ref.layout, *view_state, framebuffer, render_pass, attachment_ref.attachment,
722 "color attachment layout");
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600723 if (subpass.pResolveAttachments) {
Tony-LunarG6cc4c562022-08-24 14:55:28 -0600724 skip |= ValidateRenderPassLayoutAgainstFramebufferImageUsage(
725 rp_version, attachment_ref.layout, *view_state, framebuffer, render_pass, attachment_ref.attachment,
726 "resolve attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100727 }
728 }
Tony-LunarG0857f842022-08-23 10:32:16 -0600729 if (ms_rendered_to_single_sampled && ms_rendered_to_single_sampled->multisampledRenderToSingleSampledEnable) {
730 if (render_pass_info->pAttachments[attachment_ref.attachment].samples == VK_SAMPLE_COUNT_1_BIT) {
Tony-LunarG0857f842022-08-23 10:32:16 -0600731 skip |= ValidateMultipassRenderedToSingleSampledSampleCount(
Tony-LunarG4f2cf2b2022-08-30 14:58:40 -0600732 rp_version, framebuffer, render_pass, k, view_state->image_state.get(),
Tony-LunarG0857f842022-08-23 10:32:16 -0600733 ms_rendered_to_single_sampled->rasterizationSamples, attachment_ref.attachment);
734 }
735 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100736 }
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600737 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100738
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600739 if (render_pass_info->pSubpasses[j].pDepthStencilAttachment) {
740 auto &attachment_ref = *subpass.pDepthStencilAttachment;
741 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
742 auto image_view = attachments[attachment_ref.attachment];
743 auto view_state = Get<IMAGE_VIEW_STATE>(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100744
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600745 if (view_state) {
Tony-LunarG6cc4c562022-08-24 14:55:28 -0600746 skip |= ValidateRenderPassLayoutAgainstFramebufferImageUsage(
747 rp_version, attachment_ref.layout, *view_state, framebuffer, render_pass, attachment_ref.attachment,
748 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100749 }
Tony-LunarG0857f842022-08-23 10:32:16 -0600750 if (ms_rendered_to_single_sampled && ms_rendered_to_single_sampled->multisampledRenderToSingleSampledEnable) {
751 if (render_pass_info->pAttachments[attachment_ref.attachment].samples == VK_SAMPLE_COUNT_1_BIT) {
Tony-LunarG0857f842022-08-23 10:32:16 -0600752 skip |= ValidateMultipassRenderedToSingleSampledSampleCount(
Tony-LunarG4f2cf2b2022-08-30 14:58:40 -0600753 rp_version, framebuffer, render_pass, 0, view_state->image_state.get(),
Tony-LunarG0857f842022-08-23 10:32:16 -0600754 ms_rendered_to_single_sampled->rasterizationSamples, attachment_ref.attachment, true);
755 }
756 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100757 }
758 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700759 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600760 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700761}
762
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600763void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700764 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700765 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -0600766 IMAGE_VIEW_STATE *image_view = pCB->GetActiveAttachmentImageViewState(ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600767 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700768 VkImageLayout stencil_layout = kInvalidLayout;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700769 const auto *attachment_reference_stencil_layout = LvlFindInChain<VkAttachmentReferenceStencilLayout>(ref.pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700770 if (attachment_reference_stencil_layout) {
771 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
772 }
773
Jeremy Gebben1ec89332021-08-05 13:51:49 -0600774 pCB->SetImageViewLayout(*image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600775 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700776 }
777}
778
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600779void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
780 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700781 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700782
783 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700784 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700785 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700786 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700787 }
788 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700789 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700790 }
791 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700792 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700793 }
794 }
795}
796
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700797// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
798// 1. Transition into initialLayout state
799// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600800void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700801 FRAMEBUFFER_STATE *framebuffer_state) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700802 // First record expected initialLayout as a potential initial layout usage.
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700803 auto const rpci = render_pass_state->createInfo.ptr();
804 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -0600805 auto *view_state = cb_state->GetActiveAttachmentImageViewState(i);
John Zulauf8e308292018-09-21 11:34:37 -0600806 if (view_state) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700807 IMAGE_STATE *image_state = view_state->image_state.get();
808 const auto initial_layout = rpci->pAttachments[i].initialLayout;
Piers Daniell4fde9b72019-11-27 16:19:46 -0700809 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700810 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(rpci->pAttachments[i].pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700811 if (attachment_description_stencil_layout) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700812 const auto stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
813 VkImageSubresourceRange sub_range = view_state->normalized_subresource_range;
814 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
Jeremy Gebben1ec89332021-08-05 13:51:49 -0600815 cb_state->SetImageInitialLayout(*image_state, sub_range, initial_layout);
John Zulauf81dd1f12021-01-26 16:49:16 -0700816 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
Jeremy Gebben1ec89332021-08-05 13:51:49 -0600817 cb_state->SetImageInitialLayout(*image_state, sub_range, stencil_initial_layout);
John Zulauf81dd1f12021-01-26 16:49:16 -0700818 } else {
Jeremy Gebben1ec89332021-08-05 13:51:49 -0600819 cb_state->SetImageInitialLayout(*image_state, view_state->normalized_subresource_range, initial_layout);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700820 }
John Zulauf8e308292018-09-21 11:34:37 -0600821 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700822 }
823 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700824 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700825}
826
Dave Houlton10b39482017-03-16 13:18:15 -0600827bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600828 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600829 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600830 }
831 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600832 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600833 }
834 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600835 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600836 }
Mike Schuchardt2df08912020-12-15 16:28:09 -0800837 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 -0700838 if (FormatPlaneCount(format) == 1) return false;
839 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600840 return true;
841}
842
sfricke-samsung10b35ce2021-09-29 08:50:20 -0700843// There is a table in the Vulkan spec to list all formats that implicitly require YCbCr conversion,
844// but some features/extensions can explicitly turn that restriction off
845// The implicit check is done in format utils, while feature checks are done here in CoreChecks
846bool CoreChecks::FormatRequiresYcbcrConversionExplicitly(const VkFormat format) const {
847 if (format == VK_FORMAT_R10X6G10X6B10X6A10X6_UNORM_4PACK16 &&
848 enabled_features.rgba10x6_formats_features.formatRgba10x6WithoutYCbCrSampler) {
849 return false;
850 }
851 return FormatRequiresYcbcrConversion(format);
852}
853
Mike Weiblen62d08a32017-03-07 22:18:27 -0700854// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -0700855bool CoreChecks::ValidateBarrierLayoutToImageUsage(const Location &loc, VkImage image, VkImageLayout layout,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700856 VkImageUsageFlags usage_flags) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700857 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700858 bool is_error = false;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700859 switch (layout) {
860 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700861 is_error = ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700862 break;
863 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700864 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700865 break;
866 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700867 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700868 break;
869 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700870 is_error = ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700871 break;
872 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700873 is_error = ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700874 break;
875 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700876 is_error = ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700877 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600878 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700879 is_error = ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0);
Jeff Bolz9af91c52018-09-01 21:53:57 -0500880 break;
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700881 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700882 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700883 break;
884 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700885 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700886 break;
Tony-LunarG10f54412022-08-12 11:43:40 -0600887 case VK_IMAGE_LAYOUT_ATTACHMENT_FEEDBACK_LOOP_OPTIMAL_EXT:
888 is_error = ((usage_flags & (VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) == 0);
889 is_error |= ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0);
890 is_error |= ((usage_flags & VK_IMAGE_USAGE_ATTACHMENT_FEEDBACK_LOOP_BIT_EXT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700891 default:
892 // Other VkImageLayout values do not have VUs defined in this context.
893 break;
894 }
895
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700896 if (is_error) {
897 const auto &vuid = sync_vuid_maps::GetBadImageLayoutVUID(loc, layout);
898
899 skip |=
900 LogError(image, vuid, "%s Image barrier Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".",
901 loc.Message().c_str(), string_VkImageLayout(layout), report_data->FormatHandle(image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700902 }
903 return skip;
904}
905
906// Verify image barriers are compatible with the images they reference.
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700907template <typename ImageBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -0700908bool CoreChecks::ValidateBarriersToImages(const Location &outer_loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700909 uint32_t imageMemoryBarrierCount, const ImageBarrier *pImageMemoryBarriers) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700910 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700911 using sync_vuid_maps::GetImageBarrierVUID;
912 using sync_vuid_maps::ImageError;
Petr Krausad0096a2019-08-09 18:35:04 +0200913
John Zulauf463c51e2018-05-31 13:29:20 -0600914 // Scoreboard for duplicate layout transition barriers within the list
915 // 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 +0200916 const CommandBufferImageLayoutMap &current_map = cb_state->GetImageSubresourceLayoutMap();
917 CommandBufferImageLayoutMap layout_updates;
John Zulauf463c51e2018-05-31 13:29:20 -0600918
Mike Weiblen62d08a32017-03-07 22:18:27 -0700919 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700920 auto loc = outer_loc.dot(Field::pImageMemoryBarriers, i);
Petr Krausad0096a2019-08-09 18:35:04 +0200921 const auto &img_barrier = pImageMemoryBarriers[i];
Mike Weiblen62d08a32017-03-07 22:18:27 -0700922
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600923 auto image_state = Get<IMAGE_STATE>(img_barrier.image);
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600924 if (!image_state) {
925 continue;
926 }
Tony-LunarG10f54412022-08-12 11:43:40 -0600927
928 if ((img_barrier.srcQueueFamilyIndex != img_barrier.dstQueueFamilyIndex) ||
929 (img_barrier.oldLayout != img_barrier.newLayout)) {
930 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
931 skip |=
932 ValidateBarrierLayoutToImageUsage(loc.dot(Field::oldLayout), img_barrier.image, img_barrier.oldLayout, usage_flags);
933 skip |=
934 ValidateBarrierLayoutToImageUsage(loc.dot(Field::newLayout), img_barrier.image, img_barrier.newLayout, usage_flags);
935 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600936
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600937 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
938 if (image_state->layout_locked) {
939 // TODO: Add unique id for error when available
940 skip |= LogError(
941 img_barrier.image, "VUID-Undefined",
942 "%s Attempting to transition shared presentable %s"
943 " from layout %s to layout %s, but image has already been presented and cannot have its layout transitioned.",
944 loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
945 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(img_barrier.newLayout));
946 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600947
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600948 const VkImageCreateInfo &image_create_info = image_state->createInfo;
949 const VkFormat image_format = image_create_info.format;
950 const VkImageAspectFlags aspect_mask = img_barrier.subresourceRange.aspectMask;
951 // For a Depth/Stencil image both aspects MUST be set
952 auto image_loc = loc.dot(Field::image);
953 if (FormatIsDepthAndStencil(image_format)) {
954 if (enabled_features.core12.separateDepthStencilLayouts) {
955 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
956 auto vuid = GetImageBarrierVUID(loc, ImageError::kNotDepthOrStencilAspect);
sfricke-samsung79b00482020-04-01 21:15:50 -0700957 skip |= LogError(img_barrier.image, vuid,
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600958 "%s references %s of format %s that must have either the depth or stencil "
959 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
960 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
961 string_VkFormat(image_format), aspect_mask);
962 }
963 } else {
964 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
965 if ((aspect_mask & ds_mask) != (ds_mask)) {
966 auto error = IsExtEnabled(device_extensions.vk_khr_separate_depth_stencil_layouts)
967 ? ImageError::kNotSeparateDepthAndStencilAspect
968 : ImageError::kNotDepthAndStencilAspect;
969 auto vuid = GetImageBarrierVUID(image_loc, error);
970 skip |= LogError(img_barrier.image, vuid,
971 "%s references %s of format %s that must have the depth and stencil "
972 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700973 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700974 string_VkFormat(image_format), aspect_mask);
975 }
976 }
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600977 }
sfricke-samsung79b00482020-04-01 21:15:50 -0700978
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600979 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
980 // TODO: Set memory invalid which is in mem_tracker currently
981 } else if (!QueueFamilyIsExternal(img_barrier.srcQueueFamilyIndex)) {
982 auto &write_subresource_map = layout_updates[image_state.get()];
983 bool new_write = false;
984 if (!write_subresource_map) {
985 write_subresource_map = std::make_shared<ImageSubresourceLayoutMap>(*image_state);
986 new_write = true;
987 }
988 const auto &current_subresource_map = current_map.find(image_state.get());
989 const auto &read_subresource_map = (new_write && current_subresource_map != current_map.end())
990 ? (*current_subresource_map).second
991 : write_subresource_map;
992
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600993 // Validate aspects in isolation.
994 // This is required when handling separate depth-stencil layouts.
995 for (uint32_t aspect_index = 0; aspect_index < 32; aspect_index++) {
996 VkImageAspectFlags test_aspect = 1u << aspect_index;
997 if ((img_barrier.subresourceRange.aspectMask & test_aspect) == 0) {
998 continue;
999 }
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -06001000 auto old_layout = NormalizeSynchronization2Layout(img_barrier.subresourceRange.aspectMask, img_barrier.oldLayout);
Jeremy Gebben3d6fc342022-04-19 10:03:12 -06001001
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -06001002 LayoutUseCheckAndMessage layout_check(old_layout, test_aspect);
Jeremy Gebben3d6fc342022-04-19 10:03:12 -06001003 auto normalized_isr = image_state->NormalizeSubresourceRange(img_barrier.subresourceRange);
1004 normalized_isr.aspectMask = test_aspect;
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -06001005 skip |= read_subresource_map->AnyInRange(
Jeremy Gebbencb13f0f2022-07-15 15:48:05 -06001006 normalized_isr, [this, read_subresource_map, cb_state, &layout_check, &loc, &img_barrier](
1007 const LayoutRange &range, const LayoutEntry &state) {
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -06001008 bool subres_skip = false;
1009 if (!layout_check.Check(state)) {
1010 const auto &vuid = GetImageBarrierVUID(loc, ImageError::kConflictingLayout);
Jeremy Gebbencb13f0f2022-07-15 15:48:05 -06001011 auto subres = read_subresource_map->Decode(range.begin);
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -06001012 subres_skip = LogError(
1013 cb_state->commandBuffer(), vuid,
1014 "%s %s cannot transition the layout of aspect=%d level=%d layer=%d from %s when the "
1015 "%s layout is %s.",
1016 loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(), subres.aspectMask,
1017 subres.mipLevel, subres.arrayLayer, string_VkImageLayout(img_barrier.oldLayout),
1018 layout_check.message, string_VkImageLayout(layout_check.layout));
1019 }
1020 return subres_skip;
1021 });
Jeremy Gebben3d6fc342022-04-19 10:03:12 -06001022 write_subresource_map->SetSubresourceRangeLayout(*cb_state, normalized_isr, img_barrier.newLayout);
1023 }
Jeremy Gebben3d6fc342022-04-19 10:03:12 -06001024 }
1025
1026 // checks color format and (single-plane or non-disjoint)
1027 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
1028 if ((FormatIsColor(image_format) == true) &&
1029 ((FormatIsMultiplane(image_format) == false) || (image_state->disjoint == false))) {
1030 if (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT) {
1031 auto error = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion) ? ImageError::kNotColorAspect
1032 : ImageError::kNotColorAspectYcbcr;
1033 const auto &vuid = GetImageBarrierVUID(loc, error);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001034 skip |= LogError(img_barrier.image, vuid,
Jeremy Gebben3d6fc342022-04-19 10:03:12 -06001035 "%s references %s of format %s that must be only VK_IMAGE_ASPECT_COLOR_BIT, "
1036 "but its aspectMask is 0x%" PRIx32 ".",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001037 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -07001038 string_VkFormat(image_format), aspect_mask);
1039 }
Jeremy Gebben3d6fc342022-04-19 10:03:12 -06001040 }
sfricke-samsung79b00482020-04-01 21:15:50 -07001041
Jeremy Gebben3d6fc342022-04-19 10:03:12 -06001042 VkImageAspectFlags valid_disjoint_mask =
1043 VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT | VK_IMAGE_ASPECT_COLOR_BIT;
1044 if ((FormatIsMultiplane(image_format) == true) && (image_state->disjoint == true) &&
1045 ((aspect_mask & valid_disjoint_mask) == 0)) {
1046 const auto &vuid = GetImageBarrierVUID(image_loc, ImageError::kBadMultiplanarAspect);
1047 skip |= LogError(img_barrier.image, vuid,
1048 "%s references %s of format %s has aspectMask (0x%" PRIx32
1049 ") but needs to include either an VK_IMAGE_ASPECT_PLANE_*_BIT or VK_IMAGE_ASPECT_COLOR_BIT.",
1050 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1051 string_VkFormat(image_format), aspect_mask);
1052 }
1053
1054 if ((FormatPlaneCount(image_format) == 2) && ((aspect_mask & VK_IMAGE_ASPECT_PLANE_2_BIT) != 0)) {
1055 const auto &vuid = GetImageBarrierVUID(image_loc, ImageError::kBadPlaneCount);
1056 skip |= LogError(img_barrier.image, vuid,
1057 "%s references %s of format %s has only two planes but included "
1058 "VK_IMAGE_ASPECT_PLANE_2_BIT in its aspectMask (0x%" PRIx32 ").",
1059 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1060 string_VkFormat(image_format), aspect_mask);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001061 }
1062 }
1063 return skip;
1064}
1065
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001066template <typename Barrier, typename TransferBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001067bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const Location &loc, const CMD_BUFFER_STATE *cb_state, const Barrier &barrier,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001068 const QFOTransferBarrierSets<TransferBarrier> &barrier_sets) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001069 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001070 const char *handle_name = TransferBarrier::HandleName();
John Zulauf6b4aae82018-05-09 13:03:36 -06001071 const char *transfer_type = nullptr;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001072 if (!IsTransferOp(barrier)) {
1073 return skip;
1074 }
1075 const TransferBarrier *barrier_record = nullptr;
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001076 if (cb_state->IsReleaseOp(barrier) && !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001077 const auto found = barrier_sets.release.find(barrier);
1078 if (found != barrier_sets.release.cend()) {
1079 barrier_record = &(*found);
1080 transfer_type = "releasing";
John Zulauf6b4aae82018-05-09 13:03:36 -06001081 }
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001082 } else if (cb_state->IsAcquireOp(barrier) && !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001083 const auto found = barrier_sets.acquire.find(barrier);
1084 if (found != barrier_sets.acquire.cend()) {
1085 barrier_record = &(*found);
1086 transfer_type = "acquiring";
John Zulauf6b4aae82018-05-09 13:03:36 -06001087 }
1088 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001089 if (barrier_record != nullptr) {
1090 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001091 LogWarning(cb_state->commandBuffer(), TransferBarrier::ErrMsgDuplicateQFOInCB(),
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001092 "%s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
1093 " duplicates existing barrier recorded in this command buffer.",
1094 loc.Message().c_str(), transfer_type, handle_name, report_data->FormatHandle(barrier_record->handle).c_str(),
1095 barrier_record->srcQueueFamilyIndex, barrier_record->dstQueueFamilyIndex);
1096 }
John Zulauf6b4aae82018-05-09 13:03:36 -06001097 return skip;
1098}
1099
John Zulaufa4472282019-08-22 14:44:34 -06001100VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
1101 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1102}
1103
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001104VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier2KHR &barrier) {
1105 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1106}
1107
Jeremy Gebben9f537102021-10-05 16:37:12 -06001108std::shared_ptr<const IMAGE_STATE> BarrierHandleState(const ValidationStateTracker &device_state,
1109 const VkImageMemoryBarrier &barrier) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001110 return device_state.Get<IMAGE_STATE>(barrier.image);
John Zulaufa4472282019-08-22 14:44:34 -06001111}
1112
Jeremy Gebben9f537102021-10-05 16:37:12 -06001113std::shared_ptr<const IMAGE_STATE> BarrierHandleState(const ValidationStateTracker &device_state,
1114 const VkImageMemoryBarrier2KHR &barrier) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001115 return device_state.Get<IMAGE_STATE>(barrier.image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001116}
1117
John Zulaufa4472282019-08-22 14:44:34 -06001118VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
1119 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1120}
1121
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001122VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier2KHR &barrier) {
1123 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1124}
1125
Jeremy Gebben9f537102021-10-05 16:37:12 -06001126const std::shared_ptr<const BUFFER_STATE> BarrierHandleState(const ValidationStateTracker &device_state,
1127 const VkBufferMemoryBarrier &barrier) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001128 return device_state.Get<BUFFER_STATE>(barrier.buffer);
John Zulaufa4472282019-08-22 14:44:34 -06001129}
1130
Jeremy Gebben9f537102021-10-05 16:37:12 -06001131std::shared_ptr<const BUFFER_STATE> BarrierHandleState(const ValidationStateTracker &device_state,
1132 const VkBufferMemoryBarrier2KHR &barrier) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001133 return device_state.Get<BUFFER_STATE>(barrier.buffer);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001134}
John Zulaufa4472282019-08-22 14:44:34 -06001135
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001136template <typename Barrier, typename TransferBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001137void CoreChecks::RecordBarrierValidationInfo(const Location &loc, CMD_BUFFER_STATE *cb_state, const Barrier &barrier,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001138 QFOTransferBarrierSets<TransferBarrier> &barrier_sets) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001139 if (IsTransferOp(barrier)) {
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001140 if (cb_state->IsReleaseOp(barrier) && !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001141 barrier_sets.release.emplace(barrier);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001142 } else if (cb_state->IsAcquireOp(barrier) && !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001143 barrier_sets.acquire.emplace(barrier);
John Zulaufa4472282019-08-22 14:44:34 -06001144 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001145 }
John Zulaufa4472282019-08-22 14:44:34 -06001146
David Zhao Akeleyd76df472021-05-15 17:25:59 -07001147 // 7.7.4: If the values of srcQueueFamilyIndex and dstQueueFamilyIndex are equal, no ownership transfer is performed, and the
1148 // barrier operates as if they were both set to VK_QUEUE_FAMILY_IGNORED.
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001149 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
1150 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
David Zhao Akeleyd76df472021-05-15 17:25:59 -07001151 const bool is_ownership_transfer = src_queue_family != dst_queue_family;
1152
1153 if (is_ownership_transfer) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001154 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
1155 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
1156 auto handle_state = BarrierHandleState(*this, barrier);
1157 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
1158 if (!mode_concurrent) {
1159 const auto typed_handle = BarrierTypedHandle(barrier);
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001160 core_error::LocationCapture loc_capture(loc);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001161 cb_state->queue_submit_functions.emplace_back(
Jeremy Gebbene5361dd2021-11-18 14:23:56 -07001162 [loc_capture, typed_handle, src_queue_family, dst_queue_family](
1163 const ValidationStateTracker &device_data, const QUEUE_STATE &queue_state, const CMD_BUFFER_STATE &cb_state) {
John Zulaufb4438f02021-02-20 20:22:16 -07001164 return ValidateConcurrentBarrierAtSubmit(loc_capture.Get(), device_data, queue_state, cb_state, typed_handle,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001165 src_queue_family, dst_queue_family);
1166 });
John Zulauf6b4aae82018-05-09 13:03:36 -06001167 }
1168 }
1169}
1170
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001171// Verify image barrier image state and that the image is consistent with FB image
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001172template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001173bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001174 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1175 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001176 const ImgBarrier &img_barrier, const CMD_BUFFER_STATE *primary_cb_state) const {
1177 using sync_vuid_maps::GetImageBarrierVUID;
1178 using sync_vuid_maps::ImageError;
1179
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001180 bool skip = false;
1181 const auto *fb_state = framebuffer;
1182 assert(fb_state);
1183 const auto img_bar_image = img_barrier.image;
1184 bool image_match = false;
1185 bool sub_image_found = false; // Do we find a corresponding subpass description
1186 VkImageLayout sub_image_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1187 uint32_t attach_index = 0;
1188 // Verify that a framebuffer image matches barrier image
1189 const auto attachment_count = fb_state->createInfo.attachmentCount;
1190 for (uint32_t attachment = 0; attachment < attachment_count; ++attachment) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06001191 auto view_state = primary_cb_state ? primary_cb_state->GetActiveAttachmentImageViewState(attachment) : cb_state->GetActiveAttachmentImageViewState(attachment);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001192 if (view_state && (img_bar_image == view_state->create_info.image)) {
1193 image_match = true;
1194 attach_index = attachment;
1195 break;
1196 }
1197 }
1198 if (image_match) { // Make sure subpass is referring to matching attachment
1199 if (sub_desc.pDepthStencilAttachment && sub_desc.pDepthStencilAttachment->attachment == attach_index) {
1200 sub_image_layout = sub_desc.pDepthStencilAttachment->layout;
1201 sub_image_found = true;
1202 }
sfricke-samsung45996a42021-09-16 13:45:27 -07001203 if (!sub_image_found && IsExtEnabled(device_extensions.vk_khr_depth_stencil_resolve)) {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001204 const auto *resolve = LvlFindInChain<VkSubpassDescriptionDepthStencilResolve>(sub_desc.pNext);
1205 if (resolve && resolve->pDepthStencilResolveAttachment &&
1206 resolve->pDepthStencilResolveAttachment->attachment == attach_index) {
1207 sub_image_layout = resolve->pDepthStencilResolveAttachment->layout;
1208 sub_image_found = true;
1209 }
1210 }
1211 if (!sub_image_found) {
1212 for (uint32_t j = 0; j < sub_desc.colorAttachmentCount; ++j) {
1213 if (sub_desc.pColorAttachments && sub_desc.pColorAttachments[j].attachment == attach_index) {
1214 sub_image_layout = sub_desc.pColorAttachments[j].layout;
1215 sub_image_found = true;
1216 break;
1217 }
1218 if (!sub_image_found && sub_desc.pResolveAttachments &&
1219 sub_desc.pResolveAttachments[j].attachment == attach_index) {
1220 sub_image_layout = sub_desc.pResolveAttachments[j].layout;
1221 sub_image_found = true;
1222 break;
1223 }
1224 }
1225 }
1226 if (!sub_image_found) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001227 auto img_loc = loc.dot(Field::image);
1228 const auto &vuid = GetImageBarrierVUID(img_loc, ImageError::kRenderPassMismatch);
1229 skip |=
1230 LogError(rp_handle, vuid,
1231 "%s Barrier for %s is not referenced by the VkSubpassDescription for active subpass (%d) of current %s.",
1232 img_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(), active_subpass,
1233 report_data->FormatHandle(rp_handle).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001234 }
1235 } else { // !image_match
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001236 auto img_loc = loc.dot(Field::image);
1237 const auto &vuid = GetImageBarrierVUID(img_loc, ImageError::kRenderPassMismatch);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001238 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 -07001239 img_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001240 report_data->FormatHandle(fb_state->framebuffer()).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001241 }
1242 if (img_barrier.oldLayout != img_barrier.newLayout) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001243 auto layout_loc = loc.dot(Field::oldLayout);
1244 const auto &vuid = GetImageBarrierVUID(layout_loc, ImageError::kRenderPassLayoutChange);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001245 skip |= LogError(cb_state->commandBuffer(), vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001246 "%s As the Image Barrier for %s is being executed within a render pass instance, oldLayout must "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001247 "equal newLayout yet they are %s and %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001248 layout_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001249 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(img_barrier.newLayout));
1250 } else {
1251 if (sub_image_found && sub_image_layout != img_barrier.oldLayout) {
1252 LogObjectList objlist(rp_handle);
1253 objlist.add(img_bar_image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001254 auto layout_loc = loc.dot(Field::oldLayout);
1255 const auto &vuid = GetImageBarrierVUID(layout_loc, ImageError::kRenderPassLayoutChange);
1256 skip |= LogError(objlist, vuid,
1257 "%s Barrier for %s is referenced by the VkSubpassDescription for active "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001258 "subpass (%d) of current %s as having layout %s, but image barrier has layout %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001259 layout_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(), active_subpass,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001260 report_data->FormatHandle(rp_handle).c_str(), string_VkImageLayout(sub_image_layout),
1261 string_VkImageLayout(img_barrier.oldLayout));
1262 }
1263 }
1264 return skip;
1265}
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001266// explictly instantiate so these can be used in core_validation.cpp
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001267template bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001268 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1269 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
1270 const VkImageMemoryBarrier &img_barrier,
1271 const CMD_BUFFER_STATE *primary_cb_state) const;
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001272template bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001273 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1274 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
1275 const VkImageMemoryBarrier2KHR &img_barrier,
1276 const CMD_BUFFER_STATE *primary_cb_state) const;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001277
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001278template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001279void CoreChecks::EnqueueSubmitTimeValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001280 const ImgBarrier &barrier) {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001281 // Secondary CBs can have null framebuffer so queue up validation in that case 'til FB is known
1282 if ((cb_state->activeRenderPass) && (VK_NULL_HANDLE == cb_state->activeFramebuffer) &&
1283 (VK_COMMAND_BUFFER_LEVEL_SECONDARY == cb_state->createInfo.level)) {
1284 const auto active_subpass = cb_state->activeSubpass;
1285 const auto rp_state = cb_state->activeRenderPass;
1286 const auto &sub_desc = rp_state->createInfo.pSubpasses[active_subpass];
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001287 // Secondary CB case w/o FB specified delay validation
1288 auto *this_ptr = this; // Required for older compilers with c++20 compatibility
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001289 core_error::LocationCapture loc_capture(loc);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001290 const auto render_pass = rp_state->renderPass();
John Zulaufb4438f02021-02-20 20:22:16 -07001291 cb_state->cmd_execute_commands_functions.emplace_back(
Jeremy Gebben057f9d52021-11-05 14:12:31 -06001292 [this_ptr, loc_capture, active_subpass, sub_desc, render_pass, barrier](
1293 const CMD_BUFFER_STATE &secondary_cb, const CMD_BUFFER_STATE *primary_cb, const FRAMEBUFFER_STATE *fb) {
1294 return this_ptr->ValidateImageBarrierAttachment(loc_capture.Get(), &secondary_cb, fb, active_subpass, sub_desc,
John Zulaufb4438f02021-02-20 20:22:16 -07001295 render_pass, barrier, primary_cb);
1296 });
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001297 }
1298}
1299
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001300void CoreChecks::RecordBarriers(Func func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001301 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1302 const VkImageMemoryBarrier *pImageMemBarriers) {
1303 for (uint32_t i = 0; i < bufferBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001304 Location loc(func_name, Struct::VkBufferMemoryBarrier, Field::pBufferMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001305 RecordBarrierValidationInfo(loc, cb_state, pBufferMemBarriers[i], cb_state->qfo_transfer_buffer_barriers);
1306 }
1307 for (uint32_t i = 0; i < imageMemBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001308 Location loc(func_name, Struct::VkImageMemoryBarrier, Field::pImageMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001309 const auto &img_barrier = pImageMemBarriers[i];
1310 RecordBarrierValidationInfo(loc, cb_state, img_barrier, cb_state->qfo_transfer_image_barriers);
1311 EnqueueSubmitTimeValidateImageBarrierAttachment(loc, cb_state, img_barrier);
1312 }
1313}
1314
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001315void CoreChecks::RecordBarriers(Func func_name, CMD_BUFFER_STATE *cb_state, const VkDependencyInfoKHR &dep_info) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001316 for (uint32_t i = 0; i < dep_info.bufferMemoryBarrierCount; i++) {
Tony-LunarG279601c2021-11-16 10:50:51 -07001317 Location loc(func_name, Struct::VkBufferMemoryBarrier2, Field::pBufferMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001318 RecordBarrierValidationInfo(loc, cb_state, dep_info.pBufferMemoryBarriers[i], cb_state->qfo_transfer_buffer_barriers);
1319 }
1320 for (uint32_t i = 0; i < dep_info.imageMemoryBarrierCount; i++) {
Tony-LunarG279601c2021-11-16 10:50:51 -07001321 Location loc(func_name, Struct::VkImageMemoryBarrier2, Field::pImageMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001322 const auto &img_barrier = dep_info.pImageMemoryBarriers[i];
1323 RecordBarrierValidationInfo(loc, cb_state, img_barrier, cb_state->qfo_transfer_image_barriers);
1324 EnqueueSubmitTimeValidateImageBarrierAttachment(loc, cb_state, img_barrier);
1325 }
1326}
1327
1328template <typename TransferBarrier, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001329bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001330 const char *operation, const TransferBarrier &barrier,
1331 Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001332 // Record to the scoreboard or report that we have a duplication
1333 bool skip = false;
Jeremy Gebbencbf22862021-03-03 12:01:22 -07001334 auto inserted = scoreboard->emplace(barrier, cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001335 if (!inserted.second && inserted.first->second != cb_state) {
1336 // 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 -06001337 LogObjectList objlist(cb_state->commandBuffer());
Mark Lobodzinskiea561582020-03-16 18:13:56 -06001338 objlist.add(barrier.handle);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001339 objlist.add(inserted.first->second->commandBuffer());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001340 skip = LogWarning(objlist, TransferBarrier::ErrMsgDuplicateQFOInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001341 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1342 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001343 "vkQueueSubmit()", TransferBarrier::BarrierName(), operation, TransferBarrier::HandleName(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001344 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001345 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer()).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001346 }
1347 return skip;
1348}
1349
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001350template <typename TransferBarrier>
1351bool CoreChecks::ValidateQueuedQFOTransferBarriers(
1352 const CMD_BUFFER_STATE *cb_state, QFOTransferCBScoreboards<TransferBarrier> *scoreboards,
1353 const GlobalQFOTransferBarrierMap<TransferBarrier> &global_release_barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001354 bool skip = false;
Jeremy Gebben159b3cc2021-06-03 09:09:03 -06001355 const auto &cb_barriers = cb_state->GetQFOBarrierSets(TransferBarrier());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001356 const char *barrier_name = TransferBarrier::BarrierName();
1357 const char *handle_name = TransferBarrier::HandleName();
John Zulauf6b4aae82018-05-09 13:03:36 -06001358 // No release should have an extant duplicate (WARNING)
1359 for (const auto &release : cb_barriers.release) {
1360 // Check the global pending release barriers
1361 const auto set_it = global_release_barriers.find(release.handle);
1362 if (set_it != global_release_barriers.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001363 const QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001364 const auto found = set_for_handle.find(release);
1365 if (found != set_for_handle.cend()) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001366 skip |= LogWarning(cb_state->commandBuffer(), TransferBarrier::ErrMsgDuplicateQFOSubmitted(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001367 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1368 " to dstQueueFamilyIndex %" PRIu32
1369 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1370 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1371 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001372 }
1373 }
1374 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1375 }
1376 // Each acquire must have a matching release (ERROR)
1377 for (const auto &acquire : cb_barriers.acquire) {
1378 const auto set_it = global_release_barriers.find(acquire.handle);
1379 bool matching_release_found = false;
1380 if (set_it != global_release_barriers.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001381 const QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001382 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1383 }
1384 if (!matching_release_found) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001385 skip |= LogError(cb_state->commandBuffer(), TransferBarrier::ErrMsgMissingQFOReleaseInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001386 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1387 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1388 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1389 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001390 }
1391 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1392 }
1393 return skip;
1394}
1395
John Zulauf3b04ebd2019-07-18 14:08:11 -06001396bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001397 QFOTransferCBScoreboards<QFOImageTransferBarrier> *qfo_image_scoreboards,
1398 QFOTransferCBScoreboards<QFOBufferTransferBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001399 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001400 skip |=
1401 ValidateQueuedQFOTransferBarriers<QFOImageTransferBarrier>(cb_state, qfo_image_scoreboards, qfo_release_image_barrier_map);
1402 skip |= ValidateQueuedQFOTransferBarriers<QFOBufferTransferBarrier>(cb_state, qfo_buffer_scoreboards,
1403 qfo_release_buffer_barrier_map);
John Zulauf6b4aae82018-05-09 13:03:36 -06001404 return skip;
1405}
1406
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001407template <typename TransferBarrier>
1408void RecordQueuedQFOTransferBarriers(QFOTransferBarrierSets<TransferBarrier> &cb_barriers,
1409 GlobalQFOTransferBarrierMap<TransferBarrier> &global_release_barriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001410 // Add release barriers from this submit to the global map
1411 for (const auto &release : cb_barriers.release) {
1412 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
Jeremy Gebben51499ca2022-01-11 08:36:13 -07001413 // NOTE: vl_concurrent_ordered_map::find() makes a thread safe copy of the result, so we must
1414 // copy back after updating.
1415 auto iter = global_release_barriers.find(release.handle);
1416 iter->second.insert(release);
1417 global_release_barriers.insert_or_assign(release.handle, iter->second);
John Zulauf6b4aae82018-05-09 13:03:36 -06001418 }
1419
1420 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1421 for (const auto &acquire : cb_barriers.acquire) {
1422 // NOTE: We're not using [] because we don't want to create entries for missing releases
1423 auto set_it = global_release_barriers.find(acquire.handle);
1424 if (set_it != global_release_barriers.end()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001425 QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001426 set_for_handle.erase(acquire);
1427 if (set_for_handle.size() == 0) { // Clean up empty sets
Jeremy Gebben51499ca2022-01-11 08:36:13 -07001428 global_release_barriers.erase(acquire.handle);
1429 } else {
1430 // NOTE: vl_concurrent_ordered_map::find() makes a thread safe copy of the result, so we must
1431 // copy back after updating.
1432 global_release_barriers.insert_or_assign(acquire.handle, set_for_handle);
John Zulauf6b4aae82018-05-09 13:03:36 -06001433 }
1434 }
1435 }
1436}
1437
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001438void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001439 RecordQueuedQFOTransferBarriers<QFOImageTransferBarrier>(cb_state->qfo_transfer_image_barriers, qfo_release_image_barrier_map);
1440 RecordQueuedQFOTransferBarriers<QFOBufferTransferBarrier>(cb_state->qfo_transfer_buffer_barriers,
1441 qfo_release_buffer_barrier_map);
John Zulauf6b4aae82018-05-09 13:03:36 -06001442}
1443
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001444template <typename ImgBarrier>
1445void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count, const ImgBarrier *barriers) {
1446 // For ownership transfers, the barrier is specified twice; as a release
1447 // operation on the yielding queue family, and as an acquire operation
1448 // on the acquiring queue family. This barrier may also include a layout
1449 // transition, which occurs 'between' the two operations. For validation
1450 // purposes it doesn't seem important which side performs the layout
1451 // transition, but it must not be performed twice. We'll arbitrarily
1452 // choose to perform it as part of the acquire operation.
1453 //
1454 // However, we still need to record initial layout for the "initial layout" validation
1455 for (uint32_t i = 0; i < barrier_count; i++) {
1456 const auto &mem_barrier = barriers[i];
Jeremy Gebbenefead332021-06-18 08:22:44 -06001457 const bool is_release_op = cb_state->IsReleaseOp(mem_barrier);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001458 auto image_state = Get<IMAGE_STATE>(mem_barrier.image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001459 if (image_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06001460 RecordTransitionImageLayout(cb_state, image_state.get(), mem_barrier, is_release_op);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001461 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001462 }
1463}
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001464// explictly instantiate this template so it can be used in core_validation.cpp
1465template void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1466 const VkImageMemoryBarrier *barrier);
1467template void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1468 const VkImageMemoryBarrier2KHR *barrier);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001469
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001470VkImageLayout NormalizeSynchronization2Layout(const VkImageAspectFlags aspect_mask, VkImageLayout layout);
1471
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001472template <typename ImgBarrier>
unknown86bcb3a2019-07-11 13:05:36 -06001473void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001474 const ImgBarrier &mem_barrier, bool is_release_op) {
Tony-LunarG273f32f2021-09-28 08:56:30 -06001475 if (enabled_features.core13.synchronization2) {
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001476 if (mem_barrier.oldLayout == mem_barrier.newLayout) {
1477 return;
1478 }
1479 }
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06001480 auto normalized_isr = image_state->NormalizeSubresourceRange(mem_barrier.subresourceRange);
unknown86bcb3a2019-07-11 13:05:36 -06001481
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001482 VkImageLayout initial_layout = NormalizeSynchronization2Layout(mem_barrier.subresourceRange.aspectMask, mem_barrier.oldLayout);
1483 VkImageLayout new_layout = NormalizeSynchronization2Layout(mem_barrier.subresourceRange.aspectMask, mem_barrier.newLayout);
Michael Spang8af7c102020-05-03 20:50:09 -04001484
1485 // Layout transitions in external instance are not tracked, so don't validate initial layout.
John Zulaufcea64cb2020-06-10 17:17:27 -06001486 if (QueueFamilyIsExternal(mem_barrier.srcQueueFamilyIndex)) {
Michael Spang8af7c102020-05-03 20:50:09 -04001487 initial_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1488 }
1489
John Zulauf2be3fe02019-12-30 09:48:02 -07001490 if (is_release_op) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06001491 cb_state->SetImageInitialLayout(*image_state, normalized_isr, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001492 } else {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06001493 cb_state->SetImageLayout(*image_state, normalized_isr, new_layout, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001494 }
unknown86bcb3a2019-07-11 13:05:36 -06001495}
1496
John Zulauf15578df2022-06-02 13:50:03 -06001497template <typename RangeFactory>
1498bool CoreChecks::VerifyImageLayoutRange(const CMD_BUFFER_STATE &cb_node, const IMAGE_STATE &image_state,
1499 VkImageAspectFlags aspect_mask, VkImageLayout explicit_layout,
1500 const RangeFactory &range_factory, const char *caller, const char *layout_mismatch_msg_code,
1501 bool *error) const {
1502 bool skip = false;
1503 const auto *subresource_map = cb_node.GetImageSubresourceLayoutMap(image_state);
1504 if (!subresource_map) return skip;
1505
1506 LayoutUseCheckAndMessage layout_check(explicit_layout, aspect_mask);
1507 skip |= subresource_map->AnyInRange(
Jeremy Gebbencb13f0f2022-07-15 15:48:05 -06001508 range_factory(*subresource_map), [this, subresource_map, &cb_node, &image_state, &layout_check, layout_mismatch_msg_code,
1509 caller, error](const LayoutRange &range, const LayoutEntry &state) {
John Zulauf15578df2022-06-02 13:50:03 -06001510 bool subres_skip = false;
1511 if (!layout_check.Check(state)) {
1512 *error = true;
Jeremy Gebbencb13f0f2022-07-15 15:48:05 -06001513 auto subres = subresource_map->Decode(range.begin);
John Zulauf15578df2022-06-02 13:50:03 -06001514 subres_skip |= LogError(cb_node.commandBuffer(), layout_mismatch_msg_code,
1515 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1516 "%s layout %s.",
1517 caller, report_data->FormatHandle(image_state.Handle()).c_str(), subres.arrayLayer,
1518 subres.mipLevel, string_VkImageLayout(layout_check.expected_layout), layout_check.message,
1519 string_VkImageLayout(layout_check.layout));
1520 }
1521 return subres_skip;
1522 });
1523
1524 return skip;
1525}
1526
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001527bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE &cb_node, const IMAGE_STATE &image_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001528 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1529 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1530 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06001531 if (disabled[image_layout_validation]) return false;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001532 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001533
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001534 VkImageSubresourceRange normalized_isr = image_state.NormalizeSubresourceRange(range);
John Zulauf15578df2022-06-02 13:50:03 -06001535 auto range_factory = [&normalized_isr](const ImageSubresourceLayoutMap &map) {
1536 return map.RangeGen(normalized_isr);
1537 };
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001538 skip |= VerifyImageLayoutRange(cb_node, image_state, aspect_mask, explicit_layout, range_factory, caller,
John Zulauf15578df2022-06-02 13:50:03 -06001539 layout_mismatch_msg_code, error);
John Zulauff660ad62019-03-23 07:16:05 -06001540
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001541 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1542 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1543 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001544 if (image_state.createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001545 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001546 skip |= LogPerformanceWarning(cb_node.commandBuffer(), kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001547 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001548 report_data->FormatHandle(image_state.Handle()).c_str(),
Jeremy Gebben6335df62021-11-01 10:50:13 -06001549 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001550 }
sfricke-samsung45996a42021-09-16 13:45:27 -07001551 } else if (IsExtEnabled(device_extensions.vk_khr_shared_presentable_image)) {
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001552 if (image_state.shared_presentable) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001553 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001554 skip |=
1555 LogError(device, layout_invalid_msg_code,
1556 "%s: Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1557 caller, string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001558 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001559 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001560 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001561 *error = true;
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001562 skip |= LogError(cb_node.commandBuffer(), layout_invalid_msg_code,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001563 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001564 report_data->FormatHandle(image_state.Handle()).c_str(), string_VkImageLayout(explicit_layout),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001565 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001566 }
1567 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001568 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001569}
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001570bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE &cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001571 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1572 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001573 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001574 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1575 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1576}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001577
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001578bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE &cb_node, const IMAGE_VIEW_STATE &image_view_state,
Jeremy Gebbene7b99fc2022-06-02 08:44:33 -06001579 VkImageLayout explicit_layout, const char *caller, const char *layout_mismatch_msg_code,
1580 bool *error) const {
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -06001581 if (disabled[image_layout_validation]) return false;
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001582 assert(image_view_state.image_state);
1583 auto range_factory = [&image_view_state](const ImageSubresourceLayoutMap &map) {
1584 return image_layout_map::RangeGenerator(image_view_state.range_generator);
John Zulauf15578df2022-06-02 13:50:03 -06001585 };
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -06001586
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001587 return VerifyImageLayoutRange(cb_node, *image_view_state.image_state, image_view_state.create_info.subresourceRange.aspectMask,
1588 explicit_layout, range_factory, caller, layout_mismatch_msg_code, error);
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -06001589}
1590
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001591void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001592 FRAMEBUFFER_STATE *framebuffer_state) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001593 auto render_pass = Get<RENDER_PASS_STATE>(pRenderPassBegin->renderPass);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001594 if (!render_pass) return;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001595
Mike Schuchardt2df08912020-12-15 16:28:09 -08001596 const VkRenderPassCreateInfo2 *render_pass_info = render_pass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001597 if (framebuffer_state) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001598 for (uint32_t i = 0; i < render_pass_info->attachmentCount; ++i) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06001599 auto *view_state = pCB->GetActiveAttachmentImageViewState(i);
John Zulauf8e308292018-09-21 11:34:37 -06001600 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001601 VkImageLayout stencil_layout = kInvalidLayout;
1602 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001603 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(render_pass_info->pAttachments[i].pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -07001604 if (attachment_description_stencil_layout) {
1605 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1606 }
Jeremy Gebben1ec89332021-08-05 13:51:49 -06001607 pCB->SetImageViewLayout(*view_state, render_pass_info->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001608 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001609 }
1610 }
1611}
Dave Houltone19e20d2018-02-02 16:32:41 -07001612
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001613#ifdef VK_USE_PLATFORM_ANDROID_KHR
1614// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1615// This could also move into a seperate core_validation_android.cpp file... ?
1616
1617//
1618// AHB-specific validation within non-AHB APIs
1619//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001620bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001621 bool skip = false;
1622
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001623 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(create_info->pNext);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001624 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001625 if (0 != ext_fmt_android->externalFormat) {
1626 if (VK_FORMAT_UNDEFINED != create_info->format) {
1627 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001628 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1629 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1630 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001631 }
1632
1633 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001634 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1635 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1636 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001637 }
1638
1639 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001640 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1641 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06001642 "non-zero externalFormat, but usage includes bits (0x%" PRIx32 ") other than VK_IMAGE_USAGE_SAMPLED_BIT.",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001643 create_info->usage);
Dave Houltond9611312018-11-19 17:03:36 -07001644 }
1645
1646 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001647 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1648 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1649 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001650 }
1651 }
1652
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001653 if ((0 != ext_fmt_android->externalFormat) &&
1654 (ahb_ext_formats_map.find(ext_fmt_android->externalFormat) == ahb_ext_formats_map.end())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001655 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001656 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat (%" PRIu64
1657 ") which has "
1658 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().",
1659 ext_fmt_android->externalFormat);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001660 }
1661 }
1662
Dave Houltond9611312018-11-19 17:03:36 -07001663 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001664 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001665 skip |=
1666 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1667 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1668 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001669 }
1670 }
1671
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001672 const VkExternalMemoryImageCreateInfo *emici = LvlFindInChain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001673 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1674 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001675 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001676 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1677 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1678 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1679 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001680 }
1681
1682 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001683 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1684 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1685 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1686 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1687 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001688 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001689 }
1690
1691 return skip;
1692}
1693
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001694bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001695 bool skip = false;
Jeremy Gebbenf4449392022-01-28 10:09:10 -07001696 auto image_state = Get<IMAGE_STATE>(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001697
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06001698 if (image_state->HasAHBFormat()) {
Dave Houltond9611312018-11-19 17:03:36 -07001699 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001700 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1701 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001702 "format member is %s and must be VK_FORMAT_UNDEFINED.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001703 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001704 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001705
Dave Houltond9611312018-11-19 17:03:36 -07001706 // Chain must include a compatible ycbcr conversion
1707 bool conv_found = false;
1708 uint64_t external_format = 0;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001709 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = LvlFindInChain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001710 if (ycbcr_conv_info != nullptr) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001711 auto ycbcr_state = Get<SAMPLER_YCBCR_CONVERSION_STATE>(ycbcr_conv_info->conversion);
Jeremy Gebbenf4fb2a02021-07-08 09:57:46 -06001712 if (ycbcr_state) {
Dave Houltond9611312018-11-19 17:03:36 -07001713 conv_found = true;
Jeremy Gebbenf4fb2a02021-07-08 09:57:46 -06001714 external_format = ycbcr_state->external_format;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001715 }
Dave Houltond9611312018-11-19 17:03:36 -07001716 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001717 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001718 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001719 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1720 "an externalFormat (%" PRIu64
1721 ") but needs a chained VkSamplerYcbcrConversionInfo struct with a VkSamplerYcbcrConversion created "
1722 "with the same external format.",
1723 image_state->ahb_format);
Dave Houltond9611312018-11-19 17:03:36 -07001724 }
1725
1726 // Errors in create_info swizzles
sfricke-samsungbd0e8052020-06-06 01:36:39 -07001727 if (IsIdentitySwizzle(create_info->components) == false) {
1728 skip |= LogError(
1729 create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1730 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1731 "includes one or more non-identity component swizzles, r swizzle = %s, g swizzle = %s, b swizzle = %s, a swizzle "
1732 "= %s.",
1733 string_VkComponentSwizzle(create_info->components.r), string_VkComponentSwizzle(create_info->components.g),
1734 string_VkComponentSwizzle(create_info->components.b), string_VkComponentSwizzle(create_info->components.a));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001735 }
1736 }
Dave Houltond9611312018-11-19 17:03:36 -07001737
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001738 return skip;
1739}
1740
John Zulaufa26d3c82019-08-14 16:09:08 -06001741bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001742 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001743
Jeremy Gebbenf4449392022-01-28 10:09:10 -07001744 auto image_state = Get<IMAGE_STATE>(image);
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001745 if (image_state != nullptr) {
Aitor Camacho3294edd2022-05-16 22:34:19 +02001746 if (image_state->IsExternalAHB() && (0 == image_state->GetBoundMemoryStates().size())) {
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001747 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1748 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1749 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1750 "bound to memory.");
1751 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001752 }
1753 return skip;
1754}
1755
1756#else
1757
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001758bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001759 return false;
1760}
1761
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001762bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001763
John Zulaufa26d3c82019-08-14 16:09:08 -06001764bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001765
1766#endif // VK_USE_PLATFORM_ANDROID_KHR
1767
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001768bool CoreChecks::ValidateImageFormatFeatures(const VkImageCreateInfo *pCreateInfo) const {
1769 bool skip = false;
1770
1771 // validates based on imageCreateFormatFeatures from vkspec.html#resources-image-creation-limits
Lionel Landwerlin21719f62021-12-09 11:40:09 +02001772 VkFormatFeatureFlags2KHR tiling_features = 0;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001773 const VkImageTiling image_tiling = pCreateInfo->tiling;
1774 const VkFormat image_format = pCreateInfo->format;
1775
1776 if (image_format == VK_FORMAT_UNDEFINED) {
1777 // VU 01975 states format can't be undefined unless an android externalFormat
1778#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001779 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001780 if ((image_tiling == VK_IMAGE_TILING_OPTIMAL) && (ext_fmt_android != nullptr) && (0 != ext_fmt_android->externalFormat)) {
1781 auto it = ahb_ext_formats_map.find(ext_fmt_android->externalFormat);
1782 if (it != ahb_ext_formats_map.end()) {
1783 tiling_features = it->second;
1784 }
1785 }
1786#endif
1787 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
Lionel Landwerlin1da35792021-12-14 16:54:13 +02001788 layer_data::unordered_set<uint64_t> drm_format_modifiers;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001789 const VkImageDrmFormatModifierExplicitCreateInfoEXT *drm_explicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001790 LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001791 const VkImageDrmFormatModifierListCreateInfoEXT *drm_implicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001792 LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001793
1794 if (drm_explicit != nullptr) {
Lionel Landwerlin1da35792021-12-14 16:54:13 +02001795 drm_format_modifiers.insert(drm_explicit->drmFormatModifier);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001796 } else {
1797 // VUID 02261 makes sure its only explict or implict in parameter checking
1798 assert(drm_implicit != nullptr);
1799 for (uint32_t i = 0; i < drm_implicit->drmFormatModifierCount; i++) {
Lionel Landwerlin1da35792021-12-14 16:54:13 +02001800 drm_format_modifiers.insert(drm_implicit->pDrmFormatModifiers[i]);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001801 }
1802 }
1803
Lionel Landwerlin1da35792021-12-14 16:54:13 +02001804 auto fmt_drm_props = LvlInitStruct<VkDrmFormatModifierPropertiesListEXT>();
1805 auto fmt_props_2 = LvlInitStruct<VkFormatProperties2>(&fmt_drm_props);
1806 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &fmt_props_2);
Lionel Landwerlin09351a72020-06-22 18:15:59 +03001807 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
Lionel Landwerlin1da35792021-12-14 16:54:13 +02001808 drm_properties.resize(fmt_drm_props.drmFormatModifierCount);
1809 fmt_drm_props.pDrmFormatModifierProperties = drm_properties.data();
1810 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &fmt_props_2);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001811
Lionel Landwerlin1da35792021-12-14 16:54:13 +02001812 for (uint32_t i = 0; i < fmt_drm_props.drmFormatModifierCount; i++) {
1813 if (drm_format_modifiers.find(fmt_drm_props.pDrmFormatModifierProperties[i].drmFormatModifier) !=
1814 drm_format_modifiers.end()) {
1815 tiling_features |= fmt_drm_props.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001816 }
1817 }
1818 } else {
Lionel Landwerlin21719f62021-12-09 11:40:09 +02001819 VkFormatProperties3KHR format_properties = GetPDFormatProperties(image_format);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001820 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
1821 : format_properties.optimalTilingFeatures;
1822 }
1823
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001824 // Lack of disjoint format feature support while using the flag
1825 if (FormatIsMultiplane(image_format) && ((pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT) != 0) &&
Lionel Landwerlin21719f62021-12-09 11:40:09 +02001826 ((tiling_features & VK_FORMAT_FEATURE_2_DISJOINT_BIT_KHR) == 0)) {
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001827 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateFormatFeatures-02260",
1828 "vkCreateImage(): can't use VK_IMAGE_CREATE_DISJOINT_BIT because %s doesn't support "
1829 "VK_FORMAT_FEATURE_DISJOINT_BIT based on imageCreateFormatFeatures.",
1830 string_VkFormat(pCreateInfo->format));
1831 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001832
1833 return skip;
1834}
1835
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001836bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001837 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001838 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001839
sfricke-samsung45996a42021-09-16 13:45:27 -07001840 if (IsExtEnabled(device_extensions.vk_android_external_memory_android_hardware_buffer)) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001841 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001842 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1843 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001844 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1845 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001846 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001847 }
1848
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001849 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1850 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001851 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1852 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1853 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001854 }
Dave Houlton130c0212018-01-29 13:39:56 -07001855 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001856
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001857 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001858 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1859 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1860 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001861 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001862 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width (%u) exceeds "
1863 "device maxFramebufferWidth (%u).",
1864 pCreateInfo->extent.width, device_limits->maxFramebufferWidth);
Dave Houlton130c0212018-01-29 13:39:56 -07001865 }
1866
1867 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001868 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001869 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height (%u) exceeds "
1870 "device maxFramebufferHeight (%u).",
1871 pCreateInfo->extent.height, device_limits->maxFramebufferHeight);
Dave Houlton130c0212018-01-29 13:39:56 -07001872 }
1873
ziga-lunarg44cba6e2021-07-13 17:58:06 +02001874 VkImageCreateFlags sparseFlags =
1875 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
1876 if ((pCreateInfo->flags & sparseFlags) && (pCreateInfo->usage & VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT)) {
1877 skip |= LogError(
1878 device, "VUID-VkImageCreateInfo-None-01925",
1879 "vkCreateImage(): images using sparse memory cannot have VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT set");
1880 }
1881
Agarwal, Arpit78509112022-02-17 15:29:05 -07001882 if (!enabled_features.fragment_density_map_offset_features.fragmentDensityMapOffset) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001883 uint32_t ceiling_width = static_cast<uint32_t>(ceil(
1884 static_cast<float>(device_limits->maxFramebufferWidth) /
1885 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001886 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1887 skip |=
Agarwal, Arpit78509112022-02-17 15:29:05 -07001888 LogError(device, "VUID-VkImageCreateInfo-fragmentDensityMapOffset-06514",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001889 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1890 "ceiling of device "
1891 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1892 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1893 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001894 }
1895
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001896 uint32_t ceiling_height = static_cast<uint32_t>(ceil(
1897 static_cast<float>(device_limits->maxFramebufferHeight) /
1898 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001899 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1900 skip |=
Agarwal, Arpit78509112022-02-17 15:29:05 -07001901 LogError(device, "VUID-VkImageCreateInfo-fragmentDensityMapOffset-06515",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001902 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1903 "ceiling of device "
1904 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1905 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1906 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001907 }
1908 }
1909
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001910 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001911 VkResult result = VK_SUCCESS;
1912 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1913 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1914 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1915 &format_limits);
1916 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001917 auto modifier_list = LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1918 auto explicit_modifier = LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001919 if (modifier_list) {
1920 for (uint32_t i = 0; i < modifier_list->drmFormatModifierCount; i++) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001921 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001922 drm_format_modifier.drmFormatModifier = modifier_list->pDrmFormatModifiers[i];
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001923 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001924 image_format_info.type = pCreateInfo->imageType;
1925 image_format_info.format = pCreateInfo->format;
1926 image_format_info.tiling = pCreateInfo->tiling;
1927 image_format_info.usage = pCreateInfo->usage;
1928 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001929 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001930
1931 result =
1932 DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1933 format_limits = image_format_properties.imageFormatProperties;
1934
1935 /* The application gives a list of modifier and the driver
1936 * selects one. If one is wrong, stop there.
1937 */
1938 if (result != VK_SUCCESS) break;
1939 }
1940 } else if (explicit_modifier) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001941 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001942 drm_format_modifier.drmFormatModifier = explicit_modifier->drmFormatModifier;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001943 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001944 image_format_info.type = pCreateInfo->imageType;
1945 image_format_info.format = pCreateInfo->format;
1946 image_format_info.tiling = pCreateInfo->tiling;
1947 image_format_info.usage = pCreateInfo->usage;
1948 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001949 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001950
1951 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1952 format_limits = image_format_properties.imageFormatProperties;
1953 }
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001954 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001955
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001956 // 1. vkGetPhysicalDeviceImageFormatProperties[2] only success code is VK_SUCCESS
1957 // 2. If call returns an error, then "imageCreateImageFormatPropertiesList" is defined to be the empty list
1958 // 3. All values in 02251 are undefined if "imageCreateImageFormatPropertiesList" is empty.
1959 if (result != VK_SUCCESS) {
1960 // External memory will always have a "imageCreateImageFormatPropertiesList" so skip
Lockee87f87c2019-04-23 17:53:10 -06001961#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001962 if (!LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext)) {
Lockee87f87c2019-04-23 17:53:10 -06001963#endif // VK_USE_PLATFORM_ANDROID_KHR
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001964 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateMaxMipLevels-02251",
Spencer Frickec46fc6d2020-04-16 06:23:05 -07001965 "vkCreateImage(): Format %s is not supported for this combination of parameters and "
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001966 "VkGetPhysicalDeviceImageFormatProperties returned back %s.",
1967 string_VkFormat(pCreateInfo->format), string_VkResult(result));
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001968#ifdef VK_USE_PLATFORM_ANDROID_KHR
1969 }
1970#endif // VK_USE_PLATFORM_ANDROID_KHR
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001971 } else {
1972 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1973 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001974 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1975 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1976 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001977 }
Dave Houlton130c0212018-01-29 13:39:56 -07001978
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001979 uint64_t texel_count = static_cast<uint64_t>(pCreateInfo->extent.width) *
1980 static_cast<uint64_t>(pCreateInfo->extent.height) *
1981 static_cast<uint64_t>(pCreateInfo->extent.depth) * static_cast<uint64_t>(pCreateInfo->arrayLayers) *
1982 static_cast<uint64_t>(pCreateInfo->samples);
Dave Houlton130c0212018-01-29 13:39:56 -07001983
sfricke-samsung2e827212021-09-28 07:52:08 -07001984 // Depth/Stencil formats size can't be accurately calculated
1985 if (!FormatIsDepthAndStencil(pCreateInfo->format)) {
1986 uint64_t total_size =
1987 static_cast<uint64_t>(std::ceil(FormatTexelSize(pCreateInfo->format) * static_cast<double>(texel_count)));
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001988
sfricke-samsung2e827212021-09-28 07:52:08 -07001989 // Round up to imageGranularity boundary
1990 VkDeviceSize image_granularity = phys_dev_props.limits.bufferImageGranularity;
1991 uint64_t ig_mask = image_granularity - 1;
1992 total_size = (total_size + ig_mask) & ~ig_mask;
1993
1994 if (total_size > format_limits.maxResourceSize) {
1995 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
1996 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1997 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1998 total_size, format_limits.maxResourceSize);
1999 }
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002000 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002001
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002002 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002003 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
2004 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
2005 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002006 }
2007
2008 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002009 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
2010 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
2011 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00002012 }
sfricke-samsung612f3622020-06-20 20:42:46 -07002013
2014 if (pCreateInfo->extent.width > format_limits.maxExtent.width) {
2015 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02252",
2016 "vkCreateImage(): extent.width %u exceeds allowable maximum image extent width %u.",
2017 pCreateInfo->extent.width, format_limits.maxExtent.width);
2018 }
2019
2020 if (pCreateInfo->extent.height > format_limits.maxExtent.height) {
2021 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02253",
2022 "vkCreateImage(): extent.height %u exceeds allowable maximum image extent height %u.",
2023 pCreateInfo->extent.height, format_limits.maxExtent.height);
2024 }
2025
2026 if (pCreateInfo->extent.depth > format_limits.maxExtent.depth) {
2027 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02254",
2028 "vkCreateImage(): extent.depth %u exceeds allowable maximum image extent depth %u.",
2029 pCreateInfo->extent.depth, format_limits.maxExtent.depth);
2030 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002031 }
2032
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002033 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsung10b35ce2021-09-29 08:50:20 -07002034 if (FormatRequiresYcbcrConversionExplicitly(pCreateInfo->format)) {
sfricke-samsungcead0802020-01-30 22:20:10 -08002035 if (pCreateInfo->mipLevels != 1) {
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07002036 skip |= LogError(device, "VUID-VkImageCreateInfo-format-06410",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002037 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
tmerilehtica733542022-04-13 14:00:29 +03002038 pCreateInfo->mipLevels);
sfricke-samsungcead0802020-01-30 22:20:10 -08002039 }
2040
2041 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002042 skip |= LogError(
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07002043 device, "VUID-VkImageCreateInfo-format-06411",
sfricke-samsungcead0802020-01-30 22:20:10 -08002044 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
2045 string_VkSampleCountFlagBits(pCreateInfo->samples));
2046 }
2047
2048 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002049 skip |= LogError(
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07002050 device, "VUID-VkImageCreateInfo-format-06412",
sfricke-samsungcead0802020-01-30 22:20:10 -08002051 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
2052 string_VkImageType(pCreateInfo->imageType));
2053 }
2054 }
2055
sfricke-samsung45996a42021-09-16 13:45:27 -07002056 if (IsExtEnabled(device_extensions.vk_khr_maintenance2)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07002057 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
sfricke-samsung08796682021-09-13 07:47:20 -07002058 if (!FormatIsCompressed(pCreateInfo->format)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07002059 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01572",
2060 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
sfricke-samsung08796682021-09-13 07:47:20 -07002061 "format must be a compressed image format, but is %s",
Spencer Fricke48db59b2020-03-23 10:31:46 -07002062 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06002063 }
2064 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07002065 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01573",
2066 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
2067 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06002068 }
2069 }
2070 }
2071
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07002072 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
sfricke-samsung45996a42021-09-16 13:45:27 -07002073 const char *vuid = IsExtEnabled(device_extensions.vk_khr_get_physical_device_properties2)
2074 ? "VUID-VkImageCreateInfo-sharingMode-01420"
2075 : "VUID-VkImageCreateInfo-sharingMode-01392";
Mark Lobodzinski314b9162020-07-16 15:33:08 -06002076 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
ziga-lunarge2e283d2021-08-01 09:55:04 +02002077 "vkCreateImage", "pCreateInfo->pQueueFamilyIndices", vuid);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07002078 }
2079
unknown2c877272019-07-11 12:56:50 -06002080 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
2081 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
2082 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002083 LogError(device, "VUID-VkImageCreateInfo-format-01577",
2084 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
2085 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06002086 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002087
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07002088 const auto swapchain_create_info = LvlFindInChain<VkImageSwapchainCreateInfoKHR>(pCreateInfo->pNext);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002089 if (swapchain_create_info != nullptr) {
2090 if (swapchain_create_info->swapchain != VK_NULL_HANDLE) {
Jeremy Gebbenf4449392022-01-28 10:09:10 -07002091 auto swapchain_state = Get<SWAPCHAIN_NODE>(swapchain_create_info->swapchain);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002092 const VkSwapchainCreateFlagsKHR swapchain_flags = swapchain_state->createInfo.flags;
2093
2094 // Validate rest of Swapchain Image create check that require swapchain state
2095 const char *vuid = "VUID-VkImageSwapchainCreateInfoKHR-swapchain-00995";
2096 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR) != 0) &&
2097 ((pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) == 0)) {
2098 skip |= LogError(
2099 device, vuid,
2100 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR flag so "
2101 "all swapchain images must have the VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT flag set.");
2102 }
2103 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR) != 0) &&
2104 ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) == 0)) {
2105 skip |= LogError(device, vuid,
2106 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR flag so all "
2107 "swapchain images must have the VK_IMAGE_CREATE_PROTECTED_BIT flag set.");
2108 }
Mike Schuchardt2df08912020-12-15 16:28:09 -08002109 const VkImageCreateFlags mutable_flags = (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT | VK_IMAGE_CREATE_EXTENDED_USAGE_BIT);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002110 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR) != 0) &&
2111 ((pCreateInfo->flags & mutable_flags) != mutable_flags)) {
2112 skip |= LogError(device, vuid,
2113 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR flag so "
2114 "all swapchain images must have the VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT and "
Mike Schuchardt2df08912020-12-15 16:28:09 -08002115 "VK_IMAGE_CREATE_EXTENDED_USAGE_BIT flags both set.");
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002116 }
2117 }
2118 }
2119
sfricke-samsungedce77a2020-07-03 22:35:13 -07002120 if ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) != 0) {
2121 if (enabled_features.core11.protectedMemory == VK_FALSE) {
2122 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01890",
2123 "vkCreateImage(): the protectedMemory device feature is disabled: Images cannot be created with the "
2124 "VK_IMAGE_CREATE_PROTECTED_BIT set.");
2125 }
2126 const VkImageCreateFlags invalid_flags =
2127 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
2128 if ((pCreateInfo->flags & invalid_flags) != 0) {
2129 skip |= LogError(device, "VUID-VkImageCreateInfo-None-01891",
2130 "vkCreateImage(): VK_IMAGE_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at same "
2131 "time (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | "
2132 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT).");
2133 }
2134 }
2135
Tony-LunarG24838772022-07-19 14:07:12 -06002136 if ((pCreateInfo->flags & VK_IMAGE_CREATE_MULTISAMPLED_RENDER_TO_SINGLE_SAMPLED_BIT_EXT) != 0) {
2137 if (!(enabled_features.multisampled_render_to_single_sampled_features.multisampledRenderToSingleSampled)) {
2138 skip |= LogError(
2139 device, "VUID-VkImageCreateInfo-multisampledRenderToSingleSampled-06882",
2140 "vkCreateImage(): pCreateInfo.flags contains VK_IMAGE_CREATE_MULTISAMPLED_RENDER_TO_SINGLE_SAMPLED_BIT_EXT "
2141 "but the multisampledRenderToSingleSampled feature is not enabled");
2142 }
2143 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
2144 skip |= LogError(
2145 device, "VUID-VkImageCreateInfo-flags-06883",
2146 "vkCreateImage(): pCreateInfo.flags contains VK_IMAGE_CREATE_MULTISAMPLED_RENDER_TO_SINGLE_SAMPLED_BIT_EXT "
2147 "but samples (%s) is not equal to VK_SAMPLE_COUNT_1_BIT",
2148 string_VkSampleCountFlagBits(pCreateInfo->samples));
2149 }
2150 }
2151
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002152 skip |= ValidateImageFormatFeatures(pCreateInfo);
2153
Nathaniel Cesarioc02c2512020-11-13 12:04:24 -07002154 // Check compatibility with VK_KHR_portability_subset
sfricke-samsung45996a42021-09-16 13:45:27 -07002155 if (IsExtEnabled(device_extensions.vk_khr_portability_subset)) {
Nathaniel Cesarioc02c2512020-11-13 12:04:24 -07002156 if (VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT & pCreateInfo->flags &&
2157 VK_FALSE == enabled_features.portability_subset_features.imageView2DOn3DImage) {
2158 skip |= LogError(device, "VUID-VkImageCreateInfo-imageView2DOn3DImage-04459",
2159 "vkCreateImage (portability error): VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT is not supported.");
2160 }
2161 if ((VK_SAMPLE_COUNT_1_BIT != pCreateInfo->samples) && (1 != pCreateInfo->arrayLayers) &&
2162 (VK_FALSE == enabled_features.portability_subset_features.multisampleArrayImage)) {
2163 skip |=
2164 LogError(device, "VUID-VkImageCreateInfo-multisampleArrayImage-04460",
2165 "vkCreateImage (portability error): Cannot create an image with samples/texel > 1 && arrayLayers != 1");
2166 }
2167 }
2168
ziga-lunarg63f8d7a2021-07-20 22:10:31 +02002169 const auto external_memory_create_info_nv = LvlFindInChain<VkExternalMemoryImageCreateInfoNV>(pCreateInfo->pNext);
ziga-lunarg62aa24f2021-10-09 11:58:30 +02002170 const auto external_memory_create_info = LvlFindInChain<VkExternalMemoryImageCreateInfo>(pCreateInfo->pNext);
2171 if (external_memory_create_info_nv != nullptr && external_memory_create_info != nullptr) {
2172 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-00988",
2173 "vkCreateImage(): VkImageCreateInfo struct has both VkExternalMemoryImageCreateInfoNV and "
2174 "VkExternalMemoryImageCreateInfo chained structs.");
2175 }
2176 if (external_memory_create_info) {
2177 if (external_memory_create_info->handleTypes != 0 && pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_UNDEFINED) {
2178 skip |= LogError(
2179 device, "VUID-VkImageCreateInfo-pNext-01443",
2180 "vkCreateImage: VkImageCreateInfo pNext chain includes VkExternalMemoryImageCreateInfo with handleTypes %" PRIu32
2181 " but pCreateInfo->initialLayout is %s.",
2182 external_memory_create_info->handleTypes, string_VkImageLayout(pCreateInfo->initialLayout));
2183 }
2184 } else if (external_memory_create_info_nv) {
2185 if (external_memory_create_info_nv->handleTypes != 0 && pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_UNDEFINED) {
2186 skip |= LogError(
2187 device, "VUID-VkImageCreateInfo-pNext-01443",
2188 "vkCreateImage: VkImageCreateInfo pNext chain includes VkExternalMemoryImageCreateInfoNV with handleTypes %" PRIu32
2189 " but pCreateInfo->initialLayout is %s.",
2190 external_memory_create_info_nv->handleTypes, string_VkImageLayout(pCreateInfo->initialLayout));
ziga-lunarg63f8d7a2021-07-20 22:10:31 +02002191 }
2192 }
2193
ziga-lunarg374fd9a2021-07-18 10:32:52 +02002194 if (device_group_create_info.physicalDeviceCount == 1) {
2195 if (pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) {
2196 skip |= LogError(device, "VUID-VkImageCreateInfo-physicalDeviceCount-01421",
2197 "vkCreateImage: Device was created with VkDeviceGroupDeviceCreateInfo::physicalDeviceCount 1, but "
2198 "flags contain VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT bit.");
2199 }
2200 }
2201
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002202 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002203}
2204
John Zulauf7eeb6f72019-06-17 11:56:36 -06002205void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
2206 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
2207 if (VK_SUCCESS != result) return;
2208
2209 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
Jeremy Gebben4a8881f2022-01-10 17:04:30 -07002210 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) != 0) {
2211 // non-sparse images set up their layout maps when memory is bound
2212 auto image_state = Get<IMAGE_STATE>(*pImage);
2213 image_state->SetInitialLayoutMap();
2214 }
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07002215}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002216
Jeff Bolz5c801d12019-10-09 10:38:45 -05002217bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeremy Gebbenf4449392022-01-28 10:09:10 -07002218 auto image_state = Get<IMAGE_STATE>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002219 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07002220 if (image_state) {
paul-lunarg4820fd12022-07-12 11:08:01 -06002221 if (image_state->IsSwapchainImage() && image_state->owned_by_swapchain) {
sfricke-samsung73452522021-06-17 08:44:46 -07002222 skip |= LogError(device, "VUID-vkDestroyImage-image-04882",
sfricke-samsung9056cc12021-04-18 22:51:00 -07002223 "vkDestroyImage(): %s is a presentable image and it is controlled by the implementation and is "
2224 "destroyed with vkDestroySwapchainKHR.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002225 report_data->FormatHandle(image_state->image()).c_str());
sfricke-samsung9056cc12021-04-18 22:51:00 -07002226 }
Jeremy Gebben9f537102021-10-05 16:37:12 -06002227 skip |= ValidateObjectNotInUse(image_state.get(), "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002228 }
2229 return skip;
2230}
2231
John Zulauf7eeb6f72019-06-17 11:56:36 -06002232void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
2233 // Clean up validation specific data
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002234 auto image_state = Get<IMAGE_STATE>(image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07002235 qfo_release_image_barrier_map.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06002236 // Clean up generic image state
2237 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002238}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002239
sfricke-samsungcd924d92020-05-20 23:51:17 -07002240bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range,
2241 const char *param_name) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002242 bool skip = false;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002243 const VkImage image = image_state->image();
sfricke-samsungcd924d92020-05-20 23:51:17 -07002244 const VkFormat format = image_state->createInfo.format;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002245
2246 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002247 skip |= LogError(image, "VUID-vkCmdClearColorImage-aspectMask-02498",
2248 "vkCmdClearColorImage(): %s.aspectMasks must only be set to VK_IMAGE_ASPECT_COLOR_BIT.", param_name);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002249 }
2250
sfricke-samsungcd924d92020-05-20 23:51:17 -07002251 if (FormatIsDepthOrStencil(format)) {
2252 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2253 "vkCmdClearColorImage(): %s called with image %s which has a depth/stencil format (%s).", param_name,
2254 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
2255 } else if (FormatIsCompressed(format)) {
2256 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2257 "vkCmdClearColorImage(): %s called with image %s which has a compressed format (%s).", param_name,
2258 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002259 }
2260
2261 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002262 skip |=
2263 LogError(image, "VUID-vkCmdClearColorImage-image-00002",
2264 "vkCmdClearColorImage() %s called with image %s which was created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.",
2265 param_name, report_data->FormatHandle(image).c_str());
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002266 }
2267 return skip;
2268}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002269
John Zulauf07288512019-07-05 11:09:50 -06002270bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
2271 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
2272 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002273 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002274 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2275 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002276 skip |= LogError(image_state->image(), "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002277 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2278 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002279 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002280
2281 } else {
2282 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
sfricke-samsung45996a42021-09-16 13:45:27 -07002283 if (!IsExtEnabled(device_extensions.vk_khr_shared_presentable_image)) {
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002284 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002285 skip |= LogError(image_state->image(), "VUID-vkCmdClearColorImage-imageLayout-00005",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002286 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2287 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002288 }
2289 } else {
2290 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
2291 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002292 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002293 image_state->image(), "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002294 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
2295 func_name, string_VkImageLayout(dest_image_layout));
2296 }
2297 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002298 }
2299
John Zulauff660ad62019-03-23 07:16:05 -06002300 // Cast to const to prevent creation at validate time.
Jeremy Gebben6335df62021-11-01 10:50:13 -06002301 const auto *subresource_map = cb_node->GetImageSubresourceLayoutMap(*image_state);
John Zulauff660ad62019-03-23 07:16:05 -06002302 if (subresource_map) {
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -06002303 LayoutUseCheckAndMessage layout_check(dest_image_layout);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002304 auto normalized_isr = image_state->NormalizeSubresourceRange(range);
Tony Barbour55688172020-09-23 15:19:50 -07002305 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
2306 // the next "constant value" range
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -06002307 skip |= subresource_map->AnyInRange(
Jeremy Gebbencb13f0f2022-07-15 15:48:05 -06002308 normalized_isr, [this, cb_node, &layout_check, func_name](const LayoutRange &range, const LayoutEntry &state) {
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -06002309 bool subres_skip = false;
2310 if (!layout_check.Check(state)) {
2311 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
2312 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2313 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
2314 } else {
2315 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
2316 }
2317 subres_skip |= LogError(cb_node->commandBuffer(), error_code,
2318 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
2319 func_name, string_VkImageLayout(layout_check.expected_layout), layout_check.message,
2320 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002321 }
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -06002322 return subres_skip;
2323 });
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002324 }
2325
2326 return skip;
2327}
2328
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002329bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2330 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002331 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002332 bool skip = false;
2333 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07002334 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07002335 auto image_state = Get<IMAGE_STATE>(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002336 if (cb_node && image_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06002337 skip |= ValidateMemoryIsBoundToImage(image_state.get(), "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
2338 skip |= ValidateCmd(cb_node.get(), CMD_CLEARCOLORIMAGE);
sfricke-samsung45996a42021-09-16 13:45:27 -07002339 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Lionel Landwerlin21719f62021-12-09 11:40:09 +02002340 skip |= ValidateImageFormatFeatureFlags(image_state.get(), VK_FORMAT_FEATURE_2_TRANSFER_DST_BIT_KHR,
2341 "vkCmdClearColorImage", "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04002342 }
Jeremy Gebben9f537102021-10-05 16:37:12 -06002343 skip |= ValidateProtectedImage(cb_node.get(), image_state.get(), "vkCmdClearColorImage()",
2344 "VUID-vkCmdClearColorImage-commandBuffer-01805");
2345 skip |= ValidateUnprotectedImage(cb_node.get(), image_state.get(), "vkCmdClearColorImage()",
sfricke-samsung022fa252020-07-24 03:26:16 -07002346 "VUID-vkCmdClearColorImage-commandBuffer-01806");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002347 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002348 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Jeremy Gebben9f537102021-10-05 16:37:12 -06002349 skip |= ValidateCmdClearColorSubresourceRange(image_state.get(), pRanges[i], param_name.c_str());
2350 skip |= ValidateImageAttributes(image_state.get(), pRanges[i], param_name.c_str());
2351 skip |= VerifyClearImageLayout(cb_node.get(), image_state.get(), pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002352 }
sfricke-samsunge775d492020-02-28 09:02:25 -08002353 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsung10b35ce2021-09-29 08:50:20 -07002354 if (FormatRequiresYcbcrConversionExplicitly(image_state->createInfo.format)) {
sfricke-samsunge775d492020-02-28 09:02:25 -08002355 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
2356 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
2357 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
2358 string_VkFormat(image_state->createInfo.format));
2359 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002360 }
2361 return skip;
2362}
2363
John Zulaufeabb4462019-07-05 14:13:03 -06002364void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2365 const VkClearColorValue *pColor, uint32_t rangeCount,
2366 const VkImageSubresourceRange *pRanges) {
2367 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
2368
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07002369 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002370 auto image_state = Get<IMAGE_STATE>(image);
John Zulaufeabb4462019-07-05 14:13:03 -06002371 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002372 for (uint32_t i = 0; i < rangeCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06002373 cb_node->SetImageInitialLayout(image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002374 }
2375 }
2376}
2377
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002378bool CoreChecks::ValidateClearDepthStencilValue(VkCommandBuffer commandBuffer, VkClearDepthStencilValue clearValue,
2379 const char *apiName) const {
2380 bool skip = false;
2381
2382 // 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 -07002383 if (!IsExtEnabled(device_extensions.vk_ext_depth_range_unrestricted)) {
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002384 if (!(clearValue.depth >= 0.0) || !(clearValue.depth <= 1.0)) {
2385 // Also VUID-VkClearDepthStencilValue-depth-00022
2386 skip |= LogError(commandBuffer, "VUID-VkClearDepthStencilValue-depth-02506",
2387 "%s: VK_EXT_depth_range_unrestricted extension is not enabled and VkClearDepthStencilValue::depth "
2388 "(=%f) is not within the [0.0, 1.0] range.",
2389 apiName, clearValue.depth);
2390 }
2391 }
2392
2393 return skip;
2394}
2395
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002396bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2397 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002398 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002399 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002400
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002401 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07002402 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07002403 auto image_state = Get<IMAGE_STATE>(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002404 if (cb_node && image_state) {
sfricke-samsung30e325a2020-07-25 12:56:13 -07002405 const VkFormat image_format = image_state->createInfo.format;
Jeremy Gebben9f537102021-10-05 16:37:12 -06002406 skip |= ValidateMemoryIsBoundToImage(image_state.get(), "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002407 "VUID-vkCmdClearDepthStencilImage-image-00010");
Jeremy Gebben9f537102021-10-05 16:37:12 -06002408 skip |= ValidateCmd(cb_node.get(), CMD_CLEARDEPTHSTENCILIMAGE);
sfricke-samsung45996a42021-09-16 13:45:27 -07002409 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Lionel Landwerlin21719f62021-12-09 11:40:09 +02002410 skip |= ValidateImageFormatFeatureFlags(image_state.get(), VK_FORMAT_FEATURE_2_TRANSFER_DST_BIT_KHR,
Jeremy Gebben9f537102021-10-05 16:37:12 -06002411 "vkCmdClearDepthStencilImage", "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04002412 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002413 skip |= ValidateClearDepthStencilValue(commandBuffer, *pDepthStencil, "vkCmdClearDepthStencilImage()");
Jeremy Gebben9f537102021-10-05 16:37:12 -06002414 skip |= ValidateProtectedImage(cb_node.get(), image_state.get(), "vkCmdClearDepthStencilImage()",
sfricke-samsung022fa252020-07-24 03:26:16 -07002415 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01807");
Jeremy Gebben9f537102021-10-05 16:37:12 -06002416 skip |= ValidateUnprotectedImage(cb_node.get(), image_state.get(), "vkCmdClearDepthStencilImage()",
sfricke-samsung022fa252020-07-24 03:26:16 -07002417 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01808");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002418
2419 bool any_include_aspect_depth_bit = false;
2420 bool any_include_aspect_stencil_bit = false;
2421
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002422 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002423 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Jeremy Gebben9f537102021-10-05 16:37:12 -06002424 skip |= ValidateCmdClearDepthSubresourceRange(image_state.get(), pRanges[i], param_name.c_str());
2425 skip |=
2426 VerifyClearImageLayout(cb_node.get(), image_state.get(), pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002427 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06002428 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
2429 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002430 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-aspectMask-02824",
2431 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask can only be VK_IMAGE_ASPECT_DEPTH_BIT "
2432 "and/or VK_IMAGE_ASPECT_STENCIL_BIT.",
2433 i);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002434 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002435 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
2436 any_include_aspect_depth_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002437 if (FormatHasDepth(image_format) == false) {
2438 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02826",
2439 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_DEPTH_BIT but %s "
2440 "doesn't have a depth component.",
2441 i, string_VkFormat(image_format));
2442 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002443 }
2444 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
2445 any_include_aspect_stencil_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002446 if (FormatHasStencil(image_format) == false) {
2447 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02825",
2448 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_STENCIL_BIT but "
2449 "%s doesn't have a stencil component.",
2450 i, string_VkFormat(image_format));
2451 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002452 }
2453 }
2454 if (any_include_aspect_stencil_bit) {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07002455 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05002456 if (image_stencil_struct != nullptr) {
2457 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
2458 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002459 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
2460 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
2461 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
2462 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002463 }
2464 } else {
2465 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002466 skip |= LogError(
2467 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05002468 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
2469 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
2470 "in VkImageCreateInfo::usage used to create image");
2471 }
2472 }
2473 }
2474 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002475 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
2476 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
2477 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002478 }
sfricke-samsung30e325a2020-07-25 12:56:13 -07002479 if (image_state && !FormatIsDepthOrStencil(image_format)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002480 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014",
2481 "vkCmdClearDepthStencilImage(): called with image %s which doesn't have a depth/stencil format (%s).",
sfricke-samsung30e325a2020-07-25 12:56:13 -07002482 report_data->FormatHandle(image).c_str(), string_VkFormat(image_format));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002483 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002484 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002485 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009",
2486 "vkCmdClearDepthStencilImage(): called with image %s which was not created with the "
2487 "VK_IMAGE_USAGE_TRANSFER_DST_BIT set.",
2488 report_data->FormatHandle(image).c_str());
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002489 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002490 }
2491 return skip;
2492}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002493
John Zulaufeabb4462019-07-05 14:13:03 -06002494void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2495 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
2496 const VkImageSubresourceRange *pRanges) {
2497 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07002498
2499 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002500 auto image_state = Get<IMAGE_STATE>(image);
John Zulaufeabb4462019-07-05 14:13:03 -06002501 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002502 for (uint32_t i = 0; i < rangeCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06002503 cb_node->SetImageInitialLayout(image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002504 }
2505 }
2506}
2507
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002508// Returns true if [x, xoffset] and [y, yoffset] overlap
2509static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
2510 bool result = false;
2511 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
2512 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
2513
2514 if (intersection_max > intersection_min) {
2515 result = true;
2516 }
2517 return result;
2518}
2519
Aitor Camacho82c1a7a2022-07-05 22:21:19 +02002520// Returns true if source area of first vkImageCopy/vkImageCopy2KHR region intersects dest area of second region
2521// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
2522template <typename RegionType>
2523static bool RegionIntersects(const RegionType *region0, const RegionType *region1, VkImageType type, bool is_multiplane) {
2524 bool result = false;
2525
2526 // Separate planes within a multiplane image cannot intersect
2527 if (is_multiplane && (region0->srcSubresource.aspectMask != region1->dstSubresource.aspectMask)) {
2528 return result;
2529 }
2530
2531 if ((region0->srcSubresource.mipLevel == region1->dstSubresource.mipLevel) &&
2532 (RangesIntersect(region0->srcSubresource.baseArrayLayer, region0->srcSubresource.layerCount,
2533 region1->dstSubresource.baseArrayLayer, region1->dstSubresource.layerCount))) {
2534 result = true;
2535 switch (type) {
2536 case VK_IMAGE_TYPE_3D:
2537 result &= RangesIntersect(region0->srcOffset.z, region0->extent.depth, region1->dstOffset.z, region1->extent.depth);
2538 // fall through
2539 case VK_IMAGE_TYPE_2D:
2540 result &=
2541 RangesIntersect(region0->srcOffset.y, region0->extent.height, region1->dstOffset.y, region1->extent.height);
2542 // fall through
2543 case VK_IMAGE_TYPE_1D:
2544 result &= RangesIntersect(region0->srcOffset.x, region0->extent.width, region1->dstOffset.x, region1->extent.width);
2545 break;
2546 default:
2547 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2548 assert(false);
2549 }
2550 }
2551 return result;
2552}
2553
aitor-lunarg607fe732022-03-31 22:00:08 +02002554template <typename RegionType>
2555static bool RegionIntersectsBlit(const RegionType *region0, const RegionType *region1, VkImageType type, bool is_multiplane) {
2556 bool result = false;
2557
2558 // Separate planes within a multiplane image cannot intersect
2559 if (is_multiplane && (region0->srcSubresource.aspectMask != region1->dstSubresource.aspectMask)) {
2560 return result;
2561 }
2562
2563 if ((region0->srcSubresource.mipLevel == region1->dstSubresource.mipLevel) &&
2564 (RangesIntersect(region0->srcSubresource.baseArrayLayer, region0->srcSubresource.layerCount,
2565 region1->dstSubresource.baseArrayLayer, region1->dstSubresource.layerCount))) {
2566 result = true;
2567 switch (type) {
2568 case VK_IMAGE_TYPE_3D:
2569 result &= RangesIntersect(region0->srcOffsets[0].z, region0->srcOffsets[1].z - region0->srcOffsets[0].z,
2570 region1->dstOffsets[0].z, region1->dstOffsets[1].z - region1->dstOffsets[0].z);
2571 // fall through
2572 case VK_IMAGE_TYPE_2D:
2573 result &= RangesIntersect(region0->srcOffsets[0].y, region0->srcOffsets[1].y - region0->srcOffsets[0].y,
2574 region1->dstOffsets[0].y, region1->dstOffsets[1].y - region1->dstOffsets[0].y);
2575 // fall through
2576 case VK_IMAGE_TYPE_1D:
2577 result &= RangesIntersect(region0->srcOffsets[0].x, region0->srcOffsets[1].x - region0->srcOffsets[0].x,
2578 region1->dstOffsets[0].x, region1->dstOffsets[1].x - region1->dstOffsets[0].x);
2579 break;
2580 default:
2581 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2582 assert(false);
2583 }
2584 }
2585 return result;
2586}
2587
Dave Houltonfc1a4052017-04-27 14:32:45 -06002588// Returns non-zero if offset and extent exceed image extents
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002589static const uint32_t kXBit = 1;
2590static const uint32_t kYBit = 2;
2591static const uint32_t kZBit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002592static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002593 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002594 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002595 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2596 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002597 result |= kZBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002598 }
2599 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2600 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002601 result |= kYBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002602 }
2603 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2604 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002605 result |= kXBit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002606 }
2607 return result;
2608}
2609
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002610// Test if two VkExtent3D structs are equivalent
2611static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2612 bool result = true;
2613 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2614 (extent->depth != other_extent->depth)) {
2615 result = false;
2616 }
2617 return result;
2618}
2619
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002620// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002621static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002622 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2623}
2624
2625// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002626VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002627 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2628 VkExtent3D granularity = {0, 0, 0};
Jeremy Gebbencd7fa282021-10-27 10:25:32 -06002629 const auto pool = cb_node->command_pool;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002630 if (pool) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002631 granularity = physical_device_state->queue_family_properties[pool->queueFamilyIndex].minImageTransferGranularity;
sfricke-samsung01da6312021-10-20 07:51:32 -07002632 if (FormatIsBlockedImage(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002633 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002634 granularity.width *= block_size.width;
2635 granularity.height *= block_size.height;
2636 }
2637 }
2638 return granularity;
2639}
2640
2641// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2642static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2643 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002644 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2645 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002646 valid = false;
2647 }
2648 return valid;
2649}
2650
2651// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002652bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002653 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002654 bool skip = false;
2655 VkExtent3D offset_extent = {};
2656 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2657 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2658 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002659 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002660 // 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 -07002661 if (IsExtentAllZeroes(&offset_extent) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002662 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002663 "%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 "
2664 "image transfer granularity is (w=0, h=0, d=0).",
2665 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002666 }
2667 } else {
2668 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2669 // integer multiples of the image transfer granularity.
2670 if (IsExtentAligned(&offset_extent, granularity) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002671 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002672 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2673 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2674 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2675 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002676 }
2677 }
2678 return skip;
2679}
2680
2681// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002682bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002683 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002684 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002685 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002686 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002687 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2688 // subresource extent.
2689 if (IsExtentEqual(extent, subresource_extent) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002690 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002691 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2692 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2693 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2694 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002695 }
2696 } else {
2697 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2698 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2699 // subresource extent dimensions.
2700 VkExtent3D offset_extent_sum = {};
2701 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2702 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2703 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002704 bool x_ok = true;
2705 bool y_ok = true;
2706 bool z_ok = true;
2707 switch (image_type) {
2708 case VK_IMAGE_TYPE_3D:
2709 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2710 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002711 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002712 case VK_IMAGE_TYPE_2D:
2713 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2714 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002715 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002716 case VK_IMAGE_TYPE_1D:
2717 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2718 (subresource_extent->width == offset_extent_sum.width));
2719 break;
2720 default:
2721 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2722 assert(false);
2723 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002724 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002725 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002726 LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002727 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2728 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2729 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2730 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2731 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2732 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002733 }
2734 }
2735 return skip;
2736}
2737
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002738bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002739 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002740 bool skip = false;
2741 if (mip_level >= img->createInfo.mipLevels) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002742 skip |= LogError(cb_node->commandBuffer(), vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2743 function, i, member, mip_level, report_data->FormatHandle(img->image()).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002744 }
2745 return skip;
2746}
2747
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002748bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002749 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002750 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002751 bool skip = false;
2752 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2753 (base_layer + layer_count) > img->createInfo.arrayLayers) {
paul-lunarg74420b12022-09-02 16:35:31 +02002754 if (layer_count == VK_REMAINING_ARRAY_LAYERS) {
2755 skip |= LogError(cb_node->commandBuffer(), vuid,
2756 "In %s, pRegions[%u].%s.layerCount is VK_REMAINING_ARRAY_LAYERS, "
2757 "but this special value is not supported here.",
2758 function, i, member);
2759 } else {
2760 skip |= LogError(cb_node->commandBuffer(), vuid,
2761 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2762 "%u, but provided %s has %u array layers.",
2763 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image()).c_str(),
2764 img->createInfo.arrayLayers);
2765 }
Cort Strattonff1542a2018-05-27 10:49:28 -07002766 }
2767 return skip;
2768}
2769
Tony Barbour845d29b2021-11-09 11:43:14 -07002770// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy/VkBufferImageCopy2 structure
sfricke-samsung71f04e32022-03-16 01:21:21 -05002771template <typename RegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002772bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
sfricke-samsung71f04e32022-03-16 01:21:21 -05002773 const RegionType *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002774 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002775 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002776 VkExtent3D granularity = GetScaledItg(cb_node, img);
2777 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002778 VkExtent3D subresource_extent = img->GetSubresourceExtent(region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002779 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002780 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002781 return skip;
2782}
2783
Jeff Leger178b1e52020-10-05 12:22:23 -04002784// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy/VkImageCopy2KHR structure
2785template <typename RegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002786bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002787 const IMAGE_STATE *dst_img, const RegionType *region,
2788 const uint32_t i, const char *function,
Tony-LunarGb61514a2021-11-02 12:36:51 -06002789 CMD_TYPE cmd_type) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002790 bool skip = false;
Tony-LunarGb61514a2021-11-02 12:36:51 -06002791 const bool is_2 = (cmd_type == CMD_COPYIMAGE2KHR || cmd_type == CMD_COPYIMAGE2);
Jeff Leger178b1e52020-10-05 12:22:23 -04002792 const char *vuid;
2793
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002794 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002795 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
Tony-LunarGb61514a2021-11-02 12:36:51 -06002796 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
Jeff Leger178b1e52020-10-05 12:22:23 -04002797 skip |= CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", vuid);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002798 VkExtent3D subresource_extent = src_img->GetSubresourceExtent(region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002799 const VkExtent3D extent = region->extent;
Tony-LunarGb61514a2021-11-02 12:36:51 -06002800 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002801 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04002802 i, function, "extent", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002803
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002804 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002805 granularity = GetScaledItg(cb_node, dst_img);
Tony-LunarGb61514a2021-11-02 12:36:51 -06002806 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
Jeff Leger178b1e52020-10-05 12:22:23 -04002807 skip |= CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", vuid);
Dave Houltonee281a52017-12-08 13:51:02 -07002808 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002809 const VkExtent3D dest_effective_extent =
2810 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002811 subresource_extent = dst_img->GetSubresourceExtent(region->dstSubresource);
Tony-LunarGb61514a2021-11-02 12:36:51 -06002812 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002813 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Jeff Leger178b1e52020-10-05 12:22:23 -04002814 dst_img->createInfo.imageType, i, function, "extent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002815 return skip;
2816}
2817
Jeff Leger178b1e52020-10-05 12:22:23 -04002818// Validate contents of a VkImageCopy or VkImageCopy2KHR struct
sfricke-samsung71f04e32022-03-16 01:21:21 -05002819template <typename RegionType>
2820bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const RegionType *pRegions, const IMAGE_STATE *src_state,
2821 const IMAGE_STATE *dst_state, CMD_TYPE cmd_type) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002822 bool skip = false;
Tony-LunarGb61514a2021-11-02 12:36:51 -06002823 const bool is_2 = (cmd_type == CMD_COPYIMAGE2KHR || cmd_type == CMD_COPYIMAGE2);
2824 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04002825 const char *vuid;
Dave Houlton6f9059e2017-05-02 17:15:13 -06002826
2827 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05002828 const RegionType region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002829
2830 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002831 const VkExtent3D src_copy_extent = region.extent;
2832 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002833 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2834
Dave Houlton6f9059e2017-05-02 17:15:13 -06002835 bool slice_override = false;
2836 uint32_t depth_slices = 0;
2837
2838 // Special case for copying between a 1D/2D array and a 3D image
2839 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2840 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002841 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002842 slice_override = (depth_slices != 1);
2843 } 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 -07002844 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002845 slice_override = (depth_slices != 1);
2846 }
2847
2848 // Do all checks on source image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002849 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002850 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002851 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-00146" : "VUID-vkCmdCopyImage-srcImage-00146";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002852 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002853 "%s: pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2854 "be 0 and 1, respectively.",
2855 func_name, i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002856 }
2857 }
2858
Dave Houlton533be9f2018-03-26 17:08:30 -06002859 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 -06002860 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01785" : "VUID-vkCmdCopyImage-srcImage-01785";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002861 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002862 "%s: pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002863 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002864 func_name, i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002865 }
2866
Dave Houlton533be9f2018-03-26 17:08:30 -06002867 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002868 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01787" : "VUID-vkCmdCopyImage-srcImage-01787";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002869 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 -04002870 func_name, i, region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002871 }
2872
sfricke-samsung01da6312021-10-20 07:51:32 -07002873 // Source checks that apply only to "blocked images"
2874 if (FormatIsBlockedImage(src_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002875 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002876 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002877 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2878 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2879 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002880 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01727" : "VUID-vkCmdCopyImage-srcImage-01727";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002881 skip |= LogError(src_state->image(), vuid,
sfricke-samsung01da6312021-10-20 07:51:32 -07002882 "%s: pRegion[%d] srcOffset (%d, %d) must be multiples of the blocked image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002883 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002884 func_name, i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002885 }
2886
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002887 const VkExtent3D mip_extent = src_state->GetSubresourceExtent(region.srcSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07002888 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2889 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002890 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01728" : "VUID-vkCmdCopyImage-srcImage-01728";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002891 skip |= LogError(src_state->image(), vuid,
sfricke-samsung01da6312021-10-20 07:51:32 -07002892 "%s: pRegion[%d] extent width (%d) must be a multiple of the blocked texture block "
Jeff Leger178b1e52020-10-05 12:22:23 -04002893 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2894 func_name, i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002895 }
2896
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002897 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002898 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2899 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002900 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01729" : "VUID-vkCmdCopyImage-srcImage-01729";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002901 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002902 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2903 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2904 func_name, i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002905 }
2906
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002907 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002908 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2909 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002910 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01730" : "VUID-vkCmdCopyImage-srcImage-01730";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002911 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002912 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2913 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2914 func_name, i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002915 }
2916 } // Compressed
2917
2918 // Do all checks on dest image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002919 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002920 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002921 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-00152" : "VUID-vkCmdCopyImage-dstImage-00152";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002922 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002923 "%s: pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002924 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002925 func_name, i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002926 }
2927 }
2928
Dave Houlton533be9f2018-03-26 17:08:30 -06002929 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 -06002930 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01786" : "VUID-vkCmdCopyImage-dstImage-01786";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002931 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002932 "%s: pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2933 "and 1, respectively.",
2934 func_name, i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002935 }
2936
Dave Houlton533be9f2018-03-26 17:08:30 -06002937 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002938 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01788" : "VUID-vkCmdCopyImage-dstImage-01788";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002939 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 -04002940 func_name, i, region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002941 }
2942
sfricke-samsung30b094c2020-05-30 11:42:11 -07002943 // Handle difference between Maintenance 1
sfricke-samsung45996a42021-09-16 13:45:27 -07002944 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002945 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2946 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002947 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-04443" : "VUID-vkCmdCopyImage-srcImage-04443";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002948 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002949 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2950 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2951 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002952 }
2953 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002954 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002955 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002956 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-04444" : "VUID-vkCmdCopyImage-dstImage-04444";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002957 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002958 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2959 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2960 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002961 }
2962 }
2963 } else { // Pre maint 1
2964 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002965 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002966 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002967 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002968 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and "
sfricke-samsung30b094c2020-05-30 11:42:11 -07002969 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2970 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002971 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002972 }
Dave Houltonee281a52017-12-08 13:51:02 -07002973 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002974 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002975 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002976 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002977 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2978 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002979 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002980 }
2981 }
2982 }
2983
sfricke-samsung01da6312021-10-20 07:51:32 -07002984 // Dest checks that apply only to "blocked images"
2985 if (FormatIsBlockedImage(dst_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002986 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002987
2988 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002989 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2990 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2991 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002992 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01731" : "VUID-vkCmdCopyImage-dstImage-01731";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002993 skip |= LogError(dst_state->image(), vuid,
sfricke-samsung01da6312021-10-20 07:51:32 -07002994 "%s: pRegion[%d] dstOffset (%d, %d) must be multiples of the blocked image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002995 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002996 func_name, i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002997 }
2998
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002999 const VkExtent3D mip_extent = dst_state->GetSubresourceExtent(region.dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07003000 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
3001 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003002 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01732" : "VUID-vkCmdCopyImage-dstImage-01732";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003003 skip |= LogError(dst_state->image(), vuid,
sfricke-samsung01da6312021-10-20 07:51:32 -07003004 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the blocked texture "
Jeff Leger178b1e52020-10-05 12:22:23 -04003005 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
3006 func_name, i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06003007 }
3008
Dave Houltonee281a52017-12-08 13:51:02 -07003009 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
3010 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
3011 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003012 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01733" : "VUID-vkCmdCopyImage-dstImage-01733";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003013 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003014 "%s: pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003015 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
3016 "height (%d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04003017 func_name, i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003018 }
3019
Dave Houltonee281a52017-12-08 13:51:02 -07003020 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
3021 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
3022 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003023 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01734" : "VUID-vkCmdCopyImage-dstImage-01734";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003024 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003025 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
3026 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
3027 func_name, i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003028 }
3029 } // Compressed
3030 }
3031 return skip;
3032}
3033
Jeff Leger178b1e52020-10-05 12:22:23 -04003034template <typename RegionType>
3035bool CoreChecks::ValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3036 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Tony-LunarGb61514a2021-11-02 12:36:51 -06003037 const RegionType *pRegions, CMD_TYPE cmd_type) const {
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07003038 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07003039 auto src_image_state = Get<IMAGE_STATE>(srcImage);
3040 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Aitor Camacho82c1a7a2022-07-05 22:21:19 +02003041 const VkFormat src_format = src_image_state->createInfo.format;
3042 const VkFormat dst_format = dst_image_state->createInfo.format;
3043 const bool is_2 = (cmd_type == CMD_COPYIMAGE2KHR || cmd_type == CMD_COPYIMAGE2);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003044 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003045
sfricke-samsung85584a72021-09-30 21:43:38 -07003046 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04003047 const char *vuid;
Tony-LunarGb61514a2021-11-02 12:36:51 -06003048 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state.get(), dst_image_state.get(), cmd_type);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003049
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003050 VkCommandBuffer command_buffer = cb_node->commandBuffer();
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003051
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003052 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003053 const RegionType region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07003054
3055 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
3056 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08003057 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07003058
Dave Houlton6f9059e2017-05-02 17:15:13 -06003059 bool slice_override = false;
3060 uint32_t depth_slices = 0;
3061
3062 // Special case for copying between a 1D/2D array and a 3D image
3063 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
3064 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
3065 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07003066 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06003067 slice_override = (depth_slices != 1);
3068 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
3069 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07003070 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06003071 slice_override = (depth_slices != 1);
3072 }
3073
Jeremy Gebben9f537102021-10-05 16:37:12 -06003074 skip |= ValidateImageSubresourceLayers(cb_node.get(), &region.srcSubresource, func_name, "srcSubresource", i);
3075 skip |= ValidateImageSubresourceLayers(cb_node.get(), &region.dstSubresource, func_name, "dstSubresource", i);
Tony-LunarGb61514a2021-11-02 12:36:51 -06003076 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcSubresource-01696" : "VUID-vkCmdCopyImage-srcSubresource-01696";
3077 skip |=
3078 ValidateImageMipLevel(cb_node.get(), src_image_state.get(), region.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
3079 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstSubresource-01697" : "VUID-vkCmdCopyImage-dstSubresource-01697";
3080 skip |=
3081 ValidateImageMipLevel(cb_node.get(), dst_image_state.get(), region.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
3082 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcSubresource-01698" : "VUID-vkCmdCopyImage-srcSubresource-01698";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003083 skip |= ValidateImageArrayLayerRange(cb_node.get(), src_image_state.get(), region.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003084 region.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
Tony-LunarGb61514a2021-11-02 12:36:51 -06003085 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstSubresource-01699" : "VUID-vkCmdCopyImage-dstSubresource-01699";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003086 skip |= ValidateImageArrayLayerRange(cb_node.get(), dst_image_state.get(), region.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003087 region.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003088
sfricke-samsung45996a42021-09-16 13:45:27 -07003089 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06003090 // No chance of mismatch if we're overriding depth slice count
3091 if (!slice_override) {
3092 // The number of depth slices in srcSubresource and dstSubresource must match
3093 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
3094 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07003095 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
3096 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003097 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07003098 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
3099 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003100 if (src_slices != dst_slices) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003101 vuid = is_2 ? "VUID-VkImageCopy2-extent-00140" : "VUID-VkImageCopy-extent-00140";
Jeff Leger178b1e52020-10-05 12:22:23 -04003102 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003103 "%s: number of depth slices in source (%u) and destination (%u) subresources for pRegions[%u] "
3104 "do not match.",
3105 func_name, src_slices, dst_slices, i);
Dave Houlton6f9059e2017-05-02 17:15:13 -06003106 }
3107 }
3108 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06003109 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07003110 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003111 vuid = is_2 ? "VUID-VkImageCopy2-layerCount-00138" : "VUID-VkImageCopy-layerCount-00138";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003112 skip |=
3113 LogError(command_buffer, vuid,
3114 "%s: number of layers in source (%u) and destination (%u) subresources for pRegions[%u] do not match",
3115 func_name, region.srcSubresource.layerCount, region.dstSubresource.layerCount, i);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06003116 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003117 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003118
Dave Houltonc991cc92018-03-06 11:08:51 -07003119 // Do multiplane-specific checks, if extension enabled
sfricke-samsung45996a42021-09-16 13:45:27 -07003120 if (IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)) {
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003121 if ((!FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format))) {
3122 // If neither image is multi-plane the aspectMask member of src and dst must match
3123 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003124 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01551" : "VUID-vkCmdCopyImage-srcImage-01551";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003125 skip |= LogError(command_buffer, vuid,
3126 "%s: Copy between non-multiplane images with differing aspectMasks in pRegions[%u] with "
3127 "source (0x%x) destination (0x%x).",
3128 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
3129 }
3130 } else {
3131 // Source image multiplane checks
3132 uint32_t planes = FormatPlaneCount(src_format);
3133 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
3134 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003135 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01552" : "VUID-vkCmdCopyImage-srcImage-01552";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003136 skip |= LogError(command_buffer, vuid,
3137 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
3138 i, aspect);
3139 }
3140 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
3141 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003142 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01553" : "VUID-vkCmdCopyImage-srcImage-01553";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003143 skip |= LogError(command_buffer, vuid,
3144 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
3145 i, aspect);
3146 }
3147 // Single-plane to multi-plane
3148 if ((!FormatIsMultiplane(src_format)) && (FormatIsMultiplane(dst_format)) &&
3149 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003150 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01557" : "VUID-vkCmdCopyImage-dstImage-01557";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003151 skip |= LogError(command_buffer, vuid,
3152 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
3153 func_name, i, aspect);
3154 }
Dave Houltonc991cc92018-03-06 11:08:51 -07003155
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003156 // Dest image multiplane checks
3157 planes = FormatPlaneCount(dst_format);
3158 aspect = region.dstSubresource.aspectMask;
3159 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003160 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01554" : "VUID-vkCmdCopyImage-dstImage-01554";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003161 skip |= LogError(command_buffer, vuid,
3162 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
3163 i, aspect);
3164 }
3165 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
3166 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003167 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01555" : "VUID-vkCmdCopyImage-dstImage-01555";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003168 skip |= LogError(command_buffer, vuid,
3169 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
3170 i, aspect);
3171 }
3172 // Multi-plane to single-plane
3173 if ((FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format)) &&
3174 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003175 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01556" : "VUID-vkCmdCopyImage-srcImage-01556";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003176 skip |= LogError(command_buffer, vuid,
3177 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
3178 func_name, i, aspect);
3179 }
3180 }
3181 } else {
3182 // !vk_khr_sampler_ycbcr_conversion
Dave Houltonf5217612018-02-02 16:18:52 -07003183 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
3184 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003185 vuid = is_2 ? "VUID-VkImageCopy2-aspectMask-00137" : "VUID-VkImageCopy-aspectMask-00137";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003186 skip |= LogError(
3187 command_buffer, vuid,
3188 "%s: Copy between images with differing aspectMasks in pRegions[%u] with source (0x%x) destination (0x%x).",
3189 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
Dave Houltonf5217612018-02-02 16:18:52 -07003190 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003191 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003192
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003193 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08003194 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003195 vuid = is_2 ? "VUID-VkCopyImageInfo2-aspectMask-00142" : "VUID-vkCmdCopyImage-aspectMask-00142";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003196 skip |=
3197 LogError(command_buffer, vuid,
3198 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) cannot specify aspects not present in source image.",
3199 func_name, i, region.srcSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003200 }
3201
3202 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08003203 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003204 vuid = is_2 ? "VUID-VkCopyImageInfo2-aspectMask-00143" : "VUID-vkCmdCopyImage-aspectMask-00143";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003205 skip |= LogError(
3206 command_buffer, vuid,
3207 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) cannot specify aspects not present in destination image.",
3208 func_name, i, region.dstSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003209 }
3210
sfricke-samsung5f11b0e2022-03-22 14:12:15 -05003211 // Make sure not a empty region
3212 if (src_copy_extent.width == 0) {
3213 vuid = is_2 ? "VUID-VkImageCopy2-extent-06668" : "VUID-VkImageCopy-extent-06668";
3214 skip |=
3215 LogError(command_buffer, vuid,
3216 "%s: pRegion[%" PRIu32 "] extent.width must not be zero as empty copies are not allowed.", func_name, i);
3217 }
3218 if (src_copy_extent.height == 0) {
3219 vuid = is_2 ? "VUID-VkImageCopy2-extent-06669" : "VUID-VkImageCopy-extent-06669";
3220 skip |=
3221 LogError(command_buffer, vuid,
3222 "%s: pRegion[%" PRIu32 "] extent.height must not be zero as empty copies are not allowed.", func_name, i);
3223 }
3224 if (src_copy_extent.depth == 0) {
3225 vuid = is_2 ? "VUID-VkImageCopy2-extent-06670" : "VUID-VkImageCopy-extent-06670";
3226 skip |=
3227 LogError(command_buffer, vuid,
3228 "%s: pRegion[%" PRIu32 "] extent.depth must not be zero as empty copies are not allowed.", func_name, i);
3229 }
3230
Dave Houltonfc1a4052017-04-27 14:32:45 -06003231 // Each dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003232 VkExtent3D subresource_extent = src_image_state->GetSubresourceExtent(region.srcSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07003233 if (slice_override) src_copy_extent.depth = depth_slices;
3234 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003235 if (extent_check & kXBit) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003236 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcOffset-00144" : "VUID-vkCmdCopyImage-srcOffset-00144";
Jeff Leger178b1e52020-10-05 12:22:23 -04003237 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003238 "%s: Source image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003239 "width [%1d].",
3240 func_name, i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003241 }
3242
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003243 if (extent_check & kYBit) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003244 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcOffset-00145" : "VUID-vkCmdCopyImage-srcOffset-00145";
Jeff Leger178b1e52020-10-05 12:22:23 -04003245 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003246 "%s: Source image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003247 "height [%1d].",
3248 func_name, i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003249 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003250 if (extent_check & kZBit) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003251 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcOffset-00147" : "VUID-vkCmdCopyImage-srcOffset-00147";
Jeff Leger178b1e52020-10-05 12:22:23 -04003252 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003253 "%s: Source image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003254 "depth [%1d].",
3255 func_name, i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003256 }
3257
Dave Houltonee281a52017-12-08 13:51:02 -07003258 // Adjust dest extent if necessary
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003259 subresource_extent = dst_image_state->GetSubresourceExtent(region.dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07003260 if (slice_override) dst_copy_extent.depth = depth_slices;
3261
3262 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003263 if (extent_check & kXBit) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003264 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstOffset-00150" : "VUID-vkCmdCopyImage-dstOffset-00150";
Jeff Leger178b1e52020-10-05 12:22:23 -04003265 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003266 "%s: Dest image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003267 "width [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003268 func_name, i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003269 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003270 if (extent_check & kYBit) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003271 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstOffset-00151" : "VUID-vkCmdCopyImage-dstOffset-00151";
Jeff Leger178b1e52020-10-05 12:22:23 -04003272 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003273 "%s): Dest image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003274 "height [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003275 func_name, i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003276 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003277 if (extent_check & kZBit) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003278 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstOffset-00153" : "VUID-vkCmdCopyImage-dstOffset-00153";
Jeff Leger178b1e52020-10-05 12:22:23 -04003279 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003280 "%s: Dest image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003281 "depth [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003282 func_name, i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003283 }
3284
Aitor Camacho82c1a7a2022-07-05 22:21:19 +02003285 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
3286 // must not overlap in memory
3287 if (src_image_state->image() == dst_image_state->image()) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003288 for (uint32_t j = 0; j < regionCount; j++) {
Aitor Camacho82c1a7a2022-07-05 22:21:19 +02003289 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
3290 FormatIsMultiplane(src_format))) {
3291 vuid = is_2 ? "VUID-VkCopyImageInfo2-pRegions-00124" : "VUID-vkCmdCopyImage-pRegions-00124";
3292 skip |= LogError(command_buffer, vuid, "%s: pRegion[%u] src overlaps with pRegions[%u].", func_name, i, j);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003293 }
3294 }
3295 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08003296
3297 // 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 -07003298 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
sfricke-samsung48172ca2020-02-13 23:38:11 -08003299 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3300 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3301 (src_copy_extent.depth != 1)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003302 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01790" : "VUID-vkCmdCopyImage-srcImage-01790";
Jeff Leger178b1e52020-10-05 12:22:23 -04003303 skip |= LogError(command_buffer, vuid,
3304 "%s: pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1",
3305 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003306 }
3307 } else {
3308 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
3309 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3310 (src_copy_extent.depth != 1)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003311 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01789" : "VUID-vkCmdCopyImage-srcImage-01789";
Jeff Leger178b1e52020-10-05 12:22:23 -04003312 skip |= LogError(command_buffer, vuid,
3313 "%s: pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1",
3314 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003315 }
3316 }
3317
3318 // Check if 2D with 3D and depth not equal to 2D layerCount
3319 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3320 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
3321 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003322 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01791" : "VUID-vkCmdCopyImage-srcImage-01791";
Jeff Leger178b1e52020-10-05 12:22:23 -04003323 skip |= LogError(command_buffer, vuid,
3324 "%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 -08003325 "srcSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003326 func_name, i, src_copy_extent.depth, region.srcSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003327 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
3328 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
3329 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003330 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01792" : "VUID-vkCmdCopyImage-dstImage-01792";
Jeff Leger178b1e52020-10-05 12:22:23 -04003331 skip |= LogError(command_buffer, vuid,
3332 "%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 -08003333 "dstSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003334 func_name, i, src_copy_extent.depth, region.dstSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003335 }
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003336
3337 // Check for multi-plane format compatiblity
3338 if (FormatIsMultiplane(src_format) || FormatIsMultiplane(dst_format)) {
sfricke-samsung73e755c2021-09-30 08:34:57 -07003339 const VkFormat src_plane_format = FormatIsMultiplane(src_format)
3340 ? FindMultiplaneCompatibleFormat(src_format, region.srcSubresource.aspectMask)
3341 : src_format;
3342 const VkFormat dst_plane_format = FormatIsMultiplane(dst_format)
3343 ? FindMultiplaneCompatibleFormat(dst_format, region.dstSubresource.aspectMask)
3344 : dst_format;
3345 const size_t src_format_size = FormatElementSize(src_plane_format);
3346 const size_t dst_format_size = FormatElementSize(dst_plane_format);
3347
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003348 // If size is still zero, then format is invalid and will be caught in another VU
3349 if ((src_format_size != dst_format_size) && (src_format_size != 0) && (dst_format_size != 0)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003350 vuid = is_2 ? "VUID-VkCopyImageInfo2-None-01549" : "VUID-vkCmdCopyImage-None-01549";
Jeff Leger178b1e52020-10-05 12:22:23 -04003351 skip |= LogError(command_buffer, vuid,
3352 "%s: pRegions[%u] called with non-compatible image formats. "
3353 "The src format %s with aspectMask %s is not compatible with dst format %s aspectMask %s.",
3354 func_name, i, string_VkFormat(src_format),
3355 string_VkImageAspectFlags(region.srcSubresource.aspectMask).c_str(), string_VkFormat(dst_format),
3356 string_VkImageAspectFlags(region.dstSubresource.aspectMask).c_str());
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003357 }
3358 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003359 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003360
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003361 // The formats of non-multiplane src_image and dst_image must be compatible. Formats are considered compatible if their texel
3362 // size in bytes is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT
3363 // because because both texels are 4 bytes in size.
3364 if (!FormatIsMultiplane(src_format) && !FormatIsMultiplane(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003365 const char *compatible_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003366 IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
Tony-LunarGb61514a2021-11-02 12:36:51 -06003367 ? (is_2 ? "VUID-VkCopyImageInfo2-srcImage-01548" : "VUID-vkCmdCopyImage-srcImage-01548")
3368 : (is_2 ? "VUID-VkCopyImageInfo2-srcImage-00135" : "VUID-vkCmdCopyImage-srcImage-00135");
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003369 // Depth/stencil formats must match exactly.
3370 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3371 if (src_format != dst_format) {
3372 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003373 "%s: Depth/stencil formats must match exactly for src (%s) and dst (%s).", func_name,
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003374 string_VkFormat(src_format), string_VkFormat(dst_format));
3375 }
3376 } else {
Jeff Leger178b1e52020-10-05 12:22:23 -04003377 if (FormatElementSize(src_format) != FormatElementSize(dst_format)) {
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003378 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003379 "%s: Unmatched image format sizes. "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06003380 "The src format %s has size of %" PRIu32 " and dst format %s has size of %" PRIu32 ".",
Jeff Leger178b1e52020-10-05 12:22:23 -04003381 func_name, string_VkFormat(src_format), FormatElementSize(src_format), string_VkFormat(dst_format),
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003382 FormatElementSize(dst_format));
3383 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003384 }
3385 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003386
Dave Houlton33c22b72017-02-28 13:16:02 -07003387 // Source and dest image sample counts must match
3388 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003389 std::stringstream ss;
3390 ss << func_name << " called on image pair with non-identical sample counts.";
Tony-LunarGb61514a2021-11-02 12:36:51 -06003391 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-00136" : "VUID-vkCmdCopyImage-srcImage-00136";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003392 skip |=
3393 LogError(command_buffer, vuid, "%s: The src image sample count (%s) dose not match the dst image sample count (%s).",
3394 func_name, string_VkSampleCountFlagBits(src_image_state->createInfo.samples),
3395 string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Dave Houlton33c22b72017-02-28 13:16:02 -07003396 }
3397
Aitor Camacho82c1a7a2022-07-05 22:21:19 +02003398 vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
3399 ? (is_2 ? "VUID-VkCopyImageInfo2-srcImage-01546" : "VUID-vkCmdCopyImage-srcImage-01546")
3400 : (is_2 ? "VUID-VkCopyImageInfo2-srcImage-00127" : "VUID-vkCmdCopyImage-srcImage-00127");
3401 skip |= ValidateMemoryIsBoundToImage(src_image_state.get(), func_name, vuid);
3402 vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
3403 ? (is_2 ? "VUID-VkCopyImageInfo2-dstImage-01547" : "VUID-vkCmdCopyImage-dstImage-01547")
3404 : (is_2 ? "VUID-VkCopyImageInfo2-dstImage-00132" : "VUID-vkCmdCopyImage-dstImage-00132");
3405 skip |= ValidateMemoryIsBoundToImage(dst_image_state.get(), func_name, vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003406 // Validate that SRC & DST images have correct usage flags set
Tony-LunarGb61514a2021-11-02 12:36:51 -06003407 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-00126" : "VUID-vkCmdCopyImage-srcImage-00126";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003408 skip |= ValidateImageUsageFlags(src_image_state.get(), VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04003409 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tony-LunarGb61514a2021-11-02 12:36:51 -06003410 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-00131" : "VUID-vkCmdCopyImage-dstImage-00131";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003411 skip |= ValidateImageUsageFlags(dst_image_state.get(), VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04003412 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Tony-LunarGb61514a2021-11-02 12:36:51 -06003413 vuid = is_2 ? "VUID-vkCmdCopyImage2-commandBuffer-01825" : "VUID-vkCmdCopyImage-commandBuffer-01825";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003414 skip |= ValidateProtectedImage(cb_node.get(), src_image_state.get(), func_name, vuid);
Tony-LunarGb61514a2021-11-02 12:36:51 -06003415 vuid = is_2 ? "VUID-vkCmdCopyImage2-commandBuffer-01826" : "VUID-vkCmdCopyImage-commandBuffer-01826";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003416 skip |= ValidateProtectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
Tony-LunarGb61514a2021-11-02 12:36:51 -06003417 vuid = is_2 ? "VUID-vkCmdCopyImage2-commandBuffer-01827" : "VUID-vkCmdCopyImage-commandBuffer-01827";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003418 skip |= ValidateUnprotectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003419
3420 // Validation for VK_EXT_fragment_density_map
3421 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003422 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
Jeff Leger178b1e52020-10-05 12:22:23 -04003423 skip |=
3424 LogError(command_buffer, vuid,
3425 "%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 +02003426 }
3427 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003428 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
Jeff Leger178b1e52020-10-05 12:22:23 -04003429 skip |=
3430 LogError(command_buffer, vuid,
3431 "%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 +02003432 }
3433
sfricke-samsung45996a42021-09-16 13:45:27 -07003434 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003435 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01995" : "VUID-vkCmdCopyImage-srcImage-01995";
3436 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(), VK_FORMAT_FEATURE_2_TRANSFER_SRC_BIT, func_name, vuid);
3437 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01996" : "VUID-vkCmdCopyImage-dstImage-01996";
3438 skip |= ValidateImageFormatFeatureFlags(dst_image_state.get(), VK_FORMAT_FEATURE_2_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003439 }
Jeremy Gebben9f537102021-10-05 16:37:12 -06003440 skip |= ValidateCmd(cb_node.get(), cmd_type);
Tobin Ehlisc8266452017-04-07 12:20:30 -06003441 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04003442
3443 const char *invalid_src_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003444 (src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Tony-LunarGb61514a2021-11-02 12:36:51 -06003445 ? (is_2 ? "VUID-VkCopyImageInfo2-srcImageLayout-01917" : "VUID-vkCmdCopyImage-srcImageLayout-01917")
3446 : (is_2 ? "VUID-VkCopyImageInfo2-srcImageLayout-00129" : "VUID-vkCmdCopyImage-srcImageLayout-00129");
Jeff Leger178b1e52020-10-05 12:22:23 -04003447 const char *invalid_dst_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003448 (dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Tony-LunarGb61514a2021-11-02 12:36:51 -06003449 ? (is_2 ? "VUID-VkCopyImageInfo2-dstImageLayout-01395" : "VUID-vkCmdCopyImage-dstImageLayout-01395")
3450 : (is_2 ? "VUID-VkCopyImageInfo2-dstImageLayout-00134" : "VUID-vkCmdCopyImage-dstImageLayout-00134");
Jeff Leger178b1e52020-10-05 12:22:23 -04003451
aitor-lunargd0d85e12022-01-28 16:56:49 +01003452 bool same_image = (src_image_state == dst_image_state);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003453 for (uint32_t i = 0; i < regionCount; ++i) {
aitor-lunargd0d85e12022-01-28 16:56:49 +01003454 // When performing copy from and to same subresource, VK_IMAGE_LAYOUT_GENERAL is the only option
sfricke-samsung71f04e32022-03-16 01:21:21 -05003455 const RegionType region = pRegions[i];
3456 const auto &src_sub = region.srcSubresource;
3457 const auto &dst_sub = region.dstSubresource;
aitor-lunargd0d85e12022-01-28 16:56:49 +01003458 bool same_subresource =
3459 (same_image && (src_sub.mipLevel == dst_sub.mipLevel) && (src_sub.baseArrayLayer == dst_sub.baseArrayLayer));
3460 VkImageLayout source_optimal = (same_subresource ? VK_IMAGE_LAYOUT_GENERAL : VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL);
3461 VkImageLayout destination_optimal = (same_subresource ? VK_IMAGE_LAYOUT_GENERAL : VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL);
Tony-LunarGb61514a2021-11-02 12:36:51 -06003462 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImageLayout-00128" : "VUID-vkCmdCopyImage-srcImageLayout-00128";
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06003463 skip |= VerifyImageLayout(*cb_node, *src_image_state, region.srcSubresource, srcImageLayout, source_optimal, func_name,
3464 invalid_src_layout_vuid, vuid, &hit_error);
Tony-LunarGb61514a2021-11-02 12:36:51 -06003465 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImageLayout-00133" : "VUID-vkCmdCopyImage-dstImageLayout-00133";
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06003466 skip |= VerifyImageLayout(*cb_node, *dst_image_state, region.dstSubresource, dstImageLayout, destination_optimal, func_name,
3467 invalid_dst_layout_vuid, vuid, &hit_error);
Jeremy Gebben9f537102021-10-05 16:37:12 -06003468 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node.get(), src_image_state.get(), dst_image_state.get(),
sfricke-samsung71f04e32022-03-16 01:21:21 -05003469 &region, i, func_name, cmd_type);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003470 }
3471
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003472 return skip;
3473}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003474
Jeff Leger178b1e52020-10-05 12:22:23 -04003475bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3476 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3477 const VkImageCopy *pRegions) const {
3478 return ValidateCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
Tony-LunarGb61514a2021-11-02 12:36:51 -06003479 CMD_COPYIMAGE);
Jeff Leger178b1e52020-10-05 12:22:23 -04003480}
3481
3482bool CoreChecks::PreCallValidateCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) const {
3483 return ValidateCmdCopyImage(commandBuffer, pCopyImageInfo->srcImage, pCopyImageInfo->srcImageLayout, pCopyImageInfo->dstImage,
3484 pCopyImageInfo->dstImageLayout, pCopyImageInfo->regionCount, pCopyImageInfo->pRegions,
Tony-LunarGb61514a2021-11-02 12:36:51 -06003485 CMD_COPYIMAGE2KHR);
3486}
3487
3488bool CoreChecks::PreCallValidateCmdCopyImage2(VkCommandBuffer commandBuffer, const VkCopyImageInfo2 *pCopyImageInfo) const {
3489 return ValidateCmdCopyImage(commandBuffer, pCopyImageInfo->srcImage, pCopyImageInfo->srcImageLayout, pCopyImageInfo->dstImage,
3490 pCopyImageInfo->dstImageLayout, pCopyImageInfo->regionCount, pCopyImageInfo->pRegions,
3491 CMD_COPYIMAGE2);
Jeff Leger178b1e52020-10-05 12:22:23 -04003492}
3493
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003494void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3495 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3496 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003497 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3498 pRegions);
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07003499 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003500 auto src_image_state = Get<IMAGE_STATE>(srcImage);
3501 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003502
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003503 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003504 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06003505 cb_node->SetImageInitialLayout(*src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3506 cb_node->SetImageInitialLayout(*dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003507 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003508}
3509
Aitor Camacho82c1a7a2022-07-05 22:21:19 +02003510void CoreChecks::RecordCmdCopyImage2(VkCommandBuffer commandBuffer, const VkCopyImageInfo2 *pCopyImageInfo) {
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07003511 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003512 auto src_image_state = Get<IMAGE_STATE>(pCopyImageInfo->srcImage);
3513 auto dst_image_state = Get<IMAGE_STATE>(pCopyImageInfo->dstImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04003514
3515 // Make sure that all image slices are updated to correct layout
3516 for (uint32_t i = 0; i < pCopyImageInfo->regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06003517 cb_node->SetImageInitialLayout(*src_image_state, pCopyImageInfo->pRegions[i].srcSubresource,
3518 pCopyImageInfo->srcImageLayout);
3519 cb_node->SetImageInitialLayout(*dst_image_state, pCopyImageInfo->pRegions[i].dstSubresource,
3520 pCopyImageInfo->dstImageLayout);
Jeff Leger178b1e52020-10-05 12:22:23 -04003521 }
3522}
3523
Tony-LunarGb61514a2021-11-02 12:36:51 -06003524void CoreChecks::PreCallRecordCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) {
3525 StateTracker::PreCallRecordCmdCopyImage2KHR(commandBuffer, pCopyImageInfo);
Aitor Camacho82c1a7a2022-07-05 22:21:19 +02003526 RecordCmdCopyImage2(commandBuffer, pCopyImageInfo);
Tony-LunarGb61514a2021-11-02 12:36:51 -06003527}
3528
3529void CoreChecks::PreCallRecordCmdCopyImage2(VkCommandBuffer commandBuffer, const VkCopyImageInfo2 *pCopyImageInfo) {
3530 StateTracker::PreCallRecordCmdCopyImage2(commandBuffer, pCopyImageInfo);
Aitor Camacho82c1a7a2022-07-05 22:21:19 +02003531 RecordCmdCopyImage2(commandBuffer, pCopyImageInfo);
Tony-LunarGb61514a2021-11-02 12:36:51 -06003532}
3533
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003534// Returns true if sub_rect is entirely contained within rect
3535static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
3536 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 -07003537 (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 -07003538 return false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003539 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003540 return true;
3541}
3542
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003543bool CoreChecks::ValidateClearAttachmentExtent(const CMD_BUFFER_STATE &cb_node, uint32_t attachment_index,
amhagana448ea52021-11-02 14:09:14 -04003544 const IMAGE_VIEW_STATE* image_view_state,
3545 const VkRect2D &render_area, uint32_t rect_count, const VkClearRect *clear_rects) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07003546 bool skip = false;
John Zulauf3a548ef2019-02-01 16:14:07 -07003547
3548 for (uint32_t j = 0; j < rect_count; j++) {
3549 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003550 skip |= LogError(cb_node.Handle(), "VUID-vkCmdClearAttachments-pRects-00016",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003551 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
3552 "the current render pass instance.",
3553 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07003554 }
3555
3556 if (image_view_state) {
3557 // The layers specified by a given element of pRects must be contained within every attachment that
3558 // pAttachments refers to
ziga-lunargff6485c2021-10-08 18:18:32 +02003559 const uint32_t attachment_layer_count = image_view_state->GetAttachmentLayerCount();
John Zulauf3a548ef2019-02-01 16:14:07 -07003560 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
3561 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003562 skip |= LogError(cb_node.Handle(), "VUID-vkCmdClearAttachments-pRects-00017",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003563 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
3564 "of pAttachment[%d].",
3565 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07003566 }
3567 }
3568 }
3569 return skip;
3570}
3571
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003572bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3573 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003574 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003575 bool skip = false;
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07003576 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Petr Kraus2dffb382019-08-10 02:52:12 +02003577 if (!cb_node) return skip;
3578
Jeremy Gebben9f537102021-10-05 16:37:12 -06003579 skip |= ValidateCmd(cb_node.get(), CMD_CLEARATTACHMENTS);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003580
3581 // Validate that attachment is in reference list of active subpass
3582 if (cb_node->activeRenderPass) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08003583 const VkRenderPassCreateInfo2 *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07003584 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Mike Schuchardt2df08912020-12-15 16:28:09 -08003585 const VkSubpassDescription2 *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
locke-lunargaecf2152020-05-12 17:15:41 -06003586 const auto *framebuffer = cb_node->activeFramebuffer.get();
Aaron Hagan1656b2b2021-12-21 11:52:41 -05003587 const auto &render_area = (cb_node->activeRenderPass->use_dynamic_rendering) ?
3588 cb_node->activeRenderPass->dynamic_rendering_begin_rendering_info.renderArea :
3589 cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003590
John Zulauf3a548ef2019-02-01 16:14:07 -07003591 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3592 auto clear_desc = &pAttachments[attachment_index];
3593 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003594 const VkImageAspectFlags aspect_mask = clear_desc->aspectMask;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003595
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003596 if (aspect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
3597 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020",
3598 "vkCmdClearAttachments() pAttachments[%u] mask contains VK_IMAGE_ASPECT_METADATA_BIT",
3599 attachment_index);
3600 } else if (aspect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
3601 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
3602 skip |=
3603 LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-02246",
3604 "vkCmdClearAttachments() pAttachments[%u] mask contains a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit",
3605 attachment_index);
3606 } else if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07003607 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
Aaron Haganc6bafff2021-11-29 23:30:07 -05003608 if (subpass_desc) {
amhagana448ea52021-11-02 14:09:14 -04003609 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
3610 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3611 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
3612 skip |= LogError(
3613 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3614 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
3615 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
3616 attachment_index, clear_desc->colorAttachment,
3617 report_data->FormatHandle(cb_node->activeRenderPass->renderPass()).c_str(), cb_node->activeSubpass,
3618 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07003619
amhagana448ea52021-11-02 14:09:14 -04003620 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
3621 }
3622 } else {
3623 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3624 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
3625 " subpass %u. colorAttachmentCount=%u",
3626 attachment_index, clear_desc->colorAttachment,
3627 report_data->FormatHandle(cb_node->activeRenderPass->renderPass()).c_str(),
3628 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
John Zulauff2582972019-02-09 14:53:30 -07003629 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003630 }
John Zulauff2582972019-02-09 14:53:30 -07003631 fb_attachment = color_attachment;
3632
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003633 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
3634 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
3635 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019",
3636 "vkCmdClearAttachments() pAttachments[%u] aspectMask must set only VK_IMAGE_ASPECT_COLOR_BIT "
3637 "of a color attachment.",
3638 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003639 }
3640 } else { // Must be depth and/or stencil
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003641 bool subpass_depth = false;
3642 bool subpass_stencil = false;
amhagana448ea52021-11-02 14:09:14 -04003643 if (subpass_desc) {
3644 if (subpass_desc->pDepthStencilAttachment &&
3645 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3646 auto index = subpass_desc->pDepthStencilAttachment->attachment;
3647 subpass_depth = FormatHasDepth(renderpass_create_info->pAttachments[index].format);
3648 subpass_stencil = FormatHasStencil(renderpass_create_info->pAttachments[index].format);
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003649 }
amhagana448ea52021-11-02 14:09:14 -04003650 if (!subpass_desc->pDepthStencilAttachment ||
3651 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3652 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) && !subpass_depth) {
3653 skip |= LogError(
3654 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02502",
3655 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_DEPTH_BIT but there is no "
3656 "depth attachment in subpass",
3657 attachment_index);
3658 }
3659 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) && !subpass_stencil) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003660 skip |= LogError(
3661 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02503",
3662 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_STENCIL_BIT but there is no "
amhagana448ea52021-11-02 14:09:14 -04003663 "stencil attachment in subpass",
3664 attachment_index);
3665 }
3666 } else {
3667 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003668 }
amhagana448ea52021-11-02 14:09:14 -04003669 if (subpass_depth) {
3670 skip |= ValidateClearDepthStencilValue(commandBuffer, clear_desc->clearValue.depthStencil,
3671 "vkCmdClearAttachments()");
3672 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08003673 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003674 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003675 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
amhagana448ea52021-11-02 14:09:14 -04003676 const IMAGE_VIEW_STATE* image_view_state = nullptr;
3677 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
3678 image_view_state = cb_node->GetActiveAttachmentImageViewState(fb_attachment);
3679 }
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003680 skip |= ValidateClearAttachmentExtent(*cb_node, attachment_index, image_view_state, render_area,
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003681 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06003682 }
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003683
3684 // Once the framebuffer attachment is found, can get the image view state
3685 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) &&
3686 (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003687 const auto *image_view_state = cb_node->GetActiveAttachmentImageViewState(fb_attachment);
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003688 if (image_view_state != nullptr) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06003689 skip |= ValidateProtectedImage(cb_node.get(), image_view_state->image_state.get(), "vkCmdClearAttachments()",
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003690 "VUID-vkCmdClearAttachments-commandBuffer-02504");
Jeremy Gebben9f537102021-10-05 16:37:12 -06003691 skip |= ValidateUnprotectedImage(cb_node.get(), image_view_state->image_state.get(), "vkCmdClearAttachments()",
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003692 "VUID-vkCmdClearAttachments-commandBuffer-02505");
3693 }
3694 }
ziga-lunargfa335aa2021-08-05 16:59:39 +02003695
amhagana448ea52021-11-02 14:09:14 -04003696 // When a subpass uses a non-zero view mask, multiview functionality is considered to be enabled
3697 if (subpass_desc && (subpass_desc->viewMask > 0)) {
3698 for (uint32_t i = 0; i < rectCount; ++i) {
3699 if (pRects[i].baseArrayLayer != 0 || pRects[i].layerCount != 1) {
3700 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-baseArrayLayer-00018",
3701 "vkCmdClearAttachments(): pRects[%" PRIu32 "] baseArrayLayer is %" PRIu32
3702 " and layerCount is %" PRIu32 ", but the render pass instance uses multiview.",
3703 i, pRects[i].baseArrayLayer, pRects[i].layerCount);
3704 }
ziga-lunargfa335aa2021-08-05 16:59:39 +02003705 }
3706 }
3707 }
John Zulauf441558b2019-08-12 11:47:39 -06003708 }
3709 return skip;
3710}
3711
3712void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3713 const VkClearAttachment *pAttachments, uint32_t rectCount,
3714 const VkClearRect *pRects) {
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07003715 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
John Zulauf441558b2019-08-12 11:47:39 -06003716 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
John Zulauf441558b2019-08-12 11:47:39 -06003717 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
Aaron Haganc6bafff2021-11-29 23:30:07 -05003718 if (cb_node->activeRenderPass->use_dynamic_rendering_inherited) {
3719 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3720 const auto clear_desc = &pAttachments[attachment_index];
3721 auto colorAttachmentCount = cb_node->activeRenderPass->inheritance_rendering_info.colorAttachmentCount;
3722 int image_index = -1;
3723 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3724 (clear_desc->colorAttachment < colorAttachmentCount)) {
3725 image_index = cb_node->GetDynamicColorAttachmentImageIndex(clear_desc->colorAttachment);
3726 }
3727 else if (clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT)) {
3728 image_index = cb_node->GetDynamicDepthAttachmentImageIndex();
3729 }
3730 else if (clear_desc->aspectMask & (VK_IMAGE_ASPECT_STENCIL_BIT)) {
3731 image_index = cb_node->GetDynamicStencilAttachmentImageIndex();
3732 }
amhagana448ea52021-11-02 14:09:14 -04003733
Aaron Haganc6bafff2021-11-29 23:30:07 -05003734 if (image_index != -1) {
3735 if (!clear_rect_copy) {
3736 // We need a copy of the clear rectangles that will persist until the last lambda executes
3737 // but we want to create it as lazily as possible
3738 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
amhagana448ea52021-11-02 14:09:14 -04003739 }
Aaron Haganc6bafff2021-11-29 23:30:07 -05003740 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3741 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
3742 auto val_fn = [this, attachment_index, image_index, rectCount, clear_rect_copy](
3743 const CMD_BUFFER_STATE &secondary, const CMD_BUFFER_STATE *prim_cb,
3744 const FRAMEBUFFER_STATE *fb) {
3745 assert(rectCount == clear_rect_copy->size());
3746 bool skip = false;
3747 const IMAGE_VIEW_STATE* image_view_state = nullptr;
3748 if (image_index != -1) {
3749 image_view_state = (*prim_cb->active_attachments)[image_index];
3750 }
3751 skip = ValidateClearAttachmentExtent(secondary, attachment_index, image_view_state,
3752 prim_cb->activeRenderPass->dynamic_rendering_begin_rendering_info.renderArea,
3753 rectCount, clear_rect_copy->data());
3754 return skip;
3755 };
3756 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003757 }
amhagana448ea52021-11-02 14:09:14 -04003758 }
3759 }
Aaron Haganc6bafff2021-11-29 23:30:07 -05003760 else if (cb_node->activeRenderPass->use_dynamic_rendering == false)
amhagana448ea52021-11-02 14:09:14 -04003761 {
3762 const VkRenderPassCreateInfo2* renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3763 const VkSubpassDescription2* subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
sfricke-samsung21286f82021-11-16 08:21:46 -08003764
amhagana448ea52021-11-02 14:09:14 -04003765 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3766 const auto clear_desc = &pAttachments[attachment_index];
3767 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3768 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3769 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3770 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3771 }
3772 else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3773 subpass_desc->pDepthStencilAttachment) {
3774 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3775 }
3776 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
3777 if (!clear_rect_copy) {
3778 // We need a copy of the clear rectangles that will persist until the last lambda executes
3779 // but we want to create it as lazily as possible
3780 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
3781 }
3782 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3783 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003784 auto val_fn = [this, attachment_index, fb_attachment, rectCount, clear_rect_copy](
3785 const CMD_BUFFER_STATE &secondary, const CMD_BUFFER_STATE *prim_cb,
3786 const FRAMEBUFFER_STATE *fb) {
amhagana448ea52021-11-02 14:09:14 -04003787 assert(rectCount == clear_rect_copy->size());
3788 const auto& render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3789 bool skip = false;
3790 const IMAGE_VIEW_STATE* image_view_state = nullptr;
3791 if (fb && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < fb->createInfo.attachmentCount)) {
3792 image_view_state = prim_cb->GetActiveAttachmentImageViewState(fb_attachment);
3793 }
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003794 skip = ValidateClearAttachmentExtent(secondary, attachment_index, image_view_state, render_area, rectCount,
3795 clear_rect_copy->data());
amhagana448ea52021-11-02 14:09:14 -04003796 return skip;
3797 };
3798 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
3799 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003800 }
3801 }
3802 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003803}
3804
Jeff Leger178b1e52020-10-05 12:22:23 -04003805template <typename RegionType>
3806bool CoreChecks::ValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3807 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Tony-LunarG562fc102021-11-12 13:58:35 -07003808 const RegionType *pRegions, CMD_TYPE cmd_type) const {
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07003809 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07003810 auto src_image_state = Get<IMAGE_STATE>(srcImage);
3811 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Tony-LunarG562fc102021-11-12 13:58:35 -07003812 const bool is_2 = (cmd_type == CMD_RESOLVEIMAGE2KHR || cmd_type == CMD_RESOLVEIMAGE2);
sfricke-samsung85584a72021-09-30 21:43:38 -07003813 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04003814 const char *vuid;
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003815
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003816 bool skip = false;
3817 if (cb_node && src_image_state && dst_image_state) {
Tony-LunarG562fc102021-11-12 13:58:35 -07003818 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-00256" : "VUID-vkCmdResolveImage-srcImage-00256";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003819 skip |= ValidateMemoryIsBoundToImage(src_image_state.get(), func_name, vuid);
Tony-LunarG562fc102021-11-12 13:58:35 -07003820 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-00258" : "VUID-vkCmdResolveImage-dstImage-00258";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003821 skip |= ValidateMemoryIsBoundToImage(dst_image_state.get(), func_name, vuid);
3822 skip |= ValidateCmd(cb_node.get(), cmd_type);
Tony-LunarG562fc102021-11-12 13:58:35 -07003823 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-02003" : "VUID-vkCmdResolveImage-dstImage-02003";
3824 skip |= ValidateImageFormatFeatureFlags(dst_image_state.get(), VK_FORMAT_FEATURE_2_COLOR_ATTACHMENT_BIT, func_name, vuid);
3825 vuid = is_2 ? "VUID-vkCmdResolveImage2-commandBuffer-01837" : "VUID-vkCmdResolveImage-commandBuffer-01837";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003826 skip |= ValidateProtectedImage(cb_node.get(), src_image_state.get(), func_name, vuid);
Tony-LunarG562fc102021-11-12 13:58:35 -07003827 vuid = is_2 ? "VUID-vkCmdResolveImage2-commandBuffer-01838" : "VUID-vkCmdResolveImage-commandBuffer-01838";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003828 skip |= ValidateProtectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
Tony-LunarG562fc102021-11-12 13:58:35 -07003829 vuid = is_2 ? "VUID-vkCmdResolveImage2-commandBuffer-01839" : "VUID-vkCmdResolveImage-commandBuffer-01839";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003830 skip |= ValidateUnprotectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
ziga-lunarg73154fd2022-05-18 14:36:33 +02003831 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-06762" : "VUID-vkCmdResolveImage-srcImage-06762";
3832 skip |= ValidateImageUsageFlags(src_image_state.get(), VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3833 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3834 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-06763" : "VUID-vkCmdResolveImage-srcImage-06763";
3835 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(), VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
3836 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-06764" : "VUID-vkCmdResolveImage-dstImage-06764";
3837 skip |= ValidateImageUsageFlags(dst_image_state.get(), VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3838 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3839 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-06765" : "VUID-vkCmdResolveImage-dstImage-06765";
3840 skip |= ValidateImageFormatFeatureFlags(dst_image_state.get(), VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003841
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003842 // Validation for VK_EXT_fragment_density_map
3843 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony-LunarG562fc102021-11-12 13:58:35 -07003844 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003845 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003846 "%s: srcImage must not have been created with flags containing "
3847 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3848 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003849 }
3850 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony-LunarG562fc102021-11-12 13:58:35 -07003851 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003852 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003853 "%s: dstImage must not have been created with flags containing "
3854 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3855 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003856 }
3857
Cort Stratton7df30962018-05-17 19:45:57 -07003858 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003859 const char *invalid_src_layout_vuid =
Tony-LunarG562fc102021-11-12 13:58:35 -07003860 is_2 ? ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
3861 ? "VUID-VkResolveImageInfo2-srcImageLayout-01400"
3862 : "VUID-VkResolveImageInfo2-srcImageLayout-00261")
sfricke-samsung45996a42021-09-16 13:45:27 -07003863 : ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003864 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3865 : "VUID-vkCmdResolveImage-srcImageLayout-00261");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003866 const char *invalid_dst_layout_vuid =
Tony-LunarG562fc102021-11-12 13:58:35 -07003867 is_2 ? ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
3868 ? "VUID-VkResolveImageInfo2-dstImageLayout-01401"
3869 : "VUID-VkResolveImageInfo2-dstImageLayout-00263")
sfricke-samsung45996a42021-09-16 13:45:27 -07003870 : ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003871 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3872 : "VUID-vkCmdResolveImage-dstImageLayout-00263");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003873 // For each region, the number of layers in the image subresource should not be zero
3874 // For each region, src and dest image aspect must be color only
3875 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003876 const RegionType region = pRegions[i];
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003877 const VkImageSubresourceLayers src_subresource = region.srcSubresource;
3878 const VkImageSubresourceLayers dst_subresource = region.dstSubresource;
Tony-LunarG562fc102021-11-12 13:58:35 -07003879
Jeremy Gebben9f537102021-10-05 16:37:12 -06003880 skip |= ValidateImageSubresourceLayers(cb_node.get(), &src_subresource, func_name, "srcSubresource", i);
3881 skip |= ValidateImageSubresourceLayers(cb_node.get(), &dst_subresource, func_name, "dstSubresource", i);
Tony-LunarG562fc102021-11-12 13:58:35 -07003882 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImageLayout-00260" : "VUID-vkCmdResolveImage-srcImageLayout-00260";
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06003883 skip |= VerifyImageLayout(*cb_node, *src_image_state, src_subresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003884 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
Tony-LunarG562fc102021-11-12 13:58:35 -07003885 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImageLayout-00262" : "VUID-vkCmdResolveImage-dstImageLayout-00262";
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06003886 skip |= VerifyImageLayout(*cb_node, *dst_image_state, dst_subresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003887 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
Tony-LunarG562fc102021-11-12 13:58:35 -07003888 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcSubresource-01709" : "VUID-vkCmdResolveImage-srcSubresource-01709";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003889 skip |= ValidateImageMipLevel(cb_node.get(), src_image_state.get(), src_subresource.mipLevel, i, func_name,
3890 "srcSubresource", vuid);
Tony-LunarG562fc102021-11-12 13:58:35 -07003891 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstSubresource-01710" : "VUID-vkCmdResolveImage-dstSubresource-01710";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003892 skip |= ValidateImageMipLevel(cb_node.get(), dst_image_state.get(), dst_subresource.mipLevel, i, func_name,
3893 "dstSubresource", vuid);
Tony-LunarG562fc102021-11-12 13:58:35 -07003894 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcSubresource-01711" : "VUID-vkCmdResolveImage-srcSubresource-01711";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003895 skip |= ValidateImageArrayLayerRange(cb_node.get(), src_image_state.get(), src_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003896 src_subresource.layerCount, i, func_name, "srcSubresource", vuid);
Tony-LunarG562fc102021-11-12 13:58:35 -07003897 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstSubresource-01712" : "VUID-vkCmdResolveImage-dstSubresource-01712";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003898 skip |= ValidateImageArrayLayerRange(cb_node.get(), dst_image_state.get(), dst_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003899 dst_subresource.layerCount, i, func_name, "srcSubresource", vuid);
Cort Stratton7df30962018-05-17 19:45:57 -07003900
3901 // layer counts must match
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003902 if (src_subresource.layerCount != dst_subresource.layerCount) {
Tony-LunarG562fc102021-11-12 13:58:35 -07003903 vuid = is_2 ? "VUID-VkImageResolve2-layerCount-00267" : "VUID-VkImageResolve-layerCount-00267";
Jeff Leger178b1e52020-10-05 12:22:23 -04003904 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003905 LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003906 "%s: layerCount in source and destination subresource of pRegions[%u] does not match.", func_name, i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003907 }
Cort Stratton7df30962018-05-17 19:45:57 -07003908 // For each region, src and dest image aspect must be color only
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003909 if ((src_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3910 (dst_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
Tony-LunarG562fc102021-11-12 13:58:35 -07003911 vuid = is_2 ? "VUID-VkImageResolve2-aspectMask-00266" : "VUID-VkImageResolve-aspectMask-00266";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003912 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003913 "%s: src and dest aspectMasks for pRegions[%u] must specify only VK_IMAGE_ASPECT_COLOR_BIT.",
3914 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003915 }
3916
3917 const VkImageType src_image_type = src_image_state->createInfo.imageType;
3918 const VkImageType dst_image_type = dst_image_state->createInfo.imageType;
3919
3920 if ((VK_IMAGE_TYPE_3D == src_image_type) || (VK_IMAGE_TYPE_3D == dst_image_type)) {
Shannon McPherson74b341c2020-09-08 15:43:05 -06003921 if ((0 != src_subresource.baseArrayLayer) || (1 != src_subresource.layerCount)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003922 LogObjectList objlist(cb_node->commandBuffer());
3923 objlist.add(src_image_state->image());
3924 objlist.add(dst_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003925 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-04446" : "VUID-vkCmdResolveImage-srcImage-04446";
Jeff Leger178b1e52020-10-05 12:22:23 -04003926 skip |= LogError(objlist, vuid,
3927 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
Shannon McPherson74b341c2020-09-08 15:43:05 -06003928 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003929 func_name, i);
Shannon McPherson74b341c2020-09-08 15:43:05 -06003930 }
3931 if ((0 != dst_subresource.baseArrayLayer) || (1 != dst_subresource.layerCount)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003932 LogObjectList objlist(cb_node->commandBuffer());
3933 objlist.add(src_image_state->image());
3934 objlist.add(dst_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003935 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-04447" : "VUID-vkCmdResolveImage-srcImage-04447";
Jeff Leger178b1e52020-10-05 12:22:23 -04003936 skip |= LogError(objlist, vuid,
3937 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003938 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003939 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003940 }
3941 }
3942
3943 if (VK_IMAGE_TYPE_1D == src_image_type) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05003944 if ((region.srcOffset.y != 0) || (region.extent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003945 LogObjectList objlist(cb_node->commandBuffer());
3946 objlist.add(src_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003947 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-00271" : "VUID-vkCmdResolveImage-srcImage-00271";
Jeff Leger178b1e52020-10-05 12:22:23 -04003948 skip |= LogError(objlist, vuid,
3949 "%s: srcImage (%s) is 1D but pRegions[%u] srcOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003950 "extent.height (%u) is not 1.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05003951 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.y,
3952 region.extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003953 }
3954 }
3955 if ((VK_IMAGE_TYPE_1D == src_image_type) || (VK_IMAGE_TYPE_2D == src_image_type)) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05003956 if ((region.srcOffset.z != 0) || (region.extent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003957 LogObjectList objlist(cb_node->commandBuffer());
3958 objlist.add(src_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003959 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-00273" : "VUID-vkCmdResolveImage-srcImage-00273";
Jeff Leger178b1e52020-10-05 12:22:23 -04003960 skip |= LogError(objlist, vuid,
3961 "%s: srcImage (%s) is 2D but pRegions[%u] srcOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003962 "extent.depth (%u) is not 1.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05003963 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.z,
3964 region.extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003965 }
3966 }
3967
3968 if (VK_IMAGE_TYPE_1D == dst_image_type) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05003969 if ((region.dstOffset.y != 0) || (region.extent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003970 LogObjectList objlist(cb_node->commandBuffer());
3971 objlist.add(dst_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003972 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-00276" : "VUID-vkCmdResolveImage-dstImage-00276";
Jeff Leger178b1e52020-10-05 12:22:23 -04003973 skip |= LogError(objlist, vuid,
3974 "%s: dstImage (%s) is 1D but pRegions[%u] dstOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003975 "extent.height (%u) is not 1.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05003976 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.dstOffset.y,
3977 region.extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003978 }
3979 }
3980 if ((VK_IMAGE_TYPE_1D == dst_image_type) || (VK_IMAGE_TYPE_2D == dst_image_type)) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05003981 if ((region.dstOffset.z != 0) || (region.extent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003982 LogObjectList objlist(cb_node->commandBuffer());
3983 objlist.add(dst_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003984 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-00278" : "VUID-vkCmdResolveImage-dstImage-00278";
Jeff Leger178b1e52020-10-05 12:22:23 -04003985 skip |= LogError(objlist, vuid,
3986 "%s: dstImage (%s) is 2D but pRegions[%u] dstOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003987 "extent.depth (%u) is not 1.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05003988 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.dstOffset.z,
3989 region.extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003990 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003991 }
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003992
3993 // Each srcImage dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003994 VkExtent3D subresource_extent = src_image_state->GetSubresourceExtent(src_subresource);
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003995 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3996 // developer
3997 if (src_subresource.mipLevel < src_image_state->createInfo.mipLevels) {
3998 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003999 if ((extent_check & kXBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004000 LogObjectList objlist(cb_node->commandBuffer());
4001 objlist.add(src_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07004002 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcOffset-00269" : "VUID-vkCmdResolveImage-srcOffset-00269";
Jeff Leger178b1e52020-10-05 12:22:23 -04004003 skip |= LogError(objlist, vuid,
4004 "%s: srcImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07004005 "exceeds subResource width [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004006 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07004007 region.extent.width, subresource_extent.width);
4008 }
4009
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004010 if ((extent_check & kYBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004011 LogObjectList objlist(cb_node->commandBuffer());
4012 objlist.add(src_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07004013 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcOffset-00270" : "VUID-vkCmdResolveImage-srcOffset-00270";
Jeff Leger178b1e52020-10-05 12:22:23 -04004014 skip |= LogError(objlist, vuid,
4015 "%s: srcImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07004016 "exceeds subResource height [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004017 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07004018 region.extent.height, subresource_extent.height);
4019 }
4020
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004021 if ((extent_check & kZBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004022 LogObjectList objlist(cb_node->commandBuffer());
4023 objlist.add(src_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07004024 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcOffset-00272" : "VUID-vkCmdResolveImage-srcOffset-00272";
Jeff Leger178b1e52020-10-05 12:22:23 -04004025 skip |= LogError(objlist, vuid,
4026 "%s: srcImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07004027 "exceeds subResource depth [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004028 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07004029 region.extent.depth, subresource_extent.depth);
4030 }
4031 }
4032
4033 // Each dstImage dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06004034 subresource_extent = dst_image_state->GetSubresourceExtent(dst_subresource);
sfricke-samsungdfeb3172020-07-25 21:17:07 -07004035 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
4036 // developer
4037 if (dst_subresource.mipLevel < dst_image_state->createInfo.mipLevels) {
4038 uint32_t extent_check = ExceedsBounds(&(region.dstOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004039 if ((extent_check & kXBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004040 LogObjectList objlist(cb_node->commandBuffer());
4041 objlist.add(dst_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07004042 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstOffset-00274" : "VUID-vkCmdResolveImage-dstOffset-00274";
Jeff Leger178b1e52020-10-05 12:22:23 -04004043 skip |= LogError(objlist, vuid,
4044 "%s: dstImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07004045 "exceeds subResource width [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004046 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07004047 region.extent.width, subresource_extent.width);
4048 }
4049
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004050 if ((extent_check & kYBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004051 LogObjectList objlist(cb_node->commandBuffer());
4052 objlist.add(dst_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07004053 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstOffset-00275" : "VUID-vkCmdResolveImage-dstOffset-00275";
Jeff Leger178b1e52020-10-05 12:22:23 -04004054 skip |= LogError(objlist, vuid,
4055 "%s: dstImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07004056 "exceeds subResource height [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004057 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07004058 region.extent.height, subresource_extent.height);
4059 }
4060
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004061 if ((extent_check & kZBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004062 LogObjectList objlist(cb_node->commandBuffer());
4063 objlist.add(dst_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07004064 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstOffset-00277" : "VUID-vkCmdResolveImage-dstOffset-00277";
Jeff Leger178b1e52020-10-05 12:22:23 -04004065 skip |= LogError(objlist, vuid,
4066 "%s: dstImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07004067 "exceeds subResource depth [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004068 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07004069 region.extent.depth, subresource_extent.depth);
4070 }
4071 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07004072 }
4073
4074 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
Tony-LunarG562fc102021-11-12 13:58:35 -07004075 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-01386" : "VUID-vkCmdResolveImage-srcImage-01386";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004076 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 -04004077 func_name, string_VkFormat(src_image_state->createInfo.format),
4078 string_VkFormat(dst_image_state->createInfo.format));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07004079 }
4080 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004081 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_MismatchedImageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04004082 "%s: srcImage type (%s) and dstImage type (%s) are not the same.", func_name,
sfricke-samsungc26350e2020-05-30 12:31:31 -07004083 string_VkImageType(src_image_state->createInfo.imageType),
4084 string_VkImageType(dst_image_state->createInfo.imageType));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07004085 }
4086 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
Tony-LunarG562fc102021-11-12 13:58:35 -07004087 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-00257" : "VUID-vkCmdResolveImage-srcImage-00257";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004088 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 -07004089 }
4090 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
Tony-LunarG562fc102021-11-12 13:58:35 -07004091 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-00259" : "VUID-vkCmdResolveImage-dstImage-00259";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004092 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 -04004093 func_name, string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07004094 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004095 } else {
4096 assert(0);
4097 }
4098 return skip;
4099}
4100
Jeff Leger178b1e52020-10-05 12:22:23 -04004101bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4102 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4103 const VkImageResolve *pRegions) const {
4104 return ValidateCmdResolveImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
Tony-LunarG562fc102021-11-12 13:58:35 -07004105 CMD_RESOLVEIMAGE);
Jeff Leger178b1e52020-10-05 12:22:23 -04004106}
4107
4108bool CoreChecks::PreCallValidateCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
4109 const VkResolveImageInfo2KHR *pResolveImageInfo) const {
4110 return ValidateCmdResolveImage(commandBuffer, pResolveImageInfo->srcImage, pResolveImageInfo->srcImageLayout,
4111 pResolveImageInfo->dstImage, pResolveImageInfo->dstImageLayout, pResolveImageInfo->regionCount,
Tony-LunarG562fc102021-11-12 13:58:35 -07004112 pResolveImageInfo->pRegions, CMD_RESOLVEIMAGE2KHR);
4113}
4114
4115bool CoreChecks::PreCallValidateCmdResolveImage2(VkCommandBuffer commandBuffer,
4116 const VkResolveImageInfo2 *pResolveImageInfo) const {
4117 return ValidateCmdResolveImage(commandBuffer, pResolveImageInfo->srcImage, pResolveImageInfo->srcImageLayout,
4118 pResolveImageInfo->dstImage, pResolveImageInfo->dstImageLayout, pResolveImageInfo->regionCount,
4119 pResolveImageInfo->pRegions, CMD_RESOLVEIMAGE2);
Jeff Leger178b1e52020-10-05 12:22:23 -04004120}
4121
4122template <typename RegionType>
4123bool CoreChecks::ValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4124 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Tony-LunarG542ae912021-11-04 16:06:44 -06004125 const RegionType *pRegions, VkFilter filter, CMD_TYPE cmd_type) const {
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07004126 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07004127 auto src_image_state = Get<IMAGE_STATE>(srcImage);
4128 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Tony-LunarG542ae912021-11-04 16:06:44 -06004129 const bool is_2 = (cmd_type == CMD_BLITIMAGE2KHR || cmd_type == CMD_BLITIMAGE2);
sfricke-samsung85584a72021-09-30 21:43:38 -07004130 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04004131
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004132 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07004133 if (cb_node) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06004134 skip |= ValidateCmd(cb_node.get(), cmd_type);
John Zulauf5c2750c2018-01-30 15:04:56 -07004135 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004136 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004137 const char *vuid;
Tony-LunarG542ae912021-11-04 16:06:44 -06004138 std::string loc_head = std::string(func_name);
4139 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00233" : "VUID-vkCmdBlitImage-srcImage-00233";
4140 const char *location1 = is_2 ? loc_head.append("(): pBlitImageInfo->srcImage").c_str() : "vkCmdBlitImage(): srcImage";
4141 skip |= ValidateImageSampleCount(src_image_state.get(), VK_SAMPLE_COUNT_1_BIT, location1, vuid);
4142 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-00234" : "VUID-vkCmdBlitImage-dstImage-00234";
4143 loc_head = std::string(func_name);
4144 const char *location2 = is_2 ? loc_head.append("(): pBlitImageInfo->dstImage").c_str() : "vkCmdBlitImage(): dstImage";
4145 skip |= ValidateImageSampleCount(dst_image_state.get(), VK_SAMPLE_COUNT_1_BIT, location2, vuid);
4146 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00220" : "VUID-vkCmdBlitImage-srcImage-00220";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004147 skip |= ValidateMemoryIsBoundToImage(src_image_state.get(), func_name, vuid);
Tony-LunarG542ae912021-11-04 16:06:44 -06004148 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-00225" : "VUID-vkCmdBlitImage-dstImage-00225";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004149 skip |= ValidateMemoryIsBoundToImage(dst_image_state.get(), func_name, vuid);
Tony-LunarG542ae912021-11-04 16:06:44 -06004150 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00219" : "VUID-vkCmdBlitImage-srcImage-00219";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004151 skip |= ValidateImageUsageFlags(src_image_state.get(), VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04004152 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tony-LunarG542ae912021-11-04 16:06:44 -06004153 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-00224" : "VUID-vkCmdBlitImage-dstImage-00224";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004154 skip |= ValidateImageUsageFlags(dst_image_state.get(), VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04004155 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Jeremy Gebben9f537102021-10-05 16:37:12 -06004156 skip |= ValidateCmd(cb_node.get(), cmd_type);
Tony-LunarG542ae912021-11-04 16:06:44 -06004157 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-01999" : "VUID-vkCmdBlitImage-srcImage-01999";
4158 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(), VK_FORMAT_FEATURE_2_BLIT_SRC_BIT, func_name, vuid);
4159 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-02000" : "VUID-vkCmdBlitImage-dstImage-02000";
4160 skip |= ValidateImageFormatFeatureFlags(dst_image_state.get(), VK_FORMAT_FEATURE_2_BLIT_DST_BIT, func_name, vuid);
4161 vuid = is_2 ? "VUID-vkCmdBlitImage2-commandBuffer-01834" : "VUID-vkCmdBlitImage-commandBuffer-01834";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004162 skip |= ValidateProtectedImage(cb_node.get(), src_image_state.get(), func_name, vuid);
Tony-LunarG542ae912021-11-04 16:06:44 -06004163 vuid = is_2 ? "VUID-vkCmdBlitImage2-commandBuffer-01835" : "VUID-vkCmdBlitImage-commandBuffer-01835";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004164 skip |= ValidateProtectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
Tony-LunarG542ae912021-11-04 16:06:44 -06004165 vuid = is_2 ? "VUID-vkCmdBlitImage2-commandBuffer-01836" : "VUID-vkCmdBlitImage-commandBuffer-01836";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004166 skip |= ValidateUnprotectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
sfricke-samsung022fa252020-07-24 03:26:16 -07004167
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02004168 // Validation for VK_EXT_fragment_density_map
4169 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004170 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004171 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004172 "%s: srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
4173 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02004174 }
4175 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004176 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004177 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004178 "%s: dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
4179 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02004180 }
4181
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06004182 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004183
Dave Houlton33c2d252017-06-09 17:08:32 -06004184 VkFormat src_format = src_image_state->createInfo.format;
4185 VkFormat dst_format = dst_image_state->createInfo.format;
4186 VkImageType src_type = src_image_state->createInfo.imageType;
4187 VkImageType dst_type = dst_image_state->createInfo.imageType;
4188
Cort Stratton186b1a22018-05-01 20:18:06 -04004189 if (VK_FILTER_LINEAR == filter) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004190 vuid = is_2 ? "VUID-VkBlitImageInfo2-filter-02001" : "VUID-vkCmdBlitImage-filter-02001";
4191 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(), VK_FORMAT_FEATURE_2_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Jeremy Gebben9f537102021-10-05 16:37:12 -06004192 func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04004193 } else if (VK_FILTER_CUBIC_IMG == filter) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004194 vuid = is_2 ? "VUID-VkBlitImageInfo2-filter-02002" : "VUID-vkCmdBlitImage-filter-02002";
4195 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(), VK_FORMAT_FEATURE_2_SAMPLED_IMAGE_FILTER_CUBIC_BIT,
Jeff Leger178b1e52020-10-05 12:22:23 -04004196 func_name, vuid);
Dave Houlton33c2d252017-06-09 17:08:32 -06004197 }
4198
sfricke-samsung10b35ce2021-09-29 08:50:20 -07004199 if (FormatRequiresYcbcrConversionExplicitly(src_format)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004200 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-06421" : "VUID-vkCmdBlitImage-srcImage-06421";
Jeff Leger178b1e52020-10-05 12:22:23 -04004201 skip |= LogError(device, vuid,
4202 "%s: srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004203 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04004204 func_name, string_VkFormat(src_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004205 }
4206
sfricke-samsung10b35ce2021-09-29 08:50:20 -07004207 if (FormatRequiresYcbcrConversionExplicitly(dst_format)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004208 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-06422" : "VUID-vkCmdBlitImage-dstImage-06422";
Jeff Leger178b1e52020-10-05 12:22:23 -04004209 skip |= LogError(device, vuid,
4210 "%s: dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004211 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04004212 func_name, string_VkFormat(dst_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004213 }
4214
ziga-lunarg52604a12021-09-09 16:02:05 +02004215 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_2D != src_type)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004216 vuid = is_2 ? "VUID-VkBlitImageInfo2-filter-00237" : "VUID-vkCmdBlitImage-filter-00237";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004217 skip |= LogError(cb_node->commandBuffer(), vuid,
ziga-lunarg52604a12021-09-09 16:02:05 +02004218 "%s: source image type must be VK_IMAGE_TYPE_2D when cubic filtering is specified.", func_name);
Dave Houlton33c2d252017-06-09 17:08:32 -06004219 }
4220
Dave Houlton33c2d252017-06-09 17:08:32 -06004221 // Validate consistency for unsigned formats
sfricke-samsunge3086292021-11-18 23:02:35 -08004222 if (FormatIsUINT(src_format) != FormatIsUINT(dst_format)) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004223 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004224 ss << func_name << ": If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06004225 << "the other one must also have unsigned integer format. "
4226 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Tony-LunarG542ae912021-11-04 16:06:44 -06004227 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00230" : "VUID-vkCmdBlitImage-srcImage-00230";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004228 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004229 }
4230
4231 // Validate consistency for signed formats
sfricke-samsunge3086292021-11-18 23:02:35 -08004232 if (FormatIsSINT(src_format) != FormatIsSINT(dst_format)) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004233 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004234 ss << func_name << ": If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06004235 << "the other one must also have signed integer format. "
4236 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Tony-LunarG542ae912021-11-04 16:06:44 -06004237 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00229" : "VUID-vkCmdBlitImage-srcImage-00229";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004238 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004239 }
4240
4241 // Validate filter for Depth/Stencil formats
4242 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
4243 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004244 ss << func_name << ": If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06004245 << "then filter must be VK_FILTER_NEAREST.";
Tony-LunarG542ae912021-11-04 16:06:44 -06004246 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00232" : "VUID-vkCmdBlitImage-srcImage-00232";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004247 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004248 }
4249
4250 // Validate aspect bits and formats for depth/stencil images
4251 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
4252 if (src_format != dst_format) {
4253 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004254 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 -06004255 << "stencil, the other one must have exactly the same format. "
4256 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
4257 << string_VkFormat(dst_format);
Tony-LunarG542ae912021-11-04 16:06:44 -06004258 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00231" : "VUID-vkCmdBlitImage-srcImage-00231";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004259 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004260 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004261 } // Depth or Stencil
4262
4263 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004264 const char *invalid_src_layout_vuid =
Tony-LunarG542ae912021-11-04 16:06:44 -06004265 is_2 ? ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
4266 ? "VUID-VkBlitImageInfo2-srcImageLayout-01398"
4267 : "VUID-VkBlitImageInfo2-srcImageLayout-00222")
sfricke-samsung45996a42021-09-16 13:45:27 -07004268 : ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04004269 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
4270 : "VUID-vkCmdBlitImage-srcImageLayout-00222");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004271 const char *invalid_dst_layout_vuid =
Tony-LunarG542ae912021-11-04 16:06:44 -06004272 is_2 ? ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
4273 ? "VUID-VkBlitImageInfo2-dstImageLayout-01399"
4274 : "VUID-VkBlitImageInfo2-dstImageLayout-00227")
sfricke-samsung45996a42021-09-16 13:45:27 -07004275 : ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04004276 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
4277 : "VUID-vkCmdBlitImage-dstImageLayout-00227");
Aitor Camachoc22c3602022-06-07 20:45:50 +02004278
4279 bool same_image = (src_image_state == dst_image_state);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004280 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05004281 const RegionType region = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004282 bool hit_error = false;
Tony-LunarG542ae912021-11-04 16:06:44 -06004283
Aitor Camachoc22c3602022-06-07 20:45:50 +02004284 // When performing blit from and to same subresource, VK_IMAGE_LAYOUT_GENERAL is the only option
4285 const auto &src_sub = pRegions[i].srcSubresource;
4286 const auto &dst_sub = pRegions[i].dstSubresource;
4287 bool same_subresource =
4288 (same_image && (src_sub.mipLevel == dst_sub.mipLevel) && (src_sub.baseArrayLayer == dst_sub.baseArrayLayer));
4289 VkImageLayout source_optimal = (same_subresource ? VK_IMAGE_LAYOUT_GENERAL : VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL);
4290 VkImageLayout destination_optimal = (same_subresource ? VK_IMAGE_LAYOUT_GENERAL : VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL);
4291
Tony-LunarG542ae912021-11-04 16:06:44 -06004292 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImageLayout-00221" : "VUID-vkCmdBlitImage-srcImageLayout-00221";
Aitor Camachoc22c3602022-06-07 20:45:50 +02004293 skip |= VerifyImageLayout(*cb_node, *src_image_state, region.srcSubresource, srcImageLayout, source_optimal, func_name,
4294 invalid_src_layout_vuid, vuid, &hit_error);
Tony-LunarG542ae912021-11-04 16:06:44 -06004295 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImageLayout-00226" : "VUID-vkCmdBlitImage-dstImageLayout-00226";
Aitor Camachoc22c3602022-06-07 20:45:50 +02004296 skip |= VerifyImageLayout(*cb_node, *dst_image_state, region.dstSubresource, dstImageLayout, destination_optimal,
4297 func_name, invalid_dst_layout_vuid, vuid, &hit_error);
sfricke-samsung71f04e32022-03-16 01:21:21 -05004298 skip |= ValidateImageSubresourceLayers(cb_node.get(), &region.srcSubresource, func_name, "srcSubresource", i);
4299 skip |= ValidateImageSubresourceLayers(cb_node.get(), &region.dstSubresource, func_name, "dstSubresource", i);
Tony-LunarG542ae912021-11-04 16:06:44 -06004300 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcSubresource-01705" : "VUID-vkCmdBlitImage-srcSubresource-01705";
sfricke-samsung71f04e32022-03-16 01:21:21 -05004301 skip |= ValidateImageMipLevel(cb_node.get(), src_image_state.get(), region.srcSubresource.mipLevel, i, func_name,
Jeremy Gebben9f537102021-10-05 16:37:12 -06004302 "srcSubresource", vuid);
Tony-LunarG542ae912021-11-04 16:06:44 -06004303 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstSubresource-01706" : "VUID-vkCmdBlitImage-dstSubresource-01706";
sfricke-samsung71f04e32022-03-16 01:21:21 -05004304 skip |= ValidateImageMipLevel(cb_node.get(), dst_image_state.get(), region.dstSubresource.mipLevel, i, func_name,
Jeremy Gebben9f537102021-10-05 16:37:12 -06004305 "dstSubresource", vuid);
Tony-LunarG542ae912021-11-04 16:06:44 -06004306 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcSubresource-01707" : "VUID-vkCmdBlitImage-srcSubresource-01707";
sfricke-samsung71f04e32022-03-16 01:21:21 -05004307 skip |= ValidateImageArrayLayerRange(cb_node.get(), src_image_state.get(), region.srcSubresource.baseArrayLayer,
4308 region.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
Tony-LunarG542ae912021-11-04 16:06:44 -06004309 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstSubresource-01708" : "VUID-vkCmdBlitImage-dstSubresource-01708";
sfricke-samsung71f04e32022-03-16 01:21:21 -05004310 skip |= ValidateImageArrayLayerRange(cb_node.get(), dst_image_state.get(), region.dstSubresource.baseArrayLayer,
4311 region.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004312 // Warn for zero-sized regions
sfricke-samsung71f04e32022-03-16 01:21:21 -05004313 if ((region.srcOffsets[0].x == region.srcOffsets[1].x) || (region.srcOffsets[0].y == region.srcOffsets[1].y) ||
4314 (region.srcOffsets[0].z == region.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004315 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004316 ss << func_name << ": pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004317 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004318 }
sfricke-samsung71f04e32022-03-16 01:21:21 -05004319 if ((region.dstOffsets[0].x == region.dstOffsets[1].x) || (region.dstOffsets[0].y == region.dstOffsets[1].y) ||
4320 (region.dstOffsets[0].z == region.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004321 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004322 ss << func_name << ": pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004323 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004324 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004325
4326 // Check that src/dst layercounts match
sfricke-samsung71f04e32022-03-16 01:21:21 -05004327 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004328 vuid = is_2 ? "VUID-VkImageBlit2-layerCount-00239" : "VUID-VkImageBlit-layerCount-00239";
Jeff Leger178b1e52020-10-05 12:22:23 -04004329 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004330 LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004331 "%s: layerCount in source and destination subresource of pRegions[%d] does not match.", func_name, i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004332 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07004333
sfricke-samsung71f04e32022-03-16 01:21:21 -05004334 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004335 vuid = is_2 ? "VUID-VkImageBlit2-aspectMask-00238" : "VUID-VkImageBlit-aspectMask-00238";
Jeff Leger178b1e52020-10-05 12:22:23 -04004336 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004337 LogError(cb_node->commandBuffer(), vuid, "%s: aspectMask members for pRegion[%d] do not match.", func_name, i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07004338 }
Dave Houlton48989f32017-05-26 15:01:46 -06004339
sfricke-samsung71f04e32022-03-16 01:21:21 -05004340 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004341 vuid = is_2 ? "VUID-VkBlitImageInfo2-aspectMask-00241" : "VUID-vkCmdBlitImage-aspectMask-00241";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004342 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004343 "%s: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004344 "image format %s.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004345 func_name, i, region.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004346 }
4347
sfricke-samsung71f04e32022-03-16 01:21:21 -05004348 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004349 vuid = is_2 ? "VUID-VkBlitImageInfo2-aspectMask-00242" : "VUID-vkCmdBlitImage-aspectMask-00242";
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 aspectMask (0x%x) specifies aspects not present in dest image format %s.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004352 func_name, i, region.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004353 }
4354
Dave Houlton48989f32017-05-26 15:01:46 -06004355 // Validate source image offsets
sfricke-samsung71f04e32022-03-16 01:21:21 -05004356 VkExtent3D src_extent = src_image_state->GetSubresourceExtent(region.srcSubresource);
Dave Houlton33c2d252017-06-09 17:08:32 -06004357 if (VK_IMAGE_TYPE_1D == src_type) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05004358 if ((0 != region.srcOffsets[0].y) || (1 != region.srcOffsets[1].y)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004359 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00245" : "VUID-vkCmdBlitImage-srcImage-00245";
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], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
4362 "of (%1d, %1d). These must be (0, 1).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004363 func_name, i, region.srcOffsets[0].y, region.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004364 }
4365 }
4366
Dave Houlton33c2d252017-06-09 17:08:32 -06004367 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05004368 if ((0 != region.srcOffsets[0].z) || (1 != region.srcOffsets[1].z)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004369 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00247" : "VUID-vkCmdBlitImage-srcImage-00247";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004370 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004371 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
4372 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004373 func_name, i, region.srcOffsets[0].z, region.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004374 }
4375 }
4376
Dave Houlton33c2d252017-06-09 17:08:32 -06004377 bool oob = false;
sfricke-samsung71f04e32022-03-16 01:21:21 -05004378 if ((region.srcOffsets[0].x < 0) || (region.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
4379 (region.srcOffsets[1].x < 0) || (region.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004380 oob = true;
Tony-LunarG542ae912021-11-04 16:06:44 -06004381 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcOffset-00243" : "VUID-vkCmdBlitImage-srcOffset-00243";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004382 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004383 "%s: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004384 func_name, i, region.srcOffsets[0].x, region.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004385 }
sfricke-samsung71f04e32022-03-16 01:21:21 -05004386 if ((region.srcOffsets[0].y < 0) || (region.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
4387 (region.srcOffsets[1].y < 0) || (region.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004388 oob = true;
Tony-LunarG542ae912021-11-04 16:06:44 -06004389 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcOffset-00244" : "VUID-vkCmdBlitImage-srcOffset-00244";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004390 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004391 "%s: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004392 func_name, i, region.srcOffsets[0].y, region.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004393 }
sfricke-samsung71f04e32022-03-16 01:21:21 -05004394 if ((region.srcOffsets[0].z < 0) || (region.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
4395 (region.srcOffsets[1].z < 0) || (region.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004396 oob = true;
Tony-LunarG542ae912021-11-04 16:06:44 -06004397 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcOffset-00246" : "VUID-vkCmdBlitImage-srcOffset-00246";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004398 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004399 "%s: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004400 func_name, i, region.srcOffsets[0].z, region.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004401 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004402 if (oob) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004403 vuid = is_2 ? "VUID-VkBlitImageInfo2-pRegions-00215" : "VUID-vkCmdBlitImage-pRegions-00215";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004404 skip |= LogError(cb_node->commandBuffer(), vuid, "%s: region [%d] source image blit region exceeds image dimensions.",
Jeff Leger178b1e52020-10-05 12:22:23 -04004405 func_name, i);
Dave Houlton33c2d252017-06-09 17:08:32 -06004406 }
Dave Houlton48989f32017-05-26 15:01:46 -06004407
4408 // Validate dest image offsets
sfricke-samsung71f04e32022-03-16 01:21:21 -05004409 VkExtent3D dst_extent = dst_image_state->GetSubresourceExtent(region.dstSubresource);
Dave Houlton33c2d252017-06-09 17:08:32 -06004410 if (VK_IMAGE_TYPE_1D == dst_type) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05004411 if ((0 != region.dstOffsets[0].y) || (1 != region.dstOffsets[1].y)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004412 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-00250" : "VUID-vkCmdBlitImage-dstImage-00250";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004413 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004414 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
4415 "(%1d, %1d). These must be (0, 1).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004416 func_name, i, region.dstOffsets[0].y, region.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004417 }
4418 }
4419
Dave Houlton33c2d252017-06-09 17:08:32 -06004420 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05004421 if ((0 != region.dstOffsets[0].z) || (1 != region.dstOffsets[1].z)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004422 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-00252" : "VUID-vkCmdBlitImage-dstImage-00252";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004423 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004424 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004425 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004426 func_name, i, region.dstOffsets[0].z, region.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004427 }
4428 }
4429
Dave Houlton33c2d252017-06-09 17:08:32 -06004430 oob = false;
sfricke-samsung71f04e32022-03-16 01:21:21 -05004431 if ((region.dstOffsets[0].x < 0) || (region.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
4432 (region.dstOffsets[1].x < 0) || (region.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004433 oob = true;
Tony-LunarG542ae912021-11-04 16:06:44 -06004434 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstOffset-00248" : "VUID-vkCmdBlitImage-dstOffset-00248";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004435 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004436 "%s: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004437 func_name, i, region.dstOffsets[0].x, region.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004438 }
sfricke-samsung71f04e32022-03-16 01:21:21 -05004439 if ((region.dstOffsets[0].y < 0) || (region.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
4440 (region.dstOffsets[1].y < 0) || (region.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004441 oob = true;
Tony-LunarG542ae912021-11-04 16:06:44 -06004442 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstOffset-00249" : "VUID-vkCmdBlitImage-dstOffset-00249";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004443 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004444 "%s: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004445 func_name, i, region.dstOffsets[0].y, region.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004446 }
sfricke-samsung71f04e32022-03-16 01:21:21 -05004447 if ((region.dstOffsets[0].z < 0) || (region.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
4448 (region.dstOffsets[1].z < 0) || (region.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004449 oob = true;
Tony-LunarG542ae912021-11-04 16:06:44 -06004450 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstOffset-00251" : "VUID-vkCmdBlitImage-dstOffset-00251";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004451 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004452 "%s: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004453 func_name, i, region.dstOffsets[0].z, region.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004454 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004455 if (oob) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004456 vuid = is_2 ? "VUID-VkBlitImageInfo2-pRegions-00216" : "VUID-vkCmdBlitImage-pRegions-00216";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004457 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004458 "%s: region [%d] destination image blit region exceeds image dimensions.", func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004459 }
4460
Dave Houlton33c2d252017-06-09 17:08:32 -06004461 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05004462 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount) ||
4463 (0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004464 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00240" : "VUID-vkCmdBlitImage-srcImage-00240";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004465 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004466 "%s: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
4467 "layerCount other than 1.",
4468 func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004469 }
4470 }
aitor-lunarg607fe732022-03-31 22:00:08 +02004471
4472 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
4473 // must not overlap in memory
4474 if (srcImage == dstImage) {
4475 for (uint32_t j = 0; j < regionCount; j++) {
4476 if (RegionIntersectsBlit(&region, &pRegions[j], src_image_state->createInfo.imageType,
4477 FormatIsMultiplane(src_format))) {
4478 vuid = is_2 ? "VUID-VkBlitImageInfo2-pRegions-00217" : "VUID-vkCmdBlitImage-pRegions-00217";
4479 skip |= LogError(cb_node->commandBuffer(), vuid,
4480 "%s: pRegion[%" PRIu32 "] src overlaps with pRegions[%" PRIu32 "] dst.", func_name, i, j);
4481 }
4482 }
4483 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004484 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004485 } else {
4486 assert(0);
4487 }
4488 return skip;
4489}
4490
Jeff Leger178b1e52020-10-05 12:22:23 -04004491bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4492 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4493 const VkImageBlit *pRegions, VkFilter filter) const {
4494 return ValidateCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter,
Tony-LunarG542ae912021-11-04 16:06:44 -06004495 CMD_BLITIMAGE);
Jeff Leger178b1e52020-10-05 12:22:23 -04004496}
4497
4498bool CoreChecks::PreCallValidateCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) const {
4499 return ValidateCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4500 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
Tony-LunarG542ae912021-11-04 16:06:44 -06004501 pBlitImageInfo->filter, CMD_BLITIMAGE2KHR);
4502}
4503
4504bool CoreChecks::PreCallValidateCmdBlitImage2(VkCommandBuffer commandBuffer, const VkBlitImageInfo2 *pBlitImageInfo) const {
4505 return ValidateCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4506 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4507 pBlitImageInfo->filter, CMD_BLITIMAGE2);
Jeff Leger178b1e52020-10-05 12:22:23 -04004508}
4509
4510template <typename RegionType>
4511void CoreChecks::RecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
4512 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
4513 VkFilter filter) {
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07004514 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06004515 auto src_image_state = Get<IMAGE_STATE>(srcImage);
4516 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004517
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004518 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004519 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06004520 cb_node->SetImageInitialLayout(*src_image_state, pRegions[i].srcSubresource, srcImageLayout);
4521 cb_node->SetImageInitialLayout(*dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004522 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004523}
4524
Jeff Leger178b1e52020-10-05 12:22:23 -04004525void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4526 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4527 const VkImageBlit *pRegions, VkFilter filter) {
4528 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
4529 pRegions, filter);
4530 RecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter);
4531}
4532
4533void CoreChecks::PreCallRecordCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) {
4534 StateTracker::PreCallRecordCmdBlitImage2KHR(commandBuffer, pBlitImageInfo);
4535 RecordCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4536 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4537 pBlitImageInfo->filter);
4538}
4539
Tony-LunarG542ae912021-11-04 16:06:44 -06004540void CoreChecks::PreCallRecordCmdBlitImage2(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) {
4541 StateTracker::PreCallRecordCmdBlitImage2(commandBuffer, pBlitImageInfo);
4542 RecordCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4543 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4544 pBlitImageInfo->filter);
4545}
4546
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004547GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap &map, const IMAGE_STATE &image_state) {
John Zulauf2076e812020-01-08 14:55:54 -07004548 // This approach allows for a single hash lookup or/create new
Jeremy Gebben6335df62021-11-01 10:50:13 -06004549 auto &layout_map = map[&image_state];
John Zulauf17708d02021-02-22 11:20:58 -07004550 if (!layout_map) {
4551 layout_map.emplace(image_state.subresource_encoder.SubresourceCount());
John Zulauf2076e812020-01-08 14:55:54 -07004552 }
John Zulauf17708d02021-02-22 11:20:58 -07004553 return &layout_map;
John Zulauf2076e812020-01-08 14:55:54 -07004554}
4555
Jeremy Gebben6335df62021-11-01 10:50:13 -06004556const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, const IMAGE_STATE &image_state) {
4557 auto it = map.find(&image_state);
John Zulauf2076e812020-01-08 14:55:54 -07004558 if (it != map.end()) {
John Zulauf17708d02021-02-22 11:20:58 -07004559 return &it->second;
John Zulauf2076e812020-01-08 14:55:54 -07004560 }
4561 return nullptr;
4562}
4563
Jeremy Gebben53631302021-04-13 16:46:37 -06004564// Helper to update the Global or Overlay layout map
4565struct GlobalLayoutUpdater {
4566 bool update(VkImageLayout &dst, const image_layout_map::ImageSubresourceLayoutMap::LayoutEntry &src) const {
4567 if (src.current_layout != image_layout_map::kInvalidLayout && dst != src.current_layout) {
4568 dst = src.current_layout;
4569 return true;
4570 }
4571 return false;
4572 }
4573
4574 layer_data::optional<VkImageLayout> insert(const image_layout_map::ImageSubresourceLayoutMap::LayoutEntry &src) const {
4575 layer_data::optional<VkImageLayout> result;
4576 if (src.current_layout != image_layout_map::kInvalidLayout) {
4577 result.emplace(src.current_layout);
4578 }
4579 return result;
4580 }
4581};
4582
Shannon McPherson449fa9c2018-10-25 11:51:07 -06004583// 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 -07004584bool CoreChecks::ValidateCmdBufImageLayouts(const Location &loc, const CMD_BUFFER_STATE *pCB,
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004585 GlobalImageLayoutMap &overlayLayoutMap) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06004586 if (disabled[image_layout_validation]) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004587 bool skip = false;
John Zulauff660ad62019-03-23 07:16:05 -06004588 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07004589 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06004590 for (const auto &layout_map_entry : pCB->image_layout_map) {
Jeremy Gebben6335df62021-11-01 10:50:13 -06004591 const auto *image_state = layout_map_entry.first;
unknown089cdb82019-07-11 12:58:43 -06004592 const auto &subres_map = layout_map_entry.second;
Jeremy Gebben53631302021-04-13 16:46:37 -06004593 const auto &layout_map = subres_map->GetLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06004594 // Validate the initial_uses for each subresource referenced
Jeremy Gebben53631302021-04-13 16:46:37 -06004595 if (layout_map.empty()) continue;
John Zulauf2076e812020-01-08 14:55:54 -07004596
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004597 auto *overlay_map = GetLayoutRangeMap(overlayLayoutMap, *image_state);
Jeremy Gebben4a8881f2022-01-10 17:04:30 -07004598 const auto *global_map = image_state->layout_range_map.get();
4599 assert(global_map);
4600 auto global_map_guard = global_map->ReadLock();
John Zulauf2076e812020-01-08 14:55:54 -07004601
4602 // Note: don't know if it would matter
4603 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
4604
Jeremy Gebben53631302021-04-13 16:46:37 -06004605 auto pos = layout_map.begin();
4606 const auto end = layout_map.end();
4607 sparse_container::parallel_iterator<const GlobalImageLayoutRangeMap> current_layout(*overlay_map, *global_map,
4608 pos->first.begin);
John Zulauf2076e812020-01-08 14:55:54 -07004609 while (pos != end) {
Jeremy Gebben53631302021-04-13 16:46:37 -06004610 VkImageLayout initial_layout = pos->second.initial_layout;
4611 assert(initial_layout != image_layout_map::kInvalidLayout);
4612 if (initial_layout == image_layout_map::kInvalidLayout) {
4613 continue;
4614 }
4615
John Zulauf2076e812020-01-08 14:55:54 -07004616 VkImageLayout image_layout = kInvalidLayout;
Jeremy Gebben53631302021-04-13 16:46:37 -06004617
John Zulauf2076e812020-01-08 14:55:54 -07004618 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 -07004619 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004620 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07004621 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004622 image_layout = current_layout->pos_B->lower_bound->second;
4623 }
4624 const auto intersected_range = pos->first & current_layout->range;
4625 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
4626 // TODO: Set memory invalid which is in mem_tracker currently
4627 } else if (image_layout != initial_layout) {
Hans-Kristian Arntzen6cb03492021-07-05 16:57:31 +02004628 const auto aspect_mask = image_state->subresource_encoder.Decode(intersected_range.begin).aspectMask;
4629 bool matches = ImageLayoutMatches(aspect_mask, image_layout, initial_layout);
John Zulauf2076e812020-01-08 14:55:54 -07004630 if (!matches) {
John Zulauf2076e812020-01-08 14:55:54 -07004631 // We can report all the errors for the intersected range directly
4632 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
locke-lunarg296a3c92020-03-25 01:04:29 -06004633 const auto subresource = image_state->subresource_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004634 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004635 pCB->commandBuffer(), kVUID_Core_DrawState_InvalidImageLayout,
sfricke-samsung6b447aa2021-07-26 09:42:26 -07004636 "%s command buffer %s expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004637 "to be in layout %s--instead, current layout is %s.",
sfricke-samsung6b447aa2021-07-26 09:42:26 -07004638 loc.Message().c_str(), report_data->FormatHandle(pCB->commandBuffer()).c_str(),
Jeremy Gebben6335df62021-11-01 10:50:13 -06004639 report_data->FormatHandle(image_state->Handle()).c_str(), subresource.aspectMask, subresource.arrayLayer,
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004640 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
John Zulaufb61ed972019-04-09 16:12:35 -06004641 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004642 }
4643 }
John Zulauf2076e812020-01-08 14:55:54 -07004644 if (pos->first.includes(intersected_range.end)) {
4645 current_layout.seek(intersected_range.end);
4646 } else {
4647 ++pos;
4648 if (pos != end) {
4649 current_layout.seek(pos->first.begin);
4650 }
4651 }
John Zulauff660ad62019-03-23 07:16:05 -06004652 }
locke-lunargf155ccf2020-02-18 11:34:15 -07004653 // Update all layout set operations (which will be a subset of the initial_layouts)
Jeremy Gebben53631302021-04-13 16:46:37 -06004654 sparse_container::splice(*overlay_map, subres_map->GetLayoutMap(), GlobalLayoutUpdater());
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004655 }
John Zulauff660ad62019-03-23 07:16:05 -06004656
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004657 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004658}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07004659
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004660void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06004661 for (const auto &layout_map_entry : pCB->image_layout_map) {
Jeremy Gebben6335df62021-11-01 10:50:13 -06004662 const auto *image_state = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07004663 const auto &subres_map = layout_map_entry.second;
Jeremy Gebben4a8881f2022-01-10 17:04:30 -07004664 auto guard = image_state->layout_range_map->WriteLock();
4665 sparse_container::splice(*image_state->layout_range_map, subres_map->GetLayoutMap(), GlobalLayoutUpdater());
Tony Barbourdf013b92017-01-25 12:53:48 -07004666 }
4667}
4668
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004669// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004670// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
4671// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004672bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
4673 const VkImageLayout first_layout, const uint32_t attachment,
Mike Schuchardt2df08912020-12-15 16:28:09 -08004674 const VkAttachmentDescription2 &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004675 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004676 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
4677
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004678 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
sfricke-samsung55f01952020-03-24 08:16:41 -07004679 // for both loadOp and stencilLoaOp rp2 has it in 1 VU while rp1 has it in 2 VU with half behind Maintenance2 extension
4680 // Each is VUID is below in following order: rp2 -> rp1 with Maintenance2 -> rp1 with no extenstion
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004681 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07004682 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4683 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4684 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004685 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004686 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004687 string_VkImageLayout(first_layout));
sfricke-samsung45996a42021-09-16 13:45:27 -07004688 } else if ((use_rp2 == false) && IsExtEnabled(device_extensions.vk_khr_maintenance2) &&
sfricke-samsung55f01952020-03-24 08:16:41 -07004689 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL)) {
4690 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01566",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004691 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004692 string_VkImageLayout(first_layout));
4693 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4694 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004695 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004696 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004697 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004698 }
4699 }
sfricke-samsung55f01952020-03-24 08:16:41 -07004700
4701 // Same as above for loadOp, but for stencilLoadOp
4702 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
4703 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4704 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4705 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL))) {
4706 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02523",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004707 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004708 string_VkImageLayout(first_layout));
sfricke-samsung45996a42021-09-16 13:45:27 -07004709 } else if ((use_rp2 == false) && IsExtEnabled(device_extensions.vk_khr_maintenance2) &&
sfricke-samsung55f01952020-03-24 08:16:41 -07004710 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL)) {
4711 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01567",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004712 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004713 string_VkImageLayout(first_layout));
4714 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4715 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
4716 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-02511",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004717 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004718 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02004719 }
4720 }
4721
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004722 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004723}
4724
Mark Lobodzinski96210742017-02-09 10:33:46 -07004725// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4726// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004727template <typename T1>
4728bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
4729 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
4730 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004731 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004732 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004733 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004734 if (strict) {
4735 correct_usage = ((actual & desired) == desired);
4736 } else {
4737 correct_usage = ((actual & desired) != 0);
4738 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004739
Mark Lobodzinski96210742017-02-09 10:33:46 -07004740 if (!correct_usage) {
sfricke-samsungbb971942020-09-10 22:11:56 -07004741 // All callers should have a valid VUID
4742 assert(msgCode != kVUIDUndefined);
4743 skip =
4744 LogError(object, msgCode, "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4745 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004746 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004747 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004748}
4749
4750// 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::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004753 char const *func_name, char const *usage_string) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004754 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image(),
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06004755 image_state->Handle(), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004756}
4757
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004758bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags2KHR desired,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004759 char const *func_name, const char *vuid) const {
Cort Stratton186b1a22018-05-01 20:18:06 -04004760 bool skip = false;
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004761 const VkFormatFeatureFlags2KHR image_format_features = image_state->format_features;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004762 if ((image_format_features & desired) != desired) {
4763 // Same error, but more details if it was an AHB external format
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06004764 if (image_state->HasAHBFormat()) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004765 skip |= LogError(image_state->image(), vuid,
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004766 "In %s, VkFormatFeatureFlags (0x%" PRIxLEAST64 ") does not support required feature %s for the external format "
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004767 "found in VkAndroidHardwareBufferFormatPropertiesANDROID::formatFeatures used by %s.",
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004768 func_name, image_format_features, string_VkFormatFeatureFlags2KHR(desired).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004769 report_data->FormatHandle(image_state->image()).c_str());
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004770 } else {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004771 skip |= LogError(image_state->image(), vuid,
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004772 "In %s, VkFormatFeatureFlags (0x%" PRIxLEAST64 ") does not support required feature %s for format %u used by %s "
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004773 "with tiling %s.",
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004774 func_name, image_format_features, string_VkFormatFeatureFlags2KHR(desired).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004775 image_state->createInfo.format, report_data->FormatHandle(image_state->image()).c_str(),
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004776 string_VkImageTiling(image_state->createInfo.tiling));
Cort Stratton186b1a22018-05-01 20:18:06 -04004777 }
4778 }
4779 return skip;
4780}
4781
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004782bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004783 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004784 bool skip = false;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004785 const VkImageAspectFlags apsect_mask = subresource_layers->aspectMask;
Cort Strattond619a302018-05-17 19:46:32 -07004786 // layerCount must not be zero
4787 if (subresource_layers->layerCount == 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004788 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-layerCount-01700",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004789 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004790 }
4791 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004792 if (apsect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004793 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-00168",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004794 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004795 }
4796 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004797 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 -06004798 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-00167",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004799 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4800 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4801 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004802 }
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004803 // aspectMask must not contain VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT
4804 if (apsect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
4805 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004806 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-02247",
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004807 "In %s, pRegions[%u].%s.aspectMask has a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit set.", func_name, i,
4808 member);
4809 }
Cort Strattond619a302018-05-17 19:46:32 -07004810 return skip;
4811}
4812
Mark Lobodzinski96210742017-02-09 10:33:46 -07004813// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4814// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004815bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004816 char const *func_name, char const *usage_string) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004817 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer(),
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06004818 buffer_state->Handle(), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004819}
4820
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004821bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004822 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004823 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004824
4825 const VkDeviceSize &range = pCreateInfo->range;
4826 if (range != VK_WHOLE_SIZE) {
4827 // Range must be greater than 0
4828 if (range <= 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004829 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00928",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004830 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004831 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4832 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004833 }
4834 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004835 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4836 if (SafeModulo(range, format_size) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004837 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00929",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004838 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004839 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4840 "(%" PRIu32 ").",
4841 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004842 }
4843 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004844 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004845 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00930",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004846 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004847 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4848 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4849 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004850 }
4851 // The sum of range and offset must be less than or equal to the size of buffer
4852 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004853 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-offset-00931",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004854 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004855 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4856 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4857 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004858 }
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004859 } else {
4860 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4861
4862 // Size of buffer - offset, divided by the element size of format must be less than or equal to
4863 // VkPhysicalDeviceLimits::maxTexelBufferElements
4864 if (SafeDivision(buffer_state->createInfo.size - pCreateInfo->offset, format_size) >
4865 device_limits->maxTexelBufferElements) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004866 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-04059",
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004867 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
4868 ") equals VK_WHOLE_SIZE, the buffer's size (%" PRIuLEAST64 ") minus the offset (%" PRIuLEAST64
4869 "), divided by the element size of the format (%" PRIu32
4870 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4871 range, buffer_state->createInfo.size, pCreateInfo->offset, format_size,
4872 device_limits->maxTexelBufferElements);
4873 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004874 }
4875 return skip;
4876}
4877
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004878bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004879 bool skip = false;
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004880 const VkFormatProperties3KHR format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004881 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004882 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_2_UNIFORM_TEXEL_BUFFER_BIT_KHR)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004883 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-00933",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004884 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004885 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format (%s) must "
4886 "be supported for uniform texel buffers",
4887 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004888 }
4889 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004890 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_2_STORAGE_TEXEL_BUFFER_BIT_KHR)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004891 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-00934",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004892 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004893 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format (%s) must "
4894 "be supported for storage texel buffers",
4895 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004896 }
4897 return skip;
4898}
4899
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004900bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004901 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004902 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004903
Dave Houltond8ed0212018-05-16 17:18:24 -06004904 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004905
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004906 auto chained_devaddr_struct = LvlFindInChain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
Jeff Bolz87697532019-01-11 22:54:00 -06004907 if (chained_devaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004908 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz87697532019-01-11 22:54:00 -06004909 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004910 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4911 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004912 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004913 }
4914 }
4915
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004916 auto chained_opaqueaddr_struct = LvlFindInChain<VkBufferOpaqueCaptureAddressCreateInfo>(pCreateInfo->pNext);
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004917 if (chained_opaqueaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004918 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004919 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004920 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
Mike Schuchardt2df08912020-12-15 16:28:09 -08004921 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfo::opaqueCaptureAddress"
4922 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004923 }
4924 }
4925
ziga-lunarg2e2be1e2021-07-18 23:09:15 +02004926 auto dedicated_allocation_buffer = LvlFindInChain<VkDedicatedAllocationBufferCreateInfoNV>(pCreateInfo->pNext);
4927 if (dedicated_allocation_buffer && dedicated_allocation_buffer->dedicatedAllocation == VK_TRUE) {
4928 if (pCreateInfo->flags &
4929 (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT)) {
4930 skip |= LogError(device, "VUID-VkBufferCreateInfo-pNext-01571",
4931 "vkCreateBuffer(): pCreateInfos->flags must not include VK_BUFFER_CREATE_SPARSE_BINDING_BIT, "
4932 "VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT, or VK_BUFFER_CREATE_SPARSE_ALIASED_BIT when "
4933 "VkDedicatedAllocationBufferCreateInfoNV is in pNext chain with dedicatedAllocation VK_TRUE.");
4934 }
4935 }
4936
Mike Schuchardt2df08912020-12-15 16:28:09 -08004937 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz33fc6722020-03-31 12:58:16 -05004938 !enabled_features.core12.bufferDeviceAddressCaptureReplay &&
sfricke-samsung828e59d2021-08-22 23:20:49 -07004939 !enabled_features.buffer_device_address_ext_features.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004940 skip |= LogError(
4941 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004942 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004943 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT set.");
Jeff Bolz87697532019-01-11 22:54:00 -06004944 }
4945
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004946 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
sfricke-samsung45996a42021-09-16 13:45:27 -07004947 const char *vuid = IsExtEnabled(device_extensions.vk_khr_get_physical_device_properties2)
4948 ? "VUID-VkBufferCreateInfo-sharingMode-01419"
4949 : "VUID-VkBufferCreateInfo-sharingMode-01391";
Mark Lobodzinski314b9162020-07-16 15:33:08 -06004950 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
ziga-lunarga0b4f8a2021-07-28 13:23:02 +02004951 "vkCreateBuffer", "pCreateInfo->pQueueFamilyIndices", vuid);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004952 }
4953
sfricke-samsungedce77a2020-07-03 22:35:13 -07004954 if ((pCreateInfo->flags & VK_BUFFER_CREATE_PROTECTED_BIT) != 0) {
4955 if (enabled_features.core11.protectedMemory == VK_FALSE) {
4956 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-01887",
4957 "vkCreateBuffer(): the protectedMemory device feature is disabled: Buffers cannot be created with the "
4958 "VK_BUFFER_CREATE_PROTECTED_BIT set.");
4959 }
4960 const VkBufferCreateFlags invalid_flags =
4961 VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT;
4962 if ((pCreateInfo->flags & invalid_flags) != 0) {
4963 skip |= LogError(device, "VUID-VkBufferCreateInfo-None-01888",
4964 "vkCreateBuffer(): VK_BUFFER_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at "
4965 "same time (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | "
4966 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT).");
4967 }
4968 }
4969
ziga-lunargfe74b8d2022-04-18 17:37:46 +02004970 if ((pCreateInfo->usage & (VK_BUFFER_USAGE_VIDEO_DECODE_SRC_BIT_KHR | VK_BUFFER_USAGE_VIDEO_DECODE_DST_BIT_KHR)) > 0) {
4971 bool has_decode_codec_operation = false;
Mike Schuchardt0e558a52022-08-18 15:14:51 -07004972 const auto* video_profiles = LvlFindInChain<VkVideoProfileListInfoKHR>(pCreateInfo->pNext);
ziga-lunargfe74b8d2022-04-18 17:37:46 +02004973 if (video_profiles) {
4974 for (uint32_t i = 0; i < video_profiles->profileCount; ++i) {
4975 if (video_profiles->pProfiles[i].videoCodecOperation &
4976 (VK_VIDEO_CODEC_OPERATION_DECODE_H264_BIT_EXT | VK_VIDEO_CODEC_OPERATION_DECODE_H265_BIT_EXT)) {
4977 has_decode_codec_operation = true;
4978 break;
4979 }
4980 }
4981 }
4982 if (!has_decode_codec_operation) {
4983 skip |= LogError(device, "VUID-VkBufferCreateInfo-usage-04813",
Mike Schuchardt0e558a52022-08-18 15:14:51 -07004984 "vkCreateBuffer(): pCreateInfo->usage is %s, but pNext chain does not include VkVideoProfileListInfoKHR with "
ziga-lunargfe74b8d2022-04-18 17:37:46 +02004985 "a decode codec-operation.",
4986 string_VkBufferUsageFlags(pCreateInfo->usage).c_str());
4987 }
4988 }
4989 if ((pCreateInfo->usage & (VK_BUFFER_USAGE_VIDEO_ENCODE_SRC_BIT_KHR | VK_BUFFER_USAGE_VIDEO_ENCODE_DST_BIT_KHR)) > 0) {
4990 bool has_encode_codec_operation = false;
Mike Schuchardt0e558a52022-08-18 15:14:51 -07004991 const auto *video_profiles = LvlFindInChain<VkVideoProfileListInfoKHR>(pCreateInfo->pNext);
ziga-lunargfe74b8d2022-04-18 17:37:46 +02004992 if (video_profiles) {
4993 for (uint32_t i = 0; i < video_profiles->profileCount; ++i) {
4994 if (video_profiles->pProfiles[i].videoCodecOperation &
4995 (VK_VIDEO_CODEC_OPERATION_ENCODE_H264_BIT_EXT | VK_VIDEO_CODEC_OPERATION_ENCODE_H265_BIT_EXT)) {
4996 has_encode_codec_operation = true;
4997 break;
4998 }
4999 }
5000 }
5001 if (!has_encode_codec_operation) {
5002 skip |= LogError(device, "VUID-VkBufferCreateInfo-usage-04814",
Mike Schuchardt0e558a52022-08-18 15:14:51 -07005003 "vkCreateBuffer(): pCreateInfo->usage is %s, but pNext chain does not include VkVideoProfileListInfoKHR with "
ziga-lunargfe74b8d2022-04-18 17:37:46 +02005004 "an encode codec-operation.",
5005 string_VkBufferUsageFlags(pCreateInfo->usage).c_str());
5006 }
5007 }
5008
Mark Lobodzinski96210742017-02-09 10:33:46 -07005009 return skip;
5010}
5011
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005012bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005013 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07005014 bool skip = false;
Jeremy Gebbenf4449392022-01-28 10:09:10 -07005015 auto buffer_state = Get<BUFFER_STATE>(pCreateInfo->buffer);
sfricke-samsung2e827212021-09-28 07:52:08 -07005016
5017 if (FormatIsDepthOrStencil(pCreateInfo->format)) {
5018 // Should never hopefully get here, but there are known driver advertising the wrong feature flags
5019 // see https://gitlab.khronos.org/vulkan/vulkan/-/merge_requests/4849
5020 skip |= LogError(device, kVUID_Core_invalidDepthStencilFormat,
5021 "vkCreateBufferView(): format is a depth/stencil format (%s) but depth/stencil formats do not have a "
5022 "defined sizes for alignment, replace with a color format.",
5023 string_VkFormat(pCreateInfo->format));
5024 }
5025
Mark Lobodzinski96210742017-02-09 10:33:46 -07005026 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
5027 if (buffer_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06005028 skip |=
5029 ValidateMemoryIsBoundToBuffer(buffer_state.get(), "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07005030 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
5031 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Jeremy Gebben9f537102021-10-05 16:37:12 -06005032 skip |= ValidateBufferUsageFlags(buffer_state.get(),
Dave Houltond8ed0212018-05-16 17:18:24 -06005033 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
5034 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
5035 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06005036
Shannon McPherson0eb84f62018-06-18 16:32:40 -06005037 // Buffer view offset must be less than the size of buffer
5038 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005039 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-offset-00925",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07005040 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005041 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
5042 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06005043 }
5044
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06005045 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05005046 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
5047 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
5048 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
sfricke-samsung45996a42021-09-16 13:45:27 -07005049 const char *vuid = IsExtEnabled(device_extensions.vk_ext_texel_buffer_alignment)
5050 ? "VUID-VkBufferViewCreateInfo-offset-02749"
5051 : "VUID-VkBufferViewCreateInfo-offset-00926";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005052 skip |= LogError(buffer_state->buffer(), vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07005053 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005054 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
5055 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05005056 }
5057
5058 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005059 VkDeviceSize element_size = FormatElementSize(pCreateInfo->format);
5060 if ((element_size % 3) == 0) {
5061 element_size /= 3;
Jeff Bolzd5554e62019-07-19 13:23:52 -05005062 }
5063 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005064 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05005065 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
5066 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005067 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05005068 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005069 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005070 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005071 buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-02750",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07005072 "vkCreateBufferView(): If buffer was created with usage containing "
5073 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05005074 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
5075 ") must be a multiple of the lesser of "
5076 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
5077 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
5078 "(%" PRId32
5079 ") is VK_TRUE, the size of a texel of the requested format. "
5080 "If the size of a texel is a multiple of three bytes, then the size of a "
5081 "single component of format is used instead",
5082 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
5083 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
5084 }
5085 }
5086 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005087 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05005088 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
5089 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005090 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05005091 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005092 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005093 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005094 buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-02751",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07005095 "vkCreateBufferView(): If buffer was created with usage containing "
5096 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05005097 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
5098 ") must be a multiple of the lesser of "
5099 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
5100 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
5101 "(%" PRId32
5102 ") is VK_TRUE, the size of a texel of the requested format. "
5103 "If the size of a texel is a multiple of three bytes, then the size of a "
5104 "single component of format is used instead",
5105 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
5106 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
5107 }
5108 }
5109 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06005110
Jeremy Gebben9f537102021-10-05 16:37:12 -06005111 skip |= ValidateBufferViewRange(buffer_state.get(), pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06005112
Jeremy Gebben9f537102021-10-05 16:37:12 -06005113 skip |= ValidateBufferViewBuffer(buffer_state.get(), pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07005114 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07005115 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07005116}
5117
Mark Lobodzinski602de982017-02-09 11:01:33 -07005118// For the given format verify that the aspect masks make sense
Aitor Camachoeb35fed2022-06-07 14:07:42 +02005119bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, bool is_image_disjoint,
5120 const char *func_name, const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005121 bool skip = false;
sfricke-samsung79b00482020-04-01 21:15:50 -07005122 // checks color format and (single-plane or non-disjoint)
5123 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
Aitor Camachoeb35fed2022-06-07 14:07:42 +02005124 if ((FormatIsColor(format)) && ((FormatIsMultiplane(format) == false) || (is_image_disjoint == false))) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005125 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08005126 skip |= LogError(
5127 image, vuid,
5128 "%s: Using format (%s) with aspect flags (%s) but color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.",
5129 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005130 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08005131 skip |= LogError(image, vuid,
5132 "%s: Using format (%s) with aspect flags (%s) but color image formats must have ONLY the "
5133 "VK_IMAGE_ASPECT_COLOR_BIT set.",
5134 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005135 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06005136 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005137 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005138 skip |= LogError(image, vuid,
sfricke-samsung7687a482021-01-29 23:19:22 -08005139 "%s: Using format (%s) with aspect flags (%s) but depth/stencil image formats must have at least one "
5140 "of VK_IMAGE_ASPECT_DEPTH_BIT and VK_IMAGE_ASPECT_STENCIL_BIT set.",
5141 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005142 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005143 skip |= LogError(image, vuid,
sfricke-samsung7687a482021-01-29 23:19:22 -08005144 "%s: Using format (%s) with aspect flags (%s) but combination depth/stencil image formats can have "
5145 "only the VK_IMAGE_ASPECT_DEPTH_BIT and VK_IMAGE_ASPECT_STENCIL_BIT set.",
5146 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005147 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06005148 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005149 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08005150 skip |= LogError(image, vuid,
5151 "%s: Using format (%s) with aspect flags (%s) but depth-only image formats must have the "
5152 "VK_IMAGE_ASPECT_DEPTH_BIT set.",
5153 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005154 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08005155 skip |= LogError(image, vuid,
5156 "%s: Using format (%s) with aspect flags (%s) but depth-only image formats can have only the "
5157 "VK_IMAGE_ASPECT_DEPTH_BIT set.",
5158 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005159 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06005160 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005161 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08005162 skip |= LogError(image, vuid,
5163 "%s: Using format (%s) with aspect flags (%s) but stencil-only image formats must have the "
5164 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
5165 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005166 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08005167 skip |= LogError(image, vuid,
5168 "%s: Using format (%s) with aspect flags (%s) but stencil-only image formats can have only the "
5169 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
5170 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005171 }
Dave Houlton501b15b2018-03-30 15:07:41 -06005172 } else if (FormatIsMultiplane(format)) {
5173 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
5174 if (3 == FormatPlaneCount(format)) {
5175 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
5176 }
5177 if ((aspect_mask & valid_flags) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08005178 skip |= LogError(image, vuid,
5179 "%s: Using format (%s) with aspect flags (%s) but multi-plane image formats may have only "
5180 "VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs set, where n = [0, 1, 2].",
5181 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Dave Houlton501b15b2018-03-30 15:07:41 -06005182 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005183 }
5184 return skip;
5185}
5186
ziga-lunarg69aa72f2022-03-29 15:24:35 +02005187bool CoreChecks::ValidateImageAcquired(IMAGE_STATE const &image_state, const char *func_name) const {
ziga-lunarg04e94b32021-10-03 01:42:37 +02005188 bool skip = false;
5189
ziga-lunarg04e94b32021-10-03 01:42:37 +02005190 return skip;
5191}
5192
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005193bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
5194 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005195 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
Jeremy Gebben5573a8c2021-06-04 08:55:10 -06005196 const SubresourceRangeErrorCodes &errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005197 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02005198
5199 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02005200 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005201 skip |= LogError(image, errorCodes.base_mip_err,
5202 "%s: %s.baseMipLevel (= %" PRIu32
5203 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
5204 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02005205 }
Petr Kraus4d718682017-05-18 03:38:41 +02005206
Petr Krausffa94af2017-08-08 21:46:02 +02005207 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
5208 if (subresourceRange.levelCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07005209 skip |=
5210 LogError(image, "VUID-VkImageSubresourceRange-levelCount-01720", "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02005211 } else {
5212 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02005213
Petr Krausffa94af2017-08-08 21:46:02 +02005214 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005215 skip |= LogError(image, errorCodes.mip_count_err,
5216 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
5217 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
5218 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
5219 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02005220 }
Petr Kraus4d718682017-05-18 03:38:41 +02005221 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005222 }
Petr Kraus4d718682017-05-18 03:38:41 +02005223
5224 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02005225 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005226 skip |= LogError(image, errorCodes.base_layer_err,
5227 "%s: %s.baseArrayLayer (= %" PRIu32
5228 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
5229 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02005230 }
Petr Kraus4d718682017-05-18 03:38:41 +02005231
Petr Krausffa94af2017-08-08 21:46:02 +02005232 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
5233 if (subresourceRange.layerCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07005234 skip |=
5235 LogError(image, "VUID-VkImageSubresourceRange-layerCount-01721", "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02005236 } else {
5237 const uint64_t necessary_layer_count =
5238 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02005239
Petr Krausffa94af2017-08-08 21:46:02 +02005240 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005241 skip |= LogError(image, errorCodes.layer_count_err,
5242 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
5243 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
5244 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
5245 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02005246 }
Petr Kraus4d718682017-05-18 03:38:41 +02005247 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005248 }
Petr Kraus4d718682017-05-18 03:38:41 +02005249
ziga-lunargb4e90752021-08-02 13:58:29 +02005250 if (subresourceRange.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
5251 if (subresourceRange.aspectMask &
5252 (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT)) {
5253 skip |= LogError(image, "VUID-VkImageSubresourceRange-aspectMask-01670",
5254 "%s: aspectMask includes both VK_IMAGE_ASPECT_COLOR_BIT and one of VK_IMAGE_ASPECT_PLANE_0_BIT, "
5255 "VK_IMAGE_ASPECT_PLANE_1_BIT, or VK_IMAGE_ASPECT_PLANE_2_BIT.",
5256 cmd_name);
5257 }
5258 }
5259
Mark Lobodzinski602de982017-02-09 11:01:33 -07005260 return skip;
5261}
5262
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005263bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005264 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07005265 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Tony-LunarGbe956362022-04-05 13:34:31 -06005266 bool is_2d_compatible = (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT) ? true : false;
5267 if (device_extensions.vk_ext_image_2d_view_of_3d)
5268 is_2d_compatible |= (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_VIEW_COMPATIBLE_BIT_EXT) ? true : false;
5269 bool is_image_slicable =
5270 (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) && is_2d_compatible;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005271 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 +02005272
David McFarland2853f2f2020-11-30 15:50:39 -04005273 uint32_t image_layer_count;
5274
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005275 if (is_3_d_to_2_d_map) {
David McFarland2853f2f2020-11-30 15:50:39 -04005276 const auto layers = LayersFromRange(subresourceRange);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06005277 const auto extent = image_state->GetSubresourceExtent(layers);
David McFarland2853f2f2020-11-30 15:50:39 -04005278 image_layer_count = extent.depth;
5279 } else {
5280 image_layer_count = image_state->createInfo.arrayLayers;
5281 }
5282
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005283 const auto image_layer_count_var_name = is_3_d_to_2_d_map ? "extent.depth" : "arrayLayers";
Petr Krausffa94af2017-08-08 21:46:02 +02005284
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005285 SubresourceRangeErrorCodes subresource_range_error_codes = {};
5286 subresource_range_error_codes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
5287 subresource_range_error_codes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
5288 subresource_range_error_codes.base_layer_err =
5289 is_khr_maintenance1
Tony-LunarGbe956362022-04-05 13:34:31 -06005290 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-image-02724"
5291 : (device_extensions.vk_ext_image_2d_view_of_3d ? "VUID-VkImageViewCreateInfo-image-06724"
5292 : "VUID-VkImageViewCreateInfo-image-01482"))
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005293 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
Tony-LunarGbe956362022-04-05 13:34:31 -06005294 subresource_range_error_codes.layer_count_err =
5295 is_khr_maintenance1
5296 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
5297 : (device_extensions.vk_ext_image_2d_view_of_3d ? "VUID-VkImageViewCreateInfo-subresourceRange-06725"
5298 : "VUID-VkImageViewCreateInfo-subresourceRange-01483"))
5299 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02005300
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005301 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02005302 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005303 image_state->image(), subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02005304}
5305
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005306bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06005307 const VkImageSubresourceRange &subresourceRange,
5308 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005309 SubresourceRangeErrorCodes subresource_range_error_codes = {};
5310 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
5311 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
5312 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
5313 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02005314
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005315 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005316 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image(),
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005317 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02005318}
5319
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005320bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06005321 const VkImageSubresourceRange &subresourceRange,
5322 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005323 SubresourceRangeErrorCodes subresource_range_error_codes = {};
5324 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
5325 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
5326 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
5327 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02005328
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005329 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005330 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image(),
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005331 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02005332}
5333
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005334bool CoreChecks::ValidateImageBarrierSubresourceRange(const Location &loc, const IMAGE_STATE *image_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005335 const VkImageSubresourceRange &subresourceRange) const {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005336 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005337 loc.StringFunc().c_str(), loc.StringField().c_str(), "arrayLayers", image_state->image(),
Jeremy Gebbenbb845612021-02-18 18:16:05 -07005338 sync_vuid_maps::GetSubResourceVUIDs(loc));
Petr Krausffa94af2017-08-08 21:46:02 +02005339}
5340
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005341namespace barrier_queue_families {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005342using sync_vuid_maps::GetBarrierQueueVUID;
5343using sync_vuid_maps::kQueueErrorSummary;
5344using sync_vuid_maps::QueueError;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005345
5346class ValidatorState {
5347 public:
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005348 ValidatorState(const ValidationStateTracker *device_data, LogObjectList &&obj, const core_error::Location &location,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005349 const VulkanTypedHandle &barrier_handle, const VkSharingMode sharing_mode)
5350 : device_data_(device_data),
John Zulaufbea70432021-02-23 07:03:12 -07005351 objects_(std::move(obj)),
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005352 loc_(location),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005353 barrier_handle_(barrier_handle),
5354 sharing_mode_(sharing_mode),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005355 limit_(static_cast<uint32_t>(device_data->physical_device_state->queue_family_properties.size())),
5356 mem_ext_(IsExtEnabled(device_data->device_extensions.vk_khr_external_memory)) {}
5357
5358 // Log the messages using boilerplate from object state, and Vu specific information from the template arg
5359 // 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 -07005360 bool LogMsg(QueueError vu_index, uint32_t family, const char *param_name) const {
5361 const std::string val_code = GetBarrierQueueVUID(loc_, vu_index);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005362 const char *annotation = GetFamilyAnnotation(family);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005363 return device_data_->LogError(objects_, val_code, "%s Barrier using %s %s created with sharingMode %s, has %s %u%s. %s",
5364 loc_.Message().c_str(), GetTypeString(),
5365 device_data_->report_data->FormatHandle(barrier_handle_).c_str(), GetModeString(), param_name,
5366 family, annotation, kQueueErrorSummary.at(vu_index).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005367 }
5368
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005369 bool LogMsg(QueueError vu_index, uint32_t src_family, uint32_t dst_family) const {
5370 const std::string val_code = GetBarrierQueueVUID(loc_, vu_index);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005371 const char *src_annotation = GetFamilyAnnotation(src_family);
5372 const char *dst_annotation = GetFamilyAnnotation(dst_family);
5373 return device_data_->LogError(
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005374 objects_, val_code,
5375 "%s Barrier using %s %s created with sharingMode %s, has srcQueueFamilyIndex %u%s and dstQueueFamilyIndex %u%s. %s",
5376 loc_.Message().c_str(), GetTypeString(), device_data_->report_data->FormatHandle(barrier_handle_).c_str(),
5377 GetModeString(), src_family, src_annotation, dst_family, dst_annotation, kQueueErrorSummary.at(vu_index).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005378 }
5379
5380 // This abstract Vu can only be tested at submit time, thus we need a callback from the closure containing the needed
5381 // data. Note that the mem_barrier is copied to the closure as the lambda lifespan exceed the guarantees of validity for
5382 // application input.
5383 static bool ValidateAtQueueSubmit(const QUEUE_STATE *queue_state, const ValidationStateTracker *device_data,
5384 uint32_t src_family, uint32_t dst_family, const ValidatorState &val) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005385 auto error_code = QueueError::kSubmitQueueMustMatchSrcOrDst;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005386 uint32_t queue_family = queue_state->queueFamilyIndex;
5387 if ((src_family != queue_family) && (dst_family != queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005388 const std::string val_code = GetBarrierQueueVUID(val.loc_, error_code);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005389 const char *src_annotation = val.GetFamilyAnnotation(src_family);
5390 const char *dst_annotation = val.GetFamilyAnnotation(dst_family);
5391 return device_data->LogError(
Jeremy Gebben63f3cb02021-09-07 15:16:32 -06005392 queue_state->Handle(), val_code,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005393 "%s Barrier submitted to queue with family index %u, using %s %s created with sharingMode %s, has "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005394 "srcQueueFamilyIndex %u%s and dstQueueFamilyIndex %u%s. %s",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005395 val.loc_.Message().c_str(), queue_family, val.GetTypeString(),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005396 device_data->report_data->FormatHandle(val.barrier_handle_).c_str(), val.GetModeString(), src_family,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005397 src_annotation, dst_family, dst_annotation, kQueueErrorSummary.at(error_code).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005398 }
5399 return false;
5400 }
5401 // Logical helpers for semantic clarity
5402 inline bool KhrExternalMem() const { return mem_ext_; }
5403 inline bool IsValid(uint32_t queue_family) const { return (queue_family < limit_); }
5404 inline bool IsValidOrSpecial(uint32_t queue_family) const {
5405 return IsValid(queue_family) || (mem_ext_ && QueueFamilyIsExternal(queue_family));
5406 }
5407
5408 // Helpers for LogMsg
5409 const char *GetModeString() const { return string_VkSharingMode(sharing_mode_); }
5410
5411 // Descriptive text for the various types of queue family index
5412 const char *GetFamilyAnnotation(uint32_t family) const {
5413 const char *external = " (VK_QUEUE_FAMILY_EXTERNAL)";
5414 const char *foreign = " (VK_QUEUE_FAMILY_FOREIGN_EXT)";
5415 const char *ignored = " (VK_QUEUE_FAMILY_IGNORED)";
5416 const char *valid = " (VALID)";
5417 const char *invalid = " (INVALID)";
5418 switch (family) {
5419 case VK_QUEUE_FAMILY_EXTERNAL:
5420 return external;
5421 case VK_QUEUE_FAMILY_FOREIGN_EXT:
5422 return foreign;
5423 case VK_QUEUE_FAMILY_IGNORED:
5424 return ignored;
5425 default:
5426 if (IsValid(family)) {
5427 return valid;
5428 }
5429 return invalid;
5430 };
5431 }
5432 const char *GetTypeString() const { return object_string[barrier_handle_.type]; }
5433 VkSharingMode GetSharingMode() const { return sharing_mode_; }
5434
5435 protected:
5436 const ValidationStateTracker *device_data_;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005437 const LogObjectList objects_;
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005438 const core_error::Location loc_;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005439 const VulkanTypedHandle barrier_handle_;
5440 const VkSharingMode sharing_mode_;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005441 const uint32_t limit_;
5442 const bool mem_ext_;
5443};
5444
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005445bool Validate(const CoreChecks *device_data, const CMD_BUFFER_STATE *cb_state, const ValidatorState &val,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005446 const uint32_t src_queue_family, const uint32_t dst_queue_family) {
5447 bool skip = false;
5448
5449 const bool mode_concurrent = val.GetSharingMode() == VK_SHARING_MODE_CONCURRENT;
5450 const bool src_ignored = QueueFamilyIsIgnored(src_queue_family);
5451 const bool dst_ignored = QueueFamilyIsIgnored(dst_queue_family);
5452 if (val.KhrExternalMem()) {
5453 if (mode_concurrent) {
Tony-LunarG273f32f2021-09-28 08:56:30 -06005454 bool sync2 = device_data->enabled_features.core13.synchronization2 != 0;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005455 // this requirement is removed by VK_KHR_synchronization2
5456 if (!(src_ignored || dst_ignored) && !sync2) {
5457 skip |= val.LogMsg(QueueError::kSrcOrDstMustBeIgnore, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005458 }
5459 if ((src_ignored && !(dst_ignored || QueueFamilyIsExternal(dst_queue_family))) ||
5460 (dst_ignored && !(src_ignored || QueueFamilyIsExternal(src_queue_family)))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005461 skip |= val.LogMsg(QueueError::kSpecialOrIgnoreOnly, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005462 }
5463 } else {
5464 // VK_SHARING_MODE_EXCLUSIVE
5465 if (src_queue_family != dst_queue_family) {
5466 if (!val.IsValidOrSpecial(dst_queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005467 skip |= val.LogMsg(QueueError::kSrcAndDstValidOrSpecial, dst_queue_family, "dstQueueFamilyIndex");
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005468 }
5469 if (!val.IsValidOrSpecial(src_queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005470 skip |= val.LogMsg(QueueError::kSrcAndDstValidOrSpecial, src_queue_family, "srcQueueFamilyIndex");
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005471 }
5472 }
5473 }
5474 } else {
5475 // No memory extension
5476 if (mode_concurrent) {
Tony-LunarG273f32f2021-09-28 08:56:30 -06005477 bool sync2 = device_data->enabled_features.core13.synchronization2 != 0;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005478 // this requirement is removed by VK_KHR_synchronization2
5479 if ((!src_ignored || !dst_ignored) && !sync2) {
5480 skip |= val.LogMsg(QueueError::kSrcAndDestMustBeIgnore, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005481 }
5482 } else {
5483 // VK_SHARING_MODE_EXCLUSIVE
5484 if ((src_queue_family != dst_queue_family) && !(val.IsValid(src_queue_family) && val.IsValid(dst_queue_family))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005485 skip |= val.LogMsg(QueueError::kSrcAndDstBothValid, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005486 }
5487 }
5488 }
5489 return skip;
5490}
5491} // namespace barrier_queue_families
5492
Jeremy Gebbene5361dd2021-11-18 14:23:56 -07005493bool CoreChecks::ValidateConcurrentBarrierAtSubmit(const Location &loc, const ValidationStateTracker &state_data,
5494 const QUEUE_STATE &queue_state, const CMD_BUFFER_STATE &cb_state,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005495 const VulkanTypedHandle &typed_handle, uint32_t src_queue_family,
5496 uint32_t dst_queue_family) {
5497 using barrier_queue_families::ValidatorState;
Jeremy Gebbene5361dd2021-11-18 14:23:56 -07005498 ValidatorState val(&state_data, LogObjectList(cb_state.Handle()), loc, typed_handle, VK_SHARING_MODE_CONCURRENT);
5499 return ValidatorState::ValidateAtQueueSubmit(&queue_state, &state_data, src_queue_family, dst_queue_family, val);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005500}
5501
5502// Type specific wrapper for image barriers
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005503template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005504bool CoreChecks::ValidateBarrierQueueFamilies(const Location &loc, const CMD_BUFFER_STATE *cb_state, const ImgBarrier &barrier,
5505 const IMAGE_STATE *state_data) const {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005506 // State data is required
5507 if (!state_data) {
5508 return false;
5509 }
5510
5511 // Create the validator state from the image state
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005512 barrier_queue_families::ValidatorState val(this, LogObjectList(cb_state->commandBuffer()), loc,
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06005513 state_data->Handle(), state_data->createInfo.sharingMode);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005514 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
5515 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005516 return barrier_queue_families::Validate(this, cb_state, val, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005517}
5518
5519// Type specific wrapper for buffer barriers
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005520template <typename BufBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005521bool CoreChecks::ValidateBarrierQueueFamilies(const Location &loc, const CMD_BUFFER_STATE *cb_state, const BufBarrier &barrier,
5522 const BUFFER_STATE *state_data) const {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005523 // State data is required
5524 if (!state_data) {
5525 return false;
5526 }
5527
5528 // Create the validator state from the buffer state
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005529 barrier_queue_families::ValidatorState val(this, LogObjectList(cb_state->commandBuffer()), loc,
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06005530 state_data->Handle(), state_data->createInfo.sharingMode);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005531 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
5532 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005533 return barrier_queue_families::Validate(this, cb_state, val, src_queue_family, dst_queue_family);
5534}
5535
5536template <typename Barrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005537bool CoreChecks::ValidateBufferBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005538 const Barrier &mem_barrier) const {
5539 using sync_vuid_maps::BufferError;
5540 using sync_vuid_maps::GetBufferBarrierVUID;
5541
5542 bool skip = false;
5543
5544 skip |= ValidateQFOTransferBarrierUniqueness(loc, cb_state, mem_barrier, cb_state->qfo_transfer_buffer_barriers);
5545
5546 // Validate buffer barrier queue family indices
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06005547 auto buffer_state = Get<BUFFER_STATE>(mem_barrier.buffer);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005548 if (buffer_state) {
5549 auto buf_loc = loc.dot(Field::buffer);
5550 const auto &mem_vuid = GetBufferBarrierVUID(buf_loc, BufferError::kNoMemory);
Jeremy Gebben9f537102021-10-05 16:37:12 -06005551 skip |= ValidateMemoryIsBoundToBuffer(buffer_state.get(), loc.StringFunc().c_str(), mem_vuid.c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005552
Jeremy Gebben9f537102021-10-05 16:37:12 -06005553 skip |= ValidateBarrierQueueFamilies(buf_loc, cb_state, mem_barrier, buffer_state.get());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005554
5555 auto buffer_size = buffer_state->createInfo.size;
5556 if (mem_barrier.offset >= buffer_size) {
5557 auto offset_loc = loc.dot(Field::offset);
5558 const auto &vuid = GetBufferBarrierVUID(offset_loc, BufferError::kOffsetTooBig);
5559
5560 skip |= LogError(objects, vuid, "%s %s has offset 0x%" PRIx64 " which is not less than total size 0x%" PRIx64 ".",
5561 offset_loc.Message().c_str(), report_data->FormatHandle(mem_barrier.buffer).c_str(),
5562 HandleToUint64(mem_barrier.offset), HandleToUint64(buffer_size));
5563 } else if (mem_barrier.size != VK_WHOLE_SIZE && (mem_barrier.offset + mem_barrier.size > buffer_size)) {
5564 auto size_loc = loc.dot(Field::size);
5565 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kSizeOutOfRange);
5566 skip |= LogError(objects, vuid,
5567 "%s %s has offset 0x%" PRIx64 " and size 0x%" PRIx64 " whose sum is greater than total size 0x%" PRIx64
5568 ".",
5569 size_loc.Message().c_str(), report_data->FormatHandle(mem_barrier.buffer).c_str(),
5570 HandleToUint64(mem_barrier.offset), HandleToUint64(mem_barrier.size), HandleToUint64(buffer_size));
5571 }
5572 if (mem_barrier.size == 0) {
5573 auto size_loc = loc.dot(Field::size);
5574 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kSizeZero);
5575 skip |= LogError(objects, vuid, "%s %s has a size of 0.", loc.Message().c_str(),
5576 report_data->FormatHandle(mem_barrier.buffer).c_str());
5577 }
5578 }
ziga-lunarg8e2506c2022-04-18 20:06:00 +02005579
5580 if (mem_barrier.srcQueueFamilyIndex == VK_QUEUE_FAMILY_EXTERNAL &&
5581 mem_barrier.dstQueueFamilyIndex == VK_QUEUE_FAMILY_EXTERNAL) {
5582 auto size_loc = loc.dot(Field::srcQueueFamilyIndex);
5583 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kQueueFamilyExternal);
5584 skip |= LogError(objects, vuid, "Both srcQueueFamilyIndex and dstQueueFamilyIndex are VK_QUEUE_FAMILY_EXTERNAL.");
5585 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005586 return skip;
5587}
5588
5589template <typename Barrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005590bool CoreChecks::ValidateImageBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005591 const Barrier &mem_barrier) const {
5592 bool skip = false;
5593
5594 skip |= ValidateQFOTransferBarrierUniqueness(loc, cb_state, mem_barrier, cb_state->qfo_transfer_image_barriers);
5595
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005596 bool is_ilt = true;
Tony-LunarG273f32f2021-09-28 08:56:30 -06005597 if (enabled_features.core13.synchronization2) {
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005598 is_ilt = mem_barrier.oldLayout != mem_barrier.newLayout;
5599 }
5600
5601 if (is_ilt) {
5602 if (mem_barrier.newLayout == VK_IMAGE_LAYOUT_UNDEFINED || mem_barrier.newLayout == VK_IMAGE_LAYOUT_PREINITIALIZED) {
5603 auto layout_loc = loc.dot(Field::newLayout);
5604 const auto &vuid = sync_vuid_maps::GetImageBarrierVUID(loc, sync_vuid_maps::ImageError::kBadLayout);
5605 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005606 LogError(cb_state->commandBuffer(), vuid, "%s Image Layout cannot be transitioned to UNDEFINED or PREINITIALIZED.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005607 layout_loc.Message().c_str());
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005608 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005609 }
5610
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06005611 auto image_data = Get<IMAGE_STATE>(mem_barrier.image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005612 if (image_data) {
5613 auto image_loc = loc.dot(Field::image);
5614
Jeremy Gebben9f537102021-10-05 16:37:12 -06005615 skip |= ValidateMemoryIsBoundToImage(image_data.get(), loc);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005616
Jeremy Gebben9f537102021-10-05 16:37:12 -06005617 skip |= ValidateBarrierQueueFamilies(image_loc, cb_state, mem_barrier, image_data.get());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005618
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005619 skip |= ValidateImageAspectMask(image_data->image(), image_data->createInfo.format, mem_barrier.subresourceRange.aspectMask,
Aitor Camachoeb35fed2022-06-07 14:07:42 +02005620 image_data->disjoint, loc.StringFunc().c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005621
Jeremy Gebben9f537102021-10-05 16:37:12 -06005622 skip |=
5623 ValidateImageBarrierSubresourceRange(loc.dot(Field::subresourceRange), image_data.get(), mem_barrier.subresourceRange);
ziga-lunarg69aa72f2022-03-29 15:24:35 +02005624 skip |= ValidateImageAcquired(*image_data, loc.StringFunc().c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005625 }
5626 return skip;
5627}
5628
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005629bool CoreChecks::ValidateBarriers(const Location &outer_loc, const CMD_BUFFER_STATE *cb_state, VkPipelineStageFlags src_stage_mask,
5630 VkPipelineStageFlags dst_stage_mask, uint32_t memBarrierCount,
5631 const VkMemoryBarrier *pMemBarriers, uint32_t bufferBarrierCount,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005632 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
5633 const VkImageMemoryBarrier *pImageMemBarriers) const {
5634 bool skip = false;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005635 LogObjectList objects(cb_state->commandBuffer());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005636
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005637 for (uint32_t i = 0; i < memBarrierCount; ++i) {
5638 const auto &mem_barrier = pMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005639 auto loc = outer_loc.dot(Struct::VkMemoryBarrier, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005640 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005641 }
5642 for (uint32_t i = 0; i < imageMemBarrierCount; ++i) {
5643 const auto &mem_barrier = pImageMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005644 auto loc = outer_loc.dot(Struct::VkImageMemoryBarrier, Field::pImageMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005645 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005646 skip |= ValidateImageBarrier(objects, loc, cb_state, mem_barrier);
5647 }
5648 {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005649 Location loc(outer_loc.function, Struct::VkImageMemoryBarrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005650 skip |= ValidateBarriersToImages(loc, cb_state, imageMemBarrierCount, pImageMemBarriers);
5651 }
5652 for (uint32_t i = 0; i < bufferBarrierCount; ++i) {
5653 const auto &mem_barrier = pBufferMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005654 auto loc = outer_loc.dot(Struct::VkBufferMemoryBarrier, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005655 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005656 skip |= ValidateBufferBarrier(objects, loc, cb_state, mem_barrier);
5657 }
5658 return skip;
5659}
5660
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005661bool CoreChecks::ValidateDependencyInfo(const LogObjectList &objects, const Location &outer_loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbenefead332021-06-18 08:22:44 -06005662 const VkDependencyInfoKHR *dep_info) const {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005663 bool skip = false;
5664
5665 if (cb_state->activeRenderPass) {
5666 skip |= ValidateRenderPassPipelineBarriers(outer_loc, cb_state, dep_info);
5667 if (skip) return true; // Early return to avoid redundant errors from below calls
5668 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005669 for (uint32_t i = 0; i < dep_info->memoryBarrierCount; ++i) {
5670 const auto &mem_barrier = dep_info->pMemoryBarriers[i];
Tony-LunarG279601c2021-11-16 10:50:51 -07005671 auto loc = outer_loc.dot(Struct::VkMemoryBarrier2, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005672 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005673 }
5674 for (uint32_t i = 0; i < dep_info->imageMemoryBarrierCount; ++i) {
5675 const auto &mem_barrier = dep_info->pImageMemoryBarriers[i];
Tony-LunarG279601c2021-11-16 10:50:51 -07005676 auto loc = outer_loc.dot(Struct::VkImageMemoryBarrier2, Field::pImageMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005677 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005678 skip |= ValidateImageBarrier(objects, loc, cb_state, mem_barrier);
5679 }
5680 {
Tony-LunarG279601c2021-11-16 10:50:51 -07005681 Location loc(outer_loc.function, Struct::VkImageMemoryBarrier2);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005682 skip |= ValidateBarriersToImages(loc, cb_state, dep_info->imageMemoryBarrierCount, dep_info->pImageMemoryBarriers);
5683 }
5684
5685 for (uint32_t i = 0; i < dep_info->bufferMemoryBarrierCount; ++i) {
5686 const auto &mem_barrier = dep_info->pBufferMemoryBarriers[i];
Tony-LunarG279601c2021-11-16 10:50:51 -07005687 auto loc = outer_loc.dot(Struct::VkBufferMemoryBarrier2, Field::pBufferMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005688 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005689 skip |= ValidateBufferBarrier(objects, loc, cb_state, mem_barrier);
5690 }
5691
5692 return skip;
5693}
5694
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005695// template to check all original barrier structures
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005696template <typename Barrier>
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005697bool CoreChecks::ValidateMemoryBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
5698 const Barrier &barrier, VkPipelineStageFlags src_stage_mask,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005699 VkPipelineStageFlags dst_stage_mask) const {
5700 bool skip = false;
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005701 assert(cb_state);
5702 auto queue_flags = cb_state->GetQueueFlags();
5703
5704 if (!cb_state->IsAcquireOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005705 skip |= ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), queue_flags, barrier.srcAccessMask, src_stage_mask);
5706 }
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005707 if (!cb_state->IsReleaseOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005708 skip |= ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), queue_flags, barrier.dstAccessMask, dst_stage_mask);
5709 }
5710 return skip;
5711}
5712
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005713// template to check all synchronization2 barrier structures
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005714template <typename Barrier>
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005715bool CoreChecks::ValidateMemoryBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
5716 const Barrier &barrier) const {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005717 bool skip = false;
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005718 assert(cb_state);
5719 auto queue_flags = cb_state->GetQueueFlags();
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005720
Jeremy Gebbenefead332021-06-18 08:22:44 -06005721 skip |= ValidatePipelineStage(objects, loc.dot(Field::srcStageMask), queue_flags, barrier.srcStageMask);
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005722 if (!cb_state->IsAcquireOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005723 skip |=
5724 ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), queue_flags, barrier.srcAccessMask, barrier.srcStageMask);
5725 }
Jeremy Gebbenefead332021-06-18 08:22:44 -06005726
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005727 skip |= ValidatePipelineStage(objects, loc.dot(Field::dstStageMask), queue_flags, barrier.dstStageMask);
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005728 if (!cb_state->IsReleaseOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005729 skip |=
5730 ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), queue_flags, barrier.dstAccessMask, barrier.dstStageMask);
5731 }
5732 return skip;
5733}
5734
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005735// VkSubpassDependency validation happens when vkCreateRenderPass() is called.
5736// Dependencies between subpasses can only use pipeline stages compatible with VK_QUEUE_GRAPHICS_BIT,
5737// for external subpasses we don't have a yet command buffer so we have to assume all of them are valid.
5738static inline VkQueueFlags SubpassToQueueFlags(uint32_t subpass) {
5739 return subpass == VK_SUBPASS_EXTERNAL ? sync_utils::kAllQueueTypes : static_cast<VkQueueFlags>(VK_QUEUE_GRAPHICS_BIT);
5740}
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005741
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005742bool CoreChecks::ValidateSubpassDependency(const LogObjectList &objects, const Location &in_loc,
5743 const VkSubpassDependency2 &dependency) const {
5744 bool skip = false;
5745 Location loc = in_loc;
5746 VkMemoryBarrier2KHR converted_barrier;
5747 const auto *mem_barrier = LvlFindInChain<VkMemoryBarrier2KHR>(dependency.pNext);
5748
Tony-LunarG273f32f2021-09-28 08:56:30 -06005749 if (mem_barrier && enabled_features.core13.synchronization2) {
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005750 if (dependency.srcAccessMask != 0) {
5751 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-srcAccessMask",
5752 "%s is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5753 loc.dot(Field::srcAccessMask).Message().c_str());
5754 }
5755 if (dependency.dstAccessMask != 0) {
5756 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-dstAccessMask",
5757 "%s dstAccessMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5758 loc.dot(Field::dstAccessMask).Message().c_str());
5759 }
5760 if (dependency.srcStageMask != 0) {
5761 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-srcStageMask",
5762 "%s srcStageMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5763 loc.dot(Field::srcStageMask).Message().c_str());
5764 }
5765 if (dependency.dstStageMask != 0) {
5766 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-dstStageMask",
5767 "%s dstStageMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5768 loc.dot(Field::dstStageMask).Message().c_str());
5769 }
5770 loc = in_loc.dot(Field::pNext);
5771 converted_barrier = *mem_barrier;
5772 } else {
5773 if (mem_barrier) {
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005774 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-pNext",
5775 "%s a VkMemoryBarrier2KHR is present in pNext but synchronization2 is not enabled.",
5776 loc.Message().c_str());
5777 }
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005778 // use the subpass dependency flags, upconverted into wider synchronization2 fields.
5779 converted_barrier.srcStageMask = dependency.srcStageMask;
5780 converted_barrier.dstStageMask = dependency.dstStageMask;
5781 converted_barrier.srcAccessMask = dependency.srcAccessMask;
5782 converted_barrier.dstAccessMask = dependency.dstAccessMask;
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005783 }
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005784 auto src_queue_flags = SubpassToQueueFlags(dependency.srcSubpass);
5785 skip |= ValidatePipelineStage(objects, loc.dot(Field::srcStageMask), src_queue_flags, converted_barrier.srcStageMask);
5786 skip |= ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), src_queue_flags, converted_barrier.srcAccessMask,
5787 converted_barrier.srcStageMask);
5788
5789 auto dst_queue_flags = SubpassToQueueFlags(dependency.dstSubpass);
5790 skip |= ValidatePipelineStage(objects, loc.dot(Field::dstStageMask), dst_queue_flags, converted_barrier.dstStageMask);
5791 skip |= ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), dst_queue_flags, converted_barrier.dstAccessMask,
5792 converted_barrier.dstStageMask);
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005793 return skip;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005794}
5795
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005796bool CoreChecks::ValidateImageViewFormatFeatures(const IMAGE_STATE *image_state, const VkFormat view_format,
5797 const VkImageUsageFlags image_usage) const {
5798 // Pass in image_usage here instead of extracting it from image_state in case there's a chained VkImageViewUsageCreateInfo
5799 bool skip = false;
5800
Lionel Landwerlin21719f62021-12-09 11:40:09 +02005801 VkFormatFeatureFlags2KHR tiling_features = 0;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005802 const VkImageTiling image_tiling = image_state->createInfo.tiling;
5803
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06005804 if (image_state->HasAHBFormat()) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005805 // AHB image view and image share same feature sets
5806 tiling_features = image_state->format_features;
5807 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5808 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
sfricke-samsung45996a42021-09-16 13:45:27 -07005809 assert(IsExtEnabled(device_extensions.vk_ext_image_drm_format_modifier));
sjfrickee9b39372022-05-22 13:02:17 +09005810 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = LvlInitStruct<VkImageDrmFormatModifierPropertiesEXT>();
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005811 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image_state->image(), &drm_format_properties);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005812
Lionel Landwerlin1da35792021-12-14 16:54:13 +02005813 auto fmt_drm_props = LvlInitStruct<VkDrmFormatModifierPropertiesListEXT>();
5814 auto fmt_props_2 = LvlInitStruct<VkFormatProperties2>(&fmt_drm_props);
5815 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &fmt_props_2);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005816
nyorain38a9d232021-03-06 13:06:12 +01005817 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
Lionel Landwerlin1da35792021-12-14 16:54:13 +02005818 drm_properties.resize(fmt_drm_props.drmFormatModifierCount);
5819 fmt_drm_props.pDrmFormatModifierProperties = drm_properties.data();
nyorain38a9d232021-03-06 13:06:12 +01005820
Lionel Landwerlin1da35792021-12-14 16:54:13 +02005821 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &fmt_props_2);
nyorain38a9d232021-03-06 13:06:12 +01005822
Lionel Landwerlin1da35792021-12-14 16:54:13 +02005823 for (uint32_t i = 0; i < fmt_drm_props.drmFormatModifierCount; i++) {
5824 if (fmt_drm_props.pDrmFormatModifierProperties[i].drmFormatModifier == drm_format_properties.drmFormatModifier) {
5825 tiling_features = fmt_drm_props.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
5826 break;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005827 }
5828 }
5829 } else {
Lionel Landwerlin21719f62021-12-09 11:40:09 +02005830 VkFormatProperties3KHR format_properties = GetPDFormatProperties(view_format);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005831 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
5832 : format_properties.optimalTilingFeatures;
5833 }
5834
5835 if (tiling_features == 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005836 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-None-02273",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005837 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
5838 "physical device.",
5839 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5840 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005841 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02274",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005842 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5843 "VK_IMAGE_USAGE_SAMPLED_BIT.",
5844 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5845 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005846 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02275",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005847 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5848 "VK_IMAGE_USAGE_STORAGE_BIT.",
5849 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5850 } 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 -06005851 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02276",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005852 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5853 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
5854 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5855 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
5856 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005857 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02277",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005858 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5859 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5860 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5861 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
5862 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005863 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02652",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005864 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5865 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5866 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Tobias Hector6663c9b2020-11-05 10:18:02 +00005867 } else if ((image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) &&
5868 !(tiling_features & VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR)) {
5869 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005870 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-04550",
Tobias Hector6663c9b2020-11-05 10:18:02 +00005871 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5872 "VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR.",
5873 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5874 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005875 }
5876
5877 return skip;
5878}
5879
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005880bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005881 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005882 bool skip = false;
Jeremy Gebbenf4449392022-01-28 10:09:10 -07005883 auto image_state = Get<IMAGE_STATE>(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005884 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005885 skip |=
Jeremy Gebben9f537102021-10-05 16:37:12 -06005886 ValidateImageUsageFlags(image_state.get(),
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005887 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
5888 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
sfricke-samsungbb971942020-09-10 22:11:56 -07005889 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV |
5890 VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
5891 false, "VUID-VkImageViewCreateInfo-image-04441", "vkCreateImageView()",
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005892 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
sfricke-samsungbb971942020-09-10 22:11:56 -07005893 "TRANSIENT_ATTACHMENT|SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005894 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Jeremy Gebben9f537102021-10-05 16:37:12 -06005895 skip |= ValidateMemoryIsBoundToImage(image_state.get(), "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005896 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02005897 skip |= ValidateCreateImageViewSubresourceRange(
Jeremy Gebben9f537102021-10-05 16:37:12 -06005898 image_state.get(),
5899 pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005900 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005901
5902 VkImageCreateFlags image_flags = image_state->createInfo.flags;
5903 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005904 VkImageUsageFlags image_usage = image_state->createInfo.usage;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005905 VkFormat view_format = pCreateInfo->format;
5906 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06005907 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005908 VkImageViewType view_type = pCreateInfo->viewType;
sfricke-samsung20a8a372021-07-14 06:12:17 -07005909 uint32_t layer_count = pCreateInfo->subresourceRange.layerCount;
Mark Lobodzinski602de982017-02-09 11:01:33 -07005910
Dave Houltonbd2e2622018-04-10 16:41:14 -06005911 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005912 auto chained_ivuci_struct = LvlFindInChain<VkImageViewUsageCreateInfo>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06005913 if (chained_ivuci_struct) {
sfricke-samsung45996a42021-09-16 13:45:27 -07005914 if (IsExtEnabled(device_extensions.vk_khr_maintenance2)) {
5915 if (!IsExtEnabled(device_extensions.vk_ext_separate_stencil_usage)) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05005916 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005917 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
5918 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
5919 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05005920 }
5921 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005922 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05005923 if (image_stencil_struct == nullptr) {
5924 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005925 skip |= LogError(
5926 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005927 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
5928 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
5929 "any bits that were not set in VkImageCreateInfo::usage used to create image");
5930 }
5931 } else {
5932 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
5933 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
5934 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005935 skip |= LogError(
5936 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005937 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5938 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5939 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
5940 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
5941 }
5942 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
5943 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005944 skip |= LogError(
5945 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005946 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5947 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5948 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
5949 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
5950 }
5951 }
5952 }
5953 }
5954
Dave Houltonbd2e2622018-04-10 16:41:14 -06005955 image_usage = chained_ivuci_struct->usage;
5956 }
5957
sfricke-samsungf60b6c82021-04-05 22:59:20 -07005958 // If image used VkImageFormatListCreateInfo need to make sure a format from list is used
5959 const auto format_list_info = LvlFindInChain<VkImageFormatListCreateInfo>(image_state->createInfo.pNext);
5960 if (format_list_info && (format_list_info->viewFormatCount > 0)) {
5961 bool foundFormat = false;
5962 for (uint32_t i = 0; i < format_list_info->viewFormatCount; i++) {
5963 if (format_list_info->pViewFormats[i] == view_format) {
5964 foundFormat = true;
5965 break;
5966 }
5967 }
5968 if (foundFormat == false) {
5969 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-01585",
5970 "vkCreateImageView(): image was created with a VkImageFormatListCreateInfo in pNext of "
5971 "vkImageCreateInfo, but none of the formats match the VkImageViewCreateInfo::format (%s).",
5972 string_VkFormat(view_format));
5973 }
5974 }
5975
Dave Houlton6f5f20a2018-05-04 12:37:44 -06005976 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
5977 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005978 if (FormatIsMultiplane(image_format)) {
sjfricke67b79bc2022-07-14 14:44:37 +09005979 const VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
5980 auto image_class = FormatCompatibilityClass(compat_format);
5981 auto view_class = FormatCompatibilityClass(view_format);
5982 // Need to only check if one is NONE to handle edge case both are NONE
5983 if ((image_class != view_class) || (image_class == FORMAT_COMPATIBILITY_CLASS::NONE)) {
Graeme Leese605ca512019-05-08 12:59:44 +01005984 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06005985 std::stringstream ss;
5986 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01005987 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
sjfricke67b79bc2022-07-14 14:44:37 +09005988 << string_VkFormat(image_format) << ", must be compatible with " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005989 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005990 }
sjfricke7e0d07c2022-07-14 14:44:05 +09005991 } else if (!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT)) {
5992 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
5993 auto image_class = FormatCompatibilityClass(image_format);
5994 auto view_class = FormatCompatibilityClass(view_format);
5995 // Need to only check if one is NONE to handle edge case both are NONE
5996 if ((image_class != view_class) || (image_class == FORMAT_COMPATIBILITY_CLASS::NONE)) {
5997 const char *error_vuid;
5998 if ((!IsExtEnabled(device_extensions.vk_khr_maintenance2)) &&
5999 (!IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion))) {
6000 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
6001 } else if ((IsExtEnabled(device_extensions.vk_khr_maintenance2)) &&
6002 (!IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion))) {
6003 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
6004 } else if ((!IsExtEnabled(device_extensions.vk_khr_maintenance2)) &&
6005 (IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion))) {
6006 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
6007 } else {
6008 // both enabled
6009 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
Dave Houltonc7988072018-04-16 11:46:56 -06006010 }
sjfricke7e0d07c2022-07-14 14:44:05 +09006011 std::stringstream ss;
6012 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
6013 << " is not in the same format compatibility class as "
6014 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
6015 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
6016 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
6017 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Lenny Komowb79f04a2017-09-18 17:07:00 -06006018 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07006019 }
6020 } else {
6021 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07006022 // Unless it is a multi-planar color bit aspect
6023 if ((image_format != view_format) &&
6024 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
sfricke-samsung45996a42021-09-16 13:45:27 -07006025 const char *vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
6026 ? "VUID-VkImageViewCreateInfo-image-01762"
6027 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07006028 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06006029 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07006030 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07006031 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07006032 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07006033 }
6034 }
6035
ziga-lunargebb32de2021-08-29 21:24:30 +02006036 if (image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT && view_type != VK_IMAGE_VIEW_TYPE_2D &&
6037 view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
6038 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04972",
6039 "vkCreateImageView(): image was created with sample count %s, but pCreateInfo->viewType is %s.",
6040 string_VkSampleCountFlagBits(image_state->createInfo.samples), string_VkImageViewType(view_type));
6041 }
6042
Mark Lobodzinski602de982017-02-09 11:01:33 -07006043 // Validate correct image aspect bits for desired formats and format consistency
Aitor Camachoeb35fed2022-06-07 14:07:42 +02006044 skip |=
6045 ValidateImageAspectMask(image_state->image(), image_format, aspect_mask, image_state->disjoint, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06006046
sfricke-samsung20a8a372021-07-14 06:12:17 -07006047 // Valdiate Image/ImageView type compatibility #resources-image-views-compatibility
Jeremy Kniager846ab732017-07-10 13:12:04 -06006048 switch (image_type) {
6049 case VK_IMAGE_TYPE_1D:
6050 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
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 break;
6056 case VK_IMAGE_TYPE_2D:
6057 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
6058 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
6059 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006060 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
6061 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
6062 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06006063 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006064 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
6065 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
6066 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06006067 }
6068 }
6069 break;
6070 case VK_IMAGE_TYPE_3D:
sfricke-samsung45996a42021-09-16 13:45:27 -07006071 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06006072 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
6073 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
Tony-LunarGbe956362022-04-05 13:34:31 -06006074 if (device_extensions.vk_ext_image_2d_view_of_3d) {
6075 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT)) {
6076 if (view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
6077 skip |= LogError(
6078 pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-06723",
6079 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type "
6080 "%s since the image doesn't have VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT flag set.",
6081 string_VkImageViewType(view_type), string_VkImageType(image_type));
6082 } else if (view_type == VK_IMAGE_VIEW_TYPE_2D &&
6083 !(image_flags & VK_IMAGE_CREATE_2D_VIEW_COMPATIBLE_BIT_EXT)) {
6084 skip |= LogError(
6085 pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-06728",
6086 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type "
6087 "%s since the image doesn't have VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT or "
6088 "VK_IMAGE_CREATE_2D_VIEW_COMPATIBLE_BIT_EXT flag set.",
6089 string_VkImageViewType(view_type), string_VkImageType(image_type));
6090 }
6091 }
6092 } else if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT) &&
6093 (view_type == VK_IMAGE_VIEW_TYPE_2D)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06006094 skip |=
Tony-LunarGbe956362022-04-05 13:34:31 -06006095 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-06727",
6096 "vkCreateImageView(): pCreateInfo->viewType VK_IMAGE_VIEW_TYPE_2D is not compatible "
6097 "with image type "
sfricke-samsungd9b3e122021-07-15 22:50:00 -07006098 "%s since the image doesn't have VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT flag set.",
Tony-LunarGbe956362022-04-05 13:34:31 -06006099 string_VkImageType(image_type));
6100 }
6101 if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
Jeremy Kniager846ab732017-07-10 13:12:04 -06006102 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006103 skip |= LogError(
sfricke-samsungd9b3e122021-07-15 22:50:00 -07006104 pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04971",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006105 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
6106 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
6107 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
6108 string_VkImageViewType(view_type), string_VkImageType(image_type));
sfricke-samsungd9b3e122021-07-15 22:50:00 -07006109 } else if (pCreateInfo->subresourceRange.levelCount != 1) {
6110 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04970",
6111 "vkCreateImageView(): pCreateInfo->viewType %s is with image type %s must have a "
6112 "levelCount of 1 but it is %u.",
6113 string_VkImageViewType(view_type), string_VkImageType(image_type),
6114 pCreateInfo->subresourceRange.levelCount);
Jeremy Kniager846ab732017-07-10 13:12:04 -06006115 }
6116 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006117 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
6118 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
6119 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06006120 }
6121 }
6122 } else {
6123 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
sfricke-samsungd9b3e122021-07-15 22:50:00 -07006124 // Help point to VK_KHR_maintenance1
6125 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
6126 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
6127 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
6128 "without VK_KHR_maintenance1 enabled which was promoted in Vulkan 1.0.",
6129 string_VkImageViewType(view_type), string_VkImageType(image_type));
6130 } else {
6131 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
6132 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
6133 string_VkImageViewType(view_type), string_VkImageType(image_type));
6134 }
Jeremy Kniager846ab732017-07-10 13:12:04 -06006135 }
6136 }
6137 break;
6138 default:
6139 break;
6140 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06006141
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006142 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
sfricke-samsung45996a42021-09-16 13:45:27 -07006143 if (IsExtEnabled(device_extensions.vk_android_external_memory_android_hardware_buffer)) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07006144 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06006145 }
6146
Jeremy Gebben9f537102021-10-05 16:37:12 -06006147 skip |= ValidateImageViewFormatFeatures(image_state.get(), view_format, image_usage);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006148
sfricke-samsung828e59d2021-08-22 23:20:49 -07006149 if (enabled_features.shading_rate_image_features.shadingRateImage) {
Tobias Hector6663c9b2020-11-05 10:18:02 +00006150 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
6151 if (view_format != VK_FORMAT_R8_UINT) {
6152 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
6153 "vkCreateImageView() If image was created with usage containing "
6154 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
6155 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05006156 }
Tobias Hector6663c9b2020-11-05 10:18:02 +00006157 }
6158
sfricke-samsung828e59d2021-08-22 23:20:49 -07006159 if (enabled_features.shading_rate_image_features.shadingRateImage ||
Tobias Hector6663c9b2020-11-05 10:18:02 +00006160 enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
6161 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) {
6162 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
6163 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
6164 "vkCreateImageView() If image was created with usage containing "
6165 "VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR, viewType must be "
6166 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
6167 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05006168 }
6169 }
Jeff Bolz99e3f632020-03-24 22:59:22 -05006170
Tobias Hector6663c9b2020-11-05 10:18:02 +00006171 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate &&
6172 !phys_dev_ext_props.fragment_shading_rate_props.layeredShadingRateAttachments &&
sfricke-samsung20a8a372021-07-14 06:12:17 -07006173 image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR && layer_count != 1) {
Tobias Hector6663c9b2020-11-05 10:18:02 +00006174 skip |= LogError(device, "VUID-VkImageViewCreateInfo-usage-04551",
6175 "vkCreateImageView(): subresourceRange.layerCount is %u for a shading rate attachment image view.",
sfricke-samsung20a8a372021-07-14 06:12:17 -07006176 layer_count);
Tobias Hector6663c9b2020-11-05 10:18:02 +00006177 }
6178
sfricke-samsung20a8a372021-07-14 06:12:17 -07006179 if (layer_count == VK_REMAINING_ARRAY_LAYERS) {
6180 const uint32_t remaining_layers = image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer;
6181 if (view_type == VK_IMAGE_VIEW_TYPE_CUBE && remaining_layers != 6) {
Jeff Bolz99e3f632020-03-24 22:59:22 -05006182 skip |= LogError(device, "VUID-VkImageViewCreateInfo-viewType-02962",
6183 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be 6",
sfricke-samsung20a8a372021-07-14 06:12:17 -07006184 remaining_layers);
Jeff Bolz99e3f632020-03-24 22:59:22 -05006185 }
sfricke-samsung20a8a372021-07-14 06:12:17 -07006186 if (view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY && ((remaining_layers) % 6) != 0) {
Jeff Bolz99e3f632020-03-24 22:59:22 -05006187 skip |= LogError(
6188 device, "VUID-VkImageViewCreateInfo-viewType-02963",
6189 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be a multiple of 6",
sfricke-samsung20a8a372021-07-14 06:12:17 -07006190 remaining_layers);
6191 }
6192 if ((remaining_layers != 1) && ((view_type == VK_IMAGE_VIEW_TYPE_1D) || (view_type == VK_IMAGE_VIEW_TYPE_2D) ||
6193 (view_type == VK_IMAGE_VIEW_TYPE_3D))) {
6194 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-imageViewType-04974",
6195 "vkCreateImageView(): Using pCreateInfo->viewType %s and the subresourceRange.layerCount "
6196 "VK_REMAINING_ARRAY_LAYERS=(%d) and must 1 (try looking into VK_IMAGE_VIEW_TYPE_*_ARRAY).",
6197 string_VkImageViewType(view_type), remaining_layers);
6198 }
6199 } else {
6200 if ((layer_count != 1) && ((view_type == VK_IMAGE_VIEW_TYPE_1D) || (view_type == VK_IMAGE_VIEW_TYPE_2D) ||
6201 (view_type == VK_IMAGE_VIEW_TYPE_3D))) {
6202 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-imageViewType-04973",
ziga-lunargc9d29f72022-05-15 19:55:08 +02006203 "vkCreateImageView(): subresourceRange.layerCount (%" PRIu32
6204 ") must be 1 when using viewType %s (try looking into VK_IMAGE_VIEW_TYPE_*_ARRAY).",
6205 layer_count, string_VkImageViewType(view_type));
Jeff Bolz99e3f632020-03-24 22:59:22 -05006206 }
6207 }
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006208
6209 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
ziga-lunarga77a2832022-05-03 11:12:00 +02006210 const auto normalized_subresource_range = image_state->NormalizeSubresourceRange(pCreateInfo->subresourceRange);
6211 if (normalized_subresource_range.levelCount != 1) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06006212 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02571",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006213 "vkCreateImageView(): If image was created with usage containing "
6214 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, subresourceRange.levelCount (%d) must: be 1",
6215 pCreateInfo->subresourceRange.levelCount);
6216 }
6217 }
6218 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
6219 if (!enabled_features.fragment_density_map_features.fragmentDensityMapDynamic) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06006220 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-02572",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006221 "vkCreateImageView(): If the fragmentDensityMapDynamic feature is not enabled, "
6222 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
6223 }
6224 } else {
6225 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
6226 if (image_flags & (VK_IMAGE_CREATE_PROTECTED_BIT | VK_IMAGE_CREATE_SPARSE_BINDING_BIT |
6227 VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT)) {
Shannon McPherson8d0d1f92020-07-06 11:58:21 -06006228 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-04116",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006229 "vkCreateImageView(): If image was created with usage containing "
6230 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT flags must not contain any of "
6231 "VK_IMAGE_CREATE_PROTECTED_BIT, VK_IMAGE_CREATE_SPARSE_BINDING_BIT, "
6232 "VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or VK_IMAGE_CREATE_SPARSE_ALIASED_BIT");
6233 }
6234 }
6235 }
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07006236
ziga-lunarg966ac0e2021-07-18 11:51:44 +02006237 if (image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
paul-lunarg53344e42022-09-02 19:30:08 +02006238 if (!FormatIsCompressed(view_format)) {
6239 if (pCreateInfo->subresourceRange.levelCount != 1) {
6240 skip |=
6241 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-07072",
ziga-lunarg966ac0e2021-07-18 11:51:44 +02006242 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit, "
paul-lunarg53344e42022-09-02 19:30:08 +02006243 "and format is not compressed, but subresourcesRange.levelCount (%" PRIu32 ") is not 1.",
ziga-lunarg966ac0e2021-07-18 11:51:44 +02006244 pCreateInfo->subresourceRange.levelCount);
paul-lunarg53344e42022-09-02 19:30:08 +02006245 }
6246 if (pCreateInfo->subresourceRange.layerCount != 1) {
6247 skip |=
6248 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-07072",
ziga-lunarg966ac0e2021-07-18 11:51:44 +02006249 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit, "
paul-lunarg53344e42022-09-02 19:30:08 +02006250 "and format is not compressed, but subresourcesRange.layerCount (%" PRIu32 ") is not 1.",
ziga-lunarg966ac0e2021-07-18 11:51:44 +02006251 pCreateInfo->subresourceRange.layerCount);
paul-lunarg53344e42022-09-02 19:30:08 +02006252 }
sfricke-samsungd750f812022-02-04 10:23:34 -08006253 }
6254
6255 const bool class_compatible = FormatCompatibilityClass(view_format) == FormatCompatibilityClass(image_format);
6256 // "uncompressed format that is size-compatible" so if compressed, same as not being compatible
6257 const bool size_compatible =
6258 FormatIsCompressed(view_format) ? false : FormatElementSize(view_format) == FormatElementSize(image_format);
6259 if (!class_compatible && !size_compatible) {
6260 skip |=
6261 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01583",
6262 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit and "
6263 "format (%s), but pCreateInfo->format (%s) are not compatible.",
6264 string_VkFormat(image_format), string_VkFormat(view_format));
6265 }
ziga-lunargc290c7f2021-07-31 22:01:46 +02006266 }
6267
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02006268 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT) {
6269 if (!enabled_features.fragment_density_map2_features.fragmentDensityMapDeferred) {
6270 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03567",
6271 "vkCreateImageView(): If the fragmentDensityMapDeferred feature is not enabled, "
6272 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT");
6273 }
6274 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
6275 skip |=
6276 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03568",
6277 "vkCreateImageView(): If flags contains VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT, "
6278 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
6279 }
6280 }
sfricke-samsung45996a42021-09-16 13:45:27 -07006281 if (IsExtEnabled(device_extensions.vk_ext_fragment_density_map2)) {
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02006282 if ((image_flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) && (image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) &&
sfricke-samsung20a8a372021-07-14 06:12:17 -07006283 (layer_count > phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers)) {
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02006284 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-03569",
6285 "vkCreateImageView(): If image was created with flags containing "
6286 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT and usage containing VK_IMAGE_USAGE_SAMPLED_BIT "
6287 "subresourceRange.layerCount (%d) must: be less than or equal to maxSubsampledArrayLayers (%d)",
sfricke-samsung20a8a372021-07-14 06:12:17 -07006288 layer_count, phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers);
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02006289 }
6290 }
6291
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07006292 auto astc_decode_mode = LvlFindInChain<VkImageViewASTCDecodeModeEXT>(pCreateInfo->pNext);
sfricke-samsung45996a42021-09-16 13:45:27 -07006293 if (IsExtEnabled(device_extensions.vk_ext_astc_decode_mode) && (astc_decode_mode != nullptr)) {
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07006294 if ((enabled_features.astc_decode_features.decodeModeSharedExponent == VK_FALSE) &&
6295 (astc_decode_mode->decodeMode == VK_FORMAT_E5B9G9R9_UFLOAT_PACK32)) {
6296 skip |= LogError(device, "VUID-VkImageViewASTCDecodeModeEXT-decodeMode-02231",
6297 "vkCreateImageView(): decodeModeSharedExponent is not enabled but "
6298 "VkImageViewASTCDecodeModeEXT::decodeMode is VK_FORMAT_E5B9G9R9_UFLOAT_PACK32.");
6299 }
6300 }
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07006301
sfricke-samsung45996a42021-09-16 13:45:27 -07006302 if (IsExtEnabled(device_extensions.vk_khr_portability_subset)) {
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07006303 // If swizzling is disabled, make sure it isn't used
Nathaniel Cesario17d057e2021-06-21 22:58:45 -06006304 // NOTE: as of spec version 1.2.183, VUID 04465 states: "all elements of components _must_ be
6305 // VK_COMPONENT_SWIZZLE_IDENTITY."
6306 // However, issue https://github.com/KhronosGroup/Vulkan-Portability/issues/27 points out that the identity can
6307 // also be defined via R, G, B, A enums in the correct order.
6308 // Spec change is at https://gitlab.khronos.org/vulkan/vulkan/-/merge_requests/4600
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07006309 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatSwizzle) &&
Nathaniel Cesario17d057e2021-06-21 22:58:45 -06006310 !IsIdentitySwizzle(pCreateInfo->components)) {
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07006311 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatSwizzle-04465",
6312 "vkCreateImageView (portability error): swizzle is disabled for this device.");
6313 }
6314
6315 // Ensure ImageView's format has the same number of bits and components as Image's format if format reinterpretation is
6316 // disabled
6317 // TODO (ncesario): This is not correct for some cases (e.g., VK_FORMAT_B10G11R11_UFLOAT_PACK32 and
6318 // VK_FORMAT_E5B9G9R9_UFLOAT_PACK32), but requires additional information that should probably be generated from the
6319 // spec. See Github issue #2361.
6320 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatReinterpretation) &&
6321 ((FormatElementSize(pCreateInfo->format, VK_IMAGE_ASPECT_COLOR_BIT) !=
6322 FormatElementSize(image_state->createInfo.format, VK_IMAGE_ASPECT_COLOR_BIT)) ||
sfricke-samsunged028b02021-09-06 23:14:51 -07006323 (FormatComponentCount(pCreateInfo->format) != FormatComponentCount(image_state->createInfo.format)))) {
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07006324 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatReinterpretation-04466",
6325 "vkCreateImageView (portability error): ImageView format must have"
6326 " the same number of components and bits per component as the Image's format");
6327 }
6328 }
Tony-LunarG69604c42021-11-22 16:00:12 -07006329
6330 auto image_view_min_lod = LvlFindInChain<VkImageViewMinLodCreateInfoEXT>(pCreateInfo->pNext);
6331 if (image_view_min_lod) {
6332 if ((!enabled_features.image_view_min_lod_features.minLod) && (image_view_min_lod->minLod != 0)) {
6333 skip |= LogError(device, "VUID-VkImageViewMinLodCreateInfoEXT-minLod-06455",
6334 "vkCreateImageView(): VkImageViewMinLodCreateInfoEXT::minLod = %f, but the minLod feature is not "
6335 "enabled. If the minLod feature is not enabled, minLod must be 0.0",
6336 image_view_min_lod->minLod);
6337 }
arno-lunarg3bfe7b52022-08-29 16:33:37 +02006338 auto max_level =
6339 static_cast<float>(pCreateInfo->subresourceRange.baseMipLevel + (pCreateInfo->subresourceRange.levelCount - 1));
Tony-LunarG69604c42021-11-22 16:00:12 -07006340 if (image_view_min_lod->minLod > max_level) {
6341 skip |= LogError(device, "VUID-VkImageViewMinLodCreateInfoEXT-minLod-06456",
6342 "vkCreateImageView(): minLod (%f) must be less or equal to the index of the last mipmap level "
arno-lunarg3bfe7b52022-08-29 16:33:37 +02006343 "accessible to the view (%f)",
Tony-LunarG69604c42021-11-22 16:00:12 -07006344 image_view_min_lod->minLod, max_level);
6345 }
6346 }
sfricke-samsung0dae8952022-03-03 20:34:23 -06006347
6348 if (FormatRequiresYcbcrConversionExplicitly(view_format)) {
6349 const auto ycbcr_conversion = LvlFindInChain<VkSamplerYcbcrConversionInfo>(pCreateInfo->pNext);
6350 if (!ycbcr_conversion || ycbcr_conversion->conversion == VK_NULL_HANDLE) {
6351 skip |= LogError(
6352 device, "VUID-VkImageViewCreateInfo-format-06415",
6353 "vkCreateImageView(): Format %s requires a VkSamplerYcbcrConversion but one was not passed in the pNext chain.",
6354 string_VkFormat(view_format));
6355 }
6356 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07006357 }
6358 return skip;
6359}
6360
Jeff Leger178b1e52020-10-05 12:22:23 -04006361template <typename RegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006362bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
Tony-LunarGef035472021-11-02 10:23:33 -06006363 uint32_t regionCount, const RegionType *pRegions, CMD_TYPE cmd_type) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006364 bool skip = false;
Tony-LunarGef035472021-11-02 10:23:33 -06006365 const bool is_2 = (cmd_type == CMD_COPYBUFFER2KHR || cmd_type == CMD_COPYBUFFER2);
6366 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04006367 const char *vuid;
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006368
6369 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
6370 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
Aitor Camacho2542b9d2022-06-01 18:37:49 +02006371 bool are_buffers_sparse = src_buffer_state->sparse || dst_buffer_state->sparse;
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006372
6373 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006374 const RegionType region = pRegions[i];
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006375
6376 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
sfricke-samsung71f04e32022-03-16 01:21:21 -05006377 if (region.srcOffset >= src_buffer_size) {
Tony-LunarGef035472021-11-02 10:23:33 -06006378 vuid = is_2 ? "VUID-VkCopyBufferInfo2-srcOffset-00113" : "VUID-vkCmdCopyBuffer-srcOffset-00113";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006379 skip |= LogError(src_buffer_state->buffer(), vuid,
ziga-lunargd6b58ce2021-10-16 01:22:56 +02006380 "%s: pRegions[%" PRIu32 "].srcOffset (%" PRIuLEAST64
6381 ") is greater than size of srcBuffer (%" PRIuLEAST64 ").",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006382 func_name, i, region.srcOffset, src_buffer_size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006383 }
6384
6385 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
sfricke-samsung71f04e32022-03-16 01:21:21 -05006386 if (region.dstOffset >= dst_buffer_size) {
Tony-LunarGef035472021-11-02 10:23:33 -06006387 vuid = is_2 ? "VUID-VkCopyBufferInfo2-dstOffset-00114" : "VUID-vkCmdCopyBuffer-dstOffset-00114";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006388 skip |= LogError(dst_buffer_state->buffer(), vuid,
ziga-lunargd6b58ce2021-10-16 01:22:56 +02006389 "%s: pRegions[%" PRIu32 "].dstOffset (%" PRIuLEAST64
6390 ") is greater than size of dstBuffer (%" PRIuLEAST64 ").",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006391 func_name, i, region.dstOffset, dst_buffer_size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006392 }
6393
6394 // 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 -05006395 if (region.size > (src_buffer_size - region.srcOffset)) {
Tony-LunarGef035472021-11-02 10:23:33 -06006396 vuid = is_2 ? "VUID-VkCopyBufferInfo2-size-00115" : "VUID-vkCmdCopyBuffer-size-00115";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006397 skip |= LogError(src_buffer_state->buffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006398 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the source buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006399 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006400 func_name, i, region.size, src_buffer_size, i, region.srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006401 }
6402
6403 // 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 -05006404 if (region.size > (dst_buffer_size - region.dstOffset)) {
Tony-LunarGef035472021-11-02 10:23:33 -06006405 vuid = is_2 ? "VUID-VkCopyBufferInfo2-size-00116" : "VUID-vkCmdCopyBuffer-size-00116";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006406 skip |= LogError(dst_buffer_state->buffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006407 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the destination buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006408 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006409 func_name, i, region.size, dst_buffer_size, i, region.dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006410 }
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006411
ziga-lunargb94ff002022-03-23 23:30:19 +01006412 // 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 +02006413 if (!skip && !are_buffers_sparse) {
6414 auto src_region = sparse_container::range<VkDeviceSize>{region.srcOffset, region.srcOffset + region.size};
aitor-lunarg26fbbc22022-04-22 18:42:08 +02006415 for (uint32_t j = 0; j < regionCount; j++) {
Aitor Camacho2542b9d2022-06-01 18:37:49 +02006416 auto dst_region =
6417 sparse_container::range<VkDeviceSize>{pRegions[j].dstOffset, pRegions[j].dstOffset + pRegions[j].size};
6418 if (src_buffer_state->DoesResourceMemoryOverlap(src_region, dst_buffer_state, dst_region)) {
aitor-lunarg26fbbc22022-04-22 18:42:08 +02006419 vuid = is_2 ? "VUID-VkCopyBufferInfo2-pRegions-00117" : "VUID-vkCmdCopyBuffer-pRegions-00117";
6420 skip |= LogError(src_buffer_state->buffer(), vuid,
6421 "%s: Detected overlap between source and dest regions in memory.", func_name);
6422 }
ziga-lunargb94ff002022-03-23 23:30:19 +01006423 }
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006424 }
6425 }
6426
6427 return skip;
6428}
sfricke-samsung11813ab2021-10-20 14:53:37 -07006429template <typename RegionType>
6430bool CoreChecks::ValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer, uint32_t regionCount,
Tony-LunarGef035472021-11-02 10:23:33 -06006431 const RegionType *pRegions, CMD_TYPE cmd_type) const {
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07006432 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07006433 auto src_buffer_state = Get<BUFFER_STATE>(srcBuffer);
6434 auto dst_buffer_state = Get<BUFFER_STATE>(dstBuffer);
Tony-LunarGef035472021-11-02 10:23:33 -06006435 const bool is_2 = (cmd_type == CMD_COPYBUFFER2KHR || cmd_type == CMD_COPYBUFFER2);
sfricke-samsung11813ab2021-10-20 14:53:37 -07006436 const char *func_name = CommandTypeString(cmd_type);
6437 const char *vuid;
6438
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006439 bool skip = false;
Tony-LunarGef035472021-11-02 10:23:33 -06006440 vuid = is_2 ? "VUID-VkCopyBufferInfo2-srcBuffer-00119" : "VUID-vkCmdCopyBuffer-srcBuffer-00119";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006441 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state.get(), func_name, vuid);
Tony-LunarGef035472021-11-02 10:23:33 -06006442 vuid = is_2 ? "VUID-VkCopyBufferInfo2-dstBuffer-00121" : "VUID-vkCmdCopyBuffer-dstBuffer-00121";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006443 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state.get(), func_name, vuid);
sfricke-samsung11813ab2021-10-20 14:53:37 -07006444
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006445 // Validate that SRC & DST buffers have correct usage flags set
Tony-LunarGef035472021-11-02 10:23:33 -06006446 vuid = is_2 ? "VUID-VkCopyBufferInfo2-srcBuffer-00118" : "VUID-vkCmdCopyBuffer-srcBuffer-00118";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006447 skip |= ValidateBufferUsageFlags(src_buffer_state.get(), VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
sfricke-samsung11813ab2021-10-20 14:53:37 -07006448 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Tony-LunarGef035472021-11-02 10:23:33 -06006449 vuid = is_2 ? "VUID-VkCopyBufferInfo2-dstBuffer-00120" : "VUID-vkCmdCopyBuffer-dstBuffer-00120";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006450 skip |= ValidateBufferUsageFlags(dst_buffer_state.get(), VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
sfricke-samsung11813ab2021-10-20 14:53:37 -07006451 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
6452
Jeremy Gebben9f537102021-10-05 16:37:12 -06006453 skip |= ValidateCmd(cb_node.get(), cmd_type);
Tony-LunarGef035472021-11-02 10:23:33 -06006454 skip |= ValidateCmdCopyBufferBounds(src_buffer_state.get(), dst_buffer_state.get(), regionCount, pRegions, cmd_type);
sfricke-samsung11813ab2021-10-20 14:53:37 -07006455
Tony-LunarGef035472021-11-02 10:23:33 -06006456 vuid = is_2 ? "VUID-vkCmdCopyBuffer2-commandBuffer-01822" : "VUID-vkCmdCopyBuffer-commandBuffer-01822";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006457 skip |= ValidateProtectedBuffer(cb_node.get(), src_buffer_state.get(), func_name, vuid);
Tony-LunarGef035472021-11-02 10:23:33 -06006458 vuid = is_2 ? "VUID-vkCmdCopyBuffer2-commandBuffer-01823" : "VUID-vkCmdCopyBuffer-commandBuffer-01823";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006459 skip |= ValidateProtectedBuffer(cb_node.get(), dst_buffer_state.get(), func_name, vuid);
Tony-LunarGef035472021-11-02 10:23:33 -06006460 vuid = is_2 ? "VUID-vkCmdCopyBuffer2-commandBuffer-01824" : "VUID-vkCmdCopyBuffer-commandBuffer-01824";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006461 skip |= ValidateUnprotectedBuffer(cb_node.get(), dst_buffer_state.get(), func_name, vuid);
Tony-LunarGef035472021-11-02 10:23:33 -06006462
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006463 return skip;
6464}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07006465
sfricke-samsung11813ab2021-10-20 14:53:37 -07006466bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
6467 uint32_t regionCount, const VkBufferCopy *pRegions) const {
Tony-LunarGef035472021-11-02 10:23:33 -06006468 return ValidateCmdCopyBuffer(commandBuffer, srcBuffer, dstBuffer, regionCount, pRegions, CMD_COPYBUFFER);
sfricke-samsung11813ab2021-10-20 14:53:37 -07006469}
6470
Jeff Leger178b1e52020-10-05 12:22:23 -04006471bool CoreChecks::PreCallValidateCmdCopyBuffer2KHR(VkCommandBuffer commandBuffer,
6472 const VkCopyBufferInfo2KHR *pCopyBufferInfos) const {
sfricke-samsung11813ab2021-10-20 14:53:37 -07006473 return ValidateCmdCopyBuffer(commandBuffer, pCopyBufferInfos->srcBuffer, pCopyBufferInfos->dstBuffer,
Tony-LunarGef035472021-11-02 10:23:33 -06006474 pCopyBufferInfos->regionCount, pCopyBufferInfos->pRegions, CMD_COPYBUFFER2KHR);
6475}
6476
6477bool CoreChecks::PreCallValidateCmdCopyBuffer2(VkCommandBuffer commandBuffer, const VkCopyBufferInfo2 *pCopyBufferInfos) const {
6478 return ValidateCmdCopyBuffer(commandBuffer, pCopyBufferInfos->srcBuffer, pCopyBufferInfos->dstBuffer,
6479 pCopyBufferInfos->regionCount, pCopyBufferInfos->pRegions, CMD_COPYBUFFER2);
Jeff Leger178b1e52020-10-05 12:22:23 -04006480}
6481
Aitor Camacho2542b9d2022-06-01 18:37:49 +02006482template <typename RegionType>
6483void CoreChecks::RecordCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer, uint32_t regionCount,
6484 const RegionType *pRegions, CMD_TYPE cmd_type) {
6485 const bool is_2 = (cmd_type == CMD_COPYBUFFER2KHR || cmd_type == CMD_COPYBUFFER2);
6486 const char *func_name = CommandTypeString(cmd_type);
6487 const char *vuid = is_2 ? "VUID-VkCopyBufferInfo2-pRegions-00117" : "VUID-vkCmdCopyBuffer-pRegions-00117";
6488
6489 auto src_buffer_state = Get<BUFFER_STATE>(srcBuffer);
6490 auto dst_buffer_state = Get<BUFFER_STATE>(dstBuffer);
6491 if (src_buffer_state->sparse || dst_buffer_state->sparse) {
6492 auto cb_node = Get<CMD_BUFFER_STATE>(commandBuffer);
6493
6494 std::vector<sparse_container::range<VkDeviceSize>> src_ranges;
6495 std::vector<sparse_container::range<VkDeviceSize>> dst_ranges;
6496
6497 for (uint32_t i = 0u; i < regionCount; ++i) {
6498 const RegionType &region = pRegions[i];
6499 src_ranges.emplace_back(sparse_container::range<VkDeviceSize>{region.srcOffset, region.srcOffset + region.size});
6500 dst_ranges.emplace_back(sparse_container::range<VkDeviceSize>{region.dstOffset, region.dstOffset + region.size});
6501 }
6502
6503 auto queue_submit_validation = [this, src_buffer_state, dst_buffer_state, src_ranges, dst_ranges, vuid, func_name](
6504 const ValidationStateTracker &device_data, const class QUEUE_STATE &queue_state,
6505 const CMD_BUFFER_STATE &cb_state) -> bool {
6506 bool skip = false;
6507 for (const auto &src : src_ranges) {
6508 for (const auto &dst : dst_ranges) {
6509 if (src_buffer_state->DoesResourceMemoryOverlap(src, dst_buffer_state.get(), dst)) {
6510 skip |= this->LogError(src_buffer_state->buffer(), vuid,
6511 "%s: Detected overlap between source and dest regions in memory.", func_name);
6512 }
6513 }
6514 }
6515
6516 return skip;
6517 };
6518
6519 cb_node->queue_submit_functions.emplace_back(queue_submit_validation);
6520 }
6521}
6522
6523void CoreChecks::PreCallRecordCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
6524 uint32_t regionCount, const VkBufferCopy *pRegions) {
6525 RecordCmdCopyBuffer(commandBuffer, srcBuffer, dstBuffer, regionCount, pRegions, CMD_COPYBUFFER);
6526}
6527
6528void CoreChecks::PreCallRecordCmdCopyBuffer2KHR(VkCommandBuffer commandBuffer, const VkCopyBufferInfo2KHR *pCopyBufferInfos) {
6529 RecordCmdCopyBuffer(commandBuffer, pCopyBufferInfos->srcBuffer, pCopyBufferInfos->dstBuffer, pCopyBufferInfos->regionCount,
6530 pCopyBufferInfos->pRegions, CMD_COPYBUFFER2KHR);
6531}
6532
6533void CoreChecks::PreCallRecordCmdCopyBuffer2(VkCommandBuffer commandBuffer, const VkCopyBufferInfo2 *pCopyBufferInfos) {
6534 RecordCmdCopyBuffer(commandBuffer, pCopyBufferInfos->srcBuffer, pCopyBufferInfos->dstBuffer, pCopyBufferInfos->regionCount,
6535 pCopyBufferInfos->pRegions, CMD_COPYBUFFER2);
6536}
6537
Jeff Bolz5c801d12019-10-09 10:38:45 -05006538bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
6539 const VkAllocationCallbacks *pAllocator) const {
Jeremy Gebbenf4449392022-01-28 10:09:10 -07006540 auto image_view_state = Get<IMAGE_VIEW_STATE>(imageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07006541
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006542 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07006543 if (image_view_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06006544 skip |= ValidateObjectNotInUse(image_view_state.get(), "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006545 }
6546 return skip;
6547}
6548
Jeff Bolz5c801d12019-10-09 10:38:45 -05006549bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Jeremy Gebben8afa7162022-08-03 19:29:10 -06006550 auto buffer_state = Get<BUFFER_STATE>(buffer);
6551
6552 bool skip = false;
6553 if (buffer_state) {
6554 skip |= ValidateObjectNotInUse(buffer_state.get(), "vkDestroyBuffer", "VUID-vkDestroyBuffer-buffer-00922");
6555 }
6556 return skip;
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006557}
6558
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006559bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006560 const VkAllocationCallbacks *pAllocator) const {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006561 auto buffer_view_state = Get<BUFFER_VIEW_STATE>(bufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006562 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07006563 if (buffer_view_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06006564 skip |= ValidateObjectNotInUse(buffer_view_state.get(), "vkDestroyBufferView", "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006565 }
6566 return skip;
6567}
6568
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006569bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006570 VkDeviceSize size, uint32_t data) const {
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07006571 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006572 auto buffer_state = Get<BUFFER_STATE>(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006573 bool skip = false;
Jeremy Gebben9f537102021-10-05 16:37:12 -06006574 skip |= ValidateMemoryIsBoundToBuffer(buffer_state.get(), "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
6575 skip |= ValidateCmd(cb_node.get(), CMD_FILLBUFFER);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006576 // Validate that DST buffer has correct usage flags set
Jeremy Gebben9f537102021-10-05 16:37:12 -06006577 skip |=
6578 ValidateBufferUsageFlags(buffer_state.get(), VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
6579 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006580
Jeremy Gebben9f537102021-10-05 16:37:12 -06006581 skip |=
6582 ValidateProtectedBuffer(cb_node.get(), buffer_state.get(), "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01811");
6583 skip |= ValidateUnprotectedBuffer(cb_node.get(), buffer_state.get(), "vkCmdFillBuffer()",
6584 "VUID-vkCmdFillBuffer-commandBuffer-01812");
sfricke-samsung022fa252020-07-24 03:26:16 -07006585
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006586 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006587 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
6588 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
6589 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
6590 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006591 }
6592
6593 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006594 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
6595 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
6596 ") minus dstOffset (0x%" PRIxLEAST64 ").",
6597 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006598 }
6599
sfricke-samsung45996a42021-09-16 13:45:27 -07006600 if (!IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06006601 skip |= ValidateCmdQueueFlags(cb_node.get(), "vkCmdFillBuffer()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
ziga-lunarg3c5c84e2021-08-04 15:18:56 +02006602 "VUID-vkCmdFillBuffer-commandBuffer-00030");
6603 }
6604
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006605 return skip;
6606}
6607
sfricke-samsung71f04e32022-03-16 01:21:21 -05006608template <typename RegionType>
6609bool CoreChecks::ValidateBufferImageCopyData(const CMD_BUFFER_STATE *cb_node, uint32_t regionCount, const RegionType *pRegions,
6610 const IMAGE_STATE *image_state, const char *function, CMD_TYPE cmd_type,
6611 bool image_to_buffer) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006612 bool skip = false;
Tony Barbour845d29b2021-11-09 11:43:14 -07006613 const bool is_2 = (cmd_type == CMD_COPYBUFFERTOIMAGE2KHR || cmd_type == CMD_COPYBUFFERTOIMAGE2);
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07006614 const char *vuid;
Jeff Leger178b1e52020-10-05 12:22:23 -04006615
sfricke-samsung125d2b42020-05-28 06:32:43 -07006616 assert(image_state != nullptr);
6617 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006618
6619 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006620 const RegionType region = pRegions[i];
6621 const VkImageAspectFlags region_aspect_mask = region.imageSubresource.aspectMask;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006622 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006623 if ((region.imageOffset.y != 0) || (region.imageExtent.height != 1)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006624 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00199", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006625 "%s: pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
6626 "and 1, respectively.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006627 function, i, region.imageOffset.y, region.imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006628 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006629 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006630
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006631 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006632 if ((region.imageOffset.z != 0) || (region.imageExtent.depth != 1)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006633 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00201", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006634 "%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 -07006635 "must be 0 and 1, respectively.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006636 function, i, region.imageOffset.z, region.imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006637 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006638 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006639
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006640 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006641 if ((0 != region.imageSubresource.baseArrayLayer) || (1 != region.imageSubresource.layerCount)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006642 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00213", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006643 "%s: pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006644 "For 3D images these must be 0 and 1, respectively.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006645 function, i, region.imageSubresource.baseArrayLayer, region.imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006646 }
6647 }
6648
6649 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07006650 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
sfricke-samsung73e755c2021-09-30 08:34:57 -07006651 const uint32_t element_size =
6652 FormatIsDepthOrStencil(image_format) ? 0 : FormatElementSize(image_format, region_aspect_mask);
sfricke-samsung71f04e32022-03-16 01:21:21 -05006653 const VkDeviceSize bufferOffset = region.bufferOffset;
Locke497739c2019-03-08 11:50:47 -07006654
sfricke-samsung8feecc12021-01-23 03:28:38 -08006655 if (FormatIsDepthOrStencil(image_format)) {
6656 if (SafeModulo(bufferOffset, 4) != 0) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006657 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("04053", image_to_buffer, is_2),
sfricke-samsung8feecc12021-01-23 03:28:38 -08006658 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6659 " must be a multiple 4 if using a depth/stencil format (%s).",
6660 function, i, bufferOffset, string_VkFormat(image_format));
6661 }
6662 } else {
6663 // If not depth/stencil and not multi-plane
6664 if (!FormatIsMultiplane(image_format) && (SafeModulo(bufferOffset, element_size) != 0)) {
sfricke-samsung45996a42021-09-16 13:45:27 -07006665 vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
Tony Barbour845d29b2021-11-09 11:43:14 -07006666 ? GetBufferImageCopyCommandVUID("01558", image_to_buffer, is_2)
6667 : GetBufferImageCopyCommandVUID("00193", image_to_buffer, is_2);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006668 skip |= LogError(image_state->image(), vuid,
sfricke-samsung8feecc12021-01-23 03:28:38 -08006669 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6670 " must be a multiple of this format's texel size (%" PRIu32 ").",
6671 function, i, bufferOffset, element_size);
6672 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006673 }
6674
sfricke-samsung5f11b0e2022-03-22 14:12:15 -05006675 // Make sure not a empty region
6676 if (region.imageExtent.width == 0) {
6677 vuid = is_2 ? "VUID-VkBufferImageCopy2-imageExtent-06659" : "VUID-VkBufferImageCopy-imageExtent-06659";
6678 LogObjectList objlist(cb_node->commandBuffer());
6679 objlist.add(image_state->image());
6680 skip |=
6681 LogError(objlist, vuid, "%s: pRegion[%" PRIu32 "] extent.width must not be zero as empty copies are not allowed.",
6682 function, i);
6683 }
6684 if (region.imageExtent.height == 0) {
6685 vuid = is_2 ? "VUID-VkBufferImageCopy2-imageExtent-06660" : "VUID-VkBufferImageCopy-imageExtent-06660";
6686 LogObjectList objlist(cb_node->commandBuffer());
6687 objlist.add(image_state->image());
6688 skip |=
6689 LogError(objlist, vuid, "%s: pRegion[%" PRIu32 "] extent.height must not be zero as empty copies are not allowed.",
6690 function, i);
6691 }
6692 if (region.imageExtent.depth == 0) {
6693 vuid = is_2 ? "VUID-VkBufferImageCopy2-imageExtent-06661" : "VUID-VkBufferImageCopy-imageExtent-06661";
6694 LogObjectList objlist(cb_node->commandBuffer());
6695 objlist.add(image_state->image());
6696 skip |=
6697 LogError(objlist, vuid, "%s: pRegion[%" PRIu32 "] extent.depth must not be zero as empty copies are not allowed.",
6698 function, i);
6699 }
6700
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006701 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
sfricke-samsung71f04e32022-03-16 01:21:21 -05006702 if ((region.bufferRowLength != 0) && (region.bufferRowLength < region.imageExtent.width)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006703 vuid = (is_2) ? "VUID-VkBufferImageCopy2-bufferRowLength-00195" : "VUID-VkBufferImageCopy-bufferRowLength-00195";
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06006704 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006705 LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006706 "%s: pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006707 function, i, region.bufferRowLength, region.imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006708 }
6709
6710 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
sfricke-samsung71f04e32022-03-16 01:21:21 -05006711 if ((region.bufferImageHeight != 0) && (region.bufferImageHeight < region.imageExtent.height)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006712 vuid = (is_2) ? "VUID-VkBufferImageCopy2-bufferImageHeight-00196" : "VUID-VkBufferImageCopy-bufferImageHeight-00196";
Jeff Leger178b1e52020-10-05 12:22:23 -04006713 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006714 LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006715 "%s: pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006716 function, i, region.bufferImageHeight, region.imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006717 }
6718
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006719 // Calculate adjusted image extent, accounting for multiplane image factors
sfricke-samsung71f04e32022-03-16 01:21:21 -05006720 VkExtent3D adjusted_image_extent = image_state->GetSubresourceExtent(region.imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006721 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
sfricke-samsung71f04e32022-03-16 01:21:21 -05006722 if ((region.imageOffset.x < 0) || (region.imageOffset.x > static_cast<int32_t>(adjusted_image_extent.width)) ||
6723 ((region.imageOffset.x + static_cast<int32_t>(region.imageExtent.width)) >
Mark Lobodzinski72b1a222020-03-18 11:36:10 -06006724 static_cast<int32_t>(adjusted_image_extent.width))) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006725 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00197", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006726 "%s: Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006727 "zero or <= image subresource width (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006728 function, i, region.imageOffset.x, (region.imageOffset.x + region.imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006729 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006730 }
6731
6732 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
sfricke-samsung71f04e32022-03-16 01:21:21 -05006733 if ((region.imageOffset.y < 0) || (region.imageOffset.y > static_cast<int32_t>(adjusted_image_extent.height)) ||
6734 ((region.imageOffset.y + static_cast<int32_t>(region.imageExtent.height)) >
Mark Lobodzinski72b1a222020-03-18 11:36:10 -06006735 static_cast<int32_t>(adjusted_image_extent.height))) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006736 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00198", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006737 "%s: Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006738 "zero or <= image subresource height (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006739 function, i, region.imageOffset.y, (region.imageOffset.y + region.imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006740 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006741 }
6742
6743 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
sfricke-samsung71f04e32022-03-16 01:21:21 -05006744 if ((region.imageOffset.z < 0) || (region.imageOffset.z > static_cast<int32_t>(adjusted_image_extent.depth)) ||
6745 ((region.imageOffset.z + static_cast<int32_t>(region.imageExtent.depth)) >
Mark Lobodzinski72b1a222020-03-18 11:36:10 -06006746 static_cast<int32_t>(adjusted_image_extent.depth))) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006747 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00200", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006748 "%s: Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006749 "zero or <= image subresource depth (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006750 function, i, region.imageOffset.z, (region.imageOffset.z + region.imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006751 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006752 }
6753
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006754 // subresource aspectMask must have exactly 1 bit set
6755 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
sfricke-samsung125d2b42020-05-28 06:32:43 -07006756 std::bitset<num_bits> aspect_mask_bits(region_aspect_mask);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006757 if (aspect_mask_bits.count() != 1) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006758 vuid = (is_2) ? "VUID-VkBufferImageCopy2-aspectMask-00212" : "VUID-VkBufferImageCopy-aspectMask-00212";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006759 skip |= LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006760 "%s: aspectMasks for imageSubresource in pRegion[%d] must have only a single bit set.", function, i);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006761 }
6762
6763 // image subresource aspect bit must match format
sfricke-samsung125d2b42020-05-28 06:32:43 -07006764 if (!VerifyAspectsPresent(region_aspect_mask, image_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006765 skip |=
Tony Barbour845d29b2021-11-09 11:43:14 -07006766 LogError(image_state->image(), GetBufferImageCopyCommandVUID("00211", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006767 "%s: pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
6768 function, i, region_aspect_mask, image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006769 }
6770
6771 // Checks that apply only to compressed images
sfricke-samsung01da6312021-10-20 07:51:32 -07006772 if (FormatIsBlockedImage(image_format)) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006773 auto block_size = FormatTexelBlockExtent(image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006774
6775 // BufferRowLength must be a multiple of block width
sfricke-samsung71f04e32022-03-16 01:21:21 -05006776 if (SafeModulo(region.bufferRowLength, block_size.width) != 0) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006777 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00203", image_to_buffer, is_2),
sfricke-samsung01da6312021-10-20 07:51:32 -07006778 "%s: pRegion[%d] bufferRowLength (%d) must be a multiple of the blocked image's texel width (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006779 function, i, region.bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006780 }
6781
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006782 // BufferRowHeight must be a multiple of block height
sfricke-samsung71f04e32022-03-16 01:21:21 -05006783 if (SafeModulo(region.bufferImageHeight, block_size.height) != 0) {
sfricke-samsung01da6312021-10-20 07:51:32 -07006784 skip |=
Tony Barbour845d29b2021-11-09 11:43:14 -07006785 LogError(image_state->image(), GetBufferImageCopyCommandVUID("00204", image_to_buffer, is_2),
sfricke-samsung01da6312021-10-20 07:51:32 -07006786 "%s: pRegion[%d] bufferImageHeight (%d) must be a multiple of the blocked image's texel height (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006787 function, i, region.bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006788 }
6789
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006790 // image offsets must be multiples of block dimensions
sfricke-samsung71f04e32022-03-16 01:21:21 -05006791 if ((SafeModulo(region.imageOffset.x, block_size.width) != 0) ||
6792 (SafeModulo(region.imageOffset.y, block_size.height) != 0) ||
6793 (SafeModulo(region.imageOffset.z, block_size.depth) != 0)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006794 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00205", image_to_buffer, is_2),
sfricke-samsung01da6312021-10-20 07:51:32 -07006795 "%s: pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the blocked image's texel "
Petr Krausb0d5e592021-05-21 23:37:11 +02006796 "width & height (%d, %d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006797 function, i, region.imageOffset.x, region.imageOffset.y, block_size.width, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006798 }
6799
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006800 // bufferOffset must be a multiple of block size (linear bytes)
sfricke-samsung73e755c2021-09-30 08:34:57 -07006801 if (SafeModulo(bufferOffset, element_size) != 0) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006802 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00206", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006803 "%s: pRegion[%d] bufferOffset (0x%" PRIxLEAST64
sfricke-samsung01da6312021-10-20 07:51:32 -07006804 ") must be a multiple of the blocked image's texel block size (%" PRIu32 ").",
sfricke-samsung73e755c2021-09-30 08:34:57 -07006805 function, i, bufferOffset, element_size);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006806 }
Dave Houlton67e9b532017-03-02 17:00:10 -07006807
6808 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
sfricke-samsung71f04e32022-03-16 01:21:21 -05006809 VkExtent3D mip_extent = image_state->GetSubresourceExtent(region.imageSubresource);
6810 if ((SafeModulo(region.imageExtent.width, block_size.width) != 0) &&
6811 (region.imageExtent.width + region.imageOffset.x != mip_extent.width)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006812 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00207", image_to_buffer, is_2),
sfricke-samsung01da6312021-10-20 07:51:32 -07006813 "%s: pRegion[%d] extent width (%d) must be a multiple of the blocked texture block width "
Petr Krausb0d5e592021-05-21 23:37:11 +02006814 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006815 function, i, region.imageExtent.width, block_size.width, region.imageOffset.x, mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07006816 }
6817
6818 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
sfricke-samsung71f04e32022-03-16 01:21:21 -05006819 if ((SafeModulo(region.imageExtent.height, block_size.height) != 0) &&
6820 (region.imageExtent.height + region.imageOffset.y != mip_extent.height)) {
6821 skip |=
6822 LogError(image_state->image(), GetBufferImageCopyCommandVUID("00208", image_to_buffer, is_2),
6823 "%s: pRegion[%d] extent height (%d) must be a multiple of the blocked texture block height "
6824 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d).",
6825 function, i, region.imageExtent.height, block_size.height, region.imageOffset.y, mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07006826 }
6827
6828 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
sfricke-samsung71f04e32022-03-16 01:21:21 -05006829 if ((SafeModulo(region.imageExtent.depth, block_size.depth) != 0) &&
6830 (region.imageExtent.depth + region.imageOffset.z != mip_extent.depth)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006831 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00209", image_to_buffer, is_2),
sfricke-samsung01da6312021-10-20 07:51:32 -07006832 "%s: pRegion[%d] extent width (%d) must be a multiple of the blocked texture block depth "
Petr Krausb0d5e592021-05-21 23:37:11 +02006833 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006834 function, i, region.imageExtent.depth, block_size.depth, region.imageOffset.z, mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07006835 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006836 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08006837
6838 // Checks that apply only to multi-planar format images
sfricke-samsung125d2b42020-05-28 06:32:43 -07006839 if (FormatIsMultiplane(image_format)) {
sfricke-samsung552d5e12020-01-07 22:00:20 -08006840 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
sfricke-samsung125d2b42020-05-28 06:32:43 -07006841 if ((FormatPlaneCount(image_format) < 3) && (region_aspect_mask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006842 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006843 "%s: pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006844 "format has three planes.",
6845 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08006846 }
6847
6848 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
sfricke-samsung125d2b42020-05-28 06:32:43 -07006849 if (0 ==
6850 (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 -07006851 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006852 "%s: pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006853 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
6854 function, i);
sfricke-samsung125d2b42020-05-28 06:32:43 -07006855 } else {
6856 // Know aspect mask is valid
6857 const VkFormat compatible_format = FindMultiplaneCompatibleFormat(image_format, region_aspect_mask);
6858 const uint32_t compatible_size = FormatElementSize(compatible_format);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006859 if (SafeModulo(bufferOffset, compatible_size) != 0) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006860 skip |= LogError(
Tony Barbour845d29b2021-11-09 11:43:14 -07006861 image_state->image(), GetBufferImageCopyCommandVUID("01559", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006862 "%s: pRegion[%d]->bufferOffset is 0x%" PRIxLEAST64
sfricke-samsung125d2b42020-05-28 06:32:43 -07006863 " 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 -08006864 function, i, bufferOffset, element_size, GetPlaneIndex(region_aspect_mask),
sfricke-samsung125d2b42020-05-28 06:32:43 -07006865 string_VkFormat(compatible_format));
6866 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08006867 }
6868 }
sfricke-samsung8feecc12021-01-23 03:28:38 -08006869
6870 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
Jeremy Gebbencd7fa282021-10-27 10:25:32 -06006871 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool;
sfricke-samsung8feecc12021-01-23 03:28:38 -08006872 assert(command_pool != nullptr);
6873 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006874 const VkQueueFlags queue_flags = physical_device_state->queue_family_properties[queue_family_index].queueFlags;
sfricke-samsung8feecc12021-01-23 03:28:38 -08006875 if (((queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT)) == 0) && (SafeModulo(bufferOffset, 4) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006876 LogObjectList objlist(cb_node->commandBuffer());
6877 objlist.add(command_pool->commandPool());
sfricke-samsung4389faa2022-03-23 01:19:42 -05006878 objlist.add(image_state->image());
6879 skip |= LogError(objlist, GetBufferImageCopyCommandVUID("04052", image_to_buffer, is_2),
sfricke-samsung8feecc12021-01-23 03:28:38 -08006880 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6881 " must be a multiple 4 because the command buffer %s was allocated from the command pool %s "
6882 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT or "
6883 "VK_QUEUE_COMPUTE_BIT flag.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006884 function, i, bufferOffset, report_data->FormatHandle(cb_node->commandBuffer()).c_str(),
6885 report_data->FormatHandle(command_pool->commandPool()).c_str(), queue_family_index);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006886 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006887 }
6888
6889 return skip;
6890}
6891
sfricke-samsung71f04e32022-03-16 01:21:21 -05006892template <typename RegionType>
6893bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount, const RegionType *pRegions,
6894 const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006895 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006896 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006897
6898 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006899 const RegionType region = pRegions[i];
6900 VkExtent3D extent = region.imageExtent;
6901 VkOffset3D offset = region.imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006902
sfricke-samsung71f04e32022-03-16 01:21:21 -05006903 VkExtent3D image_extent = image_state->GetSubresourceExtent(region.imageSubresource);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006904
sfricke-samsung01da6312021-10-20 07:51:32 -07006905 // If we're using a blocked image format, valid extent is rounded up to multiple of block size (per
6906 // vkspec.html#_common_operation)
6907 if (FormatIsBlockedImage(image_info->format)) {
Dave Houltona585d132019-01-18 13:05:42 -07006908 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006909 if (image_extent.width % block_extent.width) {
6910 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
6911 }
6912 if (image_extent.height % block_extent.height) {
6913 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
6914 }
6915 if (image_extent.depth % block_extent.depth) {
6916 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
6917 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006918 }
6919
Dave Houltonfc1a4052017-04-27 14:32:45 -06006920 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Petr Krausb0d5e592021-05-21 23:37:11 +02006921 skip |= LogError(image_state->image(), msg_code, "%s: pRegion[%d] exceeds image bounds.", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006922 }
6923 }
6924
6925 return skip;
6926}
6927
sfricke-samsung71f04e32022-03-16 01:21:21 -05006928template <typename RegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006929bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
sfricke-samsung71f04e32022-03-16 01:21:21 -05006930 const RegionType *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006931 bool skip = false;
6932
sfricke-samsung11d15ba2021-09-30 09:19:56 -07006933 const VkDeviceSize buffer_size = buff_state->createInfo.size;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006934
6935 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006936 const RegionType region = pRegions[i];
6937 const VkDeviceSize buffer_copy_size = GetBufferSizeFromCopyImage(region, image_state->createInfo.format);
sfricke-samsung11d15ba2021-09-30 09:19:56 -07006938 // This blocks against invalid VkBufferCopyImage that already have been caught elsewhere
6939 if (buffer_copy_size != 0) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006940 const VkDeviceSize max_buffer_copy = buffer_copy_size + region.bufferOffset;
sfricke-samsung11d15ba2021-09-30 09:19:56 -07006941 if (buffer_size < max_buffer_copy) {
6942 skip |= LogError(device, msg_code,
6943 "%s: pRegion[%" PRIu32 "] is trying to copy %" PRIu64 " bytes plus %" PRIu64
6944 " offset to/from the VkBuffer (%s) which exceeds the VkBuffer total size of %" PRIu64 " bytes.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006945 func_name, i, buffer_copy_size, region.bufferOffset,
sfricke-samsung11d15ba2021-09-30 09:19:56 -07006946 report_data->FormatHandle(buff_state->buffer()).c_str(), buffer_size);
6947 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006948 }
6949 }
6950
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006951 return skip;
6952}
6953
sfricke-samsung71f04e32022-03-16 01:21:21 -05006954template <typename RegionType>
Jeff Leger178b1e52020-10-05 12:22:23 -04006955bool CoreChecks::ValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
sfricke-samsung71f04e32022-03-16 01:21:21 -05006956 VkBuffer dstBuffer, uint32_t regionCount, const RegionType *pRegions,
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006957
6958 CMD_TYPE cmd_type) const {
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07006959 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07006960 auto src_image_state = Get<IMAGE_STATE>(srcImage);
6961 auto dst_buffer_state = Get<BUFFER_STATE>(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006962
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006963 const bool is_2 = (cmd_type == CMD_COPYIMAGETOBUFFER2KHR || cmd_type == CMD_COPYIMAGETOBUFFER2);
sfricke-samsung85584a72021-09-30 21:43:38 -07006964 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04006965 const char *vuid;
6966
Tony Barbour845d29b2021-11-09 11:43:14 -07006967 bool skip = ValidateBufferImageCopyData(cb_node.get(), regionCount, pRegions, src_image_state.get(), func_name, cmd_type, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006968
6969 // Validate command buffer state
Jeremy Gebben9f537102021-10-05 16:37:12 -06006970 skip |= ValidateCmd(cb_node.get(), cmd_type);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006971
6972 // Command pool must support graphics, compute, or transfer operations
Jeremy Gebbencd7fa282021-10-27 10:25:32 -06006973 const auto pool = cb_node->command_pool;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006974
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006975 VkQueueFlags queue_flags = physical_device_state->queue_family_properties[pool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07006976
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006977 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006978 vuid = is_2 ? "VUID-vkCmdCopyImageToBuffer2-commandBuffer-cmdpool" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool";
Jeff Leger178b1e52020-10-05 12:22:23 -04006979 skip |= LogError(cb_node->createInfo.commandPool, vuid,
6980 "Cannot call %s on a command buffer allocated from a pool without graphics, compute, "
6981 "or transfer capabilities.",
6982 func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006983 }
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006984
6985 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-pRegions-00182" : "VUID-vkCmdCopyImageToBuffer-pRegions-06220";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006986 skip |= ValidateImageBounds(src_image_state.get(), regionCount, pRegions, func_name, vuid);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006987 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-pRegions-00183" : "VUID-vkCmdCopyImageToBuffer-pRegions-00183";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006988 skip |= ValidateBufferBounds(src_image_state.get(), dst_buffer_state.get(), regionCount, pRegions, func_name, vuid);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006989
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006990 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImage-00188" : "VUID-vkCmdCopyImageToBuffer-srcImage-00188";
6991 std::string location = func_name;
6992 location.append("() : srcImage");
6993 skip |= ValidateImageSampleCount(src_image_state.get(), VK_SAMPLE_COUNT_1_BIT, location.c_str(), vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04006994
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006995 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImage-00187" : "VUID-vkCmdCopyImageToBuffer-srcImage-00187";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006996 skip |= ValidateMemoryIsBoundToImage(src_image_state.get(), func_name, vuid);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006997 vuid = is_2 ? "vkCmdCopyImageToBuffer-dstBuffer2-00192" : "vkCmdCopyImageToBuffer dstBuffer-00192";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006998 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state.get(), func_name, vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006999
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07007000 // Validate that SRC image & DST buffer have correct usage flags set
Tony-LunarGaf3632a2021-11-10 15:51:57 -07007001 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImage-00186" : "VUID-vkCmdCopyImageToBuffer-srcImage-00186";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007002 skip |= ValidateImageUsageFlags(src_image_state.get(), VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06007003 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tony-LunarGaf3632a2021-11-10 15:51:57 -07007004 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-dstBuffer-00191" : "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007005 skip |= ValidateBufferUsageFlags(dst_buffer_state.get(), VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06007006 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Tony-LunarGaf3632a2021-11-10 15:51:57 -07007007 vuid = is_2 ? "VUID-vkCmdCopyImageToBuffer2-commandBuffer-01831" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01831";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007008 skip |= ValidateProtectedImage(cb_node.get(), src_image_state.get(), func_name, vuid);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07007009 vuid = is_2 ? "VUID-vkCmdCopyImageToBuffer2-commandBuffer-01832" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01832";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007010 skip |= ValidateProtectedBuffer(cb_node.get(), dst_buffer_state.get(), func_name, vuid);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07007011 vuid = is_2 ? "VUID-vkCmdCopyImageToBuffer2-commandBuffer-01833" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01833";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007012 skip |= ValidateUnprotectedBuffer(cb_node.get(), dst_buffer_state.get(), func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02007013
7014 // Validation for VK_EXT_fragment_density_map
7015 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony-LunarGaf3632a2021-11-10 15:51:57 -07007016 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImage-02544" : "VUID-vkCmdCopyImageToBuffer-srcImage-02544";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06007017 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04007018 "%s: srcImage must not have been created with flags containing "
7019 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
7020 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02007021 }
7022
sfricke-samsung45996a42021-09-16 13:45:27 -07007023 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Tony-LunarGaf3632a2021-11-10 15:51:57 -07007024 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImage-01998" : "VUID-vkCmdCopyImageToBuffer-srcImage-01998";
7025 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(), VK_FORMAT_FEATURE_2_TRANSFER_SRC_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04007026 }
Tobin Ehlisc8266452017-04-07 12:20:30 -06007027 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04007028
sfricke-samsung45996a42021-09-16 13:45:27 -07007029 const char *src_invalid_layout_vuid =
7030 (src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Tony-LunarGaf3632a2021-11-10 15:51:57 -07007031 ? (vuid =
7032 is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImageLayout-01397" : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397")
7033 : (vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImageLayout-00190"
7034 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190");
Jeff Leger178b1e52020-10-05 12:22:23 -04007035
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07007036 for (uint32_t i = 0; i < regionCount; ++i) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05007037 const RegionType region = pRegions[i];
7038 skip |= ValidateImageSubresourceLayers(cb_node.get(), &region.imageSubresource, func_name, "imageSubresource", i);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07007039 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImageLayout-00189" : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189";
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06007040 skip |= VerifyImageLayout(*cb_node, *src_image_state, region.imageSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04007041 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, src_invalid_layout_vuid, vuid, &hit_error);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07007042 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-imageOffset-01794" : "VUID-vkCmdCopyImageToBuffer-imageOffset-01794";
sfricke-samsung71f04e32022-03-16 01:21:21 -05007043 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node.get(), src_image_state.get(), &region, i, func_name,
7044 vuid);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07007045 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-imageSubresource-01703" : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703";
sfricke-samsung71f04e32022-03-16 01:21:21 -05007046 skip |= ValidateImageMipLevel(cb_node.get(), src_image_state.get(), region.imageSubresource.mipLevel, i, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04007047 "imageSubresource", vuid);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07007048 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-imageSubresource-01704" : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704";
sfricke-samsung71f04e32022-03-16 01:21:21 -05007049 skip |= ValidateImageArrayLayerRange(cb_node.get(), src_image_state.get(), region.imageSubresource.baseArrayLayer,
7050 region.imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07007051 }
7052 return skip;
7053}
7054
Jeff Leger178b1e52020-10-05 12:22:23 -04007055bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
7056 VkBuffer dstBuffer, uint32_t regionCount,
7057 const VkBufferImageCopy *pRegions) const {
7058 return ValidateCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions,
Tony-LunarGaf3632a2021-11-10 15:51:57 -07007059 CMD_COPYIMAGETOBUFFER);
Jeff Leger178b1e52020-10-05 12:22:23 -04007060}
7061
7062bool CoreChecks::PreCallValidateCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
7063 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) const {
7064 return ValidateCmdCopyImageToBuffer(commandBuffer, pCopyImageToBufferInfo->srcImage, pCopyImageToBufferInfo->srcImageLayout,
7065 pCopyImageToBufferInfo->dstBuffer, pCopyImageToBufferInfo->regionCount,
Tony-LunarGaf3632a2021-11-10 15:51:57 -07007066 pCopyImageToBufferInfo->pRegions, CMD_COPYIMAGETOBUFFER2KHR);
Jeff Leger178b1e52020-10-05 12:22:23 -04007067}
7068
Tony Barbour845d29b2021-11-09 11:43:14 -07007069bool CoreChecks::PreCallValidateCmdCopyImageToBuffer2(VkCommandBuffer commandBuffer,
7070 const VkCopyImageToBufferInfo2 *pCopyImageToBufferInfo) const {
7071 return ValidateCmdCopyImageToBuffer(commandBuffer, pCopyImageToBufferInfo->srcImage, pCopyImageToBufferInfo->srcImageLayout,
7072 pCopyImageToBufferInfo->dstBuffer, pCopyImageToBufferInfo->regionCount,
Tony-LunarGaf3632a2021-11-10 15:51:57 -07007073 pCopyImageToBufferInfo->pRegions, CMD_COPYIMAGETOBUFFER2);
Tony Barbour845d29b2021-11-09 11:43:14 -07007074}
7075
John Zulauf1686f232019-07-09 16:27:11 -06007076void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
7077 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
7078 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
7079
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07007080 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06007081 auto src_image_state = Get<IMAGE_STATE>(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06007082 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07007083 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06007084 cb_node->SetImageInitialLayout(*src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06007085 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07007086}
7087
Jeff Leger178b1e52020-10-05 12:22:23 -04007088void CoreChecks::PreCallRecordCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
7089 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) {
7090 StateTracker::PreCallRecordCmdCopyImageToBuffer2KHR(commandBuffer, pCopyImageToBufferInfo);
7091
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07007092 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06007093 auto src_image_state = Get<IMAGE_STATE>(pCopyImageToBufferInfo->srcImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04007094 // Make sure that all image slices record referenced layout
7095 for (uint32_t i = 0; i < pCopyImageToBufferInfo->regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06007096 cb_node->SetImageInitialLayout(*src_image_state, pCopyImageToBufferInfo->pRegions[i].imageSubresource,
7097 pCopyImageToBufferInfo->srcImageLayout);
Jeff Leger178b1e52020-10-05 12:22:23 -04007098 }
7099}
7100
Tony-LunarGaf3632a2021-11-10 15:51:57 -07007101void CoreChecks::PreCallRecordCmdCopyImageToBuffer2(VkCommandBuffer commandBuffer,
7102 const VkCopyImageToBufferInfo2 *pCopyImageToBufferInfo) {
7103 StateTracker::PreCallRecordCmdCopyImageToBuffer2(commandBuffer, pCopyImageToBufferInfo);
7104
7105 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
7106 auto src_image_state = Get<IMAGE_STATE>(pCopyImageToBufferInfo->srcImage);
7107 // Make sure that all image slices record referenced layout
7108 for (uint32_t i = 0; i < pCopyImageToBufferInfo->regionCount; ++i) {
7109 cb_node->SetImageInitialLayout(*src_image_state, pCopyImageToBufferInfo->pRegions[i].imageSubresource,
7110 pCopyImageToBufferInfo->srcImageLayout);
7111 }
7112}
7113
Jeff Leger178b1e52020-10-05 12:22:23 -04007114template <typename RegionType>
7115bool CoreChecks::ValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
7116 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
Tony Barbour845d29b2021-11-09 11:43:14 -07007117 CMD_TYPE cmd_type) const {
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07007118 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07007119 auto src_buffer_state = Get<BUFFER_STATE>(srcBuffer);
7120 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07007121
Tony Barbour845d29b2021-11-09 11:43:14 -07007122 const bool is_2 = (cmd_type == CMD_COPYBUFFERTOIMAGE2KHR || cmd_type == CMD_COPYBUFFERTOIMAGE2);
sfricke-samsung85584a72021-09-30 21:43:38 -07007123 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04007124 const char *vuid;
7125
Tony Barbour845d29b2021-11-09 11:43:14 -07007126 bool skip =
7127 ValidateBufferImageCopyData(cb_node.get(), regionCount, pRegions, dst_image_state.get(), func_name, cmd_type, false);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07007128
7129 // Validate command buffer state
Jeremy Gebben9f537102021-10-05 16:37:12 -06007130 skip |= ValidateCmd(cb_node.get(), cmd_type);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07007131
Tony Barbour845d29b2021-11-09 11:43:14 -07007132 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-pRegions-00172" : "VUID-vkCmdCopyBufferToImage-pRegions-06217";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007133 skip |= ValidateImageBounds(dst_image_state.get(), regionCount, pRegions, func_name, vuid);
Tony Barbour845d29b2021-11-09 11:43:14 -07007134 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-pRegions-00171" : "VUID-vkCmdCopyBufferToImage-pRegions-00171";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007135 skip |= ValidateBufferBounds(dst_image_state.get(), src_buffer_state.get(), regionCount, pRegions, func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04007136
Tony Barbour845d29b2021-11-09 11:43:14 -07007137 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImage-00179" : "VUID-vkCmdCopyBufferToImage-dstImage-00179";
7138 std::string location = func_name;
7139 location.append("() : dstImage");
7140 skip |= ValidateImageSampleCount(dst_image_state.get(), VK_SAMPLE_COUNT_1_BIT, location.c_str(), vuid);
7141 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-srcBuffer-00176" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00176";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007142 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state.get(), func_name, vuid);
Tony Barbour845d29b2021-11-09 11:43:14 -07007143 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImage-00178" : "VUID-vkCmdCopyBufferToImage-dstImage-00178";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007144 skip |= ValidateMemoryIsBoundToImage(dst_image_state.get(), func_name, vuid);
Tony Barbour845d29b2021-11-09 11:43:14 -07007145 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-srcBuffer-00174" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00174";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007146 skip |= ValidateBufferUsageFlags(src_buffer_state.get(), VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06007147 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Tony Barbour845d29b2021-11-09 11:43:14 -07007148 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImage-00177" : "VUID-vkCmdCopyBufferToImage-dstImage-00177";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007149 skip |= ValidateImageUsageFlags(dst_image_state.get(), VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06007150 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Tony Barbour845d29b2021-11-09 11:43:14 -07007151 vuid = is_2 ? "VUID-vkCmdCopyBufferToImage2-commandBuffer-01828" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01828";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007152 skip |= ValidateProtectedBuffer(cb_node.get(), src_buffer_state.get(), func_name, vuid);
Tony Barbour845d29b2021-11-09 11:43:14 -07007153 vuid = is_2 ? "VUID-vkCmdCopyBufferToImage2-commandBuffer-01829" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01829";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007154 skip |= ValidateProtectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
Tony Barbour845d29b2021-11-09 11:43:14 -07007155 vuid = is_2 ? "VUID-vkCmdCopyBufferToImage-commandBuffer-01830" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01830";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007156 skip |= ValidateUnprotectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02007157
7158 // Validation for VK_EXT_fragment_density_map
7159 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony Barbour845d29b2021-11-09 11:43:14 -07007160 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImage-02543" : "VUID-vkCmdCopyBufferToImage-dstImage-02543";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06007161 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04007162 "%s: dstImage must not have been created with flags containing "
7163 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
7164 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02007165 }
7166
sfricke-samsung45996a42021-09-16 13:45:27 -07007167 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07007168 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImage-01997" : "VUID-vkCmdCopyBufferToImage-dstImage-01997";
7169 skip |= ValidateImageFormatFeatureFlags(dst_image_state.get(), VK_FORMAT_FEATURE_2_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04007170 }
Tobin Ehlisc8266452017-04-07 12:20:30 -06007171 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04007172
sfricke-samsung45996a42021-09-16 13:45:27 -07007173 const char *dst_invalid_layout_vuid =
7174 (dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Tony Barbour845d29b2021-11-09 11:43:14 -07007175 ? (is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImageLayout-01396"
sfricke-samsung45996a42021-09-16 13:45:27 -07007176 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396")
Tony Barbour845d29b2021-11-09 11:43:14 -07007177 : (is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImageLayout-00181"
sfricke-samsung45996a42021-09-16 13:45:27 -07007178 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181");
Jeff Leger178b1e52020-10-05 12:22:23 -04007179
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07007180 for (uint32_t i = 0; i < regionCount; ++i) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05007181 const RegionType region = pRegions[i];
7182 skip |= ValidateImageSubresourceLayers(cb_node.get(), &region.imageSubresource, func_name, "imageSubresource", i);
Tony Barbour845d29b2021-11-09 11:43:14 -07007183 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImageLayout-00180" : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180";
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06007184 skip |= VerifyImageLayout(*cb_node, *dst_image_state, region.imageSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04007185 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, dst_invalid_layout_vuid, vuid, &hit_error);
Tony Barbour845d29b2021-11-09 11:43:14 -07007186 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-imageOffset-01793" : "VUID-vkCmdCopyBufferToImage-imageOffset-01793";
sfricke-samsung71f04e32022-03-16 01:21:21 -05007187 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node.get(), dst_image_state.get(), &region, i, func_name,
7188 vuid);
Tony Barbour845d29b2021-11-09 11:43:14 -07007189 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-imageSubresource-01701" : "VUID-vkCmdCopyBufferToImage-imageSubresource-01701";
sfricke-samsung71f04e32022-03-16 01:21:21 -05007190 skip |= ValidateImageMipLevel(cb_node.get(), dst_image_state.get(), region.imageSubresource.mipLevel, i, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04007191 "imageSubresource", vuid);
Tony Barbour845d29b2021-11-09 11:43:14 -07007192 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-imageSubresource-01702" : "VUID-vkCmdCopyBufferToImage-imageSubresource-01702";
sfricke-samsung71f04e32022-03-16 01:21:21 -05007193 skip |= ValidateImageArrayLayerRange(cb_node.get(), dst_image_state.get(), region.imageSubresource.baseArrayLayer,
7194 region.imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
sfricke-samsungea4fd142020-10-17 23:51:59 -07007195
7196 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
Jeremy Gebbencd7fa282021-10-27 10:25:32 -06007197 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool;
sfricke-samsungea4fd142020-10-17 23:51:59 -07007198 assert(command_pool != nullptr);
7199 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06007200 const VkQueueFlags queue_flags = physical_device_state->queue_family_properties[queue_family_index].queueFlags;
sfricke-samsung71f04e32022-03-16 01:21:21 -05007201 const VkImageAspectFlags region_aspect_mask = region.imageSubresource.aspectMask;
sfricke-samsungea4fd142020-10-17 23:51:59 -07007202 if (((queue_flags & VK_QUEUE_GRAPHICS_BIT) == 0) &&
7203 ((region_aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06007204 LogObjectList objlist(cb_node->commandBuffer());
7205 objlist.add(command_pool->commandPool());
sfricke-samsung4389faa2022-03-23 01:19:42 -05007206 objlist.add(dst_image_state->image());
Tony Barbour845d29b2021-11-09 11:43:14 -07007207 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-commandBuffer-04477"
sfricke-samsungea4fd142020-10-17 23:51:59 -07007208 : "VUID-vkCmdCopyBufferToImage-commandBuffer-04477";
sfricke-samsung4389faa2022-03-23 01:19:42 -05007209 skip |= LogError(objlist, vuid,
sfricke-samsungea4fd142020-10-17 23:51:59 -07007210 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies VK_IMAGE_ASPECT_DEPTH_BIT or "
7211 "VK_IMAGE_ASPECT_STENCIL_BIT but the command buffer %s was allocated from the command pool %s "
7212 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT flag.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06007213 func_name, i, region_aspect_mask, report_data->FormatHandle(cb_node->commandBuffer()).c_str(),
7214 report_data->FormatHandle(command_pool->commandPool()).c_str(), queue_family_index);
sfricke-samsungea4fd142020-10-17 23:51:59 -07007215 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07007216 }
7217 return skip;
7218}
7219
Jeff Leger178b1e52020-10-05 12:22:23 -04007220bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
7221 VkImageLayout dstImageLayout, uint32_t regionCount,
7222 const VkBufferImageCopy *pRegions) const {
7223 return ValidateCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions,
Tony Barbour845d29b2021-11-09 11:43:14 -07007224 CMD_COPYBUFFERTOIMAGE);
Jeff Leger178b1e52020-10-05 12:22:23 -04007225}
7226
7227bool CoreChecks::PreCallValidateCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
7228 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo) const {
7229 return ValidateCmdCopyBufferToImage(commandBuffer, pCopyBufferToImageInfo->srcBuffer, pCopyBufferToImageInfo->dstImage,
7230 pCopyBufferToImageInfo->dstImageLayout, pCopyBufferToImageInfo->regionCount,
Tony Barbour845d29b2021-11-09 11:43:14 -07007231 pCopyBufferToImageInfo->pRegions, CMD_COPYBUFFERTOIMAGE2KHR);
7232}
7233
7234bool CoreChecks::PreCallValidateCmdCopyBufferToImage2(VkCommandBuffer commandBuffer,
7235 const VkCopyBufferToImageInfo2 *pCopyBufferToImageInfo) const {
7236 return ValidateCmdCopyBufferToImage(commandBuffer, pCopyBufferToImageInfo->srcBuffer, pCopyBufferToImageInfo->dstImage,
7237 pCopyBufferToImageInfo->dstImageLayout, pCopyBufferToImageInfo->regionCount,
7238 pCopyBufferToImageInfo->pRegions, CMD_COPYBUFFERTOIMAGE2);
Jeff Leger178b1e52020-10-05 12:22:23 -04007239}
7240
John Zulauf1686f232019-07-09 16:27:11 -06007241void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
7242 VkImageLayout dstImageLayout, uint32_t regionCount,
7243 const VkBufferImageCopy *pRegions) {
7244 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
7245
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07007246 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06007247 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06007248 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07007249 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06007250 cb_node->SetImageInitialLayout(*dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06007251 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07007252}
Mike Weiblen672b58b2017-02-21 14:32:53 -07007253
Jeff Leger178b1e52020-10-05 12:22:23 -04007254void CoreChecks::PreCallRecordCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
7255 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo2KHR) {
7256 StateTracker::PreCallRecordCmdCopyBufferToImage2KHR(commandBuffer, pCopyBufferToImageInfo2KHR);
7257
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07007258 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06007259 auto dst_image_state = Get<IMAGE_STATE>(pCopyBufferToImageInfo2KHR->dstImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04007260 // Make sure that all image slices are record referenced layout
7261 for (uint32_t i = 0; i < pCopyBufferToImageInfo2KHR->regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06007262 cb_node->SetImageInitialLayout(*dst_image_state, pCopyBufferToImageInfo2KHR->pRegions[i].imageSubresource,
7263 pCopyBufferToImageInfo2KHR->dstImageLayout);
Jeff Leger178b1e52020-10-05 12:22:23 -04007264 }
7265}
Tony Barbour845d29b2021-11-09 11:43:14 -07007266
7267void CoreChecks::PreCallRecordCmdCopyBufferToImage2(VkCommandBuffer commandBuffer,
7268 const VkCopyBufferToImageInfo2 *pCopyBufferToImageInfo) {
7269 StateTracker::PreCallRecordCmdCopyBufferToImage2(commandBuffer, pCopyBufferToImageInfo);
7270
7271 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
7272 auto dst_image_state = Get<IMAGE_STATE>(pCopyBufferToImageInfo->dstImage);
7273 // Make sure that all image slices are record referenced layout
7274 for (uint32_t i = 0; i < pCopyBufferToImageInfo->regionCount; ++i) {
7275 cb_node->SetImageInitialLayout(*dst_image_state, pCopyBufferToImageInfo->pRegions[i].imageSubresource,
7276 pCopyBufferToImageInfo->dstImageLayout);
7277 }
7278}
7279
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07007280bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05007281 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07007282 bool skip = false;
7283 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
7284
Dave Houlton1d960ff2018-01-19 12:17:05 -07007285 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07007286 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
7287 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
7288 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07007289 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
7290 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07007291 }
7292
Jeremy Gebbenf4449392022-01-28 10:09:10 -07007293 auto image_entry = Get<IMAGE_STATE>(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07007294 if (!image_entry) {
7295 return skip;
7296 }
7297
Mark Lobodzinski6f358172019-10-02 11:09:12 -06007298 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
sfricke-samsung45996a42021-09-16 13:45:27 -07007299 if (IsExtEnabled(device_extensions.vk_ext_image_drm_format_modifier)) {
Mark Lobodzinski6f358172019-10-02 11:09:12 -06007300 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
7301 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07007302 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
7303 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
7304 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06007305 }
7306 } else {
7307 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07007308 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
7309 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06007310 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07007311 }
7312
Dave Houlton1d960ff2018-01-19 12:17:05 -07007313 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07007314 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07007315 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
7316 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
7317 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07007318 }
7319
Dave Houlton1d960ff2018-01-19 12:17:05 -07007320 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07007321 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07007322 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
7323 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
7324 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07007325 }
7326
Dave Houlton1d960ff2018-01-19 12:17:05 -07007327 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07007328 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06007329 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
7330 if (FormatIsMultiplane(img_format)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08007331 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06007332 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
7333 if (FormatPlaneCount(img_format) > 2u) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08007334 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06007335 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
7336 }
7337 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07007338 skip |= LogError(image, vuid,
7339 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
7340 ") must be a single-plane specifier flag.",
7341 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06007342 }
7343 } else if (FormatIsColor(img_format)) {
7344 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
ziga-lunargcc568bc2021-09-05 13:45:45 +02007345 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04461",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07007346 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
7347 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06007348 }
7349 } else if (FormatIsDepthOrStencil(img_format)) {
Nathaniel Cesario8c80f352021-07-15 15:06:48 -06007350 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06007351 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07007352 }
ziga-lunarg4ecbd5b2021-07-15 20:48:30 +02007353 if (!FormatIsDepthAndStencil(img_format) && !FormatIsDepthOnly(img_format)) {
7354 if (sub_aspect & VK_IMAGE_ASPECT_DEPTH_BIT) {
7355 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04464",
7356 "vkGetImageSubresourceLayout(): Image format (%s) does not contain a depth component, "
7357 "but VkImageSubresource.aspectMask contains VK_IMAGE_ASPECT_DEPTH_BIT.",
7358 string_VkFormat(img_format));
7359 }
7360 } else {
7361 if ((sub_aspect & VK_IMAGE_ASPECT_DEPTH_BIT) == 0) {
7362 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04462",
7363 "vkGetImageSubresourceLayout(): Image format (%s) contains a depth component, "
7364 "but VkImageSubresource.aspectMask does not contain VK_IMAGE_ASPECT_DEPTH_BIT.",
7365 string_VkFormat(img_format));
7366 }
7367 }
7368 if (!FormatIsDepthAndStencil(img_format) && !FormatIsStencilOnly(img_format)) {
7369 if (sub_aspect & VK_IMAGE_ASPECT_STENCIL_BIT) {
7370 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04464",
7371 "vkGetImageSubresourceLayout(): Image format (%s) does not contain a stencil component, "
7372 "but VkImageSubresource.aspectMask contains VK_IMAGE_ASPECT_STENCIL_BIT.",
7373 string_VkFormat(img_format));
7374 }
7375 } else {
7376 if ((sub_aspect & VK_IMAGE_ASPECT_STENCIL_BIT) == 0) {
7377 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04463",
7378 "vkGetImageSubresourceLayout(): Image format (%s) contains a stencil component, "
7379 "but VkImageSubresource.aspectMask does not contain VK_IMAGE_ASPECT_STENCIL_BIT.",
7380 string_VkFormat(img_format));
7381 }
7382 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06007383 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
7384 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
7385 (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 +02007386 skip |= LogError(
7387 image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
7388 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask (%s) must be VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.",
7389 string_VkImageAspectFlags(sub_aspect).c_str());
7390 } else {
7391 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
7392 assert(IsExtEnabled(device_extensions.vk_ext_image_drm_format_modifier));
7393 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = LvlInitStruct<VkImageDrmFormatModifierPropertiesEXT>();
7394 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image, &drm_format_properties);
7395
7396 auto fmt_drm_props = LvlInitStruct<VkDrmFormatModifierPropertiesListEXT>();
7397 auto fmt_props_2 = LvlInitStruct<VkFormatProperties2>(&fmt_drm_props);
7398 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_entry->createInfo.format, &fmt_props_2);
7399 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties{fmt_drm_props.drmFormatModifierCount};
7400 fmt_drm_props.pDrmFormatModifierProperties = drm_properties.data();
7401 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_entry->createInfo.format, &fmt_props_2);
7402
7403 uint32_t max_plane_count = 0u;
7404
7405 for (auto const &drm_property : drm_properties) {
7406 if (drm_format_properties.drmFormatModifier == drm_property.drmFormatModifier) {
7407 max_plane_count = drm_property.drmFormatModifierPlaneCount;
7408 break;
7409 }
7410 }
7411
7412 VkImageAspectFlagBits allowed_plane_indices[] = {
7413 VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT, VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT,
7414 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT, VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT};
7415
7416 bool is_valid = false;
7417
7418 for (uint32_t i = 0u; i < max_plane_count; ++i) {
7419 if (sub_aspect == allowed_plane_indices[i]) {
7420 is_valid = true;
7421 break;
7422 }
7423 }
7424
7425 if (!is_valid) {
7426 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
7427 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask (%s) must be "
7428 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT, with i being less than the "
7429 "VkDrmFormatModifierPropertiesEXT::drmFormatModifierPlaneCount (%" PRIu32
7430 ") associated with the image's format (%s) and "
7431 "VkImageDrmFormatModifierPropertiesEXT::drmFormatModifier (%" PRIu64 ").",
7432 string_VkImageAspectFlags(sub_aspect).c_str(), max_plane_count,
7433 string_VkFormat(image_entry->createInfo.format), drm_format_properties.drmFormatModifier);
7434 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07007435 }
7436 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06007437
sfricke-samsung45996a42021-09-16 13:45:27 -07007438 if (IsExtEnabled(device_extensions.vk_android_external_memory_android_hardware_buffer)) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07007439 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06007440 }
7441
Mike Weiblen672b58b2017-02-21 14:32:53 -07007442 return skip;
7443}
sfricke-samsung022fa252020-07-24 03:26:16 -07007444
7445// Validates the image is allowed to be protected
7446bool CoreChecks::ValidateProtectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06007447 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07007448 bool skip = false;
sfricke-samsung21286f82021-11-16 08:21:46 -08007449
7450 // if driver supports protectedNoFault the operation is valid, just has undefined values
7451 if ((!phys_dev_props_core11.protectedNoFault) && (cb_state->unprotected == true) && (image_state->unprotected == false)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06007452 LogObjectList objlist(cb_state->commandBuffer());
7453 objlist.add(image_state->image());
locke-lunarg351c9d82020-10-23 14:43:21 -06007454 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 -06007455 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
7456 report_data->FormatHandle(image_state->image()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07007457 }
7458 return skip;
7459}
7460
7461// Validates the image is allowed to be unprotected
7462bool CoreChecks::ValidateUnprotectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06007463 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07007464 bool skip = false;
sfricke-samsung21286f82021-11-16 08:21:46 -08007465
7466 // if driver supports protectedNoFault the operation is valid, just has undefined values
7467 if ((!phys_dev_props_core11.protectedNoFault) && (cb_state->unprotected == false) && (image_state->unprotected == true)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06007468 LogObjectList objlist(cb_state->commandBuffer());
7469 objlist.add(image_state->image());
locke-lunarg351c9d82020-10-23 14:43:21 -06007470 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 -06007471 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
7472 report_data->FormatHandle(image_state->image()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07007473 }
7474 return skip;
7475}
7476
7477// Validates the buffer is allowed to be protected
7478bool CoreChecks::ValidateProtectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06007479 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07007480 bool skip = false;
sfricke-samsung21286f82021-11-16 08:21:46 -08007481
7482 // if driver supports protectedNoFault the operation is valid, just has undefined values
7483 if ((!phys_dev_props_core11.protectedNoFault) && (cb_state->unprotected == true) && (buffer_state->unprotected == false)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06007484 LogObjectList objlist(cb_state->commandBuffer());
7485 objlist.add(buffer_state->buffer());
locke-lunarg351c9d82020-10-23 14:43:21 -06007486 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 -06007487 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
7488 report_data->FormatHandle(buffer_state->buffer()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07007489 }
7490 return skip;
7491}
7492
7493// Validates the buffer is allowed to be unprotected
7494bool CoreChecks::ValidateUnprotectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06007495 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07007496 bool skip = false;
sfricke-samsung21286f82021-11-16 08:21:46 -08007497
7498 // if driver supports protectedNoFault the operation is valid, just has undefined values
7499 if ((!phys_dev_props_core11.protectedNoFault) && (cb_state->unprotected == false) && (buffer_state->unprotected == true)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06007500 LogObjectList objlist(cb_state->commandBuffer());
7501 objlist.add(buffer_state->buffer());
locke-lunarg351c9d82020-10-23 14:43:21 -06007502 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 -06007503 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
7504 report_data->FormatHandle(buffer_state->buffer()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07007505 }
7506 return skip;
7507}