blob: 8f9cb4ed1b725f71cf46602298a101efc585b415 [file] [log] [blame]
Jeremy Gebben65975ed2021-10-29 11:16:10 -06001/* Copyright (c) 2015-2022 The Khronos Group Inc.
2 * Copyright (c) 2015-2022 Valve Corporation
3 * Copyright (c) 2015-2022 LunarG, Inc.
4 * Copyright (C) 2015-2022 Google Inc.
Aaron Hagan1656b2b2021-12-21 11:52:41 -05005 * Modifications Copyright (C) 2020-2022 Advanced Micro Devices, Inc. All rights reserved.
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -07006 *
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 *
19 * Author: Mark Lobodzinski <mark@lunarg.com>
Dave Houlton4eaaf3a2017-03-14 11:31:20 -060020 * Author: Dave Houlton <daveh@lunarg.com>
Shannon McPherson3ea65132018-12-05 10:37:39 -070021 * Shannon McPherson <shannon@lunarg.com>
Tobias Hector6663c9b2020-11-05 10:18:02 +000022 * Author: Tobias Hector <tobias.hector@amd.com>
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070023 */
24
Dave Houlton0d4ad6f2018-09-05 14:53:34 -060025#include <cmath>
26#include <set>
Mark Lobodzinski90224de2017-01-26 15:23:11 -070027#include <sstream>
Petr Kraus4d718682017-05-18 03:38:41 +020028#include <string>
Jeremy Gebben579aaca2021-02-15 13:36:18 -070029#include <iostream>
Mark Lobodzinski90224de2017-01-26 15:23:11 -070030
31#include "vk_enum_string_helper.h"
Petr Kraus5a01b472019-08-10 01:40:28 +020032#include "vk_format_utils.h"
Mark Lobodzinski90224de2017-01-26 15:23:11 -070033#include "vk_layer_data.h"
34#include "vk_layer_utils.h"
35#include "vk_layer_logging.h"
Dave Houltonbd2e2622018-04-10 16:41:14 -060036#include "vk_typemap_helper.h"
Mark Lobodzinski90224de2017-01-26 15:23:11 -070037
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -070038#include "chassis.h"
Mark Lobodzinski76d76662019-02-14 14:38:21 -070039#include "core_validation.h"
Jeremy Gebbene60d4172021-02-02 15:42:15 -070040#include "core_error_location.h"
Mark Lobodzinski76d76662019-02-14 14:38:21 -070041#include "shader_validation.h"
42#include "descriptor_sets.h"
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070043#include "buffer_validation.h"
Jeremy Gebben7ba56152021-06-18 10:40:10 -060044#include "sync_utils.h"
Jeremy Gebbene60d4172021-02-02 15:42:15 -070045#include "sync_vuid_maps.h"
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -070046
Jeremy Gebbencb13f0f2022-07-15 15:48:05 -060047using LayoutRange = image_layout_map::ImageSubresourceLayoutMap::RangeType;
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -060048using LayoutEntry = image_layout_map::ImageSubresourceLayoutMap::LayoutEntry;
49
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070050// All VUID from copy_bufferimage_to_imagebuffer_common.txt
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070051static const char *GetBufferImageCopyCommandVUID(std::string id, bool image_to_buffer, bool copy2) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070052 // clang-format off
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070053 static const std::map<std::string, std::array<const char *, 4>> copy_imagebuffer_vuid = {
54 {"00193", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070055 "VUID-vkCmdCopyBufferToImage-bufferOffset-00193", // !copy2 & !image_to_buffer
56 "VUID-vkCmdCopyImageToBuffer-bufferOffset-00193", // !copy2 & image_to_buffer
Tony Barbour845d29b2021-11-09 11:43:14 -070057 "VUID-VkCopyBufferToImageInfo2-bufferOffset-00193", // copy2 & !image_to_buffer
Tony-LunarGaf3632a2021-11-10 15:51:57 -070058 "VUID-VkCopyImageToBufferInfo2-bufferOffset-00193", // copy2 & image_to_buffer
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070059 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070060 {"01558", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070061 "VUID-vkCmdCopyBufferToImage-bufferOffset-01558",
62 "VUID-vkCmdCopyImageToBuffer-bufferOffset-01558",
Tony Barbour845d29b2021-11-09 11:43:14 -070063 "VUID-VkCopyBufferToImageInfo2-bufferOffset-01558",
Tony-LunarGaf3632a2021-11-10 15:51:57 -070064 "VUID-VkCopyImageToBufferInfo2-bufferOffset-01558",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070065 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070066 {"01559", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070067 "VUID-vkCmdCopyBufferToImage-bufferOffset-01559",
68 "VUID-vkCmdCopyImageToBuffer-bufferOffset-01559",
Tony Barbour845d29b2021-11-09 11:43:14 -070069 "VUID-VkCopyBufferToImageInfo2-bufferOffset-01559",
Tony-LunarGaf3632a2021-11-10 15:51:57 -070070 "VUID-VkCopyImageToBufferInfo2-bufferOffset-01559",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070071 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070072 {"00197", {
Mike Schuchardt7b152fa2021-08-03 16:30:27 -070073 "VUID-vkCmdCopyBufferToImage-pRegions-06218",
74 "VUID-vkCmdCopyImageToBuffer-pRegions-06221",
Tony Barbour845d29b2021-11-09 11:43:14 -070075 "VUID-VkCopyBufferToImageInfo2-pRegions-06223",
Tony-LunarGaf3632a2021-11-10 15:51:57 -070076 "VUID-VkCopyImageToBufferInfo2-imageOffset-00197",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070077 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070078 {"00198", {
Mike Schuchardt7b152fa2021-08-03 16:30:27 -070079 "VUID-vkCmdCopyBufferToImage-pRegions-06219",
80 "VUID-vkCmdCopyImageToBuffer-pRegions-06222",
Tony Barbour845d29b2021-11-09 11:43:14 -070081 "VUID-VkCopyBufferToImageInfo2-pRegions-06224",
Tony-LunarGaf3632a2021-11-10 15:51:57 -070082 "VUID-VkCopyImageToBufferInfo2-imageOffset-00198",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070083 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070084 {"00199", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070085 "VUID-vkCmdCopyBufferToImage-srcImage-00199",
86 "VUID-vkCmdCopyImageToBuffer-srcImage-00199",
Tony Barbour845d29b2021-11-09 11:43:14 -070087 "VUID-VkCopyBufferToImageInfo2-srcImage-00199",
Tony-LunarGaf3632a2021-11-10 15:51:57 -070088 "VUID-VkCopyImageToBufferInfo2-srcImage-00199",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070089 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070090 {"00200", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070091 "VUID-vkCmdCopyBufferToImage-imageOffset-00200",
92 "VUID-vkCmdCopyImageToBuffer-imageOffset-00200",
Tony Barbour845d29b2021-11-09 11:43:14 -070093 "VUID-VkCopyBufferToImageInfo2-imageOffset-00200",
Tony-LunarGaf3632a2021-11-10 15:51:57 -070094 "VUID-VkCopyImageToBufferInfo2-imageOffset-00200",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070095 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070096 {"00201", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070097 "VUID-vkCmdCopyBufferToImage-srcImage-00201",
98 "VUID-vkCmdCopyImageToBuffer-srcImage-00201",
Tony Barbour845d29b2021-11-09 11:43:14 -070099 "VUID-VkCopyBufferToImageInfo2-srcImage-00201",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700100 "VUID-VkCopyImageToBufferInfo2-srcImage-00201",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700101 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700102 {"00203", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700103 "VUID-vkCmdCopyBufferToImage-bufferRowLength-00203",
104 "VUID-vkCmdCopyImageToBuffer-bufferRowLength-00203",
Tony Barbour845d29b2021-11-09 11:43:14 -0700105 "VUID-VkCopyBufferToImageInfo2-bufferRowLength-00203",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700106 "VUID-VkCopyImageToBufferInfo2-bufferRowLength-00203",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700107 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700108 {"00204", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700109 "VUID-vkCmdCopyBufferToImage-bufferImageHeight-00204",
110 "VUID-vkCmdCopyImageToBuffer-bufferImageHeight-00204",
Tony Barbour845d29b2021-11-09 11:43:14 -0700111 "VUID-VkCopyBufferToImageInfo2-bufferImageHeight-00204",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700112 "VUID-VkCopyImageToBufferInfo2-bufferImageHeight-00204",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700113 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700114 {"00205", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700115 "VUID-vkCmdCopyBufferToImage-imageOffset-00205",
116 "VUID-vkCmdCopyImageToBuffer-imageOffset-00205",
Tony Barbour845d29b2021-11-09 11:43:14 -0700117 "VUID-VkCopyBufferToImageInfo2-imageOffset-00205",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700118 "VUID-VkCopyImageToBufferInfo2-imageOffset-00205",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700119 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700120 {"00206", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700121 "VUID-vkCmdCopyBufferToImage-bufferOffset-00206",
122 "VUID-vkCmdCopyImageToBuffer-bufferOffset-00206",
Tony Barbour845d29b2021-11-09 11:43:14 -0700123 "VUID-VkCopyBufferToImageInfo2-bufferOffset-00206",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700124 "VUID-VkCopyImageToBufferInfo2-bufferOffset-00206",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700125 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700126 {"00207", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700127 "VUID-vkCmdCopyBufferToImage-imageExtent-00207",
128 "VUID-vkCmdCopyImageToBuffer-imageExtent-00207",
Tony Barbour845d29b2021-11-09 11:43:14 -0700129 "VUID-VkCopyBufferToImageInfo2-imageExtent-00207",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700130 "VUID-VkCopyImageToBufferInfo2-imageExtent-00207",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700131 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700132 {"00208", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700133 "VUID-vkCmdCopyBufferToImage-imageExtent-00208",
134 "VUID-vkCmdCopyImageToBuffer-imageExtent-00208",
Tony Barbour845d29b2021-11-09 11:43:14 -0700135 "VUID-VkCopyBufferToImageInfo2-imageExtent-00208",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700136 "VUID-VkCopyImageToBufferInfo2-imageExtent-00208",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700137 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700138 {"00209", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700139 "VUID-vkCmdCopyBufferToImage-imageExtent-00209",
140 "VUID-vkCmdCopyImageToBuffer-imageExtent-00209",
Tony Barbour845d29b2021-11-09 11:43:14 -0700141 "VUID-VkCopyBufferToImageInfo2-imageExtent-00209",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700142 "VUID-VkCopyImageToBufferInfo2-imageExtent-00209",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700143 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700144 {"00211", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700145 "VUID-vkCmdCopyBufferToImage-aspectMask-00211",
146 "VUID-vkCmdCopyImageToBuffer-aspectMask-00211",
Tony Barbour845d29b2021-11-09 11:43:14 -0700147 "VUID-VkCopyBufferToImageInfo2-aspectMask-00211",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700148 "VUID-VkCopyImageToBufferInfo2-aspectMask-00211",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700149 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700150 {"01560", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700151 "VUID-vkCmdCopyBufferToImage-aspectMask-01560",
152 "VUID-vkCmdCopyImageToBuffer-aspectMask-01560",
Tony Barbour845d29b2021-11-09 11:43:14 -0700153 "VUID-VkCopyBufferToImageInfo2-aspectMask-01560",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700154 "VUID-VkCopyImageToBufferInfo2-aspectMask-01560",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700155 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700156 {"00213", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700157 "VUID-vkCmdCopyBufferToImage-baseArrayLayer-00213",
158 "VUID-vkCmdCopyImageToBuffer-baseArrayLayer-00213",
Tony Barbour845d29b2021-11-09 11:43:14 -0700159 "VUID-VkCopyBufferToImageInfo2-baseArrayLayer-00213",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700160 "VUID-VkCopyImageToBufferInfo2-baseArrayLayer-00213",
sfricke-samsung8feecc12021-01-23 03:28:38 -0800161 }},
162 {"04052", {
163 "VUID-vkCmdCopyBufferToImage-commandBuffer-04052",
164 "VUID-vkCmdCopyImageToBuffer-commandBuffer-04052",
Tony Barbour845d29b2021-11-09 11:43:14 -0700165 "VUID-VkCopyBufferToImageInfo2-commandBuffer-04052",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700166 "VUID-VkCopyImageToBufferInfo2-commandBuffer-04052",
sfricke-samsung8feecc12021-01-23 03:28:38 -0800167 }},
168 {"04053", {
169 "VUID-vkCmdCopyBufferToImage-srcImage-04053",
170 "VUID-vkCmdCopyImageToBuffer-srcImage-04053",
Tony Barbour845d29b2021-11-09 11:43:14 -0700171 "VUID-VkCopyBufferToImageInfo2-srcImage-04053",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700172 "VUID-VkCopyImageToBufferInfo2-srcImage-04053",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700173 }}
174 };
175 // clang-format on
176
177 uint8_t index = 0;
Artem Bolgar82d08362021-06-03 13:11:13 -0700178 index |= uint8_t((image_to_buffer) ? 0x1 : 0);
179 index |= uint8_t((copy2) ? 0x2 : 0);
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700180 return copy_imagebuffer_vuid.at(id).at(index);
181}
182
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700183static VkImageLayout NormalizeDepthImageLayout(VkImageLayout layout) {
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200184 switch (layout) {
185 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
186 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
187 return VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL;
188
189 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
190 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
191 return VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL;
192
193 default:
194 return layout;
195 }
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700196}
197
198static VkImageLayout NormalizeStencilImageLayout(VkImageLayout layout) {
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200199 switch (layout) {
200 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
201 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
202 return VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL;
203
204 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
205 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
206 return VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL;
207
208 default:
209 return layout;
210 }
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700211}
212
Jeremy Gebben579aaca2021-02-15 13:36:18 -0700213static VkImageLayout NormalizeSynchronization2Layout(const VkImageAspectFlags aspect_mask, VkImageLayout layout) {
214 if (layout == VK_IMAGE_LAYOUT_ATTACHMENT_OPTIMAL_KHR) {
215 if (aspect_mask == VK_IMAGE_ASPECT_COLOR_BIT) {
216 layout = VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL;
217 } else if (aspect_mask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
218 layout = VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL;
219 } else if (aspect_mask == VK_IMAGE_ASPECT_DEPTH_BIT) {
220 layout = VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL;
221 } else if (aspect_mask == VK_IMAGE_ASPECT_STENCIL_BIT) {
222 layout = VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL;
223 }
224 } else if (layout == VK_IMAGE_LAYOUT_READ_ONLY_OPTIMAL_KHR) {
225 if (aspect_mask == VK_IMAGE_ASPECT_COLOR_BIT) {
226 layout = VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL;
227 } else if (aspect_mask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
228 layout = VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL;
229 } else if (aspect_mask == VK_IMAGE_ASPECT_DEPTH_BIT) {
230 layout = VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL;
231 } else if (aspect_mask == VK_IMAGE_ASPECT_STENCIL_BIT) {
232 layout = VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL;
233 }
234 }
235 return layout;
236}
237
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700238static bool ImageLayoutMatches(const VkImageAspectFlags aspect_mask, VkImageLayout a, VkImageLayout b) {
239 bool matches = (a == b);
240 if (!matches) {
John Zulaufbea70432021-02-23 07:03:12 -0700241 a = NormalizeSynchronization2Layout(aspect_mask, a);
242 b = NormalizeSynchronization2Layout(aspect_mask, b);
243 matches = (a == b);
244 if (!matches) {
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200245 // Relaxed rules when referencing *only* the depth or stencil aspects.
246 // When accessing both, normalize layouts for aspects separately.
247 if (aspect_mask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
248 matches = NormalizeDepthImageLayout(a) == NormalizeDepthImageLayout(b) &&
249 NormalizeStencilImageLayout(a) == NormalizeStencilImageLayout(b);
250 } else if (aspect_mask == VK_IMAGE_ASPECT_DEPTH_BIT) {
John Zulaufbea70432021-02-23 07:03:12 -0700251 matches = NormalizeDepthImageLayout(a) == NormalizeDepthImageLayout(b);
252 } else if (aspect_mask == VK_IMAGE_ASPECT_STENCIL_BIT) {
253 matches = NormalizeStencilImageLayout(a) == NormalizeStencilImageLayout(b);
254 }
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700255 }
256 }
257 return matches;
258}
259
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600260// Utility type for checking Image layouts
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700261struct LayoutUseCheckAndMessage {
262 const static VkImageAspectFlags kDepthOrStencil = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600263 const VkImageLayout expected_layout;
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700264 const VkImageAspectFlags aspect_mask;
265 const char *message;
266 VkImageLayout layout;
267
268 LayoutUseCheckAndMessage() = delete;
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600269 LayoutUseCheckAndMessage(VkImageLayout expected, const VkImageAspectFlags aspect_mask_ = 0)
270 : expected_layout{expected}, aspect_mask{aspect_mask_}, message(nullptr), layout(kInvalidLayout) {}
271 bool Check(const LayoutEntry &layout_entry) {
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700272 message = nullptr;
273 layout = kInvalidLayout; // Success status
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600274 if (layout_entry.current_layout != kInvalidLayout) {
275 if (!ImageLayoutMatches(aspect_mask, expected_layout, layout_entry.current_layout)) {
276 message = "previous known";
277 layout = layout_entry.current_layout;
278 }
279 } else if (layout_entry.initial_layout != kInvalidLayout) {
280 if (!ImageLayoutMatches(aspect_mask, expected_layout, layout_entry.initial_layout)) {
281 assert(layout_entry.state); // If we have an initial layout, we better have a state for it
282 if (!((layout_entry.state->aspect_mask & kDepthOrStencil) &&
283 ImageLayoutMatches(layout_entry.state->aspect_mask, expected_layout, layout_entry.initial_layout))) {
284 message = "previously used";
285 layout = layout_entry.initial_layout;
286 }
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700287 }
288 }
289 return layout == kInvalidLayout;
290 }
291};
292
locke-lunarg540b2252020-08-03 13:23:36 -0600293bool IMAGE_VIEW_STATE::OverlapSubresource(const IMAGE_VIEW_STATE &compare_view) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600294 if (image_view() == compare_view.image_view()) {
locke-lunarg540b2252020-08-03 13:23:36 -0600295 return true;
296 }
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600297 if (image_state->image() != compare_view.image_state->image()) {
locke-lunargdc287022020-08-21 12:03:57 -0600298 return false;
299 }
locke-lunarg540b2252020-08-03 13:23:36 -0600300 if (normalized_subresource_range.aspectMask != compare_view.normalized_subresource_range.aspectMask) {
301 return false;
302 }
303
304 // compare if overlap mip level
locke-lunarg540b2252020-08-03 13:23:36 -0600305 if ((normalized_subresource_range.baseMipLevel < compare_view.normalized_subresource_range.baseMipLevel) &&
locke-lunargdc287022020-08-21 12:03:57 -0600306 ((normalized_subresource_range.baseMipLevel + normalized_subresource_range.levelCount) <=
locke-lunarg540b2252020-08-03 13:23:36 -0600307 compare_view.normalized_subresource_range.baseMipLevel)) {
locke-lunargdc287022020-08-21 12:03:57 -0600308 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600309 }
310
311 if ((normalized_subresource_range.baseMipLevel > compare_view.normalized_subresource_range.baseMipLevel) &&
locke-lunargdc287022020-08-21 12:03:57 -0600312 (normalized_subresource_range.baseMipLevel >=
locke-lunarg540b2252020-08-03 13:23:36 -0600313 (compare_view.normalized_subresource_range.baseMipLevel + compare_view.normalized_subresource_range.levelCount))) {
locke-lunargdc287022020-08-21 12:03:57 -0600314 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600315 }
316
317 // compare if overlap array layer
locke-lunarg540b2252020-08-03 13:23:36 -0600318 if ((normalized_subresource_range.baseArrayLayer < compare_view.normalized_subresource_range.baseArrayLayer) &&
locke-lunargdc287022020-08-21 12:03:57 -0600319 ((normalized_subresource_range.baseArrayLayer + normalized_subresource_range.layerCount) <=
locke-lunarg540b2252020-08-03 13:23:36 -0600320 compare_view.normalized_subresource_range.baseArrayLayer)) {
locke-lunargdc287022020-08-21 12:03:57 -0600321 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600322 }
323
324 if ((normalized_subresource_range.baseArrayLayer > compare_view.normalized_subresource_range.baseArrayLayer) &&
locke-lunargdc287022020-08-21 12:03:57 -0600325 (normalized_subresource_range.baseArrayLayer >=
locke-lunarg540b2252020-08-03 13:23:36 -0600326 (compare_view.normalized_subresource_range.baseArrayLayer + compare_view.normalized_subresource_range.layerCount))) {
locke-lunargdc287022020-08-21 12:03:57 -0600327 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600328 }
locke-lunargdc287022020-08-21 12:03:57 -0600329 return true;
locke-lunarg540b2252020-08-03 13:23:36 -0600330}
331
Dave Houltond9611312018-11-19 17:03:36 -0700332uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
333 // uint cast applies floor()
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700334 return 1u + static_cast<uint32_t>(log2(std::max({height, width, depth})));
Dave Houltond9611312018-11-19 17:03:36 -0700335}
336
337uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
338
339uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
340
John Zulauf2d60a452021-03-04 15:12:03 -0700341bool CoreChecks::FindLayouts(const IMAGE_STATE &image_state, std::vector<VkImageLayout> &layouts) const {
Jeremy Gebben4a8881f2022-01-10 17:04:30 -0700342 const auto *layout_range_map = image_state.layout_range_map.get();
John Zulauf2076e812020-01-08 14:55:54 -0700343 if (!layout_range_map) return false;
Jeremy Gebben4a8881f2022-01-10 17:04:30 -0700344
345 auto guard = layout_range_map->ReadLock();
locke-lunargf155ccf2020-02-18 11:34:15 -0700346 // TODO: FindLayouts function should mutate into a ValidatePresentableLayout with the loop wrapping the LogError
347 // from the caller. You can then use decode to add the subresource of the range::begin to the error message.
348
John Zulauf2076e812020-01-08 14:55:54 -0700349 // TODO: what is this test and what is it supposed to do?! -- the logic doesn't match the comment below?!
350
351 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
John Zulauf2d60a452021-03-04 15:12:03 -0700352 if (layout_range_map->size() >= (image_state.createInfo.arrayLayers * image_state.createInfo.mipLevels + 1)) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700353 return false;
354 }
locke-lunargcba7d5f2019-12-30 16:59:11 -0700355
John Zulauf79f06582021-02-27 18:38:39 -0700356 for (const auto &entry : *layout_range_map) {
John Zulauf2076e812020-01-08 14:55:54 -0700357 layouts.push_back(entry.second);
Tony Barbourdf013b92017-01-25 12:53:48 -0700358 }
359 return true;
360}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700361
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700362bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600363 const IMAGE_VIEW_STATE &image_view_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700364 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600365 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100366 bool skip = false;
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600367 const auto &image_view = image_view_state.Handle();
368 const auto *image_state = image_view_state.image_state.get();
369 const auto &image = image_state->Handle();
Tobias Hectorbbb12282018-10-22 15:17:59 +0100370 const char *vuid;
371 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700372 const char *function_name = use_rp2 ? "vkCmdBeginRenderPass2()" : "vkCmdBeginRenderPass()";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100373
374 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600375 LogObjectList objlist(image);
376 objlist.add(renderpass);
377 objlist.add(framebuffer);
378 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700379 skip |=
sfricke-samsung4389faa2022-03-23 01:19:42 -0500380 LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700381 "%s: RenderPass %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
382 function_name, report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
383 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100384 return skip;
385 }
386
387 auto image_usage = image_state->createInfo.usage;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700388 const auto stencil_usage_info = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Ricardo Garcia3f5984c2020-04-09 10:56:34 +0200389 if (stencil_usage_info) {
390 image_usage |= stencil_usage_info->stencilUsage;
391 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100392
393 // Check for layouts that mismatch image usages in the framebuffer
394 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800395 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600396 LogObjectList objlist(image);
397 objlist.add(renderpass);
398 objlist.add(framebuffer);
399 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700400 skip |= LogError(objlist, vuid,
401 "%s: Layout/usage mismatch for attachment %u in %s"
402 " - the %s is %s but the image attached to %s via %s"
403 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
404 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
405 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
406 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100407 }
408
409 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
410 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800411 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600412 LogObjectList objlist(image);
413 objlist.add(renderpass);
414 objlist.add(framebuffer);
415 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700416 skip |= LogError(objlist, vuid,
417 "%s: Layout/usage mismatch for attachment %u in %s"
418 " - the %s is %s but the image attached to %s via %s"
419 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
420 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
421 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
422 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100423 }
424
425 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800426 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600427 LogObjectList objlist(image);
428 objlist.add(renderpass);
429 objlist.add(framebuffer);
430 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700431 skip |= LogError(objlist, vuid,
432 "%s: Layout/usage mismatch for attachment %u in %s"
433 " - the %s is %s but the image attached to %s via %s"
434 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
435 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
436 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
437 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100438 }
439
440 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800441 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600442 LogObjectList objlist(image);
443 objlist.add(renderpass);
444 objlist.add(framebuffer);
445 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700446 skip |= LogError(objlist, vuid,
447 "%s: Layout/usage mismatch for attachment %u in %s"
448 " - the %s is %s but the image attached to %s via %s"
449 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
450 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
451 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
452 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100453 }
454
sfricke-samsung45996a42021-09-16 13:45:27 -0700455 if (IsExtEnabled(device_extensions.vk_khr_maintenance2)) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100456 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
457 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
458 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
459 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
460 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800461 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600462 LogObjectList objlist(image);
463 objlist.add(renderpass);
464 objlist.add(framebuffer);
465 objlist.add(image_view);
466 skip |= LogError(objlist, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700467 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700468 " - the %s is %s but the image attached to %s via %s"
469 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700470 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700471 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
472 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100473 }
474 } else {
475 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
476 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
477 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
478 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600479 LogObjectList objlist(image);
480 objlist.add(renderpass);
481 objlist.add(framebuffer);
482 objlist.add(image_view);
483 skip |= LogError(objlist, "VUID-vkCmdBeginRenderPass-initialLayout-00896",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700484 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700485 " - the %s is %s but the image attached to %s via %s"
486 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700487 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700488 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
489 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100490 }
491 }
492 return skip;
493}
494
John Zulauf17a01bb2019-08-09 16:41:19 -0600495bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700496 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600497 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600498 bool skip = false;
Jeremy Gebbenf4449392022-01-28 10:09:10 -0700499 auto render_pass_state = Get<RENDER_PASS_STATE>(pRenderPassBegin->renderPass);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600500 const auto *render_pass_info = render_pass_state->createInfo.ptr();
501 auto render_pass = render_pass_state->renderPass();
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700502 auto const &framebuffer_info = framebuffer_state->createInfo;
503 const VkImageView *attachments = framebuffer_info.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100504
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600505 auto framebuffer = framebuffer_state->framebuffer();
Tobias Hectorbbb12282018-10-22 15:17:59 +0100506
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700507 if (render_pass_info->attachmentCount != framebuffer_info.attachmentCount) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600508 skip |= LogError(pCB->commandBuffer(), kVUID_Core_DrawState_InvalidRenderpass,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700509 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700510 }
John Zulauf8e308292018-09-21 11:34:37 -0600511
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700512 const auto *attachment_info = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext);
Mike Schuchardt2df08912020-12-15 16:28:09 -0800513 if (((framebuffer_info.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) != 0) && attachment_info != nullptr) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700514 attachments = attachment_info->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100515 }
516
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600517 if (attachments == nullptr) {
518 return skip;
519 }
520 const auto *const_p_cb = static_cast<const CMD_BUFFER_STATE *>(pCB);
521 for (uint32_t i = 0; i < render_pass_info->attachmentCount && i < framebuffer_info.attachmentCount; ++i) {
522 auto image_view = attachments[i];
523 auto view_state = Get<IMAGE_VIEW_STATE>(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100524
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600525 if (!view_state) {
526 LogObjectList objlist(pRenderPassBegin->renderPass);
527 objlist.add(framebuffer_state->framebuffer());
528 objlist.add(image_view);
529 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
530 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
531 report_data->FormatHandle(framebuffer_state->framebuffer()).c_str(), i,
532 report_data->FormatHandle(image_view).c_str());
533 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100534 }
535
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600536 const VkImage image = view_state->create_info.image;
537 const auto *image_state = view_state->image_state.get();
Tobias Hectorbbb12282018-10-22 15:17:59 +0100538
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600539 if (!image_state) {
540 LogObjectList objlist(pRenderPassBegin->renderPass);
541 objlist.add(framebuffer_state->framebuffer());
542 objlist.add(image_view);
543 objlist.add(image);
544 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
545 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
546 report_data->FormatHandle(framebuffer_state->framebuffer()).c_str(), i,
547 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
548 continue;
549 }
550 auto attachment_initial_layout = render_pass_info->pAttachments[i].initialLayout;
551 auto final_layout = render_pass_info->pAttachments[i].finalLayout;
552
553 // Default to expecting stencil in the same layout.
554 auto attachment_stencil_initial_layout = attachment_initial_layout;
555
556 // If a separate layout is specified, look for that.
557 const auto *attachment_description_stencil_layout =
558 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(render_pass_info->pAttachments[i].pNext);
559 if (attachment_description_stencil_layout) {
560 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
561 }
562
563 const ImageSubresourceLayoutMap *subresource_map = nullptr;
564 bool has_queried_map = false;
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600565
566 for (uint32_t aspect_index = 0; aspect_index < 32; aspect_index++) {
567 VkImageAspectFlags test_aspect = 1u << aspect_index;
568 if ((view_state->normalized_subresource_range.aspectMask & test_aspect) == 0) {
569 continue;
570 }
571
572 // Allow for differing depth and stencil layouts
573 VkImageLayout check_layout = attachment_initial_layout;
574 if (test_aspect == VK_IMAGE_ASPECT_STENCIL_BIT) {
575 check_layout = attachment_stencil_initial_layout;
576 }
577
578 // If no layout information for image yet, will be checked at QueueSubmit time
579 if (check_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
580 continue;
581 }
582 if (!has_queried_map) {
583 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to
584 // something in common with the non-const version.) The lookup is expensive, so cache it.
585 subresource_map = const_p_cb->GetImageSubresourceLayoutMap(*image_state);
586 has_queried_map = true;
587 }
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600588 if (!subresource_map) {
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600589 // If no layout information for image yet, will be checked at QueueSubmit time
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600590 continue;
591 }
592 auto normalized_range = view_state->normalized_subresource_range;
593 normalized_range.aspectMask = test_aspect;
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600594 LayoutUseCheckAndMessage layout_check(check_layout, test_aspect);
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600595
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600596 skip |= subresource_map->AnyInRange(
Jeremy Gebbencb13f0f2022-07-15 15:48:05 -0600597 normalized_range, [this, &layout_check, i](const LayoutRange &range, const LayoutEntry &state) {
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600598 bool subres_skip = false;
599 if (!layout_check.Check(state)) {
600 subres_skip = LogError(device, kVUID_Core_DrawState_InvalidRenderpass,
601 "You cannot start a render pass using attachment %u where the render pass initial "
602 "layout is %s "
603 "and the %s layout of the attachment is %s. The layouts must match, or the render "
604 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
605 i, string_VkImageLayout(layout_check.expected_layout), layout_check.message,
606 string_VkImageLayout(layout_check.layout));
607 }
608 return subres_skip;
609 });
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600610 }
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600611 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, *view_state, framebuffer,
612 render_pass, i, "initial layout");
613
614 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, *view_state, framebuffer, render_pass, i,
615 "final layout");
616 }
617
618 for (uint32_t j = 0; j < render_pass_info->subpassCount; ++j) {
619 auto &subpass = render_pass_info->pSubpasses[j];
620 for (uint32_t k = 0; k < render_pass_info->pSubpasses[j].inputAttachmentCount; ++k) {
621 auto &attachment_ref = subpass.pInputAttachments[k];
622 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
623 auto image_view = attachments[attachment_ref.attachment];
624 auto view_state = Get<IMAGE_VIEW_STATE>(image_view);
625
626 if (view_state) {
627 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, *view_state,
628 framebuffer, render_pass, attachment_ref.attachment,
629 "input attachment layout");
630 }
631 }
632 }
633
634 for (uint32_t k = 0; k < render_pass_info->pSubpasses[j].colorAttachmentCount; ++k) {
635 auto &attachment_ref = subpass.pColorAttachments[k];
636 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
637 auto image_view = attachments[attachment_ref.attachment];
638 auto view_state = Get<IMAGE_VIEW_STATE>(image_view);
639
640 if (view_state) {
641 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, *view_state,
642 framebuffer, render_pass, attachment_ref.attachment,
643 "color attachment layout");
644 if (subpass.pResolveAttachments) {
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600645 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, *view_state,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700646 framebuffer, render_pass, attachment_ref.attachment,
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600647 "resolve attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100648 }
649 }
650 }
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600651 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100652
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600653 if (render_pass_info->pSubpasses[j].pDepthStencilAttachment) {
654 auto &attachment_ref = *subpass.pDepthStencilAttachment;
655 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
656 auto image_view = attachments[attachment_ref.attachment];
657 auto view_state = Get<IMAGE_VIEW_STATE>(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100658
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600659 if (view_state) {
660 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, *view_state,
661 framebuffer, render_pass, attachment_ref.attachment,
662 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100663 }
664 }
665 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700666 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600667 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700668}
669
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600670void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700671 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700672 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -0600673 IMAGE_VIEW_STATE *image_view = pCB->GetActiveAttachmentImageViewState(ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600674 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700675 VkImageLayout stencil_layout = kInvalidLayout;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700676 const auto *attachment_reference_stencil_layout = LvlFindInChain<VkAttachmentReferenceStencilLayout>(ref.pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700677 if (attachment_reference_stencil_layout) {
678 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
679 }
680
Jeremy Gebben1ec89332021-08-05 13:51:49 -0600681 pCB->SetImageViewLayout(*image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600682 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700683 }
684}
685
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600686void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
687 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700688 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700689
690 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700691 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700692 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700693 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700694 }
695 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700696 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700697 }
698 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700699 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700700 }
701 }
702}
703
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700704// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
705// 1. Transition into initialLayout state
706// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600707void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700708 FRAMEBUFFER_STATE *framebuffer_state) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700709 // First record expected initialLayout as a potential initial layout usage.
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700710 auto const rpci = render_pass_state->createInfo.ptr();
711 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -0600712 auto *view_state = cb_state->GetActiveAttachmentImageViewState(i);
John Zulauf8e308292018-09-21 11:34:37 -0600713 if (view_state) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700714 IMAGE_STATE *image_state = view_state->image_state.get();
715 const auto initial_layout = rpci->pAttachments[i].initialLayout;
Piers Daniell4fde9b72019-11-27 16:19:46 -0700716 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700717 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(rpci->pAttachments[i].pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700718 if (attachment_description_stencil_layout) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700719 const auto stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
720 VkImageSubresourceRange sub_range = view_state->normalized_subresource_range;
721 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
Jeremy Gebben1ec89332021-08-05 13:51:49 -0600722 cb_state->SetImageInitialLayout(*image_state, sub_range, initial_layout);
John Zulauf81dd1f12021-01-26 16:49:16 -0700723 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
Jeremy Gebben1ec89332021-08-05 13:51:49 -0600724 cb_state->SetImageInitialLayout(*image_state, sub_range, stencil_initial_layout);
John Zulauf81dd1f12021-01-26 16:49:16 -0700725 } else {
Jeremy Gebben1ec89332021-08-05 13:51:49 -0600726 cb_state->SetImageInitialLayout(*image_state, view_state->normalized_subresource_range, initial_layout);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700727 }
John Zulauf8e308292018-09-21 11:34:37 -0600728 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700729 }
730 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700731 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700732}
733
Dave Houlton10b39482017-03-16 13:18:15 -0600734bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600735 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600736 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600737 }
738 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600739 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600740 }
741 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600742 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600743 }
Mike Schuchardt2df08912020-12-15 16:28:09 -0800744 if (0 != (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT))) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700745 if (FormatPlaneCount(format) == 1) return false;
746 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600747 return true;
748}
749
sfricke-samsung10b35ce2021-09-29 08:50:20 -0700750// There is a table in the Vulkan spec to list all formats that implicitly require YCbCr conversion,
751// but some features/extensions can explicitly turn that restriction off
752// The implicit check is done in format utils, while feature checks are done here in CoreChecks
753bool CoreChecks::FormatRequiresYcbcrConversionExplicitly(const VkFormat format) const {
754 if (format == VK_FORMAT_R10X6G10X6B10X6A10X6_UNORM_4PACK16 &&
755 enabled_features.rgba10x6_formats_features.formatRgba10x6WithoutYCbCrSampler) {
756 return false;
757 }
758 return FormatRequiresYcbcrConversion(format);
759}
760
Mike Weiblen62d08a32017-03-07 22:18:27 -0700761// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -0700762bool CoreChecks::ValidateBarrierLayoutToImageUsage(const Location &loc, VkImage image, VkImageLayout layout,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700763 VkImageUsageFlags usage_flags) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700764 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700765 bool is_error = false;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700766 switch (layout) {
767 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700768 is_error = ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700769 break;
770 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700771 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700772 break;
773 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700774 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700775 break;
776 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700777 is_error = ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700778 break;
779 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700780 is_error = ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700781 break;
782 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700783 is_error = ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700784 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600785 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700786 is_error = ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0);
Jeff Bolz9af91c52018-09-01 21:53:57 -0500787 break;
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700788 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700789 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700790 break;
791 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700792 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700793 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700794 default:
795 // Other VkImageLayout values do not have VUs defined in this context.
796 break;
797 }
798
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700799 if (is_error) {
800 const auto &vuid = sync_vuid_maps::GetBadImageLayoutVUID(loc, layout);
801
802 skip |=
803 LogError(image, vuid, "%s Image barrier Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".",
804 loc.Message().c_str(), string_VkImageLayout(layout), report_data->FormatHandle(image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700805 }
806 return skip;
807}
808
809// Verify image barriers are compatible with the images they reference.
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700810template <typename ImageBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -0700811bool CoreChecks::ValidateBarriersToImages(const Location &outer_loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700812 uint32_t imageMemoryBarrierCount, const ImageBarrier *pImageMemoryBarriers) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700813 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700814 using sync_vuid_maps::GetImageBarrierVUID;
815 using sync_vuid_maps::ImageError;
Petr Krausad0096a2019-08-09 18:35:04 +0200816
John Zulauf463c51e2018-05-31 13:29:20 -0600817 // Scoreboard for duplicate layout transition barriers within the list
818 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
ziga-lunarg189ae5d2021-10-19 13:09:58 +0200819 const CommandBufferImageLayoutMap &current_map = cb_state->GetImageSubresourceLayoutMap();
820 CommandBufferImageLayoutMap layout_updates;
John Zulauf463c51e2018-05-31 13:29:20 -0600821
Mike Weiblen62d08a32017-03-07 22:18:27 -0700822 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700823 auto loc = outer_loc.dot(Field::pImageMemoryBarriers, i);
Petr Krausad0096a2019-08-09 18:35:04 +0200824 const auto &img_barrier = pImageMemoryBarriers[i];
Mike Weiblen62d08a32017-03-07 22:18:27 -0700825
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600826 auto image_state = Get<IMAGE_STATE>(img_barrier.image);
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600827 if (!image_state) {
828 continue;
829 }
830 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
831 skip |= ValidateBarrierLayoutToImageUsage(loc.dot(Field::oldLayout), img_barrier.image, img_barrier.oldLayout, usage_flags);
832 skip |= ValidateBarrierLayoutToImageUsage(loc.dot(Field::newLayout), img_barrier.image, img_barrier.newLayout, usage_flags);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600833
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600834 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
835 if (image_state->layout_locked) {
836 // TODO: Add unique id for error when available
837 skip |= LogError(
838 img_barrier.image, "VUID-Undefined",
839 "%s Attempting to transition shared presentable %s"
840 " from layout %s to layout %s, but image has already been presented and cannot have its layout transitioned.",
841 loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
842 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(img_barrier.newLayout));
843 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600844
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600845 const VkImageCreateInfo &image_create_info = image_state->createInfo;
846 const VkFormat image_format = image_create_info.format;
847 const VkImageAspectFlags aspect_mask = img_barrier.subresourceRange.aspectMask;
848 // For a Depth/Stencil image both aspects MUST be set
849 auto image_loc = loc.dot(Field::image);
850 if (FormatIsDepthAndStencil(image_format)) {
851 if (enabled_features.core12.separateDepthStencilLayouts) {
852 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
853 auto vuid = GetImageBarrierVUID(loc, ImageError::kNotDepthOrStencilAspect);
sfricke-samsung79b00482020-04-01 21:15:50 -0700854 skip |= LogError(img_barrier.image, vuid,
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600855 "%s references %s of format %s that must have either the depth or stencil "
856 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
857 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
858 string_VkFormat(image_format), aspect_mask);
859 }
860 } else {
861 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
862 if ((aspect_mask & ds_mask) != (ds_mask)) {
863 auto error = IsExtEnabled(device_extensions.vk_khr_separate_depth_stencil_layouts)
864 ? ImageError::kNotSeparateDepthAndStencilAspect
865 : ImageError::kNotDepthAndStencilAspect;
866 auto vuid = GetImageBarrierVUID(image_loc, error);
867 skip |= LogError(img_barrier.image, vuid,
868 "%s references %s of format %s that must have the depth and stencil "
869 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700870 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700871 string_VkFormat(image_format), aspect_mask);
872 }
873 }
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600874 }
sfricke-samsung79b00482020-04-01 21:15:50 -0700875
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600876 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
877 // TODO: Set memory invalid which is in mem_tracker currently
878 } else if (!QueueFamilyIsExternal(img_barrier.srcQueueFamilyIndex)) {
879 auto &write_subresource_map = layout_updates[image_state.get()];
880 bool new_write = false;
881 if (!write_subresource_map) {
882 write_subresource_map = std::make_shared<ImageSubresourceLayoutMap>(*image_state);
883 new_write = true;
884 }
885 const auto &current_subresource_map = current_map.find(image_state.get());
886 const auto &read_subresource_map = (new_write && current_subresource_map != current_map.end())
887 ? (*current_subresource_map).second
888 : write_subresource_map;
889
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600890 // Validate aspects in isolation.
891 // This is required when handling separate depth-stencil layouts.
892 for (uint32_t aspect_index = 0; aspect_index < 32; aspect_index++) {
893 VkImageAspectFlags test_aspect = 1u << aspect_index;
894 if ((img_barrier.subresourceRange.aspectMask & test_aspect) == 0) {
895 continue;
896 }
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600897 auto old_layout = NormalizeSynchronization2Layout(img_barrier.subresourceRange.aspectMask, img_barrier.oldLayout);
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600898
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600899 LayoutUseCheckAndMessage layout_check(old_layout, test_aspect);
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600900 auto normalized_isr = image_state->NormalizeSubresourceRange(img_barrier.subresourceRange);
901 normalized_isr.aspectMask = test_aspect;
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600902 skip |= read_subresource_map->AnyInRange(
Jeremy Gebbencb13f0f2022-07-15 15:48:05 -0600903 normalized_isr, [this, read_subresource_map, cb_state, &layout_check, &loc, &img_barrier](
904 const LayoutRange &range, const LayoutEntry &state) {
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600905 bool subres_skip = false;
906 if (!layout_check.Check(state)) {
907 const auto &vuid = GetImageBarrierVUID(loc, ImageError::kConflictingLayout);
Jeremy Gebbencb13f0f2022-07-15 15:48:05 -0600908 auto subres = read_subresource_map->Decode(range.begin);
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600909 subres_skip = LogError(
910 cb_state->commandBuffer(), vuid,
911 "%s %s cannot transition the layout of aspect=%d level=%d layer=%d from %s when the "
912 "%s layout is %s.",
913 loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(), subres.aspectMask,
914 subres.mipLevel, subres.arrayLayer, string_VkImageLayout(img_barrier.oldLayout),
915 layout_check.message, string_VkImageLayout(layout_check.layout));
916 }
917 return subres_skip;
918 });
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600919 write_subresource_map->SetSubresourceRangeLayout(*cb_state, normalized_isr, img_barrier.newLayout);
920 }
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600921 }
922
923 // checks color format and (single-plane or non-disjoint)
924 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
925 if ((FormatIsColor(image_format) == true) &&
926 ((FormatIsMultiplane(image_format) == false) || (image_state->disjoint == false))) {
927 if (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT) {
928 auto error = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion) ? ImageError::kNotColorAspect
929 : ImageError::kNotColorAspectYcbcr;
930 const auto &vuid = GetImageBarrierVUID(loc, error);
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700931 skip |= LogError(img_barrier.image, vuid,
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600932 "%s references %s of format %s that must be only VK_IMAGE_ASPECT_COLOR_BIT, "
933 "but its aspectMask is 0x%" PRIx32 ".",
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700934 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700935 string_VkFormat(image_format), aspect_mask);
936 }
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600937 }
sfricke-samsung79b00482020-04-01 21:15:50 -0700938
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600939 VkImageAspectFlags valid_disjoint_mask =
940 VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT | VK_IMAGE_ASPECT_COLOR_BIT;
941 if ((FormatIsMultiplane(image_format) == true) && (image_state->disjoint == true) &&
942 ((aspect_mask & valid_disjoint_mask) == 0)) {
943 const auto &vuid = GetImageBarrierVUID(image_loc, ImageError::kBadMultiplanarAspect);
944 skip |= LogError(img_barrier.image, vuid,
945 "%s references %s of format %s has aspectMask (0x%" PRIx32
946 ") but needs to include either an VK_IMAGE_ASPECT_PLANE_*_BIT or VK_IMAGE_ASPECT_COLOR_BIT.",
947 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
948 string_VkFormat(image_format), aspect_mask);
949 }
950
951 if ((FormatPlaneCount(image_format) == 2) && ((aspect_mask & VK_IMAGE_ASPECT_PLANE_2_BIT) != 0)) {
952 const auto &vuid = GetImageBarrierVUID(image_loc, ImageError::kBadPlaneCount);
953 skip |= LogError(img_barrier.image, vuid,
954 "%s references %s of format %s has only two planes but included "
955 "VK_IMAGE_ASPECT_PLANE_2_BIT in its aspectMask (0x%" PRIx32 ").",
956 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
957 string_VkFormat(image_format), aspect_mask);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700958 }
959 }
960 return skip;
961}
962
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700963template <typename Barrier, typename TransferBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -0700964bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const Location &loc, const CMD_BUFFER_STATE *cb_state, const Barrier &barrier,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700965 const QFOTransferBarrierSets<TransferBarrier> &barrier_sets) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600966 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700967 const char *handle_name = TransferBarrier::HandleName();
John Zulauf6b4aae82018-05-09 13:03:36 -0600968 const char *transfer_type = nullptr;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700969 if (!IsTransferOp(barrier)) {
970 return skip;
971 }
972 const TransferBarrier *barrier_record = nullptr;
Jeremy Gebben7ba56152021-06-18 10:40:10 -0600973 if (cb_state->IsReleaseOp(barrier) && !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700974 const auto found = barrier_sets.release.find(barrier);
975 if (found != barrier_sets.release.cend()) {
976 barrier_record = &(*found);
977 transfer_type = "releasing";
John Zulauf6b4aae82018-05-09 13:03:36 -0600978 }
Jeremy Gebben7ba56152021-06-18 10:40:10 -0600979 } else if (cb_state->IsAcquireOp(barrier) && !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700980 const auto found = barrier_sets.acquire.find(barrier);
981 if (found != barrier_sets.acquire.cend()) {
982 barrier_record = &(*found);
983 transfer_type = "acquiring";
John Zulauf6b4aae82018-05-09 13:03:36 -0600984 }
985 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700986 if (barrier_record != nullptr) {
987 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600988 LogWarning(cb_state->commandBuffer(), TransferBarrier::ErrMsgDuplicateQFOInCB(),
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700989 "%s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
990 " duplicates existing barrier recorded in this command buffer.",
991 loc.Message().c_str(), transfer_type, handle_name, report_data->FormatHandle(barrier_record->handle).c_str(),
992 barrier_record->srcQueueFamilyIndex, barrier_record->dstQueueFamilyIndex);
993 }
John Zulauf6b4aae82018-05-09 13:03:36 -0600994 return skip;
995}
996
John Zulaufa4472282019-08-22 14:44:34 -0600997VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
998 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
999}
1000
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001001VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier2KHR &barrier) {
1002 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1003}
1004
Jeremy Gebben9f537102021-10-05 16:37:12 -06001005std::shared_ptr<const IMAGE_STATE> BarrierHandleState(const ValidationStateTracker &device_state,
1006 const VkImageMemoryBarrier &barrier) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001007 return device_state.Get<IMAGE_STATE>(barrier.image);
John Zulaufa4472282019-08-22 14:44:34 -06001008}
1009
Jeremy Gebben9f537102021-10-05 16:37:12 -06001010std::shared_ptr<const IMAGE_STATE> BarrierHandleState(const ValidationStateTracker &device_state,
1011 const VkImageMemoryBarrier2KHR &barrier) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001012 return device_state.Get<IMAGE_STATE>(barrier.image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001013}
1014
John Zulaufa4472282019-08-22 14:44:34 -06001015VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
1016 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1017}
1018
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001019VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier2KHR &barrier) {
1020 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1021}
1022
Jeremy Gebben9f537102021-10-05 16:37:12 -06001023const std::shared_ptr<const BUFFER_STATE> BarrierHandleState(const ValidationStateTracker &device_state,
1024 const VkBufferMemoryBarrier &barrier) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001025 return device_state.Get<BUFFER_STATE>(barrier.buffer);
John Zulaufa4472282019-08-22 14:44:34 -06001026}
1027
Jeremy Gebben9f537102021-10-05 16:37:12 -06001028std::shared_ptr<const BUFFER_STATE> BarrierHandleState(const ValidationStateTracker &device_state,
1029 const VkBufferMemoryBarrier2KHR &barrier) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001030 return device_state.Get<BUFFER_STATE>(barrier.buffer);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001031}
John Zulaufa4472282019-08-22 14:44:34 -06001032
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001033template <typename Barrier, typename TransferBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001034void CoreChecks::RecordBarrierValidationInfo(const Location &loc, CMD_BUFFER_STATE *cb_state, const Barrier &barrier,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001035 QFOTransferBarrierSets<TransferBarrier> &barrier_sets) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001036 if (IsTransferOp(barrier)) {
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001037 if (cb_state->IsReleaseOp(barrier) && !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001038 barrier_sets.release.emplace(barrier);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001039 } else if (cb_state->IsAcquireOp(barrier) && !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001040 barrier_sets.acquire.emplace(barrier);
John Zulaufa4472282019-08-22 14:44:34 -06001041 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001042 }
John Zulaufa4472282019-08-22 14:44:34 -06001043
David Zhao Akeleyd76df472021-05-15 17:25:59 -07001044 // 7.7.4: If the values of srcQueueFamilyIndex and dstQueueFamilyIndex are equal, no ownership transfer is performed, and the
1045 // barrier operates as if they were both set to VK_QUEUE_FAMILY_IGNORED.
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001046 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
1047 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
David Zhao Akeleyd76df472021-05-15 17:25:59 -07001048 const bool is_ownership_transfer = src_queue_family != dst_queue_family;
1049
1050 if (is_ownership_transfer) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001051 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
1052 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
1053 auto handle_state = BarrierHandleState(*this, barrier);
1054 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
1055 if (!mode_concurrent) {
1056 const auto typed_handle = BarrierTypedHandle(barrier);
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001057 core_error::LocationCapture loc_capture(loc);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001058 cb_state->queue_submit_functions.emplace_back(
Jeremy Gebbene5361dd2021-11-18 14:23:56 -07001059 [loc_capture, typed_handle, src_queue_family, dst_queue_family](
1060 const ValidationStateTracker &device_data, const QUEUE_STATE &queue_state, const CMD_BUFFER_STATE &cb_state) {
John Zulaufb4438f02021-02-20 20:22:16 -07001061 return ValidateConcurrentBarrierAtSubmit(loc_capture.Get(), device_data, queue_state, cb_state, typed_handle,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001062 src_queue_family, dst_queue_family);
1063 });
John Zulauf6b4aae82018-05-09 13:03:36 -06001064 }
1065 }
1066}
1067
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001068// Verify image barrier image state and that the image is consistent with FB image
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001069template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001070bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001071 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1072 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001073 const ImgBarrier &img_barrier, const CMD_BUFFER_STATE *primary_cb_state) const {
1074 using sync_vuid_maps::GetImageBarrierVUID;
1075 using sync_vuid_maps::ImageError;
1076
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001077 bool skip = false;
1078 const auto *fb_state = framebuffer;
1079 assert(fb_state);
1080 const auto img_bar_image = img_barrier.image;
1081 bool image_match = false;
1082 bool sub_image_found = false; // Do we find a corresponding subpass description
1083 VkImageLayout sub_image_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1084 uint32_t attach_index = 0;
1085 // Verify that a framebuffer image matches barrier image
1086 const auto attachment_count = fb_state->createInfo.attachmentCount;
1087 for (uint32_t attachment = 0; attachment < attachment_count; ++attachment) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06001088 auto view_state = primary_cb_state ? primary_cb_state->GetActiveAttachmentImageViewState(attachment) : cb_state->GetActiveAttachmentImageViewState(attachment);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001089 if (view_state && (img_bar_image == view_state->create_info.image)) {
1090 image_match = true;
1091 attach_index = attachment;
1092 break;
1093 }
1094 }
1095 if (image_match) { // Make sure subpass is referring to matching attachment
1096 if (sub_desc.pDepthStencilAttachment && sub_desc.pDepthStencilAttachment->attachment == attach_index) {
1097 sub_image_layout = sub_desc.pDepthStencilAttachment->layout;
1098 sub_image_found = true;
1099 }
sfricke-samsung45996a42021-09-16 13:45:27 -07001100 if (!sub_image_found && IsExtEnabled(device_extensions.vk_khr_depth_stencil_resolve)) {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001101 const auto *resolve = LvlFindInChain<VkSubpassDescriptionDepthStencilResolve>(sub_desc.pNext);
1102 if (resolve && resolve->pDepthStencilResolveAttachment &&
1103 resolve->pDepthStencilResolveAttachment->attachment == attach_index) {
1104 sub_image_layout = resolve->pDepthStencilResolveAttachment->layout;
1105 sub_image_found = true;
1106 }
1107 }
1108 if (!sub_image_found) {
1109 for (uint32_t j = 0; j < sub_desc.colorAttachmentCount; ++j) {
1110 if (sub_desc.pColorAttachments && sub_desc.pColorAttachments[j].attachment == attach_index) {
1111 sub_image_layout = sub_desc.pColorAttachments[j].layout;
1112 sub_image_found = true;
1113 break;
1114 }
1115 if (!sub_image_found && sub_desc.pResolveAttachments &&
1116 sub_desc.pResolveAttachments[j].attachment == attach_index) {
1117 sub_image_layout = sub_desc.pResolveAttachments[j].layout;
1118 sub_image_found = true;
1119 break;
1120 }
1121 }
1122 }
1123 if (!sub_image_found) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001124 auto img_loc = loc.dot(Field::image);
1125 const auto &vuid = GetImageBarrierVUID(img_loc, ImageError::kRenderPassMismatch);
1126 skip |=
1127 LogError(rp_handle, vuid,
1128 "%s Barrier for %s is not referenced by the VkSubpassDescription for active subpass (%d) of current %s.",
1129 img_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(), active_subpass,
1130 report_data->FormatHandle(rp_handle).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001131 }
1132 } else { // !image_match
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001133 auto img_loc = loc.dot(Field::image);
1134 const auto &vuid = GetImageBarrierVUID(img_loc, ImageError::kRenderPassMismatch);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001135 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 -07001136 img_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001137 report_data->FormatHandle(fb_state->framebuffer()).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001138 }
1139 if (img_barrier.oldLayout != img_barrier.newLayout) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001140 auto layout_loc = loc.dot(Field::oldLayout);
1141 const auto &vuid = GetImageBarrierVUID(layout_loc, ImageError::kRenderPassLayoutChange);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001142 skip |= LogError(cb_state->commandBuffer(), vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001143 "%s As the Image Barrier for %s is being executed within a render pass instance, oldLayout must "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001144 "equal newLayout yet they are %s and %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001145 layout_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001146 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(img_barrier.newLayout));
1147 } else {
1148 if (sub_image_found && sub_image_layout != img_barrier.oldLayout) {
1149 LogObjectList objlist(rp_handle);
1150 objlist.add(img_bar_image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001151 auto layout_loc = loc.dot(Field::oldLayout);
1152 const auto &vuid = GetImageBarrierVUID(layout_loc, ImageError::kRenderPassLayoutChange);
1153 skip |= LogError(objlist, vuid,
1154 "%s Barrier for %s is referenced by the VkSubpassDescription for active "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001155 "subpass (%d) of current %s as having layout %s, but image barrier has layout %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001156 layout_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(), active_subpass,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001157 report_data->FormatHandle(rp_handle).c_str(), string_VkImageLayout(sub_image_layout),
1158 string_VkImageLayout(img_barrier.oldLayout));
1159 }
1160 }
1161 return skip;
1162}
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001163// explictly instantiate so these can be used in core_validation.cpp
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001164template bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001165 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1166 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
1167 const VkImageMemoryBarrier &img_barrier,
1168 const CMD_BUFFER_STATE *primary_cb_state) const;
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001169template bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001170 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1171 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
1172 const VkImageMemoryBarrier2KHR &img_barrier,
1173 const CMD_BUFFER_STATE *primary_cb_state) const;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001174
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001175template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001176void CoreChecks::EnqueueSubmitTimeValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001177 const ImgBarrier &barrier) {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001178 // Secondary CBs can have null framebuffer so queue up validation in that case 'til FB is known
1179 if ((cb_state->activeRenderPass) && (VK_NULL_HANDLE == cb_state->activeFramebuffer) &&
1180 (VK_COMMAND_BUFFER_LEVEL_SECONDARY == cb_state->createInfo.level)) {
1181 const auto active_subpass = cb_state->activeSubpass;
1182 const auto rp_state = cb_state->activeRenderPass;
1183 const auto &sub_desc = rp_state->createInfo.pSubpasses[active_subpass];
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001184 // Secondary CB case w/o FB specified delay validation
1185 auto *this_ptr = this; // Required for older compilers with c++20 compatibility
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001186 core_error::LocationCapture loc_capture(loc);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001187 const auto render_pass = rp_state->renderPass();
John Zulaufb4438f02021-02-20 20:22:16 -07001188 cb_state->cmd_execute_commands_functions.emplace_back(
Jeremy Gebben057f9d52021-11-05 14:12:31 -06001189 [this_ptr, loc_capture, active_subpass, sub_desc, render_pass, barrier](
1190 const CMD_BUFFER_STATE &secondary_cb, const CMD_BUFFER_STATE *primary_cb, const FRAMEBUFFER_STATE *fb) {
1191 return this_ptr->ValidateImageBarrierAttachment(loc_capture.Get(), &secondary_cb, fb, active_subpass, sub_desc,
John Zulaufb4438f02021-02-20 20:22:16 -07001192 render_pass, barrier, primary_cb);
1193 });
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001194 }
1195}
1196
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001197void CoreChecks::RecordBarriers(Func func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001198 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1199 const VkImageMemoryBarrier *pImageMemBarriers) {
1200 for (uint32_t i = 0; i < bufferBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001201 Location loc(func_name, Struct::VkBufferMemoryBarrier, Field::pBufferMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001202 RecordBarrierValidationInfo(loc, cb_state, pBufferMemBarriers[i], cb_state->qfo_transfer_buffer_barriers);
1203 }
1204 for (uint32_t i = 0; i < imageMemBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001205 Location loc(func_name, Struct::VkImageMemoryBarrier, Field::pImageMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001206 const auto &img_barrier = pImageMemBarriers[i];
1207 RecordBarrierValidationInfo(loc, cb_state, img_barrier, cb_state->qfo_transfer_image_barriers);
1208 EnqueueSubmitTimeValidateImageBarrierAttachment(loc, cb_state, img_barrier);
1209 }
1210}
1211
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001212void CoreChecks::RecordBarriers(Func func_name, CMD_BUFFER_STATE *cb_state, const VkDependencyInfoKHR &dep_info) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001213 for (uint32_t i = 0; i < dep_info.bufferMemoryBarrierCount; i++) {
Tony-LunarG279601c2021-11-16 10:50:51 -07001214 Location loc(func_name, Struct::VkBufferMemoryBarrier2, Field::pBufferMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001215 RecordBarrierValidationInfo(loc, cb_state, dep_info.pBufferMemoryBarriers[i], cb_state->qfo_transfer_buffer_barriers);
1216 }
1217 for (uint32_t i = 0; i < dep_info.imageMemoryBarrierCount; i++) {
Tony-LunarG279601c2021-11-16 10:50:51 -07001218 Location loc(func_name, Struct::VkImageMemoryBarrier2, Field::pImageMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001219 const auto &img_barrier = dep_info.pImageMemoryBarriers[i];
1220 RecordBarrierValidationInfo(loc, cb_state, img_barrier, cb_state->qfo_transfer_image_barriers);
1221 EnqueueSubmitTimeValidateImageBarrierAttachment(loc, cb_state, img_barrier);
1222 }
1223}
1224
1225template <typename TransferBarrier, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001226bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001227 const char *operation, const TransferBarrier &barrier,
1228 Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001229 // Record to the scoreboard or report that we have a duplication
1230 bool skip = false;
Jeremy Gebbencbf22862021-03-03 12:01:22 -07001231 auto inserted = scoreboard->emplace(barrier, cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001232 if (!inserted.second && inserted.first->second != cb_state) {
1233 // 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 -06001234 LogObjectList objlist(cb_state->commandBuffer());
Mark Lobodzinskiea561582020-03-16 18:13:56 -06001235 objlist.add(barrier.handle);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001236 objlist.add(inserted.first->second->commandBuffer());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001237 skip = LogWarning(objlist, TransferBarrier::ErrMsgDuplicateQFOInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001238 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1239 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001240 "vkQueueSubmit()", TransferBarrier::BarrierName(), operation, TransferBarrier::HandleName(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001241 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001242 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer()).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001243 }
1244 return skip;
1245}
1246
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001247template <typename TransferBarrier>
1248bool CoreChecks::ValidateQueuedQFOTransferBarriers(
1249 const CMD_BUFFER_STATE *cb_state, QFOTransferCBScoreboards<TransferBarrier> *scoreboards,
1250 const GlobalQFOTransferBarrierMap<TransferBarrier> &global_release_barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001251 bool skip = false;
Jeremy Gebben159b3cc2021-06-03 09:09:03 -06001252 const auto &cb_barriers = cb_state->GetQFOBarrierSets(TransferBarrier());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001253 const char *barrier_name = TransferBarrier::BarrierName();
1254 const char *handle_name = TransferBarrier::HandleName();
John Zulauf6b4aae82018-05-09 13:03:36 -06001255 // No release should have an extant duplicate (WARNING)
1256 for (const auto &release : cb_barriers.release) {
1257 // Check the global pending release barriers
1258 const auto set_it = global_release_barriers.find(release.handle);
1259 if (set_it != global_release_barriers.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001260 const QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001261 const auto found = set_for_handle.find(release);
1262 if (found != set_for_handle.cend()) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001263 skip |= LogWarning(cb_state->commandBuffer(), TransferBarrier::ErrMsgDuplicateQFOSubmitted(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001264 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1265 " to dstQueueFamilyIndex %" PRIu32
1266 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1267 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1268 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001269 }
1270 }
1271 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1272 }
1273 // Each acquire must have a matching release (ERROR)
1274 for (const auto &acquire : cb_barriers.acquire) {
1275 const auto set_it = global_release_barriers.find(acquire.handle);
1276 bool matching_release_found = false;
1277 if (set_it != global_release_barriers.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001278 const QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001279 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1280 }
1281 if (!matching_release_found) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001282 skip |= LogError(cb_state->commandBuffer(), TransferBarrier::ErrMsgMissingQFOReleaseInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001283 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1284 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1285 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1286 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001287 }
1288 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1289 }
1290 return skip;
1291}
1292
John Zulauf3b04ebd2019-07-18 14:08:11 -06001293bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001294 QFOTransferCBScoreboards<QFOImageTransferBarrier> *qfo_image_scoreboards,
1295 QFOTransferCBScoreboards<QFOBufferTransferBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001296 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001297 skip |=
1298 ValidateQueuedQFOTransferBarriers<QFOImageTransferBarrier>(cb_state, qfo_image_scoreboards, qfo_release_image_barrier_map);
1299 skip |= ValidateQueuedQFOTransferBarriers<QFOBufferTransferBarrier>(cb_state, qfo_buffer_scoreboards,
1300 qfo_release_buffer_barrier_map);
John Zulauf6b4aae82018-05-09 13:03:36 -06001301 return skip;
1302}
1303
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001304template <typename TransferBarrier>
1305void RecordQueuedQFOTransferBarriers(QFOTransferBarrierSets<TransferBarrier> &cb_barriers,
1306 GlobalQFOTransferBarrierMap<TransferBarrier> &global_release_barriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001307 // Add release barriers from this submit to the global map
1308 for (const auto &release : cb_barriers.release) {
1309 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
Jeremy Gebben51499ca2022-01-11 08:36:13 -07001310 // NOTE: vl_concurrent_ordered_map::find() makes a thread safe copy of the result, so we must
1311 // copy back after updating.
1312 auto iter = global_release_barriers.find(release.handle);
1313 iter->second.insert(release);
1314 global_release_barriers.insert_or_assign(release.handle, iter->second);
John Zulauf6b4aae82018-05-09 13:03:36 -06001315 }
1316
1317 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1318 for (const auto &acquire : cb_barriers.acquire) {
1319 // NOTE: We're not using [] because we don't want to create entries for missing releases
1320 auto set_it = global_release_barriers.find(acquire.handle);
1321 if (set_it != global_release_barriers.end()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001322 QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001323 set_for_handle.erase(acquire);
1324 if (set_for_handle.size() == 0) { // Clean up empty sets
Jeremy Gebben51499ca2022-01-11 08:36:13 -07001325 global_release_barriers.erase(acquire.handle);
1326 } else {
1327 // NOTE: vl_concurrent_ordered_map::find() makes a thread safe copy of the result, so we must
1328 // copy back after updating.
1329 global_release_barriers.insert_or_assign(acquire.handle, set_for_handle);
John Zulauf6b4aae82018-05-09 13:03:36 -06001330 }
1331 }
1332 }
1333}
1334
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001335void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001336 RecordQueuedQFOTransferBarriers<QFOImageTransferBarrier>(cb_state->qfo_transfer_image_barriers, qfo_release_image_barrier_map);
1337 RecordQueuedQFOTransferBarriers<QFOBufferTransferBarrier>(cb_state->qfo_transfer_buffer_barriers,
1338 qfo_release_buffer_barrier_map);
John Zulauf6b4aae82018-05-09 13:03:36 -06001339}
1340
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001341template <typename ImgBarrier>
1342void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count, const ImgBarrier *barriers) {
1343 // For ownership transfers, the barrier is specified twice; as a release
1344 // operation on the yielding queue family, and as an acquire operation
1345 // on the acquiring queue family. This barrier may also include a layout
1346 // transition, which occurs 'between' the two operations. For validation
1347 // purposes it doesn't seem important which side performs the layout
1348 // transition, but it must not be performed twice. We'll arbitrarily
1349 // choose to perform it as part of the acquire operation.
1350 //
1351 // However, we still need to record initial layout for the "initial layout" validation
1352 for (uint32_t i = 0; i < barrier_count; i++) {
1353 const auto &mem_barrier = barriers[i];
Jeremy Gebbenefead332021-06-18 08:22:44 -06001354 const bool is_release_op = cb_state->IsReleaseOp(mem_barrier);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001355 auto image_state = Get<IMAGE_STATE>(mem_barrier.image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001356 if (image_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06001357 RecordTransitionImageLayout(cb_state, image_state.get(), mem_barrier, is_release_op);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001358 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001359 }
1360}
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001361// explictly instantiate this template so it can be used in core_validation.cpp
1362template void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1363 const VkImageMemoryBarrier *barrier);
1364template void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1365 const VkImageMemoryBarrier2KHR *barrier);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001366
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001367VkImageLayout NormalizeSynchronization2Layout(const VkImageAspectFlags aspect_mask, VkImageLayout layout);
1368
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001369template <typename ImgBarrier>
unknown86bcb3a2019-07-11 13:05:36 -06001370void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001371 const ImgBarrier &mem_barrier, bool is_release_op) {
Tony-LunarG273f32f2021-09-28 08:56:30 -06001372 if (enabled_features.core13.synchronization2) {
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001373 if (mem_barrier.oldLayout == mem_barrier.newLayout) {
1374 return;
1375 }
1376 }
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06001377 auto normalized_isr = image_state->NormalizeSubresourceRange(mem_barrier.subresourceRange);
unknown86bcb3a2019-07-11 13:05:36 -06001378
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001379 VkImageLayout initial_layout = NormalizeSynchronization2Layout(mem_barrier.subresourceRange.aspectMask, mem_barrier.oldLayout);
1380 VkImageLayout new_layout = NormalizeSynchronization2Layout(mem_barrier.subresourceRange.aspectMask, mem_barrier.newLayout);
Michael Spang8af7c102020-05-03 20:50:09 -04001381
1382 // Layout transitions in external instance are not tracked, so don't validate initial layout.
John Zulaufcea64cb2020-06-10 17:17:27 -06001383 if (QueueFamilyIsExternal(mem_barrier.srcQueueFamilyIndex)) {
Michael Spang8af7c102020-05-03 20:50:09 -04001384 initial_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1385 }
1386
John Zulauf2be3fe02019-12-30 09:48:02 -07001387 if (is_release_op) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06001388 cb_state->SetImageInitialLayout(*image_state, normalized_isr, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001389 } else {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06001390 cb_state->SetImageLayout(*image_state, normalized_isr, new_layout, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001391 }
unknown86bcb3a2019-07-11 13:05:36 -06001392}
1393
John Zulauf15578df2022-06-02 13:50:03 -06001394template <typename RangeFactory>
1395bool CoreChecks::VerifyImageLayoutRange(const CMD_BUFFER_STATE &cb_node, const IMAGE_STATE &image_state,
1396 VkImageAspectFlags aspect_mask, VkImageLayout explicit_layout,
1397 const RangeFactory &range_factory, const char *caller, const char *layout_mismatch_msg_code,
1398 bool *error) const {
1399 bool skip = false;
1400 const auto *subresource_map = cb_node.GetImageSubresourceLayoutMap(image_state);
1401 if (!subresource_map) return skip;
1402
1403 LayoutUseCheckAndMessage layout_check(explicit_layout, aspect_mask);
1404 skip |= subresource_map->AnyInRange(
Jeremy Gebbencb13f0f2022-07-15 15:48:05 -06001405 range_factory(*subresource_map), [this, subresource_map, &cb_node, &image_state, &layout_check, layout_mismatch_msg_code,
1406 caller, error](const LayoutRange &range, const LayoutEntry &state) {
John Zulauf15578df2022-06-02 13:50:03 -06001407 bool subres_skip = false;
1408 if (!layout_check.Check(state)) {
1409 *error = true;
Jeremy Gebbencb13f0f2022-07-15 15:48:05 -06001410 auto subres = subresource_map->Decode(range.begin);
John Zulauf15578df2022-06-02 13:50:03 -06001411 subres_skip |= LogError(cb_node.commandBuffer(), layout_mismatch_msg_code,
1412 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1413 "%s layout %s.",
1414 caller, report_data->FormatHandle(image_state.Handle()).c_str(), subres.arrayLayer,
1415 subres.mipLevel, string_VkImageLayout(layout_check.expected_layout), layout_check.message,
1416 string_VkImageLayout(layout_check.layout));
1417 }
1418 return subres_skip;
1419 });
1420
1421 return skip;
1422}
1423
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001424bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE &cb_node, const IMAGE_STATE &image_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001425 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1426 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1427 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06001428 if (disabled[image_layout_validation]) return false;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001429 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001430
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001431 VkImageSubresourceRange normalized_isr = image_state.NormalizeSubresourceRange(range);
John Zulauf15578df2022-06-02 13:50:03 -06001432 auto range_factory = [&normalized_isr](const ImageSubresourceLayoutMap &map) {
1433 return map.RangeGen(normalized_isr);
1434 };
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001435 skip |= VerifyImageLayoutRange(cb_node, image_state, aspect_mask, explicit_layout, range_factory, caller,
John Zulauf15578df2022-06-02 13:50:03 -06001436 layout_mismatch_msg_code, error);
John Zulauff660ad62019-03-23 07:16:05 -06001437
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001438 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1439 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1440 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001441 if (image_state.createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001442 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001443 skip |= LogPerformanceWarning(cb_node.commandBuffer(), kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001444 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001445 report_data->FormatHandle(image_state.Handle()).c_str(),
Jeremy Gebben6335df62021-11-01 10:50:13 -06001446 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001447 }
sfricke-samsung45996a42021-09-16 13:45:27 -07001448 } else if (IsExtEnabled(device_extensions.vk_khr_shared_presentable_image)) {
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001449 if (image_state.shared_presentable) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001450 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001451 skip |=
1452 LogError(device, layout_invalid_msg_code,
1453 "%s: Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1454 caller, string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001455 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001456 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001457 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001458 *error = true;
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001459 skip |= LogError(cb_node.commandBuffer(), layout_invalid_msg_code,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001460 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001461 report_data->FormatHandle(image_state.Handle()).c_str(), string_VkImageLayout(explicit_layout),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001462 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001463 }
1464 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001465 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001466}
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001467bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE &cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001468 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1469 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001470 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001471 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1472 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1473}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001474
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001475bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE &cb_node, const IMAGE_VIEW_STATE &image_view_state,
Jeremy Gebbene7b99fc2022-06-02 08:44:33 -06001476 VkImageLayout explicit_layout, const char *caller, const char *layout_mismatch_msg_code,
1477 bool *error) const {
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -06001478 if (disabled[image_layout_validation]) return false;
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001479 assert(image_view_state.image_state);
1480 auto range_factory = [&image_view_state](const ImageSubresourceLayoutMap &map) {
1481 return image_layout_map::RangeGenerator(image_view_state.range_generator);
John Zulauf15578df2022-06-02 13:50:03 -06001482 };
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -06001483
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001484 return VerifyImageLayoutRange(cb_node, *image_view_state.image_state, image_view_state.create_info.subresourceRange.aspectMask,
1485 explicit_layout, range_factory, caller, layout_mismatch_msg_code, error);
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -06001486}
1487
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001488void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001489 FRAMEBUFFER_STATE *framebuffer_state) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001490 auto render_pass = Get<RENDER_PASS_STATE>(pRenderPassBegin->renderPass);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001491 if (!render_pass) return;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001492
Mike Schuchardt2df08912020-12-15 16:28:09 -08001493 const VkRenderPassCreateInfo2 *render_pass_info = render_pass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001494 if (framebuffer_state) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001495 for (uint32_t i = 0; i < render_pass_info->attachmentCount; ++i) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06001496 auto *view_state = pCB->GetActiveAttachmentImageViewState(i);
John Zulauf8e308292018-09-21 11:34:37 -06001497 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001498 VkImageLayout stencil_layout = kInvalidLayout;
1499 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001500 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(render_pass_info->pAttachments[i].pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -07001501 if (attachment_description_stencil_layout) {
1502 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1503 }
Jeremy Gebben1ec89332021-08-05 13:51:49 -06001504 pCB->SetImageViewLayout(*view_state, render_pass_info->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001505 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001506 }
1507 }
1508}
Dave Houltone19e20d2018-02-02 16:32:41 -07001509
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001510#ifdef VK_USE_PLATFORM_ANDROID_KHR
1511// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1512// This could also move into a seperate core_validation_android.cpp file... ?
1513
1514//
1515// AHB-specific validation within non-AHB APIs
1516//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001517bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001518 bool skip = false;
1519
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001520 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(create_info->pNext);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001521 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001522 if (0 != ext_fmt_android->externalFormat) {
1523 if (VK_FORMAT_UNDEFINED != create_info->format) {
1524 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001525 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1526 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1527 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001528 }
1529
1530 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001531 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1532 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1533 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001534 }
1535
1536 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001537 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1538 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06001539 "non-zero externalFormat, but usage includes bits (0x%" PRIx32 ") other than VK_IMAGE_USAGE_SAMPLED_BIT.",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001540 create_info->usage);
Dave Houltond9611312018-11-19 17:03:36 -07001541 }
1542
1543 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001544 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1545 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1546 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001547 }
1548 }
1549
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001550 if ((0 != ext_fmt_android->externalFormat) &&
1551 (ahb_ext_formats_map.find(ext_fmt_android->externalFormat) == ahb_ext_formats_map.end())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001552 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001553 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat (%" PRIu64
1554 ") which has "
1555 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().",
1556 ext_fmt_android->externalFormat);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001557 }
1558 }
1559
Dave Houltond9611312018-11-19 17:03:36 -07001560 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001561 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001562 skip |=
1563 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1564 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1565 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001566 }
1567 }
1568
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001569 const VkExternalMemoryImageCreateInfo *emici = LvlFindInChain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001570 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1571 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001572 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001573 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1574 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1575 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1576 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001577 }
1578
1579 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001580 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1581 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1582 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1583 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1584 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001585 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001586 }
1587
1588 return skip;
1589}
1590
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001591bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001592 bool skip = false;
Jeremy Gebbenf4449392022-01-28 10:09:10 -07001593 auto image_state = Get<IMAGE_STATE>(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001594
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06001595 if (image_state->HasAHBFormat()) {
Dave Houltond9611312018-11-19 17:03:36 -07001596 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001597 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1598 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001599 "format member is %s and must be VK_FORMAT_UNDEFINED.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001600 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001601 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001602
Dave Houltond9611312018-11-19 17:03:36 -07001603 // Chain must include a compatible ycbcr conversion
1604 bool conv_found = false;
1605 uint64_t external_format = 0;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001606 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = LvlFindInChain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001607 if (ycbcr_conv_info != nullptr) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001608 auto ycbcr_state = Get<SAMPLER_YCBCR_CONVERSION_STATE>(ycbcr_conv_info->conversion);
Jeremy Gebbenf4fb2a02021-07-08 09:57:46 -06001609 if (ycbcr_state) {
Dave Houltond9611312018-11-19 17:03:36 -07001610 conv_found = true;
Jeremy Gebbenf4fb2a02021-07-08 09:57:46 -06001611 external_format = ycbcr_state->external_format;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001612 }
Dave Houltond9611312018-11-19 17:03:36 -07001613 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001614 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001615 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001616 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1617 "an externalFormat (%" PRIu64
1618 ") but needs a chained VkSamplerYcbcrConversionInfo struct with a VkSamplerYcbcrConversion created "
1619 "with the same external format.",
1620 image_state->ahb_format);
Dave Houltond9611312018-11-19 17:03:36 -07001621 }
1622
1623 // Errors in create_info swizzles
sfricke-samsungbd0e8052020-06-06 01:36:39 -07001624 if (IsIdentitySwizzle(create_info->components) == false) {
1625 skip |= LogError(
1626 create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1627 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1628 "includes one or more non-identity component swizzles, r swizzle = %s, g swizzle = %s, b swizzle = %s, a swizzle "
1629 "= %s.",
1630 string_VkComponentSwizzle(create_info->components.r), string_VkComponentSwizzle(create_info->components.g),
1631 string_VkComponentSwizzle(create_info->components.b), string_VkComponentSwizzle(create_info->components.a));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001632 }
1633 }
Dave Houltond9611312018-11-19 17:03:36 -07001634
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001635 return skip;
1636}
1637
John Zulaufa26d3c82019-08-14 16:09:08 -06001638bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001639 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001640
Jeremy Gebbenf4449392022-01-28 10:09:10 -07001641 auto image_state = Get<IMAGE_STATE>(image);
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001642 if (image_state != nullptr) {
Aitor Camacho3294edd2022-05-16 22:34:19 +02001643 if (image_state->IsExternalAHB() && (0 == image_state->GetBoundMemoryStates().size())) {
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001644 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1645 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1646 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1647 "bound to memory.");
1648 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001649 }
1650 return skip;
1651}
1652
1653#else
1654
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001655bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001656 return false;
1657}
1658
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001659bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001660
John Zulaufa26d3c82019-08-14 16:09:08 -06001661bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001662
1663#endif // VK_USE_PLATFORM_ANDROID_KHR
1664
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001665bool CoreChecks::ValidateImageFormatFeatures(const VkImageCreateInfo *pCreateInfo) const {
1666 bool skip = false;
1667
1668 // validates based on imageCreateFormatFeatures from vkspec.html#resources-image-creation-limits
Lionel Landwerlin21719f62021-12-09 11:40:09 +02001669 VkFormatFeatureFlags2KHR tiling_features = 0;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001670 const VkImageTiling image_tiling = pCreateInfo->tiling;
1671 const VkFormat image_format = pCreateInfo->format;
1672
1673 if (image_format == VK_FORMAT_UNDEFINED) {
1674 // VU 01975 states format can't be undefined unless an android externalFormat
1675#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001676 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001677 if ((image_tiling == VK_IMAGE_TILING_OPTIMAL) && (ext_fmt_android != nullptr) && (0 != ext_fmt_android->externalFormat)) {
1678 auto it = ahb_ext_formats_map.find(ext_fmt_android->externalFormat);
1679 if (it != ahb_ext_formats_map.end()) {
1680 tiling_features = it->second;
1681 }
1682 }
1683#endif
1684 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
Lionel Landwerlin1da35792021-12-14 16:54:13 +02001685 layer_data::unordered_set<uint64_t> drm_format_modifiers;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001686 const VkImageDrmFormatModifierExplicitCreateInfoEXT *drm_explicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001687 LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001688 const VkImageDrmFormatModifierListCreateInfoEXT *drm_implicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001689 LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001690
1691 if (drm_explicit != nullptr) {
Lionel Landwerlin1da35792021-12-14 16:54:13 +02001692 drm_format_modifiers.insert(drm_explicit->drmFormatModifier);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001693 } else {
1694 // VUID 02261 makes sure its only explict or implict in parameter checking
1695 assert(drm_implicit != nullptr);
1696 for (uint32_t i = 0; i < drm_implicit->drmFormatModifierCount; i++) {
Lionel Landwerlin1da35792021-12-14 16:54:13 +02001697 drm_format_modifiers.insert(drm_implicit->pDrmFormatModifiers[i]);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001698 }
1699 }
1700
Lionel Landwerlin1da35792021-12-14 16:54:13 +02001701 auto fmt_drm_props = LvlInitStruct<VkDrmFormatModifierPropertiesListEXT>();
1702 auto fmt_props_2 = LvlInitStruct<VkFormatProperties2>(&fmt_drm_props);
1703 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &fmt_props_2);
Lionel Landwerlin09351a72020-06-22 18:15:59 +03001704 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
Lionel Landwerlin1da35792021-12-14 16:54:13 +02001705 drm_properties.resize(fmt_drm_props.drmFormatModifierCount);
1706 fmt_drm_props.pDrmFormatModifierProperties = drm_properties.data();
1707 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &fmt_props_2);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001708
Lionel Landwerlin1da35792021-12-14 16:54:13 +02001709 for (uint32_t i = 0; i < fmt_drm_props.drmFormatModifierCount; i++) {
1710 if (drm_format_modifiers.find(fmt_drm_props.pDrmFormatModifierProperties[i].drmFormatModifier) !=
1711 drm_format_modifiers.end()) {
1712 tiling_features |= fmt_drm_props.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001713 }
1714 }
1715 } else {
Lionel Landwerlin21719f62021-12-09 11:40:09 +02001716 VkFormatProperties3KHR format_properties = GetPDFormatProperties(image_format);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001717 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
1718 : format_properties.optimalTilingFeatures;
1719 }
1720
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001721 // Lack of disjoint format feature support while using the flag
1722 if (FormatIsMultiplane(image_format) && ((pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT) != 0) &&
Lionel Landwerlin21719f62021-12-09 11:40:09 +02001723 ((tiling_features & VK_FORMAT_FEATURE_2_DISJOINT_BIT_KHR) == 0)) {
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001724 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateFormatFeatures-02260",
1725 "vkCreateImage(): can't use VK_IMAGE_CREATE_DISJOINT_BIT because %s doesn't support "
1726 "VK_FORMAT_FEATURE_DISJOINT_BIT based on imageCreateFormatFeatures.",
1727 string_VkFormat(pCreateInfo->format));
1728 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001729
1730 return skip;
1731}
1732
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001733bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001734 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001735 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001736
sfricke-samsung45996a42021-09-16 13:45:27 -07001737 if (IsExtEnabled(device_extensions.vk_android_external_memory_android_hardware_buffer)) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001738 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001739 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1740 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001741 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1742 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001743 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001744 }
1745
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001746 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1747 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001748 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1749 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1750 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001751 }
Dave Houlton130c0212018-01-29 13:39:56 -07001752 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001753
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001754 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001755 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1756 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1757 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001758 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001759 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width (%u) exceeds "
1760 "device maxFramebufferWidth (%u).",
1761 pCreateInfo->extent.width, device_limits->maxFramebufferWidth);
Dave Houlton130c0212018-01-29 13:39:56 -07001762 }
1763
1764 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001765 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001766 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height (%u) exceeds "
1767 "device maxFramebufferHeight (%u).",
1768 pCreateInfo->extent.height, device_limits->maxFramebufferHeight);
Dave Houlton130c0212018-01-29 13:39:56 -07001769 }
1770
ziga-lunarg44cba6e2021-07-13 17:58:06 +02001771 VkImageCreateFlags sparseFlags =
1772 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
1773 if ((pCreateInfo->flags & sparseFlags) && (pCreateInfo->usage & VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT)) {
1774 skip |= LogError(
1775 device, "VUID-VkImageCreateInfo-None-01925",
1776 "vkCreateImage(): images using sparse memory cannot have VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT set");
1777 }
1778
Agarwal, Arpit78509112022-02-17 15:29:05 -07001779 if (!enabled_features.fragment_density_map_offset_features.fragmentDensityMapOffset) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001780 uint32_t ceiling_width = static_cast<uint32_t>(ceil(
1781 static_cast<float>(device_limits->maxFramebufferWidth) /
1782 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001783 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1784 skip |=
Agarwal, Arpit78509112022-02-17 15:29:05 -07001785 LogError(device, "VUID-VkImageCreateInfo-fragmentDensityMapOffset-06514",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001786 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1787 "ceiling of device "
1788 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1789 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1790 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001791 }
1792
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001793 uint32_t ceiling_height = static_cast<uint32_t>(ceil(
1794 static_cast<float>(device_limits->maxFramebufferHeight) /
1795 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001796 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1797 skip |=
Agarwal, Arpit78509112022-02-17 15:29:05 -07001798 LogError(device, "VUID-VkImageCreateInfo-fragmentDensityMapOffset-06515",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001799 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1800 "ceiling of device "
1801 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1802 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1803 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001804 }
1805 }
1806
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001807 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001808 VkResult result = VK_SUCCESS;
1809 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1810 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1811 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1812 &format_limits);
1813 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001814 auto modifier_list = LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1815 auto explicit_modifier = LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001816 if (modifier_list) {
1817 for (uint32_t i = 0; i < modifier_list->drmFormatModifierCount; i++) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001818 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001819 drm_format_modifier.drmFormatModifier = modifier_list->pDrmFormatModifiers[i];
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001820 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001821 image_format_info.type = pCreateInfo->imageType;
1822 image_format_info.format = pCreateInfo->format;
1823 image_format_info.tiling = pCreateInfo->tiling;
1824 image_format_info.usage = pCreateInfo->usage;
1825 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001826 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001827
1828 result =
1829 DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1830 format_limits = image_format_properties.imageFormatProperties;
1831
1832 /* The application gives a list of modifier and the driver
1833 * selects one. If one is wrong, stop there.
1834 */
1835 if (result != VK_SUCCESS) break;
1836 }
1837 } else if (explicit_modifier) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001838 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001839 drm_format_modifier.drmFormatModifier = explicit_modifier->drmFormatModifier;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001840 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001841 image_format_info.type = pCreateInfo->imageType;
1842 image_format_info.format = pCreateInfo->format;
1843 image_format_info.tiling = pCreateInfo->tiling;
1844 image_format_info.usage = pCreateInfo->usage;
1845 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001846 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001847
1848 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1849 format_limits = image_format_properties.imageFormatProperties;
1850 }
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001851 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001852
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001853 // 1. vkGetPhysicalDeviceImageFormatProperties[2] only success code is VK_SUCCESS
1854 // 2. If call returns an error, then "imageCreateImageFormatPropertiesList" is defined to be the empty list
1855 // 3. All values in 02251 are undefined if "imageCreateImageFormatPropertiesList" is empty.
1856 if (result != VK_SUCCESS) {
1857 // External memory will always have a "imageCreateImageFormatPropertiesList" so skip
Lockee87f87c2019-04-23 17:53:10 -06001858#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001859 if (!LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext)) {
Lockee87f87c2019-04-23 17:53:10 -06001860#endif // VK_USE_PLATFORM_ANDROID_KHR
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001861 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateMaxMipLevels-02251",
Spencer Frickec46fc6d2020-04-16 06:23:05 -07001862 "vkCreateImage(): Format %s is not supported for this combination of parameters and "
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001863 "VkGetPhysicalDeviceImageFormatProperties returned back %s.",
1864 string_VkFormat(pCreateInfo->format), string_VkResult(result));
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001865#ifdef VK_USE_PLATFORM_ANDROID_KHR
1866 }
1867#endif // VK_USE_PLATFORM_ANDROID_KHR
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001868 } else {
1869 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1870 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001871 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1872 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1873 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001874 }
Dave Houlton130c0212018-01-29 13:39:56 -07001875
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001876 uint64_t texel_count = static_cast<uint64_t>(pCreateInfo->extent.width) *
1877 static_cast<uint64_t>(pCreateInfo->extent.height) *
1878 static_cast<uint64_t>(pCreateInfo->extent.depth) * static_cast<uint64_t>(pCreateInfo->arrayLayers) *
1879 static_cast<uint64_t>(pCreateInfo->samples);
Dave Houlton130c0212018-01-29 13:39:56 -07001880
sfricke-samsung2e827212021-09-28 07:52:08 -07001881 // Depth/Stencil formats size can't be accurately calculated
1882 if (!FormatIsDepthAndStencil(pCreateInfo->format)) {
1883 uint64_t total_size =
1884 static_cast<uint64_t>(std::ceil(FormatTexelSize(pCreateInfo->format) * static_cast<double>(texel_count)));
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001885
sfricke-samsung2e827212021-09-28 07:52:08 -07001886 // Round up to imageGranularity boundary
1887 VkDeviceSize image_granularity = phys_dev_props.limits.bufferImageGranularity;
1888 uint64_t ig_mask = image_granularity - 1;
1889 total_size = (total_size + ig_mask) & ~ig_mask;
1890
1891 if (total_size > format_limits.maxResourceSize) {
1892 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
1893 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1894 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1895 total_size, format_limits.maxResourceSize);
1896 }
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001897 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001898
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001899 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001900 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
1901 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1902 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001903 }
1904
1905 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001906 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
1907 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
1908 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001909 }
sfricke-samsung612f3622020-06-20 20:42:46 -07001910
1911 if (pCreateInfo->extent.width > format_limits.maxExtent.width) {
1912 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02252",
1913 "vkCreateImage(): extent.width %u exceeds allowable maximum image extent width %u.",
1914 pCreateInfo->extent.width, format_limits.maxExtent.width);
1915 }
1916
1917 if (pCreateInfo->extent.height > format_limits.maxExtent.height) {
1918 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02253",
1919 "vkCreateImage(): extent.height %u exceeds allowable maximum image extent height %u.",
1920 pCreateInfo->extent.height, format_limits.maxExtent.height);
1921 }
1922
1923 if (pCreateInfo->extent.depth > format_limits.maxExtent.depth) {
1924 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02254",
1925 "vkCreateImage(): extent.depth %u exceeds allowable maximum image extent depth %u.",
1926 pCreateInfo->extent.depth, format_limits.maxExtent.depth);
1927 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001928 }
1929
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001930 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsung10b35ce2021-09-29 08:50:20 -07001931 if (FormatRequiresYcbcrConversionExplicitly(pCreateInfo->format)) {
sfricke-samsungcead0802020-01-30 22:20:10 -08001932 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
sfricke-samsung45996a42021-09-16 13:45:27 -07001933 const char *error_vuid = IsExtEnabled(device_extensions.vk_ext_ycbcr_image_arrays)
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07001934 ? "VUID-VkImageCreateInfo-format-06414"
1935 : "VUID-VkImageCreateInfo-format-06413";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001936 skip |= LogError(device, error_vuid,
1937 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
1938 "YCbCr Conversion format, arrayLayers must be 1",
1939 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001940 }
1941
1942 if (pCreateInfo->mipLevels != 1) {
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07001943 skip |= LogError(device, "VUID-VkImageCreateInfo-format-06410",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001944 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
tmerilehtica733542022-04-13 14:00:29 +03001945 pCreateInfo->mipLevels);
sfricke-samsungcead0802020-01-30 22:20:10 -08001946 }
1947
1948 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001949 skip |= LogError(
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07001950 device, "VUID-VkImageCreateInfo-format-06411",
sfricke-samsungcead0802020-01-30 22:20:10 -08001951 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
1952 string_VkSampleCountFlagBits(pCreateInfo->samples));
1953 }
1954
1955 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001956 skip |= LogError(
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07001957 device, "VUID-VkImageCreateInfo-format-06412",
sfricke-samsungcead0802020-01-30 22:20:10 -08001958 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
1959 string_VkImageType(pCreateInfo->imageType));
1960 }
1961 }
1962
sfricke-samsung45996a42021-09-16 13:45:27 -07001963 if (IsExtEnabled(device_extensions.vk_khr_maintenance2)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001964 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
sfricke-samsung08796682021-09-13 07:47:20 -07001965 if (!FormatIsCompressed(pCreateInfo->format)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001966 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01572",
1967 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
sfricke-samsung08796682021-09-13 07:47:20 -07001968 "format must be a compressed image format, but is %s",
Spencer Fricke48db59b2020-03-23 10:31:46 -07001969 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001970 }
1971 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001972 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01573",
1973 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1974 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001975 }
1976 }
1977 }
1978
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001979 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
sfricke-samsung45996a42021-09-16 13:45:27 -07001980 const char *vuid = IsExtEnabled(device_extensions.vk_khr_get_physical_device_properties2)
1981 ? "VUID-VkImageCreateInfo-sharingMode-01420"
1982 : "VUID-VkImageCreateInfo-sharingMode-01392";
Mark Lobodzinski314b9162020-07-16 15:33:08 -06001983 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
ziga-lunarge2e283d2021-08-01 09:55:04 +02001984 "vkCreateImage", "pCreateInfo->pQueueFamilyIndices", vuid);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001985 }
1986
unknown2c877272019-07-11 12:56:50 -06001987 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
1988 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
1989 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001990 LogError(device, "VUID-VkImageCreateInfo-format-01577",
1991 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
1992 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06001993 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001994
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001995 const auto swapchain_create_info = LvlFindInChain<VkImageSwapchainCreateInfoKHR>(pCreateInfo->pNext);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07001996 if (swapchain_create_info != nullptr) {
1997 if (swapchain_create_info->swapchain != VK_NULL_HANDLE) {
Jeremy Gebbenf4449392022-01-28 10:09:10 -07001998 auto swapchain_state = Get<SWAPCHAIN_NODE>(swapchain_create_info->swapchain);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07001999 const VkSwapchainCreateFlagsKHR swapchain_flags = swapchain_state->createInfo.flags;
2000
2001 // Validate rest of Swapchain Image create check that require swapchain state
2002 const char *vuid = "VUID-VkImageSwapchainCreateInfoKHR-swapchain-00995";
2003 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR) != 0) &&
2004 ((pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) == 0)) {
2005 skip |= LogError(
2006 device, vuid,
2007 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR flag so "
2008 "all swapchain images must have the VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT flag set.");
2009 }
2010 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR) != 0) &&
2011 ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) == 0)) {
2012 skip |= LogError(device, vuid,
2013 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR flag so all "
2014 "swapchain images must have the VK_IMAGE_CREATE_PROTECTED_BIT flag set.");
2015 }
Mike Schuchardt2df08912020-12-15 16:28:09 -08002016 const VkImageCreateFlags mutable_flags = (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT | VK_IMAGE_CREATE_EXTENDED_USAGE_BIT);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002017 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR) != 0) &&
2018 ((pCreateInfo->flags & mutable_flags) != mutable_flags)) {
2019 skip |= LogError(device, vuid,
2020 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR flag so "
2021 "all swapchain images must have the VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT and "
Mike Schuchardt2df08912020-12-15 16:28:09 -08002022 "VK_IMAGE_CREATE_EXTENDED_USAGE_BIT flags both set.");
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002023 }
2024 }
2025 }
2026
sfricke-samsungedce77a2020-07-03 22:35:13 -07002027 if ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) != 0) {
2028 if (enabled_features.core11.protectedMemory == VK_FALSE) {
2029 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01890",
2030 "vkCreateImage(): the protectedMemory device feature is disabled: Images cannot be created with the "
2031 "VK_IMAGE_CREATE_PROTECTED_BIT set.");
2032 }
2033 const VkImageCreateFlags invalid_flags =
2034 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
2035 if ((pCreateInfo->flags & invalid_flags) != 0) {
2036 skip |= LogError(device, "VUID-VkImageCreateInfo-None-01891",
2037 "vkCreateImage(): VK_IMAGE_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at same "
2038 "time (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | "
2039 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT).");
2040 }
2041 }
2042
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002043 skip |= ValidateImageFormatFeatures(pCreateInfo);
2044
Nathaniel Cesarioc02c2512020-11-13 12:04:24 -07002045 // Check compatibility with VK_KHR_portability_subset
sfricke-samsung45996a42021-09-16 13:45:27 -07002046 if (IsExtEnabled(device_extensions.vk_khr_portability_subset)) {
Nathaniel Cesarioc02c2512020-11-13 12:04:24 -07002047 if (VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT & pCreateInfo->flags &&
2048 VK_FALSE == enabled_features.portability_subset_features.imageView2DOn3DImage) {
2049 skip |= LogError(device, "VUID-VkImageCreateInfo-imageView2DOn3DImage-04459",
2050 "vkCreateImage (portability error): VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT is not supported.");
2051 }
2052 if ((VK_SAMPLE_COUNT_1_BIT != pCreateInfo->samples) && (1 != pCreateInfo->arrayLayers) &&
2053 (VK_FALSE == enabled_features.portability_subset_features.multisampleArrayImage)) {
2054 skip |=
2055 LogError(device, "VUID-VkImageCreateInfo-multisampleArrayImage-04460",
2056 "vkCreateImage (portability error): Cannot create an image with samples/texel > 1 && arrayLayers != 1");
2057 }
2058 }
2059
ziga-lunarg63f8d7a2021-07-20 22:10:31 +02002060 const auto external_memory_create_info_nv = LvlFindInChain<VkExternalMemoryImageCreateInfoNV>(pCreateInfo->pNext);
ziga-lunarg62aa24f2021-10-09 11:58:30 +02002061 const auto external_memory_create_info = LvlFindInChain<VkExternalMemoryImageCreateInfo>(pCreateInfo->pNext);
2062 if (external_memory_create_info_nv != nullptr && external_memory_create_info != nullptr) {
2063 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-00988",
2064 "vkCreateImage(): VkImageCreateInfo struct has both VkExternalMemoryImageCreateInfoNV and "
2065 "VkExternalMemoryImageCreateInfo chained structs.");
2066 }
2067 if (external_memory_create_info) {
2068 if (external_memory_create_info->handleTypes != 0 && pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_UNDEFINED) {
2069 skip |= LogError(
2070 device, "VUID-VkImageCreateInfo-pNext-01443",
2071 "vkCreateImage: VkImageCreateInfo pNext chain includes VkExternalMemoryImageCreateInfo with handleTypes %" PRIu32
2072 " but pCreateInfo->initialLayout is %s.",
2073 external_memory_create_info->handleTypes, string_VkImageLayout(pCreateInfo->initialLayout));
2074 }
2075 } else if (external_memory_create_info_nv) {
2076 if (external_memory_create_info_nv->handleTypes != 0 && pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_UNDEFINED) {
2077 skip |= LogError(
2078 device, "VUID-VkImageCreateInfo-pNext-01443",
2079 "vkCreateImage: VkImageCreateInfo pNext chain includes VkExternalMemoryImageCreateInfoNV with handleTypes %" PRIu32
2080 " but pCreateInfo->initialLayout is %s.",
2081 external_memory_create_info_nv->handleTypes, string_VkImageLayout(pCreateInfo->initialLayout));
ziga-lunarg63f8d7a2021-07-20 22:10:31 +02002082 }
2083 }
2084
ziga-lunarg374fd9a2021-07-18 10:32:52 +02002085 if (device_group_create_info.physicalDeviceCount == 1) {
2086 if (pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) {
2087 skip |= LogError(device, "VUID-VkImageCreateInfo-physicalDeviceCount-01421",
2088 "vkCreateImage: Device was created with VkDeviceGroupDeviceCreateInfo::physicalDeviceCount 1, but "
2089 "flags contain VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT bit.");
2090 }
2091 }
2092
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002093 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002094}
2095
John Zulauf7eeb6f72019-06-17 11:56:36 -06002096void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
2097 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
2098 if (VK_SUCCESS != result) return;
2099
2100 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
Jeremy Gebben4a8881f2022-01-10 17:04:30 -07002101 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) != 0) {
2102 // non-sparse images set up their layout maps when memory is bound
2103 auto image_state = Get<IMAGE_STATE>(*pImage);
2104 image_state->SetInitialLayoutMap();
2105 }
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07002106}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002107
Jeff Bolz5c801d12019-10-09 10:38:45 -05002108bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeremy Gebbenf4449392022-01-28 10:09:10 -07002109 auto image_state = Get<IMAGE_STATE>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002110 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07002111 if (image_state) {
paul-lunarg4820fd12022-07-12 11:08:01 -06002112 if (image_state->IsSwapchainImage() && image_state->owned_by_swapchain) {
sfricke-samsung73452522021-06-17 08:44:46 -07002113 skip |= LogError(device, "VUID-vkDestroyImage-image-04882",
sfricke-samsung9056cc12021-04-18 22:51:00 -07002114 "vkDestroyImage(): %s is a presentable image and it is controlled by the implementation and is "
2115 "destroyed with vkDestroySwapchainKHR.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002116 report_data->FormatHandle(image_state->image()).c_str());
sfricke-samsung9056cc12021-04-18 22:51:00 -07002117 }
Jeremy Gebben9f537102021-10-05 16:37:12 -06002118 skip |= ValidateObjectNotInUse(image_state.get(), "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002119 }
2120 return skip;
2121}
2122
John Zulauf7eeb6f72019-06-17 11:56:36 -06002123void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
2124 // Clean up validation specific data
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002125 auto image_state = Get<IMAGE_STATE>(image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07002126 qfo_release_image_barrier_map.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06002127 // Clean up generic image state
2128 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002129}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002130
sfricke-samsungcd924d92020-05-20 23:51:17 -07002131bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range,
2132 const char *param_name) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002133 bool skip = false;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002134 const VkImage image = image_state->image();
sfricke-samsungcd924d92020-05-20 23:51:17 -07002135 const VkFormat format = image_state->createInfo.format;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002136
2137 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002138 skip |= LogError(image, "VUID-vkCmdClearColorImage-aspectMask-02498",
2139 "vkCmdClearColorImage(): %s.aspectMasks must only be set to VK_IMAGE_ASPECT_COLOR_BIT.", param_name);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002140 }
2141
sfricke-samsungcd924d92020-05-20 23:51:17 -07002142 if (FormatIsDepthOrStencil(format)) {
2143 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2144 "vkCmdClearColorImage(): %s called with image %s which has a depth/stencil format (%s).", param_name,
2145 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
2146 } else if (FormatIsCompressed(format)) {
2147 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2148 "vkCmdClearColorImage(): %s called with image %s which has a compressed format (%s).", param_name,
2149 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002150 }
2151
2152 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002153 skip |=
2154 LogError(image, "VUID-vkCmdClearColorImage-image-00002",
2155 "vkCmdClearColorImage() %s called with image %s which was created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.",
2156 param_name, report_data->FormatHandle(image).c_str());
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002157 }
2158 return skip;
2159}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002160
John Zulauf07288512019-07-05 11:09:50 -06002161bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
2162 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
2163 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002164 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002165 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2166 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002167 skip |= LogError(image_state->image(), "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002168 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2169 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002170 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002171
2172 } else {
2173 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
sfricke-samsung45996a42021-09-16 13:45:27 -07002174 if (!IsExtEnabled(device_extensions.vk_khr_shared_presentable_image)) {
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002175 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002176 skip |= LogError(image_state->image(), "VUID-vkCmdClearColorImage-imageLayout-00005",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002177 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2178 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002179 }
2180 } else {
2181 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
2182 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002183 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002184 image_state->image(), "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002185 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
2186 func_name, string_VkImageLayout(dest_image_layout));
2187 }
2188 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002189 }
2190
John Zulauff660ad62019-03-23 07:16:05 -06002191 // Cast to const to prevent creation at validate time.
Jeremy Gebben6335df62021-11-01 10:50:13 -06002192 const auto *subresource_map = cb_node->GetImageSubresourceLayoutMap(*image_state);
John Zulauff660ad62019-03-23 07:16:05 -06002193 if (subresource_map) {
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -06002194 LayoutUseCheckAndMessage layout_check(dest_image_layout);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002195 auto normalized_isr = image_state->NormalizeSubresourceRange(range);
Tony Barbour55688172020-09-23 15:19:50 -07002196 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
2197 // the next "constant value" range
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -06002198 skip |= subresource_map->AnyInRange(
Jeremy Gebbencb13f0f2022-07-15 15:48:05 -06002199 normalized_isr, [this, cb_node, &layout_check, func_name](const LayoutRange &range, const LayoutEntry &state) {
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -06002200 bool subres_skip = false;
2201 if (!layout_check.Check(state)) {
2202 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
2203 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2204 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
2205 } else {
2206 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
2207 }
2208 subres_skip |= LogError(cb_node->commandBuffer(), error_code,
2209 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
2210 func_name, string_VkImageLayout(layout_check.expected_layout), layout_check.message,
2211 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002212 }
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -06002213 return subres_skip;
2214 });
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002215 }
2216
2217 return skip;
2218}
2219
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002220bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2221 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002222 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002223 bool skip = false;
2224 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07002225 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07002226 auto image_state = Get<IMAGE_STATE>(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002227 if (cb_node && image_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06002228 skip |= ValidateMemoryIsBoundToImage(image_state.get(), "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
2229 skip |= ValidateCmd(cb_node.get(), CMD_CLEARCOLORIMAGE);
sfricke-samsung45996a42021-09-16 13:45:27 -07002230 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Lionel Landwerlin21719f62021-12-09 11:40:09 +02002231 skip |= ValidateImageFormatFeatureFlags(image_state.get(), VK_FORMAT_FEATURE_2_TRANSFER_DST_BIT_KHR,
2232 "vkCmdClearColorImage", "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04002233 }
Jeremy Gebben9f537102021-10-05 16:37:12 -06002234 skip |= ValidateProtectedImage(cb_node.get(), image_state.get(), "vkCmdClearColorImage()",
2235 "VUID-vkCmdClearColorImage-commandBuffer-01805");
2236 skip |= ValidateUnprotectedImage(cb_node.get(), image_state.get(), "vkCmdClearColorImage()",
sfricke-samsung022fa252020-07-24 03:26:16 -07002237 "VUID-vkCmdClearColorImage-commandBuffer-01806");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002238 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002239 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Jeremy Gebben9f537102021-10-05 16:37:12 -06002240 skip |= ValidateCmdClearColorSubresourceRange(image_state.get(), pRanges[i], param_name.c_str());
2241 skip |= ValidateImageAttributes(image_state.get(), pRanges[i], param_name.c_str());
2242 skip |= VerifyClearImageLayout(cb_node.get(), image_state.get(), pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002243 }
sfricke-samsunge775d492020-02-28 09:02:25 -08002244 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsung10b35ce2021-09-29 08:50:20 -07002245 if (FormatRequiresYcbcrConversionExplicitly(image_state->createInfo.format)) {
sfricke-samsunge775d492020-02-28 09:02:25 -08002246 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
2247 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
2248 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
2249 string_VkFormat(image_state->createInfo.format));
2250 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002251 }
2252 return skip;
2253}
2254
John Zulaufeabb4462019-07-05 14:13:03 -06002255void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2256 const VkClearColorValue *pColor, uint32_t rangeCount,
2257 const VkImageSubresourceRange *pRanges) {
2258 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
2259
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07002260 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002261 auto image_state = Get<IMAGE_STATE>(image);
John Zulaufeabb4462019-07-05 14:13:03 -06002262 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002263 for (uint32_t i = 0; i < rangeCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06002264 cb_node->SetImageInitialLayout(image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002265 }
2266 }
2267}
2268
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002269bool CoreChecks::ValidateClearDepthStencilValue(VkCommandBuffer commandBuffer, VkClearDepthStencilValue clearValue,
2270 const char *apiName) const {
2271 bool skip = false;
2272
2273 // The extension was not created with a feature bit whichs prevents displaying the 2 variations of the VUIDs
sfricke-samsung45996a42021-09-16 13:45:27 -07002274 if (!IsExtEnabled(device_extensions.vk_ext_depth_range_unrestricted)) {
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002275 if (!(clearValue.depth >= 0.0) || !(clearValue.depth <= 1.0)) {
2276 // Also VUID-VkClearDepthStencilValue-depth-00022
2277 skip |= LogError(commandBuffer, "VUID-VkClearDepthStencilValue-depth-02506",
2278 "%s: VK_EXT_depth_range_unrestricted extension is not enabled and VkClearDepthStencilValue::depth "
2279 "(=%f) is not within the [0.0, 1.0] range.",
2280 apiName, clearValue.depth);
2281 }
2282 }
2283
2284 return skip;
2285}
2286
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002287bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2288 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002289 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002290 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002291
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002292 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07002293 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07002294 auto image_state = Get<IMAGE_STATE>(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002295 if (cb_node && image_state) {
sfricke-samsung30e325a2020-07-25 12:56:13 -07002296 const VkFormat image_format = image_state->createInfo.format;
Jeremy Gebben9f537102021-10-05 16:37:12 -06002297 skip |= ValidateMemoryIsBoundToImage(image_state.get(), "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002298 "VUID-vkCmdClearDepthStencilImage-image-00010");
Jeremy Gebben9f537102021-10-05 16:37:12 -06002299 skip |= ValidateCmd(cb_node.get(), CMD_CLEARDEPTHSTENCILIMAGE);
sfricke-samsung45996a42021-09-16 13:45:27 -07002300 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Lionel Landwerlin21719f62021-12-09 11:40:09 +02002301 skip |= ValidateImageFormatFeatureFlags(image_state.get(), VK_FORMAT_FEATURE_2_TRANSFER_DST_BIT_KHR,
Jeremy Gebben9f537102021-10-05 16:37:12 -06002302 "vkCmdClearDepthStencilImage", "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04002303 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002304 skip |= ValidateClearDepthStencilValue(commandBuffer, *pDepthStencil, "vkCmdClearDepthStencilImage()");
Jeremy Gebben9f537102021-10-05 16:37:12 -06002305 skip |= ValidateProtectedImage(cb_node.get(), image_state.get(), "vkCmdClearDepthStencilImage()",
sfricke-samsung022fa252020-07-24 03:26:16 -07002306 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01807");
Jeremy Gebben9f537102021-10-05 16:37:12 -06002307 skip |= ValidateUnprotectedImage(cb_node.get(), image_state.get(), "vkCmdClearDepthStencilImage()",
sfricke-samsung022fa252020-07-24 03:26:16 -07002308 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01808");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002309
2310 bool any_include_aspect_depth_bit = false;
2311 bool any_include_aspect_stencil_bit = false;
2312
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002313 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002314 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Jeremy Gebben9f537102021-10-05 16:37:12 -06002315 skip |= ValidateCmdClearDepthSubresourceRange(image_state.get(), pRanges[i], param_name.c_str());
2316 skip |=
2317 VerifyClearImageLayout(cb_node.get(), image_state.get(), pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002318 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06002319 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
2320 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002321 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-aspectMask-02824",
2322 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask can only be VK_IMAGE_ASPECT_DEPTH_BIT "
2323 "and/or VK_IMAGE_ASPECT_STENCIL_BIT.",
2324 i);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002325 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002326 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
2327 any_include_aspect_depth_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002328 if (FormatHasDepth(image_format) == false) {
2329 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02826",
2330 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_DEPTH_BIT but %s "
2331 "doesn't have a depth component.",
2332 i, string_VkFormat(image_format));
2333 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002334 }
2335 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
2336 any_include_aspect_stencil_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002337 if (FormatHasStencil(image_format) == false) {
2338 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02825",
2339 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_STENCIL_BIT but "
2340 "%s doesn't have a stencil component.",
2341 i, string_VkFormat(image_format));
2342 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002343 }
2344 }
2345 if (any_include_aspect_stencil_bit) {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07002346 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05002347 if (image_stencil_struct != nullptr) {
2348 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
2349 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002350 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
2351 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
2352 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
2353 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002354 }
2355 } else {
2356 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002357 skip |= LogError(
2358 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05002359 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
2360 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
2361 "in VkImageCreateInfo::usage used to create image");
2362 }
2363 }
2364 }
2365 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002366 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
2367 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
2368 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002369 }
sfricke-samsung30e325a2020-07-25 12:56:13 -07002370 if (image_state && !FormatIsDepthOrStencil(image_format)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002371 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014",
2372 "vkCmdClearDepthStencilImage(): called with image %s which doesn't have a depth/stencil format (%s).",
sfricke-samsung30e325a2020-07-25 12:56:13 -07002373 report_data->FormatHandle(image).c_str(), string_VkFormat(image_format));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002374 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002375 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002376 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009",
2377 "vkCmdClearDepthStencilImage(): called with image %s which was not created with the "
2378 "VK_IMAGE_USAGE_TRANSFER_DST_BIT set.",
2379 report_data->FormatHandle(image).c_str());
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002380 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002381 }
2382 return skip;
2383}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002384
John Zulaufeabb4462019-07-05 14:13:03 -06002385void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2386 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
2387 const VkImageSubresourceRange *pRanges) {
2388 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07002389
2390 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002391 auto image_state = Get<IMAGE_STATE>(image);
John Zulaufeabb4462019-07-05 14:13:03 -06002392 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002393 for (uint32_t i = 0; i < rangeCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06002394 cb_node->SetImageInitialLayout(image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002395 }
2396 }
2397}
2398
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002399// Returns true if [x, xoffset] and [y, yoffset] overlap
2400static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
2401 bool result = false;
2402 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
2403 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
2404
2405 if (intersection_max > intersection_min) {
2406 result = true;
2407 }
2408 return result;
2409}
2410
Aitor Camacho82c1a7a2022-07-05 22:21:19 +02002411// Returns true if source area of first vkImageCopy/vkImageCopy2KHR region intersects dest area of second region
2412// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
2413template <typename RegionType>
2414static bool RegionIntersects(const RegionType *region0, const RegionType *region1, VkImageType type, bool is_multiplane) {
2415 bool result = false;
2416
2417 // Separate planes within a multiplane image cannot intersect
2418 if (is_multiplane && (region0->srcSubresource.aspectMask != region1->dstSubresource.aspectMask)) {
2419 return result;
2420 }
2421
2422 if ((region0->srcSubresource.mipLevel == region1->dstSubresource.mipLevel) &&
2423 (RangesIntersect(region0->srcSubresource.baseArrayLayer, region0->srcSubresource.layerCount,
2424 region1->dstSubresource.baseArrayLayer, region1->dstSubresource.layerCount))) {
2425 result = true;
2426 switch (type) {
2427 case VK_IMAGE_TYPE_3D:
2428 result &= RangesIntersect(region0->srcOffset.z, region0->extent.depth, region1->dstOffset.z, region1->extent.depth);
2429 // fall through
2430 case VK_IMAGE_TYPE_2D:
2431 result &=
2432 RangesIntersect(region0->srcOffset.y, region0->extent.height, region1->dstOffset.y, region1->extent.height);
2433 // fall through
2434 case VK_IMAGE_TYPE_1D:
2435 result &= RangesIntersect(region0->srcOffset.x, region0->extent.width, region1->dstOffset.x, region1->extent.width);
2436 break;
2437 default:
2438 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2439 assert(false);
2440 }
2441 }
2442 return result;
2443}
2444
aitor-lunarg607fe732022-03-31 22:00:08 +02002445template <typename RegionType>
2446static bool RegionIntersectsBlit(const RegionType *region0, const RegionType *region1, VkImageType type, bool is_multiplane) {
2447 bool result = false;
2448
2449 // Separate planes within a multiplane image cannot intersect
2450 if (is_multiplane && (region0->srcSubresource.aspectMask != region1->dstSubresource.aspectMask)) {
2451 return result;
2452 }
2453
2454 if ((region0->srcSubresource.mipLevel == region1->dstSubresource.mipLevel) &&
2455 (RangesIntersect(region0->srcSubresource.baseArrayLayer, region0->srcSubresource.layerCount,
2456 region1->dstSubresource.baseArrayLayer, region1->dstSubresource.layerCount))) {
2457 result = true;
2458 switch (type) {
2459 case VK_IMAGE_TYPE_3D:
2460 result &= RangesIntersect(region0->srcOffsets[0].z, region0->srcOffsets[1].z - region0->srcOffsets[0].z,
2461 region1->dstOffsets[0].z, region1->dstOffsets[1].z - region1->dstOffsets[0].z);
2462 // fall through
2463 case VK_IMAGE_TYPE_2D:
2464 result &= RangesIntersect(region0->srcOffsets[0].y, region0->srcOffsets[1].y - region0->srcOffsets[0].y,
2465 region1->dstOffsets[0].y, region1->dstOffsets[1].y - region1->dstOffsets[0].y);
2466 // fall through
2467 case VK_IMAGE_TYPE_1D:
2468 result &= RangesIntersect(region0->srcOffsets[0].x, region0->srcOffsets[1].x - region0->srcOffsets[0].x,
2469 region1->dstOffsets[0].x, region1->dstOffsets[1].x - region1->dstOffsets[0].x);
2470 break;
2471 default:
2472 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2473 assert(false);
2474 }
2475 }
2476 return result;
2477}
2478
Dave Houltonfc1a4052017-04-27 14:32:45 -06002479// Returns non-zero if offset and extent exceed image extents
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002480static const uint32_t kXBit = 1;
2481static const uint32_t kYBit = 2;
2482static const uint32_t kZBit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002483static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002484 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002485 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002486 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2487 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002488 result |= kZBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002489 }
2490 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2491 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002492 result |= kYBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002493 }
2494 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2495 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002496 result |= kXBit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002497 }
2498 return result;
2499}
2500
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002501// Test if two VkExtent3D structs are equivalent
2502static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2503 bool result = true;
2504 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2505 (extent->depth != other_extent->depth)) {
2506 result = false;
2507 }
2508 return result;
2509}
2510
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002511// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002512static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002513 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2514}
2515
2516// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002517VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002518 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2519 VkExtent3D granularity = {0, 0, 0};
Jeremy Gebbencd7fa282021-10-27 10:25:32 -06002520 const auto pool = cb_node->command_pool;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002521 if (pool) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002522 granularity = physical_device_state->queue_family_properties[pool->queueFamilyIndex].minImageTransferGranularity;
sfricke-samsung01da6312021-10-20 07:51:32 -07002523 if (FormatIsBlockedImage(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002524 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002525 granularity.width *= block_size.width;
2526 granularity.height *= block_size.height;
2527 }
2528 }
2529 return granularity;
2530}
2531
2532// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2533static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2534 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002535 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2536 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002537 valid = false;
2538 }
2539 return valid;
2540}
2541
2542// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002543bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002544 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002545 bool skip = false;
2546 VkExtent3D offset_extent = {};
2547 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2548 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2549 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002550 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002551 // If the queue family image transfer granularity is (0, 0, 0), then the offset must always be (0, 0, 0)
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002552 if (IsExtentAllZeroes(&offset_extent) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002553 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002554 "%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 "
2555 "image transfer granularity is (w=0, h=0, d=0).",
2556 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002557 }
2558 } else {
2559 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2560 // integer multiples of the image transfer granularity.
2561 if (IsExtentAligned(&offset_extent, granularity) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002562 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002563 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2564 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2565 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2566 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002567 }
2568 }
2569 return skip;
2570}
2571
2572// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002573bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002574 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002575 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002576 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002577 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002578 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2579 // subresource extent.
2580 if (IsExtentEqual(extent, subresource_extent) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002581 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002582 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2583 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2584 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2585 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002586 }
2587 } else {
2588 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2589 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2590 // subresource extent dimensions.
2591 VkExtent3D offset_extent_sum = {};
2592 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2593 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2594 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002595 bool x_ok = true;
2596 bool y_ok = true;
2597 bool z_ok = true;
2598 switch (image_type) {
2599 case VK_IMAGE_TYPE_3D:
2600 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2601 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002602 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002603 case VK_IMAGE_TYPE_2D:
2604 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2605 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002606 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002607 case VK_IMAGE_TYPE_1D:
2608 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2609 (subresource_extent->width == offset_extent_sum.width));
2610 break;
2611 default:
2612 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2613 assert(false);
2614 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002615 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002616 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002617 LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002618 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2619 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2620 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2621 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2622 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2623 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002624 }
2625 }
2626 return skip;
2627}
2628
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002629bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002630 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002631 bool skip = false;
2632 if (mip_level >= img->createInfo.mipLevels) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002633 skip |= LogError(cb_node->commandBuffer(), vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2634 function, i, member, mip_level, report_data->FormatHandle(img->image()).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002635 }
2636 return skip;
2637}
2638
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002639bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002640 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002641 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002642 bool skip = false;
2643 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2644 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002645 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002646 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2647 "%u, but provided %s has %u array layers.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002648 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image()).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002649 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002650 }
2651 return skip;
2652}
2653
Tony Barbour845d29b2021-11-09 11:43:14 -07002654// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy/VkBufferImageCopy2 structure
sfricke-samsung71f04e32022-03-16 01:21:21 -05002655template <typename RegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002656bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
sfricke-samsung71f04e32022-03-16 01:21:21 -05002657 const RegionType *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002658 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002659 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002660 VkExtent3D granularity = GetScaledItg(cb_node, img);
2661 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002662 VkExtent3D subresource_extent = img->GetSubresourceExtent(region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002663 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002664 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002665 return skip;
2666}
2667
Jeff Leger178b1e52020-10-05 12:22:23 -04002668// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy/VkImageCopy2KHR structure
2669template <typename RegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002670bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002671 const IMAGE_STATE *dst_img, const RegionType *region,
2672 const uint32_t i, const char *function,
Tony-LunarGb61514a2021-11-02 12:36:51 -06002673 CMD_TYPE cmd_type) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002674 bool skip = false;
Tony-LunarGb61514a2021-11-02 12:36:51 -06002675 const bool is_2 = (cmd_type == CMD_COPYIMAGE2KHR || cmd_type == CMD_COPYIMAGE2);
Jeff Leger178b1e52020-10-05 12:22:23 -04002676 const char *vuid;
2677
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002678 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002679 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
Tony-LunarGb61514a2021-11-02 12:36:51 -06002680 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
Jeff Leger178b1e52020-10-05 12:22:23 -04002681 skip |= CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", vuid);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002682 VkExtent3D subresource_extent = src_img->GetSubresourceExtent(region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002683 const VkExtent3D extent = region->extent;
Tony-LunarGb61514a2021-11-02 12:36:51 -06002684 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002685 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04002686 i, function, "extent", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002687
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002688 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002689 granularity = GetScaledItg(cb_node, dst_img);
Tony-LunarGb61514a2021-11-02 12:36:51 -06002690 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
Jeff Leger178b1e52020-10-05 12:22:23 -04002691 skip |= CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", vuid);
Dave Houltonee281a52017-12-08 13:51:02 -07002692 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002693 const VkExtent3D dest_effective_extent =
2694 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002695 subresource_extent = dst_img->GetSubresourceExtent(region->dstSubresource);
Tony-LunarGb61514a2021-11-02 12:36:51 -06002696 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002697 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Jeff Leger178b1e52020-10-05 12:22:23 -04002698 dst_img->createInfo.imageType, i, function, "extent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002699 return skip;
2700}
2701
Jeff Leger178b1e52020-10-05 12:22:23 -04002702// Validate contents of a VkImageCopy or VkImageCopy2KHR struct
sfricke-samsung71f04e32022-03-16 01:21:21 -05002703template <typename RegionType>
2704bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const RegionType *pRegions, const IMAGE_STATE *src_state,
2705 const IMAGE_STATE *dst_state, CMD_TYPE cmd_type) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002706 bool skip = false;
Tony-LunarGb61514a2021-11-02 12:36:51 -06002707 const bool is_2 = (cmd_type == CMD_COPYIMAGE2KHR || cmd_type == CMD_COPYIMAGE2);
2708 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04002709 const char *vuid;
Dave Houlton6f9059e2017-05-02 17:15:13 -06002710
2711 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05002712 const RegionType region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002713
2714 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002715 const VkExtent3D src_copy_extent = region.extent;
2716 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002717 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2718
Dave Houlton6f9059e2017-05-02 17:15:13 -06002719 bool slice_override = false;
2720 uint32_t depth_slices = 0;
2721
2722 // Special case for copying between a 1D/2D array and a 3D image
2723 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2724 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002725 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002726 slice_override = (depth_slices != 1);
2727 } 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 -07002728 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002729 slice_override = (depth_slices != 1);
2730 }
2731
2732 // Do all checks on source image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002733 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002734 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002735 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-00146" : "VUID-vkCmdCopyImage-srcImage-00146";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002736 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002737 "%s: pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2738 "be 0 and 1, respectively.",
2739 func_name, i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002740 }
2741 }
2742
Dave Houlton533be9f2018-03-26 17:08:30 -06002743 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 -06002744 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01785" : "VUID-vkCmdCopyImage-srcImage-01785";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002745 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002746 "%s: pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002747 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002748 func_name, i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002749 }
2750
Dave Houlton533be9f2018-03-26 17:08:30 -06002751 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002752 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01787" : "VUID-vkCmdCopyImage-srcImage-01787";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002753 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 -04002754 func_name, i, region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002755 }
2756
sfricke-samsung01da6312021-10-20 07:51:32 -07002757 // Source checks that apply only to "blocked images"
2758 if (FormatIsBlockedImage(src_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002759 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002760 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002761 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2762 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2763 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002764 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01727" : "VUID-vkCmdCopyImage-srcImage-01727";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002765 skip |= LogError(src_state->image(), vuid,
sfricke-samsung01da6312021-10-20 07:51:32 -07002766 "%s: pRegion[%d] srcOffset (%d, %d) must be multiples of the blocked image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002767 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002768 func_name, i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002769 }
2770
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002771 const VkExtent3D mip_extent = src_state->GetSubresourceExtent(region.srcSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07002772 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2773 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002774 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01728" : "VUID-vkCmdCopyImage-srcImage-01728";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002775 skip |= LogError(src_state->image(), vuid,
sfricke-samsung01da6312021-10-20 07:51:32 -07002776 "%s: pRegion[%d] extent width (%d) must be a multiple of the blocked texture block "
Jeff Leger178b1e52020-10-05 12:22:23 -04002777 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2778 func_name, i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002779 }
2780
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002781 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002782 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2783 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002784 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01729" : "VUID-vkCmdCopyImage-srcImage-01729";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002785 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002786 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2787 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2788 func_name, i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002789 }
2790
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002791 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002792 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2793 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002794 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01730" : "VUID-vkCmdCopyImage-srcImage-01730";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002795 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002796 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2797 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2798 func_name, i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002799 }
2800 } // Compressed
2801
2802 // Do all checks on dest image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002803 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002804 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002805 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-00152" : "VUID-vkCmdCopyImage-dstImage-00152";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002806 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002807 "%s: pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002808 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002809 func_name, i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002810 }
2811 }
2812
Dave Houlton533be9f2018-03-26 17:08:30 -06002813 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 -06002814 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01786" : "VUID-vkCmdCopyImage-dstImage-01786";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002815 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002816 "%s: pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2817 "and 1, respectively.",
2818 func_name, i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002819 }
2820
Dave Houlton533be9f2018-03-26 17:08:30 -06002821 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002822 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01788" : "VUID-vkCmdCopyImage-dstImage-01788";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002823 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 -04002824 func_name, i, region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002825 }
2826
sfricke-samsung30b094c2020-05-30 11:42:11 -07002827 // Handle difference between Maintenance 1
sfricke-samsung45996a42021-09-16 13:45:27 -07002828 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002829 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2830 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002831 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-04443" : "VUID-vkCmdCopyImage-srcImage-04443";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002832 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002833 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2834 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2835 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002836 }
2837 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002838 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002839 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002840 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-04444" : "VUID-vkCmdCopyImage-dstImage-04444";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002841 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002842 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2843 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2844 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002845 }
2846 }
2847 } else { // Pre maint 1
2848 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002849 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002850 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002851 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002852 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and "
sfricke-samsung30b094c2020-05-30 11:42:11 -07002853 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2854 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002855 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002856 }
Dave Houltonee281a52017-12-08 13:51:02 -07002857 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002858 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002859 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002860 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002861 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2862 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002863 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002864 }
2865 }
2866 }
2867
sfricke-samsung01da6312021-10-20 07:51:32 -07002868 // Dest checks that apply only to "blocked images"
2869 if (FormatIsBlockedImage(dst_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002870 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002871
2872 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002873 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2874 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2875 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002876 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01731" : "VUID-vkCmdCopyImage-dstImage-01731";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002877 skip |= LogError(dst_state->image(), vuid,
sfricke-samsung01da6312021-10-20 07:51:32 -07002878 "%s: pRegion[%d] dstOffset (%d, %d) must be multiples of the blocked image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002879 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002880 func_name, i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002881 }
2882
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002883 const VkExtent3D mip_extent = dst_state->GetSubresourceExtent(region.dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07002884 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2885 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002886 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01732" : "VUID-vkCmdCopyImage-dstImage-01732";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002887 skip |= LogError(dst_state->image(), vuid,
sfricke-samsung01da6312021-10-20 07:51:32 -07002888 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the blocked texture "
Jeff Leger178b1e52020-10-05 12:22:23 -04002889 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2890 func_name, i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002891 }
2892
Dave Houltonee281a52017-12-08 13:51:02 -07002893 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2894 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2895 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002896 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01733" : "VUID-vkCmdCopyImage-dstImage-01733";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002897 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002898 "%s: pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002899 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2900 "height (%d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002901 func_name, i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002902 }
2903
Dave Houltonee281a52017-12-08 13:51:02 -07002904 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2905 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2906 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002907 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01734" : "VUID-vkCmdCopyImage-dstImage-01734";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002908 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002909 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2910 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2911 func_name, i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002912 }
2913 } // Compressed
2914 }
2915 return skip;
2916}
2917
Jeff Leger178b1e52020-10-05 12:22:23 -04002918template <typename RegionType>
2919bool CoreChecks::ValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2920 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Tony-LunarGb61514a2021-11-02 12:36:51 -06002921 const RegionType *pRegions, CMD_TYPE cmd_type) const {
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07002922 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07002923 auto src_image_state = Get<IMAGE_STATE>(srcImage);
2924 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Aitor Camacho82c1a7a2022-07-05 22:21:19 +02002925 const VkFormat src_format = src_image_state->createInfo.format;
2926 const VkFormat dst_format = dst_image_state->createInfo.format;
2927 const bool is_2 = (cmd_type == CMD_COPYIMAGE2KHR || cmd_type == CMD_COPYIMAGE2);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002928 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002929
sfricke-samsung85584a72021-09-30 21:43:38 -07002930 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04002931 const char *vuid;
Tony-LunarGb61514a2021-11-02 12:36:51 -06002932 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state.get(), dst_image_state.get(), cmd_type);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002933
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002934 VkCommandBuffer command_buffer = cb_node->commandBuffer();
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002935
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002936 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002937 const RegionType region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002938
2939 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2940 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08002941 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07002942
Dave Houlton6f9059e2017-05-02 17:15:13 -06002943 bool slice_override = false;
2944 uint32_t depth_slices = 0;
2945
2946 // Special case for copying between a 1D/2D array and a 3D image
2947 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2948 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2949 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002950 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002951 slice_override = (depth_slices != 1);
2952 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2953 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002954 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002955 slice_override = (depth_slices != 1);
2956 }
2957
Jeremy Gebben9f537102021-10-05 16:37:12 -06002958 skip |= ValidateImageSubresourceLayers(cb_node.get(), &region.srcSubresource, func_name, "srcSubresource", i);
2959 skip |= ValidateImageSubresourceLayers(cb_node.get(), &region.dstSubresource, func_name, "dstSubresource", i);
Tony-LunarGb61514a2021-11-02 12:36:51 -06002960 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcSubresource-01696" : "VUID-vkCmdCopyImage-srcSubresource-01696";
2961 skip |=
2962 ValidateImageMipLevel(cb_node.get(), src_image_state.get(), region.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
2963 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstSubresource-01697" : "VUID-vkCmdCopyImage-dstSubresource-01697";
2964 skip |=
2965 ValidateImageMipLevel(cb_node.get(), dst_image_state.get(), region.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
2966 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcSubresource-01698" : "VUID-vkCmdCopyImage-srcSubresource-01698";
Jeremy Gebben9f537102021-10-05 16:37:12 -06002967 skip |= ValidateImageArrayLayerRange(cb_node.get(), src_image_state.get(), region.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002968 region.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
Tony-LunarGb61514a2021-11-02 12:36:51 -06002969 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstSubresource-01699" : "VUID-vkCmdCopyImage-dstSubresource-01699";
Jeremy Gebben9f537102021-10-05 16:37:12 -06002970 skip |= ValidateImageArrayLayerRange(cb_node.get(), dst_image_state.get(), region.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002971 region.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002972
sfricke-samsung45996a42021-09-16 13:45:27 -07002973 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002974 // No chance of mismatch if we're overriding depth slice count
2975 if (!slice_override) {
2976 // The number of depth slices in srcSubresource and dstSubresource must match
2977 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2978 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002979 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2980 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002981 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002982 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2983 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002984 if (src_slices != dst_slices) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002985 vuid = is_2 ? "VUID-VkImageCopy2-extent-00140" : "VUID-VkImageCopy-extent-00140";
Jeff Leger178b1e52020-10-05 12:22:23 -04002986 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002987 "%s: number of depth slices in source (%u) and destination (%u) subresources for pRegions[%u] "
2988 "do not match.",
2989 func_name, src_slices, dst_slices, i);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002990 }
2991 }
2992 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002993 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002994 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002995 vuid = is_2 ? "VUID-VkImageCopy2-layerCount-00138" : "VUID-VkImageCopy-layerCount-00138";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002996 skip |=
2997 LogError(command_buffer, vuid,
2998 "%s: number of layers in source (%u) and destination (%u) subresources for pRegions[%u] do not match",
2999 func_name, region.srcSubresource.layerCount, region.dstSubresource.layerCount, i);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06003000 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003001 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003002
Dave Houltonc991cc92018-03-06 11:08:51 -07003003 // Do multiplane-specific checks, if extension enabled
sfricke-samsung45996a42021-09-16 13:45:27 -07003004 if (IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)) {
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003005 if ((!FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format))) {
3006 // If neither image is multi-plane the aspectMask member of src and dst must match
3007 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003008 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01551" : "VUID-vkCmdCopyImage-srcImage-01551";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003009 skip |= LogError(command_buffer, vuid,
3010 "%s: Copy between non-multiplane images with differing aspectMasks in pRegions[%u] with "
3011 "source (0x%x) destination (0x%x).",
3012 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
3013 }
3014 } else {
3015 // Source image multiplane checks
3016 uint32_t planes = FormatPlaneCount(src_format);
3017 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
3018 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003019 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01552" : "VUID-vkCmdCopyImage-srcImage-01552";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003020 skip |= LogError(command_buffer, vuid,
3021 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
3022 i, aspect);
3023 }
3024 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
3025 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003026 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01553" : "VUID-vkCmdCopyImage-srcImage-01553";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003027 skip |= LogError(command_buffer, vuid,
3028 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
3029 i, aspect);
3030 }
3031 // Single-plane to multi-plane
3032 if ((!FormatIsMultiplane(src_format)) && (FormatIsMultiplane(dst_format)) &&
3033 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003034 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01557" : "VUID-vkCmdCopyImage-dstImage-01557";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003035 skip |= LogError(command_buffer, vuid,
3036 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
3037 func_name, i, aspect);
3038 }
Dave Houltonc991cc92018-03-06 11:08:51 -07003039
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003040 // Dest image multiplane checks
3041 planes = FormatPlaneCount(dst_format);
3042 aspect = region.dstSubresource.aspectMask;
3043 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003044 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01554" : "VUID-vkCmdCopyImage-dstImage-01554";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003045 skip |= LogError(command_buffer, vuid,
3046 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
3047 i, aspect);
3048 }
3049 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
3050 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003051 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01555" : "VUID-vkCmdCopyImage-dstImage-01555";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003052 skip |= LogError(command_buffer, vuid,
3053 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
3054 i, aspect);
3055 }
3056 // Multi-plane to single-plane
3057 if ((FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format)) &&
3058 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003059 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01556" : "VUID-vkCmdCopyImage-srcImage-01556";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003060 skip |= LogError(command_buffer, vuid,
3061 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
3062 func_name, i, aspect);
3063 }
3064 }
3065 } else {
3066 // !vk_khr_sampler_ycbcr_conversion
Dave Houltonf5217612018-02-02 16:18:52 -07003067 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
3068 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003069 vuid = is_2 ? "VUID-VkImageCopy2-aspectMask-00137" : "VUID-VkImageCopy-aspectMask-00137";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003070 skip |= LogError(
3071 command_buffer, vuid,
3072 "%s: Copy between images with differing aspectMasks in pRegions[%u] with source (0x%x) destination (0x%x).",
3073 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
Dave Houltonf5217612018-02-02 16:18:52 -07003074 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003075 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003076
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003077 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08003078 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003079 vuid = is_2 ? "VUID-VkCopyImageInfo2-aspectMask-00142" : "VUID-vkCmdCopyImage-aspectMask-00142";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003080 skip |=
3081 LogError(command_buffer, vuid,
3082 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) cannot specify aspects not present in source image.",
3083 func_name, i, region.srcSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003084 }
3085
3086 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08003087 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003088 vuid = is_2 ? "VUID-VkCopyImageInfo2-aspectMask-00143" : "VUID-vkCmdCopyImage-aspectMask-00143";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003089 skip |= LogError(
3090 command_buffer, vuid,
3091 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) cannot specify aspects not present in destination image.",
3092 func_name, i, region.dstSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003093 }
3094
sfricke-samsung5f11b0e2022-03-22 14:12:15 -05003095 // Make sure not a empty region
3096 if (src_copy_extent.width == 0) {
3097 vuid = is_2 ? "VUID-VkImageCopy2-extent-06668" : "VUID-VkImageCopy-extent-06668";
3098 skip |=
3099 LogError(command_buffer, vuid,
3100 "%s: pRegion[%" PRIu32 "] extent.width must not be zero as empty copies are not allowed.", func_name, i);
3101 }
3102 if (src_copy_extent.height == 0) {
3103 vuid = is_2 ? "VUID-VkImageCopy2-extent-06669" : "VUID-VkImageCopy-extent-06669";
3104 skip |=
3105 LogError(command_buffer, vuid,
3106 "%s: pRegion[%" PRIu32 "] extent.height must not be zero as empty copies are not allowed.", func_name, i);
3107 }
3108 if (src_copy_extent.depth == 0) {
3109 vuid = is_2 ? "VUID-VkImageCopy2-extent-06670" : "VUID-VkImageCopy-extent-06670";
3110 skip |=
3111 LogError(command_buffer, vuid,
3112 "%s: pRegion[%" PRIu32 "] extent.depth must not be zero as empty copies are not allowed.", func_name, i);
3113 }
3114
Dave Houltonfc1a4052017-04-27 14:32:45 -06003115 // Each dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003116 VkExtent3D subresource_extent = src_image_state->GetSubresourceExtent(region.srcSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07003117 if (slice_override) src_copy_extent.depth = depth_slices;
3118 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003119 if (extent_check & kXBit) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003120 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcOffset-00144" : "VUID-vkCmdCopyImage-srcOffset-00144";
Jeff Leger178b1e52020-10-05 12:22:23 -04003121 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003122 "%s: Source image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003123 "width [%1d].",
3124 func_name, i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003125 }
3126
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003127 if (extent_check & kYBit) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003128 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcOffset-00145" : "VUID-vkCmdCopyImage-srcOffset-00145";
Jeff Leger178b1e52020-10-05 12:22:23 -04003129 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003130 "%s: Source image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003131 "height [%1d].",
3132 func_name, i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003133 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003134 if (extent_check & kZBit) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003135 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcOffset-00147" : "VUID-vkCmdCopyImage-srcOffset-00147";
Jeff Leger178b1e52020-10-05 12:22:23 -04003136 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003137 "%s: Source image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003138 "depth [%1d].",
3139 func_name, i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003140 }
3141
Dave Houltonee281a52017-12-08 13:51:02 -07003142 // Adjust dest extent if necessary
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003143 subresource_extent = dst_image_state->GetSubresourceExtent(region.dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07003144 if (slice_override) dst_copy_extent.depth = depth_slices;
3145
3146 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003147 if (extent_check & kXBit) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003148 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstOffset-00150" : "VUID-vkCmdCopyImage-dstOffset-00150";
Jeff Leger178b1e52020-10-05 12:22:23 -04003149 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003150 "%s: Dest image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003151 "width [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003152 func_name, i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003153 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003154 if (extent_check & kYBit) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003155 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstOffset-00151" : "VUID-vkCmdCopyImage-dstOffset-00151";
Jeff Leger178b1e52020-10-05 12:22:23 -04003156 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003157 "%s): Dest image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003158 "height [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003159 func_name, i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003160 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003161 if (extent_check & kZBit) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003162 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstOffset-00153" : "VUID-vkCmdCopyImage-dstOffset-00153";
Jeff Leger178b1e52020-10-05 12:22:23 -04003163 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003164 "%s: Dest image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003165 "depth [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003166 func_name, i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003167 }
3168
Aitor Camacho82c1a7a2022-07-05 22:21:19 +02003169 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
3170 // must not overlap in memory
3171 if (src_image_state->image() == dst_image_state->image()) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003172 for (uint32_t j = 0; j < regionCount; j++) {
Aitor Camacho82c1a7a2022-07-05 22:21:19 +02003173 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
3174 FormatIsMultiplane(src_format))) {
3175 vuid = is_2 ? "VUID-VkCopyImageInfo2-pRegions-00124" : "VUID-vkCmdCopyImage-pRegions-00124";
3176 skip |= LogError(command_buffer, vuid, "%s: pRegion[%u] src overlaps with pRegions[%u].", func_name, i, j);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003177 }
3178 }
3179 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08003180
3181 // 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 -07003182 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
sfricke-samsung48172ca2020-02-13 23:38:11 -08003183 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3184 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3185 (src_copy_extent.depth != 1)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003186 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01790" : "VUID-vkCmdCopyImage-srcImage-01790";
Jeff Leger178b1e52020-10-05 12:22:23 -04003187 skip |= LogError(command_buffer, vuid,
3188 "%s: pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1",
3189 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003190 }
3191 } else {
3192 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
3193 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3194 (src_copy_extent.depth != 1)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003195 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01789" : "VUID-vkCmdCopyImage-srcImage-01789";
Jeff Leger178b1e52020-10-05 12:22:23 -04003196 skip |= LogError(command_buffer, vuid,
3197 "%s: pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1",
3198 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003199 }
3200 }
3201
3202 // Check if 2D with 3D and depth not equal to 2D layerCount
3203 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3204 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
3205 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003206 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01791" : "VUID-vkCmdCopyImage-srcImage-01791";
Jeff Leger178b1e52020-10-05 12:22:23 -04003207 skip |= LogError(command_buffer, vuid,
3208 "%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 -08003209 "srcSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003210 func_name, i, src_copy_extent.depth, region.srcSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003211 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
3212 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
3213 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003214 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01792" : "VUID-vkCmdCopyImage-dstImage-01792";
Jeff Leger178b1e52020-10-05 12:22:23 -04003215 skip |= LogError(command_buffer, vuid,
3216 "%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 -08003217 "dstSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003218 func_name, i, src_copy_extent.depth, region.dstSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003219 }
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003220
3221 // Check for multi-plane format compatiblity
3222 if (FormatIsMultiplane(src_format) || FormatIsMultiplane(dst_format)) {
sfricke-samsung73e755c2021-09-30 08:34:57 -07003223 const VkFormat src_plane_format = FormatIsMultiplane(src_format)
3224 ? FindMultiplaneCompatibleFormat(src_format, region.srcSubresource.aspectMask)
3225 : src_format;
3226 const VkFormat dst_plane_format = FormatIsMultiplane(dst_format)
3227 ? FindMultiplaneCompatibleFormat(dst_format, region.dstSubresource.aspectMask)
3228 : dst_format;
3229 const size_t src_format_size = FormatElementSize(src_plane_format);
3230 const size_t dst_format_size = FormatElementSize(dst_plane_format);
3231
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003232 // If size is still zero, then format is invalid and will be caught in another VU
3233 if ((src_format_size != dst_format_size) && (src_format_size != 0) && (dst_format_size != 0)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003234 vuid = is_2 ? "VUID-VkCopyImageInfo2-None-01549" : "VUID-vkCmdCopyImage-None-01549";
Jeff Leger178b1e52020-10-05 12:22:23 -04003235 skip |= LogError(command_buffer, vuid,
3236 "%s: pRegions[%u] called with non-compatible image formats. "
3237 "The src format %s with aspectMask %s is not compatible with dst format %s aspectMask %s.",
3238 func_name, i, string_VkFormat(src_format),
3239 string_VkImageAspectFlags(region.srcSubresource.aspectMask).c_str(), string_VkFormat(dst_format),
3240 string_VkImageAspectFlags(region.dstSubresource.aspectMask).c_str());
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003241 }
3242 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003243 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003244
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003245 // The formats of non-multiplane src_image and dst_image must be compatible. Formats are considered compatible if their texel
3246 // size in bytes is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT
3247 // because because both texels are 4 bytes in size.
3248 if (!FormatIsMultiplane(src_format) && !FormatIsMultiplane(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003249 const char *compatible_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003250 IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
Tony-LunarGb61514a2021-11-02 12:36:51 -06003251 ? (is_2 ? "VUID-VkCopyImageInfo2-srcImage-01548" : "VUID-vkCmdCopyImage-srcImage-01548")
3252 : (is_2 ? "VUID-VkCopyImageInfo2-srcImage-00135" : "VUID-vkCmdCopyImage-srcImage-00135");
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003253 // Depth/stencil formats must match exactly.
3254 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3255 if (src_format != dst_format) {
3256 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003257 "%s: Depth/stencil formats must match exactly for src (%s) and dst (%s).", func_name,
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003258 string_VkFormat(src_format), string_VkFormat(dst_format));
3259 }
3260 } else {
Jeff Leger178b1e52020-10-05 12:22:23 -04003261 if (FormatElementSize(src_format) != FormatElementSize(dst_format)) {
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003262 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003263 "%s: Unmatched image format sizes. "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06003264 "The src format %s has size of %" PRIu32 " and dst format %s has size of %" PRIu32 ".",
Jeff Leger178b1e52020-10-05 12:22:23 -04003265 func_name, string_VkFormat(src_format), FormatElementSize(src_format), string_VkFormat(dst_format),
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003266 FormatElementSize(dst_format));
3267 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003268 }
3269 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003270
Dave Houlton33c22b72017-02-28 13:16:02 -07003271 // Source and dest image sample counts must match
3272 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003273 std::stringstream ss;
3274 ss << func_name << " called on image pair with non-identical sample counts.";
Tony-LunarGb61514a2021-11-02 12:36:51 -06003275 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-00136" : "VUID-vkCmdCopyImage-srcImage-00136";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003276 skip |=
3277 LogError(command_buffer, vuid, "%s: The src image sample count (%s) dose not match the dst image sample count (%s).",
3278 func_name, string_VkSampleCountFlagBits(src_image_state->createInfo.samples),
3279 string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Dave Houlton33c22b72017-02-28 13:16:02 -07003280 }
3281
Aitor Camacho82c1a7a2022-07-05 22:21:19 +02003282 vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
3283 ? (is_2 ? "VUID-VkCopyImageInfo2-srcImage-01546" : "VUID-vkCmdCopyImage-srcImage-01546")
3284 : (is_2 ? "VUID-VkCopyImageInfo2-srcImage-00127" : "VUID-vkCmdCopyImage-srcImage-00127");
3285 skip |= ValidateMemoryIsBoundToImage(src_image_state.get(), func_name, vuid);
3286 vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
3287 ? (is_2 ? "VUID-VkCopyImageInfo2-dstImage-01547" : "VUID-vkCmdCopyImage-dstImage-01547")
3288 : (is_2 ? "VUID-VkCopyImageInfo2-dstImage-00132" : "VUID-vkCmdCopyImage-dstImage-00132");
3289 skip |= ValidateMemoryIsBoundToImage(dst_image_state.get(), func_name, vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003290 // Validate that SRC & DST images have correct usage flags set
Tony-LunarGb61514a2021-11-02 12:36:51 -06003291 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-00126" : "VUID-vkCmdCopyImage-srcImage-00126";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003292 skip |= ValidateImageUsageFlags(src_image_state.get(), VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04003293 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tony-LunarGb61514a2021-11-02 12:36:51 -06003294 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-00131" : "VUID-vkCmdCopyImage-dstImage-00131";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003295 skip |= ValidateImageUsageFlags(dst_image_state.get(), VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04003296 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Tony-LunarGb61514a2021-11-02 12:36:51 -06003297 vuid = is_2 ? "VUID-vkCmdCopyImage2-commandBuffer-01825" : "VUID-vkCmdCopyImage-commandBuffer-01825";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003298 skip |= ValidateProtectedImage(cb_node.get(), src_image_state.get(), func_name, vuid);
Tony-LunarGb61514a2021-11-02 12:36:51 -06003299 vuid = is_2 ? "VUID-vkCmdCopyImage2-commandBuffer-01826" : "VUID-vkCmdCopyImage-commandBuffer-01826";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003300 skip |= ValidateProtectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
Tony-LunarGb61514a2021-11-02 12:36:51 -06003301 vuid = is_2 ? "VUID-vkCmdCopyImage2-commandBuffer-01827" : "VUID-vkCmdCopyImage-commandBuffer-01827";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003302 skip |= ValidateUnprotectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003303
3304 // Validation for VK_EXT_fragment_density_map
3305 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003306 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
Jeff Leger178b1e52020-10-05 12:22:23 -04003307 skip |=
3308 LogError(command_buffer, vuid,
3309 "%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 +02003310 }
3311 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003312 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
Jeff Leger178b1e52020-10-05 12:22:23 -04003313 skip |=
3314 LogError(command_buffer, vuid,
3315 "%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 +02003316 }
3317
sfricke-samsung45996a42021-09-16 13:45:27 -07003318 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003319 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01995" : "VUID-vkCmdCopyImage-srcImage-01995";
3320 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(), VK_FORMAT_FEATURE_2_TRANSFER_SRC_BIT, func_name, vuid);
3321 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01996" : "VUID-vkCmdCopyImage-dstImage-01996";
3322 skip |= ValidateImageFormatFeatureFlags(dst_image_state.get(), VK_FORMAT_FEATURE_2_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003323 }
Jeremy Gebben9f537102021-10-05 16:37:12 -06003324 skip |= ValidateCmd(cb_node.get(), cmd_type);
Tobin Ehlisc8266452017-04-07 12:20:30 -06003325 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04003326
3327 const char *invalid_src_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003328 (src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Tony-LunarGb61514a2021-11-02 12:36:51 -06003329 ? (is_2 ? "VUID-VkCopyImageInfo2-srcImageLayout-01917" : "VUID-vkCmdCopyImage-srcImageLayout-01917")
3330 : (is_2 ? "VUID-VkCopyImageInfo2-srcImageLayout-00129" : "VUID-vkCmdCopyImage-srcImageLayout-00129");
Jeff Leger178b1e52020-10-05 12:22:23 -04003331 const char *invalid_dst_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003332 (dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Tony-LunarGb61514a2021-11-02 12:36:51 -06003333 ? (is_2 ? "VUID-VkCopyImageInfo2-dstImageLayout-01395" : "VUID-vkCmdCopyImage-dstImageLayout-01395")
3334 : (is_2 ? "VUID-VkCopyImageInfo2-dstImageLayout-00134" : "VUID-vkCmdCopyImage-dstImageLayout-00134");
Jeff Leger178b1e52020-10-05 12:22:23 -04003335
aitor-lunargd0d85e12022-01-28 16:56:49 +01003336 bool same_image = (src_image_state == dst_image_state);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003337 for (uint32_t i = 0; i < regionCount; ++i) {
aitor-lunargd0d85e12022-01-28 16:56:49 +01003338 // When performing copy from and to same subresource, VK_IMAGE_LAYOUT_GENERAL is the only option
sfricke-samsung71f04e32022-03-16 01:21:21 -05003339 const RegionType region = pRegions[i];
3340 const auto &src_sub = region.srcSubresource;
3341 const auto &dst_sub = region.dstSubresource;
aitor-lunargd0d85e12022-01-28 16:56:49 +01003342 bool same_subresource =
3343 (same_image && (src_sub.mipLevel == dst_sub.mipLevel) && (src_sub.baseArrayLayer == dst_sub.baseArrayLayer));
3344 VkImageLayout source_optimal = (same_subresource ? VK_IMAGE_LAYOUT_GENERAL : VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL);
3345 VkImageLayout destination_optimal = (same_subresource ? VK_IMAGE_LAYOUT_GENERAL : VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL);
Tony-LunarGb61514a2021-11-02 12:36:51 -06003346 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImageLayout-00128" : "VUID-vkCmdCopyImage-srcImageLayout-00128";
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06003347 skip |= VerifyImageLayout(*cb_node, *src_image_state, region.srcSubresource, srcImageLayout, source_optimal, func_name,
3348 invalid_src_layout_vuid, vuid, &hit_error);
Tony-LunarGb61514a2021-11-02 12:36:51 -06003349 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImageLayout-00133" : "VUID-vkCmdCopyImage-dstImageLayout-00133";
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06003350 skip |= VerifyImageLayout(*cb_node, *dst_image_state, region.dstSubresource, dstImageLayout, destination_optimal, func_name,
3351 invalid_dst_layout_vuid, vuid, &hit_error);
Jeremy Gebben9f537102021-10-05 16:37:12 -06003352 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node.get(), src_image_state.get(), dst_image_state.get(),
sfricke-samsung71f04e32022-03-16 01:21:21 -05003353 &region, i, func_name, cmd_type);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003354 }
3355
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003356 return skip;
3357}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003358
Jeff Leger178b1e52020-10-05 12:22:23 -04003359bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3360 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3361 const VkImageCopy *pRegions) const {
3362 return ValidateCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
Tony-LunarGb61514a2021-11-02 12:36:51 -06003363 CMD_COPYIMAGE);
Jeff Leger178b1e52020-10-05 12:22:23 -04003364}
3365
3366bool CoreChecks::PreCallValidateCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) const {
3367 return ValidateCmdCopyImage(commandBuffer, pCopyImageInfo->srcImage, pCopyImageInfo->srcImageLayout, pCopyImageInfo->dstImage,
3368 pCopyImageInfo->dstImageLayout, pCopyImageInfo->regionCount, pCopyImageInfo->pRegions,
Tony-LunarGb61514a2021-11-02 12:36:51 -06003369 CMD_COPYIMAGE2KHR);
3370}
3371
3372bool CoreChecks::PreCallValidateCmdCopyImage2(VkCommandBuffer commandBuffer, const VkCopyImageInfo2 *pCopyImageInfo) const {
3373 return ValidateCmdCopyImage(commandBuffer, pCopyImageInfo->srcImage, pCopyImageInfo->srcImageLayout, pCopyImageInfo->dstImage,
3374 pCopyImageInfo->dstImageLayout, pCopyImageInfo->regionCount, pCopyImageInfo->pRegions,
3375 CMD_COPYIMAGE2);
Jeff Leger178b1e52020-10-05 12:22:23 -04003376}
3377
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003378void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3379 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3380 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003381 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3382 pRegions);
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07003383 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003384 auto src_image_state = Get<IMAGE_STATE>(srcImage);
3385 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003386
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003387 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003388 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06003389 cb_node->SetImageInitialLayout(*src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3390 cb_node->SetImageInitialLayout(*dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003391 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003392}
3393
Aitor Camacho82c1a7a2022-07-05 22:21:19 +02003394void CoreChecks::RecordCmdCopyImage2(VkCommandBuffer commandBuffer, const VkCopyImageInfo2 *pCopyImageInfo) {
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07003395 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003396 auto src_image_state = Get<IMAGE_STATE>(pCopyImageInfo->srcImage);
3397 auto dst_image_state = Get<IMAGE_STATE>(pCopyImageInfo->dstImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04003398
3399 // Make sure that all image slices are updated to correct layout
3400 for (uint32_t i = 0; i < pCopyImageInfo->regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06003401 cb_node->SetImageInitialLayout(*src_image_state, pCopyImageInfo->pRegions[i].srcSubresource,
3402 pCopyImageInfo->srcImageLayout);
3403 cb_node->SetImageInitialLayout(*dst_image_state, pCopyImageInfo->pRegions[i].dstSubresource,
3404 pCopyImageInfo->dstImageLayout);
Jeff Leger178b1e52020-10-05 12:22:23 -04003405 }
3406}
3407
Tony-LunarGb61514a2021-11-02 12:36:51 -06003408void CoreChecks::PreCallRecordCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) {
3409 StateTracker::PreCallRecordCmdCopyImage2KHR(commandBuffer, pCopyImageInfo);
Aitor Camacho82c1a7a2022-07-05 22:21:19 +02003410 RecordCmdCopyImage2(commandBuffer, pCopyImageInfo);
Tony-LunarGb61514a2021-11-02 12:36:51 -06003411}
3412
3413void CoreChecks::PreCallRecordCmdCopyImage2(VkCommandBuffer commandBuffer, const VkCopyImageInfo2 *pCopyImageInfo) {
3414 StateTracker::PreCallRecordCmdCopyImage2(commandBuffer, pCopyImageInfo);
Aitor Camacho82c1a7a2022-07-05 22:21:19 +02003415 RecordCmdCopyImage2(commandBuffer, pCopyImageInfo);
Tony-LunarGb61514a2021-11-02 12:36:51 -06003416}
3417
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003418// Returns true if sub_rect is entirely contained within rect
3419static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
3420 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 -07003421 (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 -07003422 return false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003423 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003424 return true;
3425}
3426
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003427bool CoreChecks::ValidateClearAttachmentExtent(const CMD_BUFFER_STATE &cb_node, uint32_t attachment_index,
amhagana448ea52021-11-02 14:09:14 -04003428 const IMAGE_VIEW_STATE* image_view_state,
3429 const VkRect2D &render_area, uint32_t rect_count, const VkClearRect *clear_rects) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07003430 bool skip = false;
John Zulauf3a548ef2019-02-01 16:14:07 -07003431
3432 for (uint32_t j = 0; j < rect_count; j++) {
3433 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003434 skip |= LogError(cb_node.Handle(), "VUID-vkCmdClearAttachments-pRects-00016",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003435 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
3436 "the current render pass instance.",
3437 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07003438 }
3439
3440 if (image_view_state) {
3441 // The layers specified by a given element of pRects must be contained within every attachment that
3442 // pAttachments refers to
ziga-lunargff6485c2021-10-08 18:18:32 +02003443 const uint32_t attachment_layer_count = image_view_state->GetAttachmentLayerCount();
John Zulauf3a548ef2019-02-01 16:14:07 -07003444 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
3445 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003446 skip |= LogError(cb_node.Handle(), "VUID-vkCmdClearAttachments-pRects-00017",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003447 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
3448 "of pAttachment[%d].",
3449 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07003450 }
3451 }
3452 }
3453 return skip;
3454}
3455
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003456bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3457 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003458 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003459 bool skip = false;
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07003460 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Petr Kraus2dffb382019-08-10 02:52:12 +02003461 if (!cb_node) return skip;
3462
Jeremy Gebben9f537102021-10-05 16:37:12 -06003463 skip |= ValidateCmd(cb_node.get(), CMD_CLEARATTACHMENTS);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003464
3465 // Validate that attachment is in reference list of active subpass
3466 if (cb_node->activeRenderPass) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08003467 const VkRenderPassCreateInfo2 *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07003468 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Mike Schuchardt2df08912020-12-15 16:28:09 -08003469 const VkSubpassDescription2 *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
locke-lunargaecf2152020-05-12 17:15:41 -06003470 const auto *framebuffer = cb_node->activeFramebuffer.get();
Aaron Hagan1656b2b2021-12-21 11:52:41 -05003471 const auto &render_area = (cb_node->activeRenderPass->use_dynamic_rendering) ?
3472 cb_node->activeRenderPass->dynamic_rendering_begin_rendering_info.renderArea :
3473 cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003474
John Zulauf3a548ef2019-02-01 16:14:07 -07003475 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3476 auto clear_desc = &pAttachments[attachment_index];
3477 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003478 const VkImageAspectFlags aspect_mask = clear_desc->aspectMask;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003479
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003480 if (aspect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
3481 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020",
3482 "vkCmdClearAttachments() pAttachments[%u] mask contains VK_IMAGE_ASPECT_METADATA_BIT",
3483 attachment_index);
3484 } else if (aspect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
3485 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
3486 skip |=
3487 LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-02246",
3488 "vkCmdClearAttachments() pAttachments[%u] mask contains a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit",
3489 attachment_index);
3490 } else if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07003491 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
Aaron Haganc6bafff2021-11-29 23:30:07 -05003492 if (subpass_desc) {
amhagana448ea52021-11-02 14:09:14 -04003493 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
3494 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3495 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
3496 skip |= LogError(
3497 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3498 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
3499 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
3500 attachment_index, clear_desc->colorAttachment,
3501 report_data->FormatHandle(cb_node->activeRenderPass->renderPass()).c_str(), cb_node->activeSubpass,
3502 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07003503
amhagana448ea52021-11-02 14:09:14 -04003504 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
3505 }
3506 } else {
3507 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3508 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
3509 " subpass %u. colorAttachmentCount=%u",
3510 attachment_index, clear_desc->colorAttachment,
3511 report_data->FormatHandle(cb_node->activeRenderPass->renderPass()).c_str(),
3512 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
John Zulauff2582972019-02-09 14:53:30 -07003513 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003514 }
John Zulauff2582972019-02-09 14:53:30 -07003515 fb_attachment = color_attachment;
3516
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003517 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
3518 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
3519 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019",
3520 "vkCmdClearAttachments() pAttachments[%u] aspectMask must set only VK_IMAGE_ASPECT_COLOR_BIT "
3521 "of a color attachment.",
3522 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003523 }
3524 } else { // Must be depth and/or stencil
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003525 bool subpass_depth = false;
3526 bool subpass_stencil = false;
amhagana448ea52021-11-02 14:09:14 -04003527 if (subpass_desc) {
3528 if (subpass_desc->pDepthStencilAttachment &&
3529 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3530 auto index = subpass_desc->pDepthStencilAttachment->attachment;
3531 subpass_depth = FormatHasDepth(renderpass_create_info->pAttachments[index].format);
3532 subpass_stencil = FormatHasStencil(renderpass_create_info->pAttachments[index].format);
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003533 }
amhagana448ea52021-11-02 14:09:14 -04003534 if (!subpass_desc->pDepthStencilAttachment ||
3535 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3536 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) && !subpass_depth) {
3537 skip |= LogError(
3538 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02502",
3539 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_DEPTH_BIT but there is no "
3540 "depth attachment in subpass",
3541 attachment_index);
3542 }
3543 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) && !subpass_stencil) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003544 skip |= LogError(
3545 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02503",
3546 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_STENCIL_BIT but there is no "
amhagana448ea52021-11-02 14:09:14 -04003547 "stencil attachment in subpass",
3548 attachment_index);
3549 }
3550 } else {
3551 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003552 }
amhagana448ea52021-11-02 14:09:14 -04003553 if (subpass_depth) {
3554 skip |= ValidateClearDepthStencilValue(commandBuffer, clear_desc->clearValue.depthStencil,
3555 "vkCmdClearAttachments()");
3556 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08003557 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003558 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003559 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
amhagana448ea52021-11-02 14:09:14 -04003560 const IMAGE_VIEW_STATE* image_view_state = nullptr;
3561 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
3562 image_view_state = cb_node->GetActiveAttachmentImageViewState(fb_attachment);
3563 }
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003564 skip |= ValidateClearAttachmentExtent(*cb_node, attachment_index, image_view_state, render_area,
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003565 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06003566 }
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003567
3568 // Once the framebuffer attachment is found, can get the image view state
3569 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) &&
3570 (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003571 const auto *image_view_state = cb_node->GetActiveAttachmentImageViewState(fb_attachment);
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003572 if (image_view_state != nullptr) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06003573 skip |= ValidateProtectedImage(cb_node.get(), image_view_state->image_state.get(), "vkCmdClearAttachments()",
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003574 "VUID-vkCmdClearAttachments-commandBuffer-02504");
Jeremy Gebben9f537102021-10-05 16:37:12 -06003575 skip |= ValidateUnprotectedImage(cb_node.get(), image_view_state->image_state.get(), "vkCmdClearAttachments()",
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003576 "VUID-vkCmdClearAttachments-commandBuffer-02505");
3577 }
3578 }
ziga-lunargfa335aa2021-08-05 16:59:39 +02003579
amhagana448ea52021-11-02 14:09:14 -04003580 // When a subpass uses a non-zero view mask, multiview functionality is considered to be enabled
3581 if (subpass_desc && (subpass_desc->viewMask > 0)) {
3582 for (uint32_t i = 0; i < rectCount; ++i) {
3583 if (pRects[i].baseArrayLayer != 0 || pRects[i].layerCount != 1) {
3584 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-baseArrayLayer-00018",
3585 "vkCmdClearAttachments(): pRects[%" PRIu32 "] baseArrayLayer is %" PRIu32
3586 " and layerCount is %" PRIu32 ", but the render pass instance uses multiview.",
3587 i, pRects[i].baseArrayLayer, pRects[i].layerCount);
3588 }
ziga-lunargfa335aa2021-08-05 16:59:39 +02003589 }
3590 }
3591 }
John Zulauf441558b2019-08-12 11:47:39 -06003592 }
3593 return skip;
3594}
3595
3596void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3597 const VkClearAttachment *pAttachments, uint32_t rectCount,
3598 const VkClearRect *pRects) {
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07003599 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
John Zulauf441558b2019-08-12 11:47:39 -06003600 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
John Zulauf441558b2019-08-12 11:47:39 -06003601 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
Aaron Haganc6bafff2021-11-29 23:30:07 -05003602 if (cb_node->activeRenderPass->use_dynamic_rendering_inherited) {
3603 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3604 const auto clear_desc = &pAttachments[attachment_index];
3605 auto colorAttachmentCount = cb_node->activeRenderPass->inheritance_rendering_info.colorAttachmentCount;
3606 int image_index = -1;
3607 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3608 (clear_desc->colorAttachment < colorAttachmentCount)) {
3609 image_index = cb_node->GetDynamicColorAttachmentImageIndex(clear_desc->colorAttachment);
3610 }
3611 else if (clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT)) {
3612 image_index = cb_node->GetDynamicDepthAttachmentImageIndex();
3613 }
3614 else if (clear_desc->aspectMask & (VK_IMAGE_ASPECT_STENCIL_BIT)) {
3615 image_index = cb_node->GetDynamicStencilAttachmentImageIndex();
3616 }
amhagana448ea52021-11-02 14:09:14 -04003617
Aaron Haganc6bafff2021-11-29 23:30:07 -05003618 if (image_index != -1) {
3619 if (!clear_rect_copy) {
3620 // We need a copy of the clear rectangles that will persist until the last lambda executes
3621 // but we want to create it as lazily as possible
3622 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
amhagana448ea52021-11-02 14:09:14 -04003623 }
Aaron Haganc6bafff2021-11-29 23:30:07 -05003624 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3625 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
3626 auto val_fn = [this, attachment_index, image_index, rectCount, clear_rect_copy](
3627 const CMD_BUFFER_STATE &secondary, const CMD_BUFFER_STATE *prim_cb,
3628 const FRAMEBUFFER_STATE *fb) {
3629 assert(rectCount == clear_rect_copy->size());
3630 bool skip = false;
3631 const IMAGE_VIEW_STATE* image_view_state = nullptr;
3632 if (image_index != -1) {
3633 image_view_state = (*prim_cb->active_attachments)[image_index];
3634 }
3635 skip = ValidateClearAttachmentExtent(secondary, attachment_index, image_view_state,
3636 prim_cb->activeRenderPass->dynamic_rendering_begin_rendering_info.renderArea,
3637 rectCount, clear_rect_copy->data());
3638 return skip;
3639 };
3640 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003641 }
amhagana448ea52021-11-02 14:09:14 -04003642 }
3643 }
Aaron Haganc6bafff2021-11-29 23:30:07 -05003644 else if (cb_node->activeRenderPass->use_dynamic_rendering == false)
amhagana448ea52021-11-02 14:09:14 -04003645 {
3646 const VkRenderPassCreateInfo2* renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3647 const VkSubpassDescription2* subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
sfricke-samsung21286f82021-11-16 08:21:46 -08003648
amhagana448ea52021-11-02 14:09:14 -04003649 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3650 const auto clear_desc = &pAttachments[attachment_index];
3651 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3652 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3653 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3654 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3655 }
3656 else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3657 subpass_desc->pDepthStencilAttachment) {
3658 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3659 }
3660 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
3661 if (!clear_rect_copy) {
3662 // We need a copy of the clear rectangles that will persist until the last lambda executes
3663 // but we want to create it as lazily as possible
3664 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
3665 }
3666 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3667 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003668 auto val_fn = [this, attachment_index, fb_attachment, rectCount, clear_rect_copy](
3669 const CMD_BUFFER_STATE &secondary, const CMD_BUFFER_STATE *prim_cb,
3670 const FRAMEBUFFER_STATE *fb) {
amhagana448ea52021-11-02 14:09:14 -04003671 assert(rectCount == clear_rect_copy->size());
3672 const auto& render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3673 bool skip = false;
3674 const IMAGE_VIEW_STATE* image_view_state = nullptr;
3675 if (fb && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < fb->createInfo.attachmentCount)) {
3676 image_view_state = prim_cb->GetActiveAttachmentImageViewState(fb_attachment);
3677 }
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003678 skip = ValidateClearAttachmentExtent(secondary, attachment_index, image_view_state, render_area, rectCount,
3679 clear_rect_copy->data());
amhagana448ea52021-11-02 14:09:14 -04003680 return skip;
3681 };
3682 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
3683 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003684 }
3685 }
3686 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003687}
3688
Jeff Leger178b1e52020-10-05 12:22:23 -04003689template <typename RegionType>
3690bool CoreChecks::ValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3691 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Tony-LunarG562fc102021-11-12 13:58:35 -07003692 const RegionType *pRegions, CMD_TYPE cmd_type) const {
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07003693 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07003694 auto src_image_state = Get<IMAGE_STATE>(srcImage);
3695 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Tony-LunarG562fc102021-11-12 13:58:35 -07003696 const bool is_2 = (cmd_type == CMD_RESOLVEIMAGE2KHR || cmd_type == CMD_RESOLVEIMAGE2);
sfricke-samsung85584a72021-09-30 21:43:38 -07003697 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04003698 const char *vuid;
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003699
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003700 bool skip = false;
3701 if (cb_node && src_image_state && dst_image_state) {
Tony-LunarG562fc102021-11-12 13:58:35 -07003702 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-00256" : "VUID-vkCmdResolveImage-srcImage-00256";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003703 skip |= ValidateMemoryIsBoundToImage(src_image_state.get(), func_name, vuid);
Tony-LunarG562fc102021-11-12 13:58:35 -07003704 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-00258" : "VUID-vkCmdResolveImage-dstImage-00258";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003705 skip |= ValidateMemoryIsBoundToImage(dst_image_state.get(), func_name, vuid);
3706 skip |= ValidateCmd(cb_node.get(), cmd_type);
Tony-LunarG562fc102021-11-12 13:58:35 -07003707 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-02003" : "VUID-vkCmdResolveImage-dstImage-02003";
3708 skip |= ValidateImageFormatFeatureFlags(dst_image_state.get(), VK_FORMAT_FEATURE_2_COLOR_ATTACHMENT_BIT, func_name, vuid);
3709 vuid = is_2 ? "VUID-vkCmdResolveImage2-commandBuffer-01837" : "VUID-vkCmdResolveImage-commandBuffer-01837";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003710 skip |= ValidateProtectedImage(cb_node.get(), src_image_state.get(), func_name, vuid);
Tony-LunarG562fc102021-11-12 13:58:35 -07003711 vuid = is_2 ? "VUID-vkCmdResolveImage2-commandBuffer-01838" : "VUID-vkCmdResolveImage-commandBuffer-01838";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003712 skip |= ValidateProtectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
Tony-LunarG562fc102021-11-12 13:58:35 -07003713 vuid = is_2 ? "VUID-vkCmdResolveImage2-commandBuffer-01839" : "VUID-vkCmdResolveImage-commandBuffer-01839";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003714 skip |= ValidateUnprotectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
ziga-lunarg73154fd2022-05-18 14:36:33 +02003715 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-06762" : "VUID-vkCmdResolveImage-srcImage-06762";
3716 skip |= ValidateImageUsageFlags(src_image_state.get(), VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3717 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3718 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-06763" : "VUID-vkCmdResolveImage-srcImage-06763";
3719 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(), VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
3720 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-06764" : "VUID-vkCmdResolveImage-dstImage-06764";
3721 skip |= ValidateImageUsageFlags(dst_image_state.get(), VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3722 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3723 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-06765" : "VUID-vkCmdResolveImage-dstImage-06765";
3724 skip |= ValidateImageFormatFeatureFlags(dst_image_state.get(), VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003725
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003726 // Validation for VK_EXT_fragment_density_map
3727 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony-LunarG562fc102021-11-12 13:58:35 -07003728 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003729 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003730 "%s: srcImage must not have been created with flags containing "
3731 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3732 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003733 }
3734 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony-LunarG562fc102021-11-12 13:58:35 -07003735 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003736 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003737 "%s: dstImage must not have been created with flags containing "
3738 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3739 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003740 }
3741
Cort Stratton7df30962018-05-17 19:45:57 -07003742 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003743 const char *invalid_src_layout_vuid =
Tony-LunarG562fc102021-11-12 13:58:35 -07003744 is_2 ? ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
3745 ? "VUID-VkResolveImageInfo2-srcImageLayout-01400"
3746 : "VUID-VkResolveImageInfo2-srcImageLayout-00261")
sfricke-samsung45996a42021-09-16 13:45:27 -07003747 : ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003748 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3749 : "VUID-vkCmdResolveImage-srcImageLayout-00261");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003750 const char *invalid_dst_layout_vuid =
Tony-LunarG562fc102021-11-12 13:58:35 -07003751 is_2 ? ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
3752 ? "VUID-VkResolveImageInfo2-dstImageLayout-01401"
3753 : "VUID-VkResolveImageInfo2-dstImageLayout-00263")
sfricke-samsung45996a42021-09-16 13:45:27 -07003754 : ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003755 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3756 : "VUID-vkCmdResolveImage-dstImageLayout-00263");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003757 // For each region, the number of layers in the image subresource should not be zero
3758 // For each region, src and dest image aspect must be color only
3759 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003760 const RegionType region = pRegions[i];
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003761 const VkImageSubresourceLayers src_subresource = region.srcSubresource;
3762 const VkImageSubresourceLayers dst_subresource = region.dstSubresource;
Tony-LunarG562fc102021-11-12 13:58:35 -07003763
Jeremy Gebben9f537102021-10-05 16:37:12 -06003764 skip |= ValidateImageSubresourceLayers(cb_node.get(), &src_subresource, func_name, "srcSubresource", i);
3765 skip |= ValidateImageSubresourceLayers(cb_node.get(), &dst_subresource, func_name, "dstSubresource", i);
Tony-LunarG562fc102021-11-12 13:58:35 -07003766 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImageLayout-00260" : "VUID-vkCmdResolveImage-srcImageLayout-00260";
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06003767 skip |= VerifyImageLayout(*cb_node, *src_image_state, src_subresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003768 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
Tony-LunarG562fc102021-11-12 13:58:35 -07003769 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImageLayout-00262" : "VUID-vkCmdResolveImage-dstImageLayout-00262";
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06003770 skip |= VerifyImageLayout(*cb_node, *dst_image_state, dst_subresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003771 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
Tony-LunarG562fc102021-11-12 13:58:35 -07003772 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcSubresource-01709" : "VUID-vkCmdResolveImage-srcSubresource-01709";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003773 skip |= ValidateImageMipLevel(cb_node.get(), src_image_state.get(), src_subresource.mipLevel, i, func_name,
3774 "srcSubresource", vuid);
Tony-LunarG562fc102021-11-12 13:58:35 -07003775 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstSubresource-01710" : "VUID-vkCmdResolveImage-dstSubresource-01710";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003776 skip |= ValidateImageMipLevel(cb_node.get(), dst_image_state.get(), dst_subresource.mipLevel, i, func_name,
3777 "dstSubresource", vuid);
Tony-LunarG562fc102021-11-12 13:58:35 -07003778 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcSubresource-01711" : "VUID-vkCmdResolveImage-srcSubresource-01711";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003779 skip |= ValidateImageArrayLayerRange(cb_node.get(), src_image_state.get(), src_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003780 src_subresource.layerCount, i, func_name, "srcSubresource", vuid);
Tony-LunarG562fc102021-11-12 13:58:35 -07003781 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstSubresource-01712" : "VUID-vkCmdResolveImage-dstSubresource-01712";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003782 skip |= ValidateImageArrayLayerRange(cb_node.get(), dst_image_state.get(), dst_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003783 dst_subresource.layerCount, i, func_name, "srcSubresource", vuid);
Cort Stratton7df30962018-05-17 19:45:57 -07003784
3785 // layer counts must match
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003786 if (src_subresource.layerCount != dst_subresource.layerCount) {
Tony-LunarG562fc102021-11-12 13:58:35 -07003787 vuid = is_2 ? "VUID-VkImageResolve2-layerCount-00267" : "VUID-VkImageResolve-layerCount-00267";
Jeff Leger178b1e52020-10-05 12:22:23 -04003788 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003789 LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003790 "%s: layerCount in source and destination subresource of pRegions[%u] does not match.", func_name, i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003791 }
Cort Stratton7df30962018-05-17 19:45:57 -07003792 // For each region, src and dest image aspect must be color only
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003793 if ((src_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3794 (dst_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
Tony-LunarG562fc102021-11-12 13:58:35 -07003795 vuid = is_2 ? "VUID-VkImageResolve2-aspectMask-00266" : "VUID-VkImageResolve-aspectMask-00266";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003796 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003797 "%s: src and dest aspectMasks for pRegions[%u] must specify only VK_IMAGE_ASPECT_COLOR_BIT.",
3798 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003799 }
3800
3801 const VkImageType src_image_type = src_image_state->createInfo.imageType;
3802 const VkImageType dst_image_type = dst_image_state->createInfo.imageType;
3803
3804 if ((VK_IMAGE_TYPE_3D == src_image_type) || (VK_IMAGE_TYPE_3D == dst_image_type)) {
Shannon McPherson74b341c2020-09-08 15:43:05 -06003805 if ((0 != src_subresource.baseArrayLayer) || (1 != src_subresource.layerCount)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003806 LogObjectList objlist(cb_node->commandBuffer());
3807 objlist.add(src_image_state->image());
3808 objlist.add(dst_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003809 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-04446" : "VUID-vkCmdResolveImage-srcImage-04446";
Jeff Leger178b1e52020-10-05 12:22:23 -04003810 skip |= LogError(objlist, vuid,
3811 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
Shannon McPherson74b341c2020-09-08 15:43:05 -06003812 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003813 func_name, i);
Shannon McPherson74b341c2020-09-08 15:43:05 -06003814 }
3815 if ((0 != dst_subresource.baseArrayLayer) || (1 != dst_subresource.layerCount)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003816 LogObjectList objlist(cb_node->commandBuffer());
3817 objlist.add(src_image_state->image());
3818 objlist.add(dst_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003819 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-04447" : "VUID-vkCmdResolveImage-srcImage-04447";
Jeff Leger178b1e52020-10-05 12:22:23 -04003820 skip |= LogError(objlist, vuid,
3821 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003822 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003823 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003824 }
3825 }
3826
3827 if (VK_IMAGE_TYPE_1D == src_image_type) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05003828 if ((region.srcOffset.y != 0) || (region.extent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003829 LogObjectList objlist(cb_node->commandBuffer());
3830 objlist.add(src_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003831 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-00271" : "VUID-vkCmdResolveImage-srcImage-00271";
Jeff Leger178b1e52020-10-05 12:22:23 -04003832 skip |= LogError(objlist, vuid,
3833 "%s: srcImage (%s) is 1D but pRegions[%u] srcOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003834 "extent.height (%u) is not 1.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05003835 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.y,
3836 region.extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003837 }
3838 }
3839 if ((VK_IMAGE_TYPE_1D == src_image_type) || (VK_IMAGE_TYPE_2D == src_image_type)) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05003840 if ((region.srcOffset.z != 0) || (region.extent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003841 LogObjectList objlist(cb_node->commandBuffer());
3842 objlist.add(src_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003843 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-00273" : "VUID-vkCmdResolveImage-srcImage-00273";
Jeff Leger178b1e52020-10-05 12:22:23 -04003844 skip |= LogError(objlist, vuid,
3845 "%s: srcImage (%s) is 2D but pRegions[%u] srcOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003846 "extent.depth (%u) is not 1.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05003847 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.z,
3848 region.extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003849 }
3850 }
3851
3852 if (VK_IMAGE_TYPE_1D == dst_image_type) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05003853 if ((region.dstOffset.y != 0) || (region.extent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003854 LogObjectList objlist(cb_node->commandBuffer());
3855 objlist.add(dst_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003856 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-00276" : "VUID-vkCmdResolveImage-dstImage-00276";
Jeff Leger178b1e52020-10-05 12:22:23 -04003857 skip |= LogError(objlist, vuid,
3858 "%s: dstImage (%s) is 1D but pRegions[%u] dstOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003859 "extent.height (%u) is not 1.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05003860 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.dstOffset.y,
3861 region.extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003862 }
3863 }
3864 if ((VK_IMAGE_TYPE_1D == dst_image_type) || (VK_IMAGE_TYPE_2D == dst_image_type)) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05003865 if ((region.dstOffset.z != 0) || (region.extent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003866 LogObjectList objlist(cb_node->commandBuffer());
3867 objlist.add(dst_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003868 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-00278" : "VUID-vkCmdResolveImage-dstImage-00278";
Jeff Leger178b1e52020-10-05 12:22:23 -04003869 skip |= LogError(objlist, vuid,
3870 "%s: dstImage (%s) is 2D but pRegions[%u] dstOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003871 "extent.depth (%u) is not 1.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05003872 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.dstOffset.z,
3873 region.extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003874 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003875 }
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003876
3877 // Each srcImage dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003878 VkExtent3D subresource_extent = src_image_state->GetSubresourceExtent(src_subresource);
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003879 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3880 // developer
3881 if (src_subresource.mipLevel < src_image_state->createInfo.mipLevels) {
3882 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003883 if ((extent_check & kXBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003884 LogObjectList objlist(cb_node->commandBuffer());
3885 objlist.add(src_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003886 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcOffset-00269" : "VUID-vkCmdResolveImage-srcOffset-00269";
Jeff Leger178b1e52020-10-05 12:22:23 -04003887 skip |= LogError(objlist, vuid,
3888 "%s: srcImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003889 "exceeds subResource width [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003890 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003891 region.extent.width, subresource_extent.width);
3892 }
3893
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003894 if ((extent_check & kYBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003895 LogObjectList objlist(cb_node->commandBuffer());
3896 objlist.add(src_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003897 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcOffset-00270" : "VUID-vkCmdResolveImage-srcOffset-00270";
Jeff Leger178b1e52020-10-05 12:22:23 -04003898 skip |= LogError(objlist, vuid,
3899 "%s: srcImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003900 "exceeds subResource height [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003901 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003902 region.extent.height, subresource_extent.height);
3903 }
3904
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003905 if ((extent_check & kZBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003906 LogObjectList objlist(cb_node->commandBuffer());
3907 objlist.add(src_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003908 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcOffset-00272" : "VUID-vkCmdResolveImage-srcOffset-00272";
Jeff Leger178b1e52020-10-05 12:22:23 -04003909 skip |= LogError(objlist, vuid,
3910 "%s: srcImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003911 "exceeds subResource depth [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003912 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003913 region.extent.depth, subresource_extent.depth);
3914 }
3915 }
3916
3917 // Each dstImage dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003918 subresource_extent = dst_image_state->GetSubresourceExtent(dst_subresource);
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003919 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3920 // developer
3921 if (dst_subresource.mipLevel < dst_image_state->createInfo.mipLevels) {
3922 uint32_t extent_check = ExceedsBounds(&(region.dstOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003923 if ((extent_check & kXBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003924 LogObjectList objlist(cb_node->commandBuffer());
3925 objlist.add(dst_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003926 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstOffset-00274" : "VUID-vkCmdResolveImage-dstOffset-00274";
Jeff Leger178b1e52020-10-05 12:22:23 -04003927 skip |= LogError(objlist, vuid,
3928 "%s: dstImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003929 "exceeds subResource width [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003930 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003931 region.extent.width, subresource_extent.width);
3932 }
3933
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003934 if ((extent_check & kYBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003935 LogObjectList objlist(cb_node->commandBuffer());
3936 objlist.add(dst_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003937 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstOffset-00275" : "VUID-vkCmdResolveImage-dstOffset-00275";
Jeff Leger178b1e52020-10-05 12:22:23 -04003938 skip |= LogError(objlist, vuid,
3939 "%s: dstImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003940 "exceeds subResource height [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003941 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003942 region.extent.height, subresource_extent.height);
3943 }
3944
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003945 if ((extent_check & kZBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003946 LogObjectList objlist(cb_node->commandBuffer());
3947 objlist.add(dst_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003948 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstOffset-00277" : "VUID-vkCmdResolveImage-dstOffset-00277";
Jeff Leger178b1e52020-10-05 12:22:23 -04003949 skip |= LogError(objlist, vuid,
3950 "%s: dstImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003951 "exceeds subResource depth [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003952 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003953 region.extent.depth, subresource_extent.depth);
3954 }
3955 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003956 }
3957
3958 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
Tony-LunarG562fc102021-11-12 13:58:35 -07003959 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-01386" : "VUID-vkCmdResolveImage-srcImage-01386";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003960 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 -04003961 func_name, string_VkFormat(src_image_state->createInfo.format),
3962 string_VkFormat(dst_image_state->createInfo.format));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003963 }
3964 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003965 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_MismatchedImageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04003966 "%s: srcImage type (%s) and dstImage type (%s) are not the same.", func_name,
sfricke-samsungc26350e2020-05-30 12:31:31 -07003967 string_VkImageType(src_image_state->createInfo.imageType),
3968 string_VkImageType(dst_image_state->createInfo.imageType));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003969 }
3970 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
Tony-LunarG562fc102021-11-12 13:58:35 -07003971 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-00257" : "VUID-vkCmdResolveImage-srcImage-00257";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003972 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 -07003973 }
3974 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
Tony-LunarG562fc102021-11-12 13:58:35 -07003975 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-00259" : "VUID-vkCmdResolveImage-dstImage-00259";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003976 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 -04003977 func_name, string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003978 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003979 } else {
3980 assert(0);
3981 }
3982 return skip;
3983}
3984
Jeff Leger178b1e52020-10-05 12:22:23 -04003985bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3986 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3987 const VkImageResolve *pRegions) const {
3988 return ValidateCmdResolveImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
Tony-LunarG562fc102021-11-12 13:58:35 -07003989 CMD_RESOLVEIMAGE);
Jeff Leger178b1e52020-10-05 12:22:23 -04003990}
3991
3992bool CoreChecks::PreCallValidateCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
3993 const VkResolveImageInfo2KHR *pResolveImageInfo) const {
3994 return ValidateCmdResolveImage(commandBuffer, pResolveImageInfo->srcImage, pResolveImageInfo->srcImageLayout,
3995 pResolveImageInfo->dstImage, pResolveImageInfo->dstImageLayout, pResolveImageInfo->regionCount,
Tony-LunarG562fc102021-11-12 13:58:35 -07003996 pResolveImageInfo->pRegions, CMD_RESOLVEIMAGE2KHR);
3997}
3998
3999bool CoreChecks::PreCallValidateCmdResolveImage2(VkCommandBuffer commandBuffer,
4000 const VkResolveImageInfo2 *pResolveImageInfo) const {
4001 return ValidateCmdResolveImage(commandBuffer, pResolveImageInfo->srcImage, pResolveImageInfo->srcImageLayout,
4002 pResolveImageInfo->dstImage, pResolveImageInfo->dstImageLayout, pResolveImageInfo->regionCount,
4003 pResolveImageInfo->pRegions, CMD_RESOLVEIMAGE2);
Jeff Leger178b1e52020-10-05 12:22:23 -04004004}
4005
4006template <typename RegionType>
4007bool CoreChecks::ValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4008 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Tony-LunarG542ae912021-11-04 16:06:44 -06004009 const RegionType *pRegions, VkFilter filter, CMD_TYPE cmd_type) const {
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07004010 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07004011 auto src_image_state = Get<IMAGE_STATE>(srcImage);
4012 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Tony-LunarG542ae912021-11-04 16:06:44 -06004013 const bool is_2 = (cmd_type == CMD_BLITIMAGE2KHR || cmd_type == CMD_BLITIMAGE2);
sfricke-samsung85584a72021-09-30 21:43:38 -07004014 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04004015
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004016 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07004017 if (cb_node) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06004018 skip |= ValidateCmd(cb_node.get(), cmd_type);
John Zulauf5c2750c2018-01-30 15:04:56 -07004019 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004020 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004021 const char *vuid;
Tony-LunarG542ae912021-11-04 16:06:44 -06004022 std::string loc_head = std::string(func_name);
4023 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00233" : "VUID-vkCmdBlitImage-srcImage-00233";
4024 const char *location1 = is_2 ? loc_head.append("(): pBlitImageInfo->srcImage").c_str() : "vkCmdBlitImage(): srcImage";
4025 skip |= ValidateImageSampleCount(src_image_state.get(), VK_SAMPLE_COUNT_1_BIT, location1, vuid);
4026 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-00234" : "VUID-vkCmdBlitImage-dstImage-00234";
4027 loc_head = std::string(func_name);
4028 const char *location2 = is_2 ? loc_head.append("(): pBlitImageInfo->dstImage").c_str() : "vkCmdBlitImage(): dstImage";
4029 skip |= ValidateImageSampleCount(dst_image_state.get(), VK_SAMPLE_COUNT_1_BIT, location2, vuid);
4030 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00220" : "VUID-vkCmdBlitImage-srcImage-00220";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004031 skip |= ValidateMemoryIsBoundToImage(src_image_state.get(), func_name, vuid);
Tony-LunarG542ae912021-11-04 16:06:44 -06004032 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-00225" : "VUID-vkCmdBlitImage-dstImage-00225";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004033 skip |= ValidateMemoryIsBoundToImage(dst_image_state.get(), func_name, vuid);
Tony-LunarG542ae912021-11-04 16:06:44 -06004034 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00219" : "VUID-vkCmdBlitImage-srcImage-00219";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004035 skip |= ValidateImageUsageFlags(src_image_state.get(), VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04004036 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tony-LunarG542ae912021-11-04 16:06:44 -06004037 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-00224" : "VUID-vkCmdBlitImage-dstImage-00224";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004038 skip |= ValidateImageUsageFlags(dst_image_state.get(), VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04004039 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Jeremy Gebben9f537102021-10-05 16:37:12 -06004040 skip |= ValidateCmd(cb_node.get(), cmd_type);
Tony-LunarG542ae912021-11-04 16:06:44 -06004041 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-01999" : "VUID-vkCmdBlitImage-srcImage-01999";
4042 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(), VK_FORMAT_FEATURE_2_BLIT_SRC_BIT, func_name, vuid);
4043 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-02000" : "VUID-vkCmdBlitImage-dstImage-02000";
4044 skip |= ValidateImageFormatFeatureFlags(dst_image_state.get(), VK_FORMAT_FEATURE_2_BLIT_DST_BIT, func_name, vuid);
4045 vuid = is_2 ? "VUID-vkCmdBlitImage2-commandBuffer-01834" : "VUID-vkCmdBlitImage-commandBuffer-01834";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004046 skip |= ValidateProtectedImage(cb_node.get(), src_image_state.get(), func_name, vuid);
Tony-LunarG542ae912021-11-04 16:06:44 -06004047 vuid = is_2 ? "VUID-vkCmdBlitImage2-commandBuffer-01835" : "VUID-vkCmdBlitImage-commandBuffer-01835";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004048 skip |= ValidateProtectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
Tony-LunarG542ae912021-11-04 16:06:44 -06004049 vuid = is_2 ? "VUID-vkCmdBlitImage2-commandBuffer-01836" : "VUID-vkCmdBlitImage-commandBuffer-01836";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004050 skip |= ValidateUnprotectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
sfricke-samsung022fa252020-07-24 03:26:16 -07004051
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02004052 // Validation for VK_EXT_fragment_density_map
4053 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004054 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004055 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004056 "%s: srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
4057 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02004058 }
4059 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004060 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004061 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004062 "%s: dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
4063 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02004064 }
4065
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06004066 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004067
Dave Houlton33c2d252017-06-09 17:08:32 -06004068 VkFormat src_format = src_image_state->createInfo.format;
4069 VkFormat dst_format = dst_image_state->createInfo.format;
4070 VkImageType src_type = src_image_state->createInfo.imageType;
4071 VkImageType dst_type = dst_image_state->createInfo.imageType;
4072
Cort Stratton186b1a22018-05-01 20:18:06 -04004073 if (VK_FILTER_LINEAR == filter) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004074 vuid = is_2 ? "VUID-VkBlitImageInfo2-filter-02001" : "VUID-vkCmdBlitImage-filter-02001";
4075 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(), VK_FORMAT_FEATURE_2_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Jeremy Gebben9f537102021-10-05 16:37:12 -06004076 func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04004077 } else if (VK_FILTER_CUBIC_IMG == filter) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004078 vuid = is_2 ? "VUID-VkBlitImageInfo2-filter-02002" : "VUID-vkCmdBlitImage-filter-02002";
4079 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(), VK_FORMAT_FEATURE_2_SAMPLED_IMAGE_FILTER_CUBIC_BIT,
Jeff Leger178b1e52020-10-05 12:22:23 -04004080 func_name, vuid);
Dave Houlton33c2d252017-06-09 17:08:32 -06004081 }
4082
sfricke-samsung10b35ce2021-09-29 08:50:20 -07004083 if (FormatRequiresYcbcrConversionExplicitly(src_format)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004084 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-06421" : "VUID-vkCmdBlitImage-srcImage-06421";
Jeff Leger178b1e52020-10-05 12:22:23 -04004085 skip |= LogError(device, vuid,
4086 "%s: srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004087 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04004088 func_name, string_VkFormat(src_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004089 }
4090
sfricke-samsung10b35ce2021-09-29 08:50:20 -07004091 if (FormatRequiresYcbcrConversionExplicitly(dst_format)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004092 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-06422" : "VUID-vkCmdBlitImage-dstImage-06422";
Jeff Leger178b1e52020-10-05 12:22:23 -04004093 skip |= LogError(device, vuid,
4094 "%s: dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004095 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04004096 func_name, string_VkFormat(dst_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004097 }
4098
ziga-lunarg52604a12021-09-09 16:02:05 +02004099 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_2D != src_type)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004100 vuid = is_2 ? "VUID-VkBlitImageInfo2-filter-00237" : "VUID-vkCmdBlitImage-filter-00237";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004101 skip |= LogError(cb_node->commandBuffer(), vuid,
ziga-lunarg52604a12021-09-09 16:02:05 +02004102 "%s: source image type must be VK_IMAGE_TYPE_2D when cubic filtering is specified.", func_name);
Dave Houlton33c2d252017-06-09 17:08:32 -06004103 }
4104
Dave Houlton33c2d252017-06-09 17:08:32 -06004105 // Validate consistency for unsigned formats
sfricke-samsunge3086292021-11-18 23:02:35 -08004106 if (FormatIsUINT(src_format) != FormatIsUINT(dst_format)) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004107 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004108 ss << func_name << ": If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06004109 << "the other one must also have unsigned integer format. "
4110 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Tony-LunarG542ae912021-11-04 16:06:44 -06004111 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00230" : "VUID-vkCmdBlitImage-srcImage-00230";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004112 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004113 }
4114
4115 // Validate consistency for signed formats
sfricke-samsunge3086292021-11-18 23:02:35 -08004116 if (FormatIsSINT(src_format) != FormatIsSINT(dst_format)) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004117 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004118 ss << func_name << ": If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06004119 << "the other one must also have signed integer format. "
4120 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Tony-LunarG542ae912021-11-04 16:06:44 -06004121 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00229" : "VUID-vkCmdBlitImage-srcImage-00229";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004122 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004123 }
4124
4125 // Validate filter for Depth/Stencil formats
4126 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
4127 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004128 ss << func_name << ": If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06004129 << "then filter must be VK_FILTER_NEAREST.";
Tony-LunarG542ae912021-11-04 16:06:44 -06004130 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00232" : "VUID-vkCmdBlitImage-srcImage-00232";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004131 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004132 }
4133
4134 // Validate aspect bits and formats for depth/stencil images
4135 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
4136 if (src_format != dst_format) {
4137 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004138 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 -06004139 << "stencil, the other one must have exactly the same format. "
4140 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
4141 << string_VkFormat(dst_format);
Tony-LunarG542ae912021-11-04 16:06:44 -06004142 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00231" : "VUID-vkCmdBlitImage-srcImage-00231";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004143 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004144 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004145 } // Depth or Stencil
4146
4147 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004148 const char *invalid_src_layout_vuid =
Tony-LunarG542ae912021-11-04 16:06:44 -06004149 is_2 ? ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
4150 ? "VUID-VkBlitImageInfo2-srcImageLayout-01398"
4151 : "VUID-VkBlitImageInfo2-srcImageLayout-00222")
sfricke-samsung45996a42021-09-16 13:45:27 -07004152 : ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04004153 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
4154 : "VUID-vkCmdBlitImage-srcImageLayout-00222");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004155 const char *invalid_dst_layout_vuid =
Tony-LunarG542ae912021-11-04 16:06:44 -06004156 is_2 ? ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
4157 ? "VUID-VkBlitImageInfo2-dstImageLayout-01399"
4158 : "VUID-VkBlitImageInfo2-dstImageLayout-00227")
sfricke-samsung45996a42021-09-16 13:45:27 -07004159 : ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04004160 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
4161 : "VUID-vkCmdBlitImage-dstImageLayout-00227");
Aitor Camachoc22c3602022-06-07 20:45:50 +02004162
4163 bool same_image = (src_image_state == dst_image_state);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004164 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05004165 const RegionType region = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004166 bool hit_error = false;
Tony-LunarG542ae912021-11-04 16:06:44 -06004167
Aitor Camachoc22c3602022-06-07 20:45:50 +02004168 // When performing blit from and to same subresource, VK_IMAGE_LAYOUT_GENERAL is the only option
4169 const auto &src_sub = pRegions[i].srcSubresource;
4170 const auto &dst_sub = pRegions[i].dstSubresource;
4171 bool same_subresource =
4172 (same_image && (src_sub.mipLevel == dst_sub.mipLevel) && (src_sub.baseArrayLayer == dst_sub.baseArrayLayer));
4173 VkImageLayout source_optimal = (same_subresource ? VK_IMAGE_LAYOUT_GENERAL : VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL);
4174 VkImageLayout destination_optimal = (same_subresource ? VK_IMAGE_LAYOUT_GENERAL : VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL);
4175
Tony-LunarG542ae912021-11-04 16:06:44 -06004176 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImageLayout-00221" : "VUID-vkCmdBlitImage-srcImageLayout-00221";
Aitor Camachoc22c3602022-06-07 20:45:50 +02004177 skip |= VerifyImageLayout(*cb_node, *src_image_state, region.srcSubresource, srcImageLayout, source_optimal, func_name,
4178 invalid_src_layout_vuid, vuid, &hit_error);
Tony-LunarG542ae912021-11-04 16:06:44 -06004179 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImageLayout-00226" : "VUID-vkCmdBlitImage-dstImageLayout-00226";
Aitor Camachoc22c3602022-06-07 20:45:50 +02004180 skip |= VerifyImageLayout(*cb_node, *dst_image_state, region.dstSubresource, dstImageLayout, destination_optimal,
4181 func_name, invalid_dst_layout_vuid, vuid, &hit_error);
sfricke-samsung71f04e32022-03-16 01:21:21 -05004182 skip |= ValidateImageSubresourceLayers(cb_node.get(), &region.srcSubresource, func_name, "srcSubresource", i);
4183 skip |= ValidateImageSubresourceLayers(cb_node.get(), &region.dstSubresource, func_name, "dstSubresource", i);
Tony-LunarG542ae912021-11-04 16:06:44 -06004184 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcSubresource-01705" : "VUID-vkCmdBlitImage-srcSubresource-01705";
sfricke-samsung71f04e32022-03-16 01:21:21 -05004185 skip |= ValidateImageMipLevel(cb_node.get(), src_image_state.get(), region.srcSubresource.mipLevel, i, func_name,
Jeremy Gebben9f537102021-10-05 16:37:12 -06004186 "srcSubresource", vuid);
Tony-LunarG542ae912021-11-04 16:06:44 -06004187 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstSubresource-01706" : "VUID-vkCmdBlitImage-dstSubresource-01706";
sfricke-samsung71f04e32022-03-16 01:21:21 -05004188 skip |= ValidateImageMipLevel(cb_node.get(), dst_image_state.get(), region.dstSubresource.mipLevel, i, func_name,
Jeremy Gebben9f537102021-10-05 16:37:12 -06004189 "dstSubresource", vuid);
Tony-LunarG542ae912021-11-04 16:06:44 -06004190 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcSubresource-01707" : "VUID-vkCmdBlitImage-srcSubresource-01707";
sfricke-samsung71f04e32022-03-16 01:21:21 -05004191 skip |= ValidateImageArrayLayerRange(cb_node.get(), src_image_state.get(), region.srcSubresource.baseArrayLayer,
4192 region.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
Tony-LunarG542ae912021-11-04 16:06:44 -06004193 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstSubresource-01708" : "VUID-vkCmdBlitImage-dstSubresource-01708";
sfricke-samsung71f04e32022-03-16 01:21:21 -05004194 skip |= ValidateImageArrayLayerRange(cb_node.get(), dst_image_state.get(), region.dstSubresource.baseArrayLayer,
4195 region.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004196 // Warn for zero-sized regions
sfricke-samsung71f04e32022-03-16 01:21:21 -05004197 if ((region.srcOffsets[0].x == region.srcOffsets[1].x) || (region.srcOffsets[0].y == region.srcOffsets[1].y) ||
4198 (region.srcOffsets[0].z == region.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004199 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004200 ss << func_name << ": pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004201 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004202 }
sfricke-samsung71f04e32022-03-16 01:21:21 -05004203 if ((region.dstOffsets[0].x == region.dstOffsets[1].x) || (region.dstOffsets[0].y == region.dstOffsets[1].y) ||
4204 (region.dstOffsets[0].z == region.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004205 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004206 ss << func_name << ": pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004207 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004208 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004209
4210 // Check that src/dst layercounts match
sfricke-samsung71f04e32022-03-16 01:21:21 -05004211 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004212 vuid = is_2 ? "VUID-VkImageBlit2-layerCount-00239" : "VUID-VkImageBlit-layerCount-00239";
Jeff Leger178b1e52020-10-05 12:22:23 -04004213 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004214 LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004215 "%s: layerCount in source and destination subresource of pRegions[%d] does not match.", func_name, i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004216 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07004217
sfricke-samsung71f04e32022-03-16 01:21:21 -05004218 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004219 vuid = is_2 ? "VUID-VkImageBlit2-aspectMask-00238" : "VUID-VkImageBlit-aspectMask-00238";
Jeff Leger178b1e52020-10-05 12:22:23 -04004220 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004221 LogError(cb_node->commandBuffer(), vuid, "%s: aspectMask members for pRegion[%d] do not match.", func_name, i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07004222 }
Dave Houlton48989f32017-05-26 15:01:46 -06004223
sfricke-samsung71f04e32022-03-16 01:21:21 -05004224 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004225 vuid = is_2 ? "VUID-VkBlitImageInfo2-aspectMask-00241" : "VUID-vkCmdBlitImage-aspectMask-00241";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004226 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004227 "%s: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004228 "image format %s.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004229 func_name, i, region.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004230 }
4231
sfricke-samsung71f04e32022-03-16 01:21:21 -05004232 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004233 vuid = is_2 ? "VUID-VkBlitImageInfo2-aspectMask-00242" : "VUID-vkCmdBlitImage-aspectMask-00242";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004234 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004235 "%s: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004236 func_name, i, region.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004237 }
4238
Dave Houlton48989f32017-05-26 15:01:46 -06004239 // Validate source image offsets
sfricke-samsung71f04e32022-03-16 01:21:21 -05004240 VkExtent3D src_extent = src_image_state->GetSubresourceExtent(region.srcSubresource);
Dave Houlton33c2d252017-06-09 17:08:32 -06004241 if (VK_IMAGE_TYPE_1D == src_type) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05004242 if ((0 != region.srcOffsets[0].y) || (1 != region.srcOffsets[1].y)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004243 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00245" : "VUID-vkCmdBlitImage-srcImage-00245";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004244 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004245 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
4246 "of (%1d, %1d). These must be (0, 1).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004247 func_name, i, region.srcOffsets[0].y, region.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004248 }
4249 }
4250
Dave Houlton33c2d252017-06-09 17:08:32 -06004251 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05004252 if ((0 != region.srcOffsets[0].z) || (1 != region.srcOffsets[1].z)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004253 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00247" : "VUID-vkCmdBlitImage-srcImage-00247";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004254 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004255 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
4256 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004257 func_name, i, region.srcOffsets[0].z, region.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004258 }
4259 }
4260
Dave Houlton33c2d252017-06-09 17:08:32 -06004261 bool oob = false;
sfricke-samsung71f04e32022-03-16 01:21:21 -05004262 if ((region.srcOffsets[0].x < 0) || (region.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
4263 (region.srcOffsets[1].x < 0) || (region.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004264 oob = true;
Tony-LunarG542ae912021-11-04 16:06:44 -06004265 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcOffset-00243" : "VUID-vkCmdBlitImage-srcOffset-00243";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004266 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004267 "%s: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004268 func_name, i, region.srcOffsets[0].x, region.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004269 }
sfricke-samsung71f04e32022-03-16 01:21:21 -05004270 if ((region.srcOffsets[0].y < 0) || (region.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
4271 (region.srcOffsets[1].y < 0) || (region.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004272 oob = true;
Tony-LunarG542ae912021-11-04 16:06:44 -06004273 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcOffset-00244" : "VUID-vkCmdBlitImage-srcOffset-00244";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004274 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004275 "%s: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004276 func_name, i, region.srcOffsets[0].y, region.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004277 }
sfricke-samsung71f04e32022-03-16 01:21:21 -05004278 if ((region.srcOffsets[0].z < 0) || (region.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
4279 (region.srcOffsets[1].z < 0) || (region.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004280 oob = true;
Tony-LunarG542ae912021-11-04 16:06:44 -06004281 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcOffset-00246" : "VUID-vkCmdBlitImage-srcOffset-00246";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004282 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004283 "%s: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004284 func_name, i, region.srcOffsets[0].z, region.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004285 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004286 if (oob) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004287 vuid = is_2 ? "VUID-VkBlitImageInfo2-pRegions-00215" : "VUID-vkCmdBlitImage-pRegions-00215";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004288 skip |= LogError(cb_node->commandBuffer(), vuid, "%s: region [%d] source image blit region exceeds image dimensions.",
Jeff Leger178b1e52020-10-05 12:22:23 -04004289 func_name, i);
Dave Houlton33c2d252017-06-09 17:08:32 -06004290 }
Dave Houlton48989f32017-05-26 15:01:46 -06004291
4292 // Validate dest image offsets
sfricke-samsung71f04e32022-03-16 01:21:21 -05004293 VkExtent3D dst_extent = dst_image_state->GetSubresourceExtent(region.dstSubresource);
Dave Houlton33c2d252017-06-09 17:08:32 -06004294 if (VK_IMAGE_TYPE_1D == dst_type) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05004295 if ((0 != region.dstOffsets[0].y) || (1 != region.dstOffsets[1].y)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004296 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-00250" : "VUID-vkCmdBlitImage-dstImage-00250";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004297 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004298 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
4299 "(%1d, %1d). These must be (0, 1).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004300 func_name, i, region.dstOffsets[0].y, region.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004301 }
4302 }
4303
Dave Houlton33c2d252017-06-09 17:08:32 -06004304 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05004305 if ((0 != region.dstOffsets[0].z) || (1 != region.dstOffsets[1].z)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004306 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-00252" : "VUID-vkCmdBlitImage-dstImage-00252";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004307 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004308 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004309 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004310 func_name, i, region.dstOffsets[0].z, region.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004311 }
4312 }
4313
Dave Houlton33c2d252017-06-09 17:08:32 -06004314 oob = false;
sfricke-samsung71f04e32022-03-16 01:21:21 -05004315 if ((region.dstOffsets[0].x < 0) || (region.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
4316 (region.dstOffsets[1].x < 0) || (region.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004317 oob = true;
Tony-LunarG542ae912021-11-04 16:06:44 -06004318 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstOffset-00248" : "VUID-vkCmdBlitImage-dstOffset-00248";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004319 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004320 "%s: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004321 func_name, i, region.dstOffsets[0].x, region.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004322 }
sfricke-samsung71f04e32022-03-16 01:21:21 -05004323 if ((region.dstOffsets[0].y < 0) || (region.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
4324 (region.dstOffsets[1].y < 0) || (region.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004325 oob = true;
Tony-LunarG542ae912021-11-04 16:06:44 -06004326 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstOffset-00249" : "VUID-vkCmdBlitImage-dstOffset-00249";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004327 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004328 "%s: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004329 func_name, i, region.dstOffsets[0].y, region.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004330 }
sfricke-samsung71f04e32022-03-16 01:21:21 -05004331 if ((region.dstOffsets[0].z < 0) || (region.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
4332 (region.dstOffsets[1].z < 0) || (region.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004333 oob = true;
Tony-LunarG542ae912021-11-04 16:06:44 -06004334 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstOffset-00251" : "VUID-vkCmdBlitImage-dstOffset-00251";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004335 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004336 "%s: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004337 func_name, i, region.dstOffsets[0].z, region.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004338 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004339 if (oob) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004340 vuid = is_2 ? "VUID-VkBlitImageInfo2-pRegions-00216" : "VUID-vkCmdBlitImage-pRegions-00216";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004341 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004342 "%s: region [%d] destination image blit region exceeds image dimensions.", func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004343 }
4344
Dave Houlton33c2d252017-06-09 17:08:32 -06004345 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05004346 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount) ||
4347 (0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004348 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00240" : "VUID-vkCmdBlitImage-srcImage-00240";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004349 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004350 "%s: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
4351 "layerCount other than 1.",
4352 func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004353 }
4354 }
aitor-lunarg607fe732022-03-31 22:00:08 +02004355
4356 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
4357 // must not overlap in memory
4358 if (srcImage == dstImage) {
4359 for (uint32_t j = 0; j < regionCount; j++) {
4360 if (RegionIntersectsBlit(&region, &pRegions[j], src_image_state->createInfo.imageType,
4361 FormatIsMultiplane(src_format))) {
4362 vuid = is_2 ? "VUID-VkBlitImageInfo2-pRegions-00217" : "VUID-vkCmdBlitImage-pRegions-00217";
4363 skip |= LogError(cb_node->commandBuffer(), vuid,
4364 "%s: pRegion[%" PRIu32 "] src overlaps with pRegions[%" PRIu32 "] dst.", func_name, i, j);
4365 }
4366 }
4367 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004368 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004369 } else {
4370 assert(0);
4371 }
4372 return skip;
4373}
4374
Jeff Leger178b1e52020-10-05 12:22:23 -04004375bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4376 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4377 const VkImageBlit *pRegions, VkFilter filter) const {
4378 return ValidateCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter,
Tony-LunarG542ae912021-11-04 16:06:44 -06004379 CMD_BLITIMAGE);
Jeff Leger178b1e52020-10-05 12:22:23 -04004380}
4381
4382bool CoreChecks::PreCallValidateCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) const {
4383 return ValidateCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4384 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
Tony-LunarG542ae912021-11-04 16:06:44 -06004385 pBlitImageInfo->filter, CMD_BLITIMAGE2KHR);
4386}
4387
4388bool CoreChecks::PreCallValidateCmdBlitImage2(VkCommandBuffer commandBuffer, const VkBlitImageInfo2 *pBlitImageInfo) const {
4389 return ValidateCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4390 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4391 pBlitImageInfo->filter, CMD_BLITIMAGE2);
Jeff Leger178b1e52020-10-05 12:22:23 -04004392}
4393
4394template <typename RegionType>
4395void CoreChecks::RecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
4396 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
4397 VkFilter filter) {
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07004398 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06004399 auto src_image_state = Get<IMAGE_STATE>(srcImage);
4400 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004401
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004402 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004403 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06004404 cb_node->SetImageInitialLayout(*src_image_state, pRegions[i].srcSubresource, srcImageLayout);
4405 cb_node->SetImageInitialLayout(*dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004406 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004407}
4408
Jeff Leger178b1e52020-10-05 12:22:23 -04004409void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4410 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4411 const VkImageBlit *pRegions, VkFilter filter) {
4412 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
4413 pRegions, filter);
4414 RecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter);
4415}
4416
4417void CoreChecks::PreCallRecordCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) {
4418 StateTracker::PreCallRecordCmdBlitImage2KHR(commandBuffer, pBlitImageInfo);
4419 RecordCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4420 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4421 pBlitImageInfo->filter);
4422}
4423
Tony-LunarG542ae912021-11-04 16:06:44 -06004424void CoreChecks::PreCallRecordCmdBlitImage2(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) {
4425 StateTracker::PreCallRecordCmdBlitImage2(commandBuffer, pBlitImageInfo);
4426 RecordCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4427 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4428 pBlitImageInfo->filter);
4429}
4430
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004431GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap &map, const IMAGE_STATE &image_state) {
John Zulauf2076e812020-01-08 14:55:54 -07004432 // This approach allows for a single hash lookup or/create new
Jeremy Gebben6335df62021-11-01 10:50:13 -06004433 auto &layout_map = map[&image_state];
John Zulauf17708d02021-02-22 11:20:58 -07004434 if (!layout_map) {
4435 layout_map.emplace(image_state.subresource_encoder.SubresourceCount());
John Zulauf2076e812020-01-08 14:55:54 -07004436 }
John Zulauf17708d02021-02-22 11:20:58 -07004437 return &layout_map;
John Zulauf2076e812020-01-08 14:55:54 -07004438}
4439
Jeremy Gebben6335df62021-11-01 10:50:13 -06004440const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, const IMAGE_STATE &image_state) {
4441 auto it = map.find(&image_state);
John Zulauf2076e812020-01-08 14:55:54 -07004442 if (it != map.end()) {
John Zulauf17708d02021-02-22 11:20:58 -07004443 return &it->second;
John Zulauf2076e812020-01-08 14:55:54 -07004444 }
4445 return nullptr;
4446}
4447
Jeremy Gebben53631302021-04-13 16:46:37 -06004448// Helper to update the Global or Overlay layout map
4449struct GlobalLayoutUpdater {
4450 bool update(VkImageLayout &dst, const image_layout_map::ImageSubresourceLayoutMap::LayoutEntry &src) const {
4451 if (src.current_layout != image_layout_map::kInvalidLayout && dst != src.current_layout) {
4452 dst = src.current_layout;
4453 return true;
4454 }
4455 return false;
4456 }
4457
4458 layer_data::optional<VkImageLayout> insert(const image_layout_map::ImageSubresourceLayoutMap::LayoutEntry &src) const {
4459 layer_data::optional<VkImageLayout> result;
4460 if (src.current_layout != image_layout_map::kInvalidLayout) {
4461 result.emplace(src.current_layout);
4462 }
4463 return result;
4464 }
4465};
4466
Shannon McPherson449fa9c2018-10-25 11:51:07 -06004467// 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 -07004468bool CoreChecks::ValidateCmdBufImageLayouts(const Location &loc, const CMD_BUFFER_STATE *pCB,
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004469 GlobalImageLayoutMap &overlayLayoutMap) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06004470 if (disabled[image_layout_validation]) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004471 bool skip = false;
John Zulauff660ad62019-03-23 07:16:05 -06004472 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07004473 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06004474 for (const auto &layout_map_entry : pCB->image_layout_map) {
Jeremy Gebben6335df62021-11-01 10:50:13 -06004475 const auto *image_state = layout_map_entry.first;
unknown089cdb82019-07-11 12:58:43 -06004476 const auto &subres_map = layout_map_entry.second;
Jeremy Gebben53631302021-04-13 16:46:37 -06004477 const auto &layout_map = subres_map->GetLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06004478 // Validate the initial_uses for each subresource referenced
Jeremy Gebben53631302021-04-13 16:46:37 -06004479 if (layout_map.empty()) continue;
John Zulauf2076e812020-01-08 14:55:54 -07004480
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004481 auto *overlay_map = GetLayoutRangeMap(overlayLayoutMap, *image_state);
Jeremy Gebben4a8881f2022-01-10 17:04:30 -07004482 const auto *global_map = image_state->layout_range_map.get();
4483 assert(global_map);
4484 auto global_map_guard = global_map->ReadLock();
John Zulauf2076e812020-01-08 14:55:54 -07004485
4486 // Note: don't know if it would matter
4487 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
4488
Jeremy Gebben53631302021-04-13 16:46:37 -06004489 auto pos = layout_map.begin();
4490 const auto end = layout_map.end();
4491 sparse_container::parallel_iterator<const GlobalImageLayoutRangeMap> current_layout(*overlay_map, *global_map,
4492 pos->first.begin);
John Zulauf2076e812020-01-08 14:55:54 -07004493 while (pos != end) {
Jeremy Gebben53631302021-04-13 16:46:37 -06004494 VkImageLayout initial_layout = pos->second.initial_layout;
4495 assert(initial_layout != image_layout_map::kInvalidLayout);
4496 if (initial_layout == image_layout_map::kInvalidLayout) {
4497 continue;
4498 }
4499
John Zulauf2076e812020-01-08 14:55:54 -07004500 VkImageLayout image_layout = kInvalidLayout;
Jeremy Gebben53631302021-04-13 16:46:37 -06004501
John Zulauf2076e812020-01-08 14:55:54 -07004502 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 -07004503 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004504 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07004505 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004506 image_layout = current_layout->pos_B->lower_bound->second;
4507 }
4508 const auto intersected_range = pos->first & current_layout->range;
4509 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
4510 // TODO: Set memory invalid which is in mem_tracker currently
4511 } else if (image_layout != initial_layout) {
Hans-Kristian Arntzen6cb03492021-07-05 16:57:31 +02004512 const auto aspect_mask = image_state->subresource_encoder.Decode(intersected_range.begin).aspectMask;
4513 bool matches = ImageLayoutMatches(aspect_mask, image_layout, initial_layout);
John Zulauf2076e812020-01-08 14:55:54 -07004514 if (!matches) {
John Zulauf2076e812020-01-08 14:55:54 -07004515 // We can report all the errors for the intersected range directly
4516 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
locke-lunarg296a3c92020-03-25 01:04:29 -06004517 const auto subresource = image_state->subresource_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004518 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004519 pCB->commandBuffer(), kVUID_Core_DrawState_InvalidImageLayout,
sfricke-samsung6b447aa2021-07-26 09:42:26 -07004520 "%s command buffer %s expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004521 "to be in layout %s--instead, current layout is %s.",
sfricke-samsung6b447aa2021-07-26 09:42:26 -07004522 loc.Message().c_str(), report_data->FormatHandle(pCB->commandBuffer()).c_str(),
Jeremy Gebben6335df62021-11-01 10:50:13 -06004523 report_data->FormatHandle(image_state->Handle()).c_str(), subresource.aspectMask, subresource.arrayLayer,
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004524 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
John Zulaufb61ed972019-04-09 16:12:35 -06004525 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004526 }
4527 }
John Zulauf2076e812020-01-08 14:55:54 -07004528 if (pos->first.includes(intersected_range.end)) {
4529 current_layout.seek(intersected_range.end);
4530 } else {
4531 ++pos;
4532 if (pos != end) {
4533 current_layout.seek(pos->first.begin);
4534 }
4535 }
John Zulauff660ad62019-03-23 07:16:05 -06004536 }
locke-lunargf155ccf2020-02-18 11:34:15 -07004537 // Update all layout set operations (which will be a subset of the initial_layouts)
Jeremy Gebben53631302021-04-13 16:46:37 -06004538 sparse_container::splice(*overlay_map, subres_map->GetLayoutMap(), GlobalLayoutUpdater());
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004539 }
John Zulauff660ad62019-03-23 07:16:05 -06004540
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004541 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004542}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07004543
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004544void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06004545 for (const auto &layout_map_entry : pCB->image_layout_map) {
Jeremy Gebben6335df62021-11-01 10:50:13 -06004546 const auto *image_state = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07004547 const auto &subres_map = layout_map_entry.second;
Jeremy Gebben4a8881f2022-01-10 17:04:30 -07004548 auto guard = image_state->layout_range_map->WriteLock();
4549 sparse_container::splice(*image_state->layout_range_map, subres_map->GetLayoutMap(), GlobalLayoutUpdater());
Tony Barbourdf013b92017-01-25 12:53:48 -07004550 }
4551}
4552
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004553// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004554// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
4555// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004556bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
4557 const VkImageLayout first_layout, const uint32_t attachment,
Mike Schuchardt2df08912020-12-15 16:28:09 -08004558 const VkAttachmentDescription2 &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004559 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004560 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
4561
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004562 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
sfricke-samsung55f01952020-03-24 08:16:41 -07004563 // for both loadOp and stencilLoaOp rp2 has it in 1 VU while rp1 has it in 2 VU with half behind Maintenance2 extension
4564 // Each is VUID is below in following order: rp2 -> rp1 with Maintenance2 -> rp1 with no extenstion
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004565 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07004566 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4567 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4568 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004569 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004570 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004571 string_VkImageLayout(first_layout));
sfricke-samsung45996a42021-09-16 13:45:27 -07004572 } else if ((use_rp2 == false) && IsExtEnabled(device_extensions.vk_khr_maintenance2) &&
sfricke-samsung55f01952020-03-24 08:16:41 -07004573 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL)) {
4574 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01566",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004575 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004576 string_VkImageLayout(first_layout));
4577 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4578 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004579 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004580 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004581 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004582 }
4583 }
sfricke-samsung55f01952020-03-24 08:16:41 -07004584
4585 // Same as above for loadOp, but for stencilLoadOp
4586 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
4587 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4588 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4589 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL))) {
4590 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02523",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004591 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004592 string_VkImageLayout(first_layout));
sfricke-samsung45996a42021-09-16 13:45:27 -07004593 } else if ((use_rp2 == false) && IsExtEnabled(device_extensions.vk_khr_maintenance2) &&
sfricke-samsung55f01952020-03-24 08:16:41 -07004594 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL)) {
4595 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01567",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004596 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004597 string_VkImageLayout(first_layout));
4598 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4599 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
4600 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-02511",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004601 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004602 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02004603 }
4604 }
4605
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004606 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004607}
4608
Mark Lobodzinski96210742017-02-09 10:33:46 -07004609// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4610// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004611template <typename T1>
4612bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
4613 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
4614 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004615 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004616 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004617 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004618 if (strict) {
4619 correct_usage = ((actual & desired) == desired);
4620 } else {
4621 correct_usage = ((actual & desired) != 0);
4622 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004623
Mark Lobodzinski96210742017-02-09 10:33:46 -07004624 if (!correct_usage) {
sfricke-samsungbb971942020-09-10 22:11:56 -07004625 // All callers should have a valid VUID
4626 assert(msgCode != kVUIDUndefined);
4627 skip =
4628 LogError(object, msgCode, "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4629 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004630 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004631 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004632}
4633
4634// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4635// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004636bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004637 char const *func_name, char const *usage_string) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004638 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image(),
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06004639 image_state->Handle(), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004640}
4641
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004642bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags2KHR desired,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004643 char const *func_name, const char *vuid) const {
Cort Stratton186b1a22018-05-01 20:18:06 -04004644 bool skip = false;
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004645 const VkFormatFeatureFlags2KHR image_format_features = image_state->format_features;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004646 if ((image_format_features & desired) != desired) {
4647 // Same error, but more details if it was an AHB external format
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06004648 if (image_state->HasAHBFormat()) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004649 skip |= LogError(image_state->image(), vuid,
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004650 "In %s, VkFormatFeatureFlags (0x%" PRIxLEAST64 ") does not support required feature %s for the external format "
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004651 "found in VkAndroidHardwareBufferFormatPropertiesANDROID::formatFeatures used by %s.",
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004652 func_name, image_format_features, string_VkFormatFeatureFlags2KHR(desired).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004653 report_data->FormatHandle(image_state->image()).c_str());
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004654 } else {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004655 skip |= LogError(image_state->image(), vuid,
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004656 "In %s, VkFormatFeatureFlags (0x%" PRIxLEAST64 ") does not support required feature %s for format %u used by %s "
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004657 "with tiling %s.",
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004658 func_name, image_format_features, string_VkFormatFeatureFlags2KHR(desired).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004659 image_state->createInfo.format, report_data->FormatHandle(image_state->image()).c_str(),
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004660 string_VkImageTiling(image_state->createInfo.tiling));
Cort Stratton186b1a22018-05-01 20:18:06 -04004661 }
4662 }
4663 return skip;
4664}
4665
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004666bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004667 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004668 bool skip = false;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004669 const VkImageAspectFlags apsect_mask = subresource_layers->aspectMask;
Cort Strattond619a302018-05-17 19:46:32 -07004670 // layerCount must not be zero
4671 if (subresource_layers->layerCount == 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004672 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-layerCount-01700",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004673 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004674 }
4675 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004676 if (apsect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004677 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-00168",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004678 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004679 }
4680 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004681 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 -06004682 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-00167",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004683 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4684 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4685 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004686 }
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004687 // aspectMask must not contain VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT
4688 if (apsect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
4689 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004690 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-02247",
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004691 "In %s, pRegions[%u].%s.aspectMask has a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit set.", func_name, i,
4692 member);
4693 }
Cort Strattond619a302018-05-17 19:46:32 -07004694 return skip;
4695}
4696
Mark Lobodzinski96210742017-02-09 10:33:46 -07004697// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4698// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004699bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004700 char const *func_name, char const *usage_string) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004701 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer(),
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06004702 buffer_state->Handle(), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004703}
4704
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004705bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004706 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004707 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004708
4709 const VkDeviceSize &range = pCreateInfo->range;
4710 if (range != VK_WHOLE_SIZE) {
4711 // Range must be greater than 0
4712 if (range <= 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004713 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00928",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004714 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004715 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4716 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004717 }
4718 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004719 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4720 if (SafeModulo(range, format_size) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004721 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00929",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004722 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004723 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4724 "(%" PRIu32 ").",
4725 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004726 }
4727 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004728 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004729 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00930",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004730 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004731 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4732 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4733 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004734 }
4735 // The sum of range and offset must be less than or equal to the size of buffer
4736 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004737 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-offset-00931",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004738 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004739 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4740 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4741 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004742 }
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004743 } else {
4744 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4745
4746 // Size of buffer - offset, divided by the element size of format must be less than or equal to
4747 // VkPhysicalDeviceLimits::maxTexelBufferElements
4748 if (SafeDivision(buffer_state->createInfo.size - pCreateInfo->offset, format_size) >
4749 device_limits->maxTexelBufferElements) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004750 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-04059",
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004751 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
4752 ") equals VK_WHOLE_SIZE, the buffer's size (%" PRIuLEAST64 ") minus the offset (%" PRIuLEAST64
4753 "), divided by the element size of the format (%" PRIu32
4754 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4755 range, buffer_state->createInfo.size, pCreateInfo->offset, format_size,
4756 device_limits->maxTexelBufferElements);
4757 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004758 }
4759 return skip;
4760}
4761
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004762bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004763 bool skip = false;
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004764 const VkFormatProperties3KHR format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004765 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004766 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_2_UNIFORM_TEXEL_BUFFER_BIT_KHR)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004767 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-00933",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004768 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004769 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format (%s) must "
4770 "be supported for uniform texel buffers",
4771 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004772 }
4773 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004774 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_2_STORAGE_TEXEL_BUFFER_BIT_KHR)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004775 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-00934",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004776 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004777 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format (%s) must "
4778 "be supported for storage texel buffers",
4779 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004780 }
4781 return skip;
4782}
4783
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004784bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004785 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004786 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004787
Dave Houltond8ed0212018-05-16 17:18:24 -06004788 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004789
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004790 auto chained_devaddr_struct = LvlFindInChain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
Jeff Bolz87697532019-01-11 22:54:00 -06004791 if (chained_devaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004792 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz87697532019-01-11 22:54:00 -06004793 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004794 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4795 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004796 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004797 }
4798 }
4799
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004800 auto chained_opaqueaddr_struct = LvlFindInChain<VkBufferOpaqueCaptureAddressCreateInfo>(pCreateInfo->pNext);
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004801 if (chained_opaqueaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004802 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004803 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004804 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
Mike Schuchardt2df08912020-12-15 16:28:09 -08004805 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfo::opaqueCaptureAddress"
4806 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004807 }
4808 }
4809
ziga-lunarg2e2be1e2021-07-18 23:09:15 +02004810 auto dedicated_allocation_buffer = LvlFindInChain<VkDedicatedAllocationBufferCreateInfoNV>(pCreateInfo->pNext);
4811 if (dedicated_allocation_buffer && dedicated_allocation_buffer->dedicatedAllocation == VK_TRUE) {
4812 if (pCreateInfo->flags &
4813 (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT)) {
4814 skip |= LogError(device, "VUID-VkBufferCreateInfo-pNext-01571",
4815 "vkCreateBuffer(): pCreateInfos->flags must not include VK_BUFFER_CREATE_SPARSE_BINDING_BIT, "
4816 "VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT, or VK_BUFFER_CREATE_SPARSE_ALIASED_BIT when "
4817 "VkDedicatedAllocationBufferCreateInfoNV is in pNext chain with dedicatedAllocation VK_TRUE.");
4818 }
4819 }
4820
Mike Schuchardt2df08912020-12-15 16:28:09 -08004821 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz33fc6722020-03-31 12:58:16 -05004822 !enabled_features.core12.bufferDeviceAddressCaptureReplay &&
sfricke-samsung828e59d2021-08-22 23:20:49 -07004823 !enabled_features.buffer_device_address_ext_features.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004824 skip |= LogError(
4825 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004826 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004827 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT set.");
Jeff Bolz87697532019-01-11 22:54:00 -06004828 }
4829
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004830 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
sfricke-samsung45996a42021-09-16 13:45:27 -07004831 const char *vuid = IsExtEnabled(device_extensions.vk_khr_get_physical_device_properties2)
4832 ? "VUID-VkBufferCreateInfo-sharingMode-01419"
4833 : "VUID-VkBufferCreateInfo-sharingMode-01391";
Mark Lobodzinski314b9162020-07-16 15:33:08 -06004834 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
ziga-lunarga0b4f8a2021-07-28 13:23:02 +02004835 "vkCreateBuffer", "pCreateInfo->pQueueFamilyIndices", vuid);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004836 }
4837
sfricke-samsungedce77a2020-07-03 22:35:13 -07004838 if ((pCreateInfo->flags & VK_BUFFER_CREATE_PROTECTED_BIT) != 0) {
4839 if (enabled_features.core11.protectedMemory == VK_FALSE) {
4840 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-01887",
4841 "vkCreateBuffer(): the protectedMemory device feature is disabled: Buffers cannot be created with the "
4842 "VK_BUFFER_CREATE_PROTECTED_BIT set.");
4843 }
4844 const VkBufferCreateFlags invalid_flags =
4845 VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT;
4846 if ((pCreateInfo->flags & invalid_flags) != 0) {
4847 skip |= LogError(device, "VUID-VkBufferCreateInfo-None-01888",
4848 "vkCreateBuffer(): VK_BUFFER_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at "
4849 "same time (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | "
4850 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT).");
4851 }
4852 }
4853
ziga-lunargfe74b8d2022-04-18 17:37:46 +02004854 if ((pCreateInfo->usage & (VK_BUFFER_USAGE_VIDEO_DECODE_SRC_BIT_KHR | VK_BUFFER_USAGE_VIDEO_DECODE_DST_BIT_KHR)) > 0) {
4855 bool has_decode_codec_operation = false;
4856 const auto* video_profiles = LvlFindInChain<VkVideoProfilesKHR>(pCreateInfo->pNext);
4857 if (video_profiles) {
4858 for (uint32_t i = 0; i < video_profiles->profileCount; ++i) {
4859 if (video_profiles->pProfiles[i].videoCodecOperation &
4860 (VK_VIDEO_CODEC_OPERATION_DECODE_H264_BIT_EXT | VK_VIDEO_CODEC_OPERATION_DECODE_H265_BIT_EXT)) {
4861 has_decode_codec_operation = true;
4862 break;
4863 }
4864 }
4865 }
4866 if (!has_decode_codec_operation) {
4867 skip |= LogError(device, "VUID-VkBufferCreateInfo-usage-04813",
4868 "vkCreateBuffer(): pCreateInfo->usage is %s, but pNext chain does not include VkVideoProfilesKHR with "
4869 "a decode codec-operation.",
4870 string_VkBufferUsageFlags(pCreateInfo->usage).c_str());
4871 }
4872 }
4873 if ((pCreateInfo->usage & (VK_BUFFER_USAGE_VIDEO_ENCODE_SRC_BIT_KHR | VK_BUFFER_USAGE_VIDEO_ENCODE_DST_BIT_KHR)) > 0) {
4874 bool has_encode_codec_operation = false;
4875 const auto *video_profiles = LvlFindInChain<VkVideoProfilesKHR>(pCreateInfo->pNext);
4876 if (video_profiles) {
4877 for (uint32_t i = 0; i < video_profiles->profileCount; ++i) {
4878 if (video_profiles->pProfiles[i].videoCodecOperation &
4879 (VK_VIDEO_CODEC_OPERATION_ENCODE_H264_BIT_EXT | VK_VIDEO_CODEC_OPERATION_ENCODE_H265_BIT_EXT)) {
4880 has_encode_codec_operation = true;
4881 break;
4882 }
4883 }
4884 }
4885 if (!has_encode_codec_operation) {
4886 skip |= LogError(device, "VUID-VkBufferCreateInfo-usage-04814",
4887 "vkCreateBuffer(): pCreateInfo->usage is %s, but pNext chain does not include VkVideoProfilesKHR with "
4888 "an encode codec-operation.",
4889 string_VkBufferUsageFlags(pCreateInfo->usage).c_str());
4890 }
4891 }
4892
Mark Lobodzinski96210742017-02-09 10:33:46 -07004893 return skip;
4894}
4895
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004896bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004897 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004898 bool skip = false;
Jeremy Gebbenf4449392022-01-28 10:09:10 -07004899 auto buffer_state = Get<BUFFER_STATE>(pCreateInfo->buffer);
sfricke-samsung2e827212021-09-28 07:52:08 -07004900
4901 if (FormatIsDepthOrStencil(pCreateInfo->format)) {
4902 // Should never hopefully get here, but there are known driver advertising the wrong feature flags
4903 // see https://gitlab.khronos.org/vulkan/vulkan/-/merge_requests/4849
4904 skip |= LogError(device, kVUID_Core_invalidDepthStencilFormat,
4905 "vkCreateBufferView(): format is a depth/stencil format (%s) but depth/stencil formats do not have a "
4906 "defined sizes for alignment, replace with a color format.",
4907 string_VkFormat(pCreateInfo->format));
4908 }
4909
Mark Lobodzinski96210742017-02-09 10:33:46 -07004910 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4911 if (buffer_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06004912 skip |=
4913 ValidateMemoryIsBoundToBuffer(buffer_state.get(), "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004914 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4915 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Jeremy Gebben9f537102021-10-05 16:37:12 -06004916 skip |= ValidateBufferUsageFlags(buffer_state.get(),
Dave Houltond8ed0212018-05-16 17:18:24 -06004917 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4918 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4919 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004920
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004921 // Buffer view offset must be less than the size of buffer
4922 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004923 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-offset-00925",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004924 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004925 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4926 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004927 }
4928
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004929 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004930 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4931 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4932 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
sfricke-samsung45996a42021-09-16 13:45:27 -07004933 const char *vuid = IsExtEnabled(device_extensions.vk_ext_texel_buffer_alignment)
4934 ? "VUID-VkBufferViewCreateInfo-offset-02749"
4935 : "VUID-VkBufferViewCreateInfo-offset-00926";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004936 skip |= LogError(buffer_state->buffer(), vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004937 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004938 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4939 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004940 }
4941
4942 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004943 VkDeviceSize element_size = FormatElementSize(pCreateInfo->format);
4944 if ((element_size % 3) == 0) {
4945 element_size /= 3;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004946 }
4947 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004948 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05004949 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4950 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004951 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004952 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004953 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004954 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004955 buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-02750",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004956 "vkCreateBufferView(): If buffer was created with usage containing "
4957 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004958 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4959 ") must be a multiple of the lesser of "
4960 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4961 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4962 "(%" PRId32
4963 ") is VK_TRUE, the size of a texel of the requested format. "
4964 "If the size of a texel is a multiple of three bytes, then the size of a "
4965 "single component of format is used instead",
4966 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4967 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4968 }
4969 }
4970 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004971 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05004972 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4973 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004974 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004975 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004976 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004977 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004978 buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-02751",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004979 "vkCreateBufferView(): If buffer was created with usage containing "
4980 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004981 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4982 ") must be a multiple of the lesser of "
4983 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4984 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4985 "(%" PRId32
4986 ") is VK_TRUE, the size of a texel of the requested format. "
4987 "If the size of a texel is a multiple of three bytes, then the size of a "
4988 "single component of format is used instead",
4989 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4990 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4991 }
4992 }
4993 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004994
Jeremy Gebben9f537102021-10-05 16:37:12 -06004995 skip |= ValidateBufferViewRange(buffer_state.get(), pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004996
Jeremy Gebben9f537102021-10-05 16:37:12 -06004997 skip |= ValidateBufferViewBuffer(buffer_state.get(), pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004998 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004999 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07005000}
5001
Mark Lobodzinski602de982017-02-09 11:01:33 -07005002// For the given format verify that the aspect masks make sense
Aitor Camachoeb35fed2022-06-07 14:07:42 +02005003bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, bool is_image_disjoint,
5004 const char *func_name, const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005005 bool skip = false;
sfricke-samsung79b00482020-04-01 21:15:50 -07005006 // checks color format and (single-plane or non-disjoint)
5007 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
Aitor Camachoeb35fed2022-06-07 14:07:42 +02005008 if ((FormatIsColor(format)) && ((FormatIsMultiplane(format) == false) || (is_image_disjoint == false))) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005009 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08005010 skip |= LogError(
5011 image, vuid,
5012 "%s: Using format (%s) with aspect flags (%s) but color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.",
5013 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005014 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08005015 skip |= LogError(image, vuid,
5016 "%s: Using format (%s) with aspect flags (%s) but color image formats must have ONLY the "
5017 "VK_IMAGE_ASPECT_COLOR_BIT set.",
5018 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005019 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06005020 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005021 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005022 skip |= LogError(image, vuid,
sfricke-samsung7687a482021-01-29 23:19:22 -08005023 "%s: Using format (%s) with aspect flags (%s) but depth/stencil image formats must have at least one "
5024 "of VK_IMAGE_ASPECT_DEPTH_BIT and VK_IMAGE_ASPECT_STENCIL_BIT set.",
5025 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005026 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005027 skip |= LogError(image, vuid,
sfricke-samsung7687a482021-01-29 23:19:22 -08005028 "%s: Using format (%s) with aspect flags (%s) but combination depth/stencil image formats can have "
5029 "only the VK_IMAGE_ASPECT_DEPTH_BIT and VK_IMAGE_ASPECT_STENCIL_BIT set.",
5030 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005031 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06005032 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005033 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08005034 skip |= LogError(image, vuid,
5035 "%s: Using format (%s) with aspect flags (%s) but depth-only image formats must have the "
5036 "VK_IMAGE_ASPECT_DEPTH_BIT set.",
5037 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005038 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08005039 skip |= LogError(image, vuid,
5040 "%s: Using format (%s) with aspect flags (%s) but depth-only image formats can have only the "
5041 "VK_IMAGE_ASPECT_DEPTH_BIT set.",
5042 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005043 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06005044 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005045 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08005046 skip |= LogError(image, vuid,
5047 "%s: Using format (%s) with aspect flags (%s) but stencil-only image formats must have the "
5048 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
5049 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005050 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08005051 skip |= LogError(image, vuid,
5052 "%s: Using format (%s) with aspect flags (%s) but stencil-only image formats can have only the "
5053 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
5054 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005055 }
Dave Houlton501b15b2018-03-30 15:07:41 -06005056 } else if (FormatIsMultiplane(format)) {
5057 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
5058 if (3 == FormatPlaneCount(format)) {
5059 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
5060 }
5061 if ((aspect_mask & valid_flags) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08005062 skip |= LogError(image, vuid,
5063 "%s: Using format (%s) with aspect flags (%s) but multi-plane image formats may have only "
5064 "VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs set, where n = [0, 1, 2].",
5065 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Dave Houlton501b15b2018-03-30 15:07:41 -06005066 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005067 }
5068 return skip;
5069}
5070
ziga-lunarg69aa72f2022-03-29 15:24:35 +02005071bool CoreChecks::ValidateImageAcquired(IMAGE_STATE const &image_state, const char *func_name) const {
ziga-lunarg04e94b32021-10-03 01:42:37 +02005072 bool skip = false;
5073
ziga-lunarg04e94b32021-10-03 01:42:37 +02005074 return skip;
5075}
5076
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005077bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
5078 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005079 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
Jeremy Gebben5573a8c2021-06-04 08:55:10 -06005080 const SubresourceRangeErrorCodes &errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005081 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02005082
5083 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02005084 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005085 skip |= LogError(image, errorCodes.base_mip_err,
5086 "%s: %s.baseMipLevel (= %" PRIu32
5087 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
5088 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02005089 }
Petr Kraus4d718682017-05-18 03:38:41 +02005090
Petr Krausffa94af2017-08-08 21:46:02 +02005091 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
5092 if (subresourceRange.levelCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07005093 skip |=
5094 LogError(image, "VUID-VkImageSubresourceRange-levelCount-01720", "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02005095 } else {
5096 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02005097
Petr Krausffa94af2017-08-08 21:46:02 +02005098 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005099 skip |= LogError(image, errorCodes.mip_count_err,
5100 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
5101 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
5102 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
5103 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02005104 }
Petr Kraus4d718682017-05-18 03:38:41 +02005105 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005106 }
Petr Kraus4d718682017-05-18 03:38:41 +02005107
5108 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02005109 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005110 skip |= LogError(image, errorCodes.base_layer_err,
5111 "%s: %s.baseArrayLayer (= %" PRIu32
5112 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
5113 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02005114 }
Petr Kraus4d718682017-05-18 03:38:41 +02005115
Petr Krausffa94af2017-08-08 21:46:02 +02005116 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
5117 if (subresourceRange.layerCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07005118 skip |=
5119 LogError(image, "VUID-VkImageSubresourceRange-layerCount-01721", "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02005120 } else {
5121 const uint64_t necessary_layer_count =
5122 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02005123
Petr Krausffa94af2017-08-08 21:46:02 +02005124 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005125 skip |= LogError(image, errorCodes.layer_count_err,
5126 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
5127 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
5128 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
5129 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02005130 }
Petr Kraus4d718682017-05-18 03:38:41 +02005131 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005132 }
Petr Kraus4d718682017-05-18 03:38:41 +02005133
ziga-lunargb4e90752021-08-02 13:58:29 +02005134 if (subresourceRange.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
5135 if (subresourceRange.aspectMask &
5136 (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT)) {
5137 skip |= LogError(image, "VUID-VkImageSubresourceRange-aspectMask-01670",
5138 "%s: aspectMask includes both VK_IMAGE_ASPECT_COLOR_BIT and one of VK_IMAGE_ASPECT_PLANE_0_BIT, "
5139 "VK_IMAGE_ASPECT_PLANE_1_BIT, or VK_IMAGE_ASPECT_PLANE_2_BIT.",
5140 cmd_name);
5141 }
5142 }
5143
Mark Lobodzinski602de982017-02-09 11:01:33 -07005144 return skip;
5145}
5146
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005147bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005148 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07005149 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Tony-LunarGbe956362022-04-05 13:34:31 -06005150 bool is_2d_compatible = (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT) ? true : false;
5151 if (device_extensions.vk_ext_image_2d_view_of_3d)
5152 is_2d_compatible |= (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_VIEW_COMPATIBLE_BIT_EXT) ? true : false;
5153 bool is_image_slicable =
5154 (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) && is_2d_compatible;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005155 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 +02005156
David McFarland2853f2f2020-11-30 15:50:39 -04005157 uint32_t image_layer_count;
5158
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005159 if (is_3_d_to_2_d_map) {
David McFarland2853f2f2020-11-30 15:50:39 -04005160 const auto layers = LayersFromRange(subresourceRange);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06005161 const auto extent = image_state->GetSubresourceExtent(layers);
David McFarland2853f2f2020-11-30 15:50:39 -04005162 image_layer_count = extent.depth;
5163 } else {
5164 image_layer_count = image_state->createInfo.arrayLayers;
5165 }
5166
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005167 const auto image_layer_count_var_name = is_3_d_to_2_d_map ? "extent.depth" : "arrayLayers";
Petr Krausffa94af2017-08-08 21:46:02 +02005168
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005169 SubresourceRangeErrorCodes subresource_range_error_codes = {};
5170 subresource_range_error_codes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
5171 subresource_range_error_codes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
5172 subresource_range_error_codes.base_layer_err =
5173 is_khr_maintenance1
Tony-LunarGbe956362022-04-05 13:34:31 -06005174 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-image-02724"
5175 : (device_extensions.vk_ext_image_2d_view_of_3d ? "VUID-VkImageViewCreateInfo-image-06724"
5176 : "VUID-VkImageViewCreateInfo-image-01482"))
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005177 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
Tony-LunarGbe956362022-04-05 13:34:31 -06005178 subresource_range_error_codes.layer_count_err =
5179 is_khr_maintenance1
5180 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
5181 : (device_extensions.vk_ext_image_2d_view_of_3d ? "VUID-VkImageViewCreateInfo-subresourceRange-06725"
5182 : "VUID-VkImageViewCreateInfo-subresourceRange-01483"))
5183 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02005184
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005185 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02005186 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005187 image_state->image(), subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02005188}
5189
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005190bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06005191 const VkImageSubresourceRange &subresourceRange,
5192 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005193 SubresourceRangeErrorCodes subresource_range_error_codes = {};
5194 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
5195 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
5196 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
5197 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02005198
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005199 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005200 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image(),
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005201 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02005202}
5203
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005204bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06005205 const VkImageSubresourceRange &subresourceRange,
5206 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005207 SubresourceRangeErrorCodes subresource_range_error_codes = {};
5208 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
5209 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
5210 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
5211 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02005212
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005213 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005214 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image(),
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005215 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02005216}
5217
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005218bool CoreChecks::ValidateImageBarrierSubresourceRange(const Location &loc, const IMAGE_STATE *image_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005219 const VkImageSubresourceRange &subresourceRange) const {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005220 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005221 loc.StringFunc().c_str(), loc.StringField().c_str(), "arrayLayers", image_state->image(),
Jeremy Gebbenbb845612021-02-18 18:16:05 -07005222 sync_vuid_maps::GetSubResourceVUIDs(loc));
Petr Krausffa94af2017-08-08 21:46:02 +02005223}
5224
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005225namespace barrier_queue_families {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005226using sync_vuid_maps::GetBarrierQueueVUID;
5227using sync_vuid_maps::kQueueErrorSummary;
5228using sync_vuid_maps::QueueError;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005229
5230class ValidatorState {
5231 public:
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005232 ValidatorState(const ValidationStateTracker *device_data, LogObjectList &&obj, const core_error::Location &location,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005233 const VulkanTypedHandle &barrier_handle, const VkSharingMode sharing_mode)
5234 : device_data_(device_data),
John Zulaufbea70432021-02-23 07:03:12 -07005235 objects_(std::move(obj)),
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005236 loc_(location),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005237 barrier_handle_(barrier_handle),
5238 sharing_mode_(sharing_mode),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005239 limit_(static_cast<uint32_t>(device_data->physical_device_state->queue_family_properties.size())),
5240 mem_ext_(IsExtEnabled(device_data->device_extensions.vk_khr_external_memory)) {}
5241
5242 // Log the messages using boilerplate from object state, and Vu specific information from the template arg
5243 // 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 -07005244 bool LogMsg(QueueError vu_index, uint32_t family, const char *param_name) const {
5245 const std::string val_code = GetBarrierQueueVUID(loc_, vu_index);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005246 const char *annotation = GetFamilyAnnotation(family);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005247 return device_data_->LogError(objects_, val_code, "%s Barrier using %s %s created with sharingMode %s, has %s %u%s. %s",
5248 loc_.Message().c_str(), GetTypeString(),
5249 device_data_->report_data->FormatHandle(barrier_handle_).c_str(), GetModeString(), param_name,
5250 family, annotation, kQueueErrorSummary.at(vu_index).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005251 }
5252
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005253 bool LogMsg(QueueError vu_index, uint32_t src_family, uint32_t dst_family) const {
5254 const std::string val_code = GetBarrierQueueVUID(loc_, vu_index);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005255 const char *src_annotation = GetFamilyAnnotation(src_family);
5256 const char *dst_annotation = GetFamilyAnnotation(dst_family);
5257 return device_data_->LogError(
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005258 objects_, val_code,
5259 "%s Barrier using %s %s created with sharingMode %s, has srcQueueFamilyIndex %u%s and dstQueueFamilyIndex %u%s. %s",
5260 loc_.Message().c_str(), GetTypeString(), device_data_->report_data->FormatHandle(barrier_handle_).c_str(),
5261 GetModeString(), src_family, src_annotation, dst_family, dst_annotation, kQueueErrorSummary.at(vu_index).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005262 }
5263
5264 // This abstract Vu can only be tested at submit time, thus we need a callback from the closure containing the needed
5265 // data. Note that the mem_barrier is copied to the closure as the lambda lifespan exceed the guarantees of validity for
5266 // application input.
5267 static bool ValidateAtQueueSubmit(const QUEUE_STATE *queue_state, const ValidationStateTracker *device_data,
5268 uint32_t src_family, uint32_t dst_family, const ValidatorState &val) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005269 auto error_code = QueueError::kSubmitQueueMustMatchSrcOrDst;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005270 uint32_t queue_family = queue_state->queueFamilyIndex;
5271 if ((src_family != queue_family) && (dst_family != queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005272 const std::string val_code = GetBarrierQueueVUID(val.loc_, error_code);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005273 const char *src_annotation = val.GetFamilyAnnotation(src_family);
5274 const char *dst_annotation = val.GetFamilyAnnotation(dst_family);
5275 return device_data->LogError(
Jeremy Gebben63f3cb02021-09-07 15:16:32 -06005276 queue_state->Handle(), val_code,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005277 "%s Barrier submitted to queue with family index %u, using %s %s created with sharingMode %s, has "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005278 "srcQueueFamilyIndex %u%s and dstQueueFamilyIndex %u%s. %s",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005279 val.loc_.Message().c_str(), queue_family, val.GetTypeString(),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005280 device_data->report_data->FormatHandle(val.barrier_handle_).c_str(), val.GetModeString(), src_family,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005281 src_annotation, dst_family, dst_annotation, kQueueErrorSummary.at(error_code).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005282 }
5283 return false;
5284 }
5285 // Logical helpers for semantic clarity
5286 inline bool KhrExternalMem() const { return mem_ext_; }
5287 inline bool IsValid(uint32_t queue_family) const { return (queue_family < limit_); }
5288 inline bool IsValidOrSpecial(uint32_t queue_family) const {
5289 return IsValid(queue_family) || (mem_ext_ && QueueFamilyIsExternal(queue_family));
5290 }
5291
5292 // Helpers for LogMsg
5293 const char *GetModeString() const { return string_VkSharingMode(sharing_mode_); }
5294
5295 // Descriptive text for the various types of queue family index
5296 const char *GetFamilyAnnotation(uint32_t family) const {
5297 const char *external = " (VK_QUEUE_FAMILY_EXTERNAL)";
5298 const char *foreign = " (VK_QUEUE_FAMILY_FOREIGN_EXT)";
5299 const char *ignored = " (VK_QUEUE_FAMILY_IGNORED)";
5300 const char *valid = " (VALID)";
5301 const char *invalid = " (INVALID)";
5302 switch (family) {
5303 case VK_QUEUE_FAMILY_EXTERNAL:
5304 return external;
5305 case VK_QUEUE_FAMILY_FOREIGN_EXT:
5306 return foreign;
5307 case VK_QUEUE_FAMILY_IGNORED:
5308 return ignored;
5309 default:
5310 if (IsValid(family)) {
5311 return valid;
5312 }
5313 return invalid;
5314 };
5315 }
5316 const char *GetTypeString() const { return object_string[barrier_handle_.type]; }
5317 VkSharingMode GetSharingMode() const { return sharing_mode_; }
5318
5319 protected:
5320 const ValidationStateTracker *device_data_;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005321 const LogObjectList objects_;
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005322 const core_error::Location loc_;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005323 const VulkanTypedHandle barrier_handle_;
5324 const VkSharingMode sharing_mode_;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005325 const uint32_t limit_;
5326 const bool mem_ext_;
5327};
5328
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005329bool Validate(const CoreChecks *device_data, const CMD_BUFFER_STATE *cb_state, const ValidatorState &val,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005330 const uint32_t src_queue_family, const uint32_t dst_queue_family) {
5331 bool skip = false;
5332
5333 const bool mode_concurrent = val.GetSharingMode() == VK_SHARING_MODE_CONCURRENT;
5334 const bool src_ignored = QueueFamilyIsIgnored(src_queue_family);
5335 const bool dst_ignored = QueueFamilyIsIgnored(dst_queue_family);
5336 if (val.KhrExternalMem()) {
5337 if (mode_concurrent) {
Tony-LunarG273f32f2021-09-28 08:56:30 -06005338 bool sync2 = device_data->enabled_features.core13.synchronization2 != 0;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005339 // this requirement is removed by VK_KHR_synchronization2
5340 if (!(src_ignored || dst_ignored) && !sync2) {
5341 skip |= val.LogMsg(QueueError::kSrcOrDstMustBeIgnore, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005342 }
5343 if ((src_ignored && !(dst_ignored || QueueFamilyIsExternal(dst_queue_family))) ||
5344 (dst_ignored && !(src_ignored || QueueFamilyIsExternal(src_queue_family)))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005345 skip |= val.LogMsg(QueueError::kSpecialOrIgnoreOnly, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005346 }
5347 } else {
5348 // VK_SHARING_MODE_EXCLUSIVE
5349 if (src_queue_family != dst_queue_family) {
5350 if (!val.IsValidOrSpecial(dst_queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005351 skip |= val.LogMsg(QueueError::kSrcAndDstValidOrSpecial, dst_queue_family, "dstQueueFamilyIndex");
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005352 }
5353 if (!val.IsValidOrSpecial(src_queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005354 skip |= val.LogMsg(QueueError::kSrcAndDstValidOrSpecial, src_queue_family, "srcQueueFamilyIndex");
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005355 }
5356 }
5357 }
5358 } else {
5359 // No memory extension
5360 if (mode_concurrent) {
Tony-LunarG273f32f2021-09-28 08:56:30 -06005361 bool sync2 = device_data->enabled_features.core13.synchronization2 != 0;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005362 // this requirement is removed by VK_KHR_synchronization2
5363 if ((!src_ignored || !dst_ignored) && !sync2) {
5364 skip |= val.LogMsg(QueueError::kSrcAndDestMustBeIgnore, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005365 }
5366 } else {
5367 // VK_SHARING_MODE_EXCLUSIVE
5368 if ((src_queue_family != dst_queue_family) && !(val.IsValid(src_queue_family) && val.IsValid(dst_queue_family))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005369 skip |= val.LogMsg(QueueError::kSrcAndDstBothValid, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005370 }
5371 }
5372 }
5373 return skip;
5374}
5375} // namespace barrier_queue_families
5376
Jeremy Gebbene5361dd2021-11-18 14:23:56 -07005377bool CoreChecks::ValidateConcurrentBarrierAtSubmit(const Location &loc, const ValidationStateTracker &state_data,
5378 const QUEUE_STATE &queue_state, const CMD_BUFFER_STATE &cb_state,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005379 const VulkanTypedHandle &typed_handle, uint32_t src_queue_family,
5380 uint32_t dst_queue_family) {
5381 using barrier_queue_families::ValidatorState;
Jeremy Gebbene5361dd2021-11-18 14:23:56 -07005382 ValidatorState val(&state_data, LogObjectList(cb_state.Handle()), loc, typed_handle, VK_SHARING_MODE_CONCURRENT);
5383 return ValidatorState::ValidateAtQueueSubmit(&queue_state, &state_data, src_queue_family, dst_queue_family, val);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005384}
5385
5386// Type specific wrapper for image barriers
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005387template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005388bool CoreChecks::ValidateBarrierQueueFamilies(const Location &loc, const CMD_BUFFER_STATE *cb_state, const ImgBarrier &barrier,
5389 const IMAGE_STATE *state_data) const {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005390 // State data is required
5391 if (!state_data) {
5392 return false;
5393 }
5394
5395 // Create the validator state from the image state
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005396 barrier_queue_families::ValidatorState val(this, LogObjectList(cb_state->commandBuffer()), loc,
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06005397 state_data->Handle(), state_data->createInfo.sharingMode);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005398 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
5399 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005400 return barrier_queue_families::Validate(this, cb_state, val, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005401}
5402
5403// Type specific wrapper for buffer barriers
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005404template <typename BufBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005405bool CoreChecks::ValidateBarrierQueueFamilies(const Location &loc, const CMD_BUFFER_STATE *cb_state, const BufBarrier &barrier,
5406 const BUFFER_STATE *state_data) const {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005407 // State data is required
5408 if (!state_data) {
5409 return false;
5410 }
5411
5412 // Create the validator state from the buffer state
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005413 barrier_queue_families::ValidatorState val(this, LogObjectList(cb_state->commandBuffer()), loc,
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06005414 state_data->Handle(), state_data->createInfo.sharingMode);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005415 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
5416 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005417 return barrier_queue_families::Validate(this, cb_state, val, src_queue_family, dst_queue_family);
5418}
5419
5420template <typename Barrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005421bool CoreChecks::ValidateBufferBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005422 const Barrier &mem_barrier) const {
5423 using sync_vuid_maps::BufferError;
5424 using sync_vuid_maps::GetBufferBarrierVUID;
5425
5426 bool skip = false;
5427
5428 skip |= ValidateQFOTransferBarrierUniqueness(loc, cb_state, mem_barrier, cb_state->qfo_transfer_buffer_barriers);
5429
5430 // Validate buffer barrier queue family indices
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06005431 auto buffer_state = Get<BUFFER_STATE>(mem_barrier.buffer);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005432 if (buffer_state) {
5433 auto buf_loc = loc.dot(Field::buffer);
5434 const auto &mem_vuid = GetBufferBarrierVUID(buf_loc, BufferError::kNoMemory);
Jeremy Gebben9f537102021-10-05 16:37:12 -06005435 skip |= ValidateMemoryIsBoundToBuffer(buffer_state.get(), loc.StringFunc().c_str(), mem_vuid.c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005436
Jeremy Gebben9f537102021-10-05 16:37:12 -06005437 skip |= ValidateBarrierQueueFamilies(buf_loc, cb_state, mem_barrier, buffer_state.get());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005438
5439 auto buffer_size = buffer_state->createInfo.size;
5440 if (mem_barrier.offset >= buffer_size) {
5441 auto offset_loc = loc.dot(Field::offset);
5442 const auto &vuid = GetBufferBarrierVUID(offset_loc, BufferError::kOffsetTooBig);
5443
5444 skip |= LogError(objects, vuid, "%s %s has offset 0x%" PRIx64 " which is not less than total size 0x%" PRIx64 ".",
5445 offset_loc.Message().c_str(), report_data->FormatHandle(mem_barrier.buffer).c_str(),
5446 HandleToUint64(mem_barrier.offset), HandleToUint64(buffer_size));
5447 } else if (mem_barrier.size != VK_WHOLE_SIZE && (mem_barrier.offset + mem_barrier.size > buffer_size)) {
5448 auto size_loc = loc.dot(Field::size);
5449 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kSizeOutOfRange);
5450 skip |= LogError(objects, vuid,
5451 "%s %s has offset 0x%" PRIx64 " and size 0x%" PRIx64 " whose sum is greater than total size 0x%" PRIx64
5452 ".",
5453 size_loc.Message().c_str(), report_data->FormatHandle(mem_barrier.buffer).c_str(),
5454 HandleToUint64(mem_barrier.offset), HandleToUint64(mem_barrier.size), HandleToUint64(buffer_size));
5455 }
5456 if (mem_barrier.size == 0) {
5457 auto size_loc = loc.dot(Field::size);
5458 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kSizeZero);
5459 skip |= LogError(objects, vuid, "%s %s has a size of 0.", loc.Message().c_str(),
5460 report_data->FormatHandle(mem_barrier.buffer).c_str());
5461 }
5462 }
ziga-lunarg8e2506c2022-04-18 20:06:00 +02005463
5464 if (mem_barrier.srcQueueFamilyIndex == VK_QUEUE_FAMILY_EXTERNAL &&
5465 mem_barrier.dstQueueFamilyIndex == VK_QUEUE_FAMILY_EXTERNAL) {
5466 auto size_loc = loc.dot(Field::srcQueueFamilyIndex);
5467 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kQueueFamilyExternal);
5468 skip |= LogError(objects, vuid, "Both srcQueueFamilyIndex and dstQueueFamilyIndex are VK_QUEUE_FAMILY_EXTERNAL.");
5469 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005470 return skip;
5471}
5472
5473template <typename Barrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005474bool CoreChecks::ValidateImageBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005475 const Barrier &mem_barrier) const {
5476 bool skip = false;
5477
5478 skip |= ValidateQFOTransferBarrierUniqueness(loc, cb_state, mem_barrier, cb_state->qfo_transfer_image_barriers);
5479
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005480 bool is_ilt = true;
Tony-LunarG273f32f2021-09-28 08:56:30 -06005481 if (enabled_features.core13.synchronization2) {
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005482 is_ilt = mem_barrier.oldLayout != mem_barrier.newLayout;
5483 }
5484
5485 if (is_ilt) {
5486 if (mem_barrier.newLayout == VK_IMAGE_LAYOUT_UNDEFINED || mem_barrier.newLayout == VK_IMAGE_LAYOUT_PREINITIALIZED) {
5487 auto layout_loc = loc.dot(Field::newLayout);
5488 const auto &vuid = sync_vuid_maps::GetImageBarrierVUID(loc, sync_vuid_maps::ImageError::kBadLayout);
5489 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005490 LogError(cb_state->commandBuffer(), vuid, "%s Image Layout cannot be transitioned to UNDEFINED or PREINITIALIZED.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005491 layout_loc.Message().c_str());
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005492 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005493 }
5494
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06005495 auto image_data = Get<IMAGE_STATE>(mem_barrier.image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005496 if (image_data) {
5497 auto image_loc = loc.dot(Field::image);
5498
Jeremy Gebben9f537102021-10-05 16:37:12 -06005499 skip |= ValidateMemoryIsBoundToImage(image_data.get(), loc);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005500
Jeremy Gebben9f537102021-10-05 16:37:12 -06005501 skip |= ValidateBarrierQueueFamilies(image_loc, cb_state, mem_barrier, image_data.get());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005502
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005503 skip |= ValidateImageAspectMask(image_data->image(), image_data->createInfo.format, mem_barrier.subresourceRange.aspectMask,
Aitor Camachoeb35fed2022-06-07 14:07:42 +02005504 image_data->disjoint, loc.StringFunc().c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005505
Jeremy Gebben9f537102021-10-05 16:37:12 -06005506 skip |=
5507 ValidateImageBarrierSubresourceRange(loc.dot(Field::subresourceRange), image_data.get(), mem_barrier.subresourceRange);
ziga-lunarg69aa72f2022-03-29 15:24:35 +02005508 skip |= ValidateImageAcquired(*image_data, loc.StringFunc().c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005509 }
5510 return skip;
5511}
5512
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005513bool CoreChecks::ValidateBarriers(const Location &outer_loc, const CMD_BUFFER_STATE *cb_state, VkPipelineStageFlags src_stage_mask,
5514 VkPipelineStageFlags dst_stage_mask, uint32_t memBarrierCount,
5515 const VkMemoryBarrier *pMemBarriers, uint32_t bufferBarrierCount,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005516 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
5517 const VkImageMemoryBarrier *pImageMemBarriers) const {
5518 bool skip = false;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005519 LogObjectList objects(cb_state->commandBuffer());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005520
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005521 for (uint32_t i = 0; i < memBarrierCount; ++i) {
5522 const auto &mem_barrier = pMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005523 auto loc = outer_loc.dot(Struct::VkMemoryBarrier, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005524 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005525 }
5526 for (uint32_t i = 0; i < imageMemBarrierCount; ++i) {
5527 const auto &mem_barrier = pImageMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005528 auto loc = outer_loc.dot(Struct::VkImageMemoryBarrier, Field::pImageMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005529 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005530 skip |= ValidateImageBarrier(objects, loc, cb_state, mem_barrier);
5531 }
5532 {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005533 Location loc(outer_loc.function, Struct::VkImageMemoryBarrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005534 skip |= ValidateBarriersToImages(loc, cb_state, imageMemBarrierCount, pImageMemBarriers);
5535 }
5536 for (uint32_t i = 0; i < bufferBarrierCount; ++i) {
5537 const auto &mem_barrier = pBufferMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005538 auto loc = outer_loc.dot(Struct::VkBufferMemoryBarrier, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005539 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005540 skip |= ValidateBufferBarrier(objects, loc, cb_state, mem_barrier);
5541 }
5542 return skip;
5543}
5544
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005545bool CoreChecks::ValidateDependencyInfo(const LogObjectList &objects, const Location &outer_loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbenefead332021-06-18 08:22:44 -06005546 const VkDependencyInfoKHR *dep_info) const {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005547 bool skip = false;
5548
5549 if (cb_state->activeRenderPass) {
5550 skip |= ValidateRenderPassPipelineBarriers(outer_loc, cb_state, dep_info);
5551 if (skip) return true; // Early return to avoid redundant errors from below calls
5552 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005553 for (uint32_t i = 0; i < dep_info->memoryBarrierCount; ++i) {
5554 const auto &mem_barrier = dep_info->pMemoryBarriers[i];
Tony-LunarG279601c2021-11-16 10:50:51 -07005555 auto loc = outer_loc.dot(Struct::VkMemoryBarrier2, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005556 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005557 }
5558 for (uint32_t i = 0; i < dep_info->imageMemoryBarrierCount; ++i) {
5559 const auto &mem_barrier = dep_info->pImageMemoryBarriers[i];
Tony-LunarG279601c2021-11-16 10:50:51 -07005560 auto loc = outer_loc.dot(Struct::VkImageMemoryBarrier2, Field::pImageMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005561 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005562 skip |= ValidateImageBarrier(objects, loc, cb_state, mem_barrier);
5563 }
5564 {
Tony-LunarG279601c2021-11-16 10:50:51 -07005565 Location loc(outer_loc.function, Struct::VkImageMemoryBarrier2);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005566 skip |= ValidateBarriersToImages(loc, cb_state, dep_info->imageMemoryBarrierCount, dep_info->pImageMemoryBarriers);
5567 }
5568
5569 for (uint32_t i = 0; i < dep_info->bufferMemoryBarrierCount; ++i) {
5570 const auto &mem_barrier = dep_info->pBufferMemoryBarriers[i];
Tony-LunarG279601c2021-11-16 10:50:51 -07005571 auto loc = outer_loc.dot(Struct::VkBufferMemoryBarrier2, Field::pBufferMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005572 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005573 skip |= ValidateBufferBarrier(objects, loc, cb_state, mem_barrier);
5574 }
5575
5576 return skip;
5577}
5578
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005579// template to check all original barrier structures
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005580template <typename Barrier>
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005581bool CoreChecks::ValidateMemoryBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
5582 const Barrier &barrier, VkPipelineStageFlags src_stage_mask,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005583 VkPipelineStageFlags dst_stage_mask) const {
5584 bool skip = false;
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005585 assert(cb_state);
5586 auto queue_flags = cb_state->GetQueueFlags();
5587
5588 if (!cb_state->IsAcquireOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005589 skip |= ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), queue_flags, barrier.srcAccessMask, src_stage_mask);
5590 }
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005591 if (!cb_state->IsReleaseOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005592 skip |= ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), queue_flags, barrier.dstAccessMask, dst_stage_mask);
5593 }
5594 return skip;
5595}
5596
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005597// template to check all synchronization2 barrier structures
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005598template <typename Barrier>
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005599bool CoreChecks::ValidateMemoryBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
5600 const Barrier &barrier) const {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005601 bool skip = false;
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005602 assert(cb_state);
5603 auto queue_flags = cb_state->GetQueueFlags();
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005604
Jeremy Gebbenefead332021-06-18 08:22:44 -06005605 skip |= ValidatePipelineStage(objects, loc.dot(Field::srcStageMask), queue_flags, barrier.srcStageMask);
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005606 if (!cb_state->IsAcquireOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005607 skip |=
5608 ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), queue_flags, barrier.srcAccessMask, barrier.srcStageMask);
5609 }
Jeremy Gebbenefead332021-06-18 08:22:44 -06005610
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005611 skip |= ValidatePipelineStage(objects, loc.dot(Field::dstStageMask), queue_flags, barrier.dstStageMask);
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005612 if (!cb_state->IsReleaseOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005613 skip |=
5614 ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), queue_flags, barrier.dstAccessMask, barrier.dstStageMask);
5615 }
5616 return skip;
5617}
5618
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005619// VkSubpassDependency validation happens when vkCreateRenderPass() is called.
5620// Dependencies between subpasses can only use pipeline stages compatible with VK_QUEUE_GRAPHICS_BIT,
5621// for external subpasses we don't have a yet command buffer so we have to assume all of them are valid.
5622static inline VkQueueFlags SubpassToQueueFlags(uint32_t subpass) {
5623 return subpass == VK_SUBPASS_EXTERNAL ? sync_utils::kAllQueueTypes : static_cast<VkQueueFlags>(VK_QUEUE_GRAPHICS_BIT);
5624}
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005625
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005626bool CoreChecks::ValidateSubpassDependency(const LogObjectList &objects, const Location &in_loc,
5627 const VkSubpassDependency2 &dependency) const {
5628 bool skip = false;
5629 Location loc = in_loc;
5630 VkMemoryBarrier2KHR converted_barrier;
5631 const auto *mem_barrier = LvlFindInChain<VkMemoryBarrier2KHR>(dependency.pNext);
5632
Tony-LunarG273f32f2021-09-28 08:56:30 -06005633 if (mem_barrier && enabled_features.core13.synchronization2) {
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005634 if (dependency.srcAccessMask != 0) {
5635 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-srcAccessMask",
5636 "%s is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5637 loc.dot(Field::srcAccessMask).Message().c_str());
5638 }
5639 if (dependency.dstAccessMask != 0) {
5640 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-dstAccessMask",
5641 "%s dstAccessMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5642 loc.dot(Field::dstAccessMask).Message().c_str());
5643 }
5644 if (dependency.srcStageMask != 0) {
5645 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-srcStageMask",
5646 "%s srcStageMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5647 loc.dot(Field::srcStageMask).Message().c_str());
5648 }
5649 if (dependency.dstStageMask != 0) {
5650 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-dstStageMask",
5651 "%s dstStageMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5652 loc.dot(Field::dstStageMask).Message().c_str());
5653 }
5654 loc = in_loc.dot(Field::pNext);
5655 converted_barrier = *mem_barrier;
5656 } else {
5657 if (mem_barrier) {
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005658 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-pNext",
5659 "%s a VkMemoryBarrier2KHR is present in pNext but synchronization2 is not enabled.",
5660 loc.Message().c_str());
5661 }
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005662 // use the subpass dependency flags, upconverted into wider synchronization2 fields.
5663 converted_barrier.srcStageMask = dependency.srcStageMask;
5664 converted_barrier.dstStageMask = dependency.dstStageMask;
5665 converted_barrier.srcAccessMask = dependency.srcAccessMask;
5666 converted_barrier.dstAccessMask = dependency.dstAccessMask;
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005667 }
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005668 auto src_queue_flags = SubpassToQueueFlags(dependency.srcSubpass);
5669 skip |= ValidatePipelineStage(objects, loc.dot(Field::srcStageMask), src_queue_flags, converted_barrier.srcStageMask);
5670 skip |= ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), src_queue_flags, converted_barrier.srcAccessMask,
5671 converted_barrier.srcStageMask);
5672
5673 auto dst_queue_flags = SubpassToQueueFlags(dependency.dstSubpass);
5674 skip |= ValidatePipelineStage(objects, loc.dot(Field::dstStageMask), dst_queue_flags, converted_barrier.dstStageMask);
5675 skip |= ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), dst_queue_flags, converted_barrier.dstAccessMask,
5676 converted_barrier.dstStageMask);
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005677 return skip;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005678}
5679
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005680bool CoreChecks::ValidateImageViewFormatFeatures(const IMAGE_STATE *image_state, const VkFormat view_format,
5681 const VkImageUsageFlags image_usage) const {
5682 // Pass in image_usage here instead of extracting it from image_state in case there's a chained VkImageViewUsageCreateInfo
5683 bool skip = false;
5684
Lionel Landwerlin21719f62021-12-09 11:40:09 +02005685 VkFormatFeatureFlags2KHR tiling_features = 0;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005686 const VkImageTiling image_tiling = image_state->createInfo.tiling;
5687
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06005688 if (image_state->HasAHBFormat()) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005689 // AHB image view and image share same feature sets
5690 tiling_features = image_state->format_features;
5691 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5692 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
sfricke-samsung45996a42021-09-16 13:45:27 -07005693 assert(IsExtEnabled(device_extensions.vk_ext_image_drm_format_modifier));
sjfrickee9b39372022-05-22 13:02:17 +09005694 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = LvlInitStruct<VkImageDrmFormatModifierPropertiesEXT>();
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005695 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image_state->image(), &drm_format_properties);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005696
Lionel Landwerlin1da35792021-12-14 16:54:13 +02005697 auto fmt_drm_props = LvlInitStruct<VkDrmFormatModifierPropertiesListEXT>();
5698 auto fmt_props_2 = LvlInitStruct<VkFormatProperties2>(&fmt_drm_props);
5699 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &fmt_props_2);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005700
nyorain38a9d232021-03-06 13:06:12 +01005701 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
Lionel Landwerlin1da35792021-12-14 16:54:13 +02005702 drm_properties.resize(fmt_drm_props.drmFormatModifierCount);
5703 fmt_drm_props.pDrmFormatModifierProperties = drm_properties.data();
nyorain38a9d232021-03-06 13:06:12 +01005704
Lionel Landwerlin1da35792021-12-14 16:54:13 +02005705 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &fmt_props_2);
nyorain38a9d232021-03-06 13:06:12 +01005706
Lionel Landwerlin1da35792021-12-14 16:54:13 +02005707 for (uint32_t i = 0; i < fmt_drm_props.drmFormatModifierCount; i++) {
5708 if (fmt_drm_props.pDrmFormatModifierProperties[i].drmFormatModifier == drm_format_properties.drmFormatModifier) {
5709 tiling_features = fmt_drm_props.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
5710 break;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005711 }
5712 }
5713 } else {
Lionel Landwerlin21719f62021-12-09 11:40:09 +02005714 VkFormatProperties3KHR format_properties = GetPDFormatProperties(view_format);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005715 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
5716 : format_properties.optimalTilingFeatures;
5717 }
5718
5719 if (tiling_features == 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005720 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-None-02273",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005721 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
5722 "physical device.",
5723 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5724 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005725 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02274",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005726 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5727 "VK_IMAGE_USAGE_SAMPLED_BIT.",
5728 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5729 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005730 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02275",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005731 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5732 "VK_IMAGE_USAGE_STORAGE_BIT.",
5733 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5734 } 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 -06005735 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02276",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005736 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5737 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
5738 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5739 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
5740 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005741 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02277",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005742 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5743 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5744 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5745 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
5746 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005747 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02652",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005748 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5749 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5750 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Tobias Hector6663c9b2020-11-05 10:18:02 +00005751 } else if ((image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) &&
5752 !(tiling_features & VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR)) {
5753 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005754 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-04550",
Tobias Hector6663c9b2020-11-05 10:18:02 +00005755 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5756 "VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR.",
5757 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5758 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005759 }
5760
5761 return skip;
5762}
5763
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005764bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005765 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005766 bool skip = false;
Jeremy Gebbenf4449392022-01-28 10:09:10 -07005767 auto image_state = Get<IMAGE_STATE>(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005768 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005769 skip |=
Jeremy Gebben9f537102021-10-05 16:37:12 -06005770 ValidateImageUsageFlags(image_state.get(),
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005771 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
5772 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
sfricke-samsungbb971942020-09-10 22:11:56 -07005773 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV |
5774 VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
5775 false, "VUID-VkImageViewCreateInfo-image-04441", "vkCreateImageView()",
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005776 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
sfricke-samsungbb971942020-09-10 22:11:56 -07005777 "TRANSIENT_ATTACHMENT|SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005778 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Jeremy Gebben9f537102021-10-05 16:37:12 -06005779 skip |= ValidateMemoryIsBoundToImage(image_state.get(), "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005780 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02005781 skip |= ValidateCreateImageViewSubresourceRange(
Jeremy Gebben9f537102021-10-05 16:37:12 -06005782 image_state.get(),
5783 pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005784 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005785
5786 VkImageCreateFlags image_flags = image_state->createInfo.flags;
5787 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005788 VkImageUsageFlags image_usage = image_state->createInfo.usage;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005789 VkFormat view_format = pCreateInfo->format;
5790 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06005791 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005792 VkImageViewType view_type = pCreateInfo->viewType;
sfricke-samsung20a8a372021-07-14 06:12:17 -07005793 uint32_t layer_count = pCreateInfo->subresourceRange.layerCount;
Mark Lobodzinski602de982017-02-09 11:01:33 -07005794
Dave Houltonbd2e2622018-04-10 16:41:14 -06005795 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005796 auto chained_ivuci_struct = LvlFindInChain<VkImageViewUsageCreateInfo>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06005797 if (chained_ivuci_struct) {
sfricke-samsung45996a42021-09-16 13:45:27 -07005798 if (IsExtEnabled(device_extensions.vk_khr_maintenance2)) {
5799 if (!IsExtEnabled(device_extensions.vk_ext_separate_stencil_usage)) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05005800 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005801 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
5802 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
5803 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05005804 }
5805 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005806 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05005807 if (image_stencil_struct == nullptr) {
5808 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005809 skip |= LogError(
5810 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005811 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
5812 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
5813 "any bits that were not set in VkImageCreateInfo::usage used to create image");
5814 }
5815 } else {
5816 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
5817 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
5818 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005819 skip |= LogError(
5820 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005821 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5822 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5823 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
5824 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
5825 }
5826 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
5827 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005828 skip |= LogError(
5829 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005830 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5831 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5832 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
5833 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
5834 }
5835 }
5836 }
5837 }
5838
Dave Houltonbd2e2622018-04-10 16:41:14 -06005839 image_usage = chained_ivuci_struct->usage;
5840 }
5841
sfricke-samsungf60b6c82021-04-05 22:59:20 -07005842 // If image used VkImageFormatListCreateInfo need to make sure a format from list is used
5843 const auto format_list_info = LvlFindInChain<VkImageFormatListCreateInfo>(image_state->createInfo.pNext);
5844 if (format_list_info && (format_list_info->viewFormatCount > 0)) {
5845 bool foundFormat = false;
5846 for (uint32_t i = 0; i < format_list_info->viewFormatCount; i++) {
5847 if (format_list_info->pViewFormats[i] == view_format) {
5848 foundFormat = true;
5849 break;
5850 }
5851 }
5852 if (foundFormat == false) {
5853 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-01585",
5854 "vkCreateImageView(): image was created with a VkImageFormatListCreateInfo in pNext of "
5855 "vkImageCreateInfo, but none of the formats match the VkImageViewCreateInfo::format (%s).",
5856 string_VkFormat(view_format));
5857 }
5858 }
5859
Dave Houlton6f5f20a2018-05-04 12:37:44 -06005860 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
5861 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005862 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01005863 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06005864 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01005865 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06005866 std::stringstream ss;
5867 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01005868 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06005869 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005870 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005871 }
5872 } else {
Mike Schuchardt2df08912020-12-15 16:28:09 -08005873 if (!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005874 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
sfricke-samsung965e5f82021-11-24 00:17:47 -06005875 auto image_class = FormatCompatibilityClass(image_format);
5876 auto view_class = FormatCompatibilityClass(view_format);
5877 // Need to only check if one is NONE to handle edge case both are NONE
5878 if ((image_class != view_class) || (image_class == FORMAT_COMPATIBILITY_CLASS::NONE)) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005879 const char *error_vuid;
sfricke-samsung45996a42021-09-16 13:45:27 -07005880 if ((!IsExtEnabled(device_extensions.vk_khr_maintenance2)) &&
5881 (!IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion))) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005882 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
sfricke-samsung45996a42021-09-16 13:45:27 -07005883 } else if ((IsExtEnabled(device_extensions.vk_khr_maintenance2)) &&
5884 (!IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion))) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005885 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
sfricke-samsung45996a42021-09-16 13:45:27 -07005886 } else if ((!IsExtEnabled(device_extensions.vk_khr_maintenance2)) &&
5887 (IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion))) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005888 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
5889 } else {
5890 // both enabled
5891 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
5892 }
Dave Houltonc7988072018-04-16 11:46:56 -06005893 std::stringstream ss;
5894 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06005895 << " is not in the same format compatibility class as "
5896 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06005897 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
5898 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005899 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005900 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06005901 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005902 }
5903 } else {
5904 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07005905 // Unless it is a multi-planar color bit aspect
5906 if ((image_format != view_format) &&
5907 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
sfricke-samsung45996a42021-09-16 13:45:27 -07005908 const char *vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
5909 ? "VUID-VkImageViewCreateInfo-image-01762"
5910 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07005911 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06005912 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07005913 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07005914 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07005915 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005916 }
5917 }
5918
ziga-lunargebb32de2021-08-29 21:24:30 +02005919 if (image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT && view_type != VK_IMAGE_VIEW_TYPE_2D &&
5920 view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5921 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04972",
5922 "vkCreateImageView(): image was created with sample count %s, but pCreateInfo->viewType is %s.",
5923 string_VkSampleCountFlagBits(image_state->createInfo.samples), string_VkImageViewType(view_type));
5924 }
5925
Mark Lobodzinski602de982017-02-09 11:01:33 -07005926 // Validate correct image aspect bits for desired formats and format consistency
Aitor Camachoeb35fed2022-06-07 14:07:42 +02005927 skip |=
5928 ValidateImageAspectMask(image_state->image(), image_format, aspect_mask, image_state->disjoint, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06005929
sfricke-samsung20a8a372021-07-14 06:12:17 -07005930 // Valdiate Image/ImageView type compatibility #resources-image-views-compatibility
Jeremy Kniager846ab732017-07-10 13:12:04 -06005931 switch (image_type) {
5932 case VK_IMAGE_TYPE_1D:
5933 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005934 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5935 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5936 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005937 }
5938 break;
5939 case VK_IMAGE_TYPE_2D:
5940 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5941 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
5942 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005943 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
5944 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5945 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005946 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005947 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5948 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5949 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005950 }
5951 }
5952 break;
5953 case VK_IMAGE_TYPE_3D:
sfricke-samsung45996a42021-09-16 13:45:27 -07005954 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06005955 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
5956 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
Tony-LunarGbe956362022-04-05 13:34:31 -06005957 if (device_extensions.vk_ext_image_2d_view_of_3d) {
5958 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT)) {
5959 if (view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5960 skip |= LogError(
5961 pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-06723",
5962 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type "
5963 "%s since the image doesn't have VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT flag set.",
5964 string_VkImageViewType(view_type), string_VkImageType(image_type));
5965 } else if (view_type == VK_IMAGE_VIEW_TYPE_2D &&
5966 !(image_flags & VK_IMAGE_CREATE_2D_VIEW_COMPATIBLE_BIT_EXT)) {
5967 skip |= LogError(
5968 pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-06728",
5969 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type "
5970 "%s since the image doesn't have VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT or "
5971 "VK_IMAGE_CREATE_2D_VIEW_COMPATIBLE_BIT_EXT flag set.",
5972 string_VkImageViewType(view_type), string_VkImageType(image_type));
5973 }
5974 }
5975 } else if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT) &&
5976 (view_type == VK_IMAGE_VIEW_TYPE_2D)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005977 skip |=
Tony-LunarGbe956362022-04-05 13:34:31 -06005978 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-06727",
5979 "vkCreateImageView(): pCreateInfo->viewType VK_IMAGE_VIEW_TYPE_2D is not compatible "
5980 "with image type "
sfricke-samsungd9b3e122021-07-15 22:50:00 -07005981 "%s since the image doesn't have VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT flag set.",
Tony-LunarGbe956362022-04-05 13:34:31 -06005982 string_VkImageType(image_type));
5983 }
5984 if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
Jeremy Kniager846ab732017-07-10 13:12:04 -06005985 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005986 skip |= LogError(
sfricke-samsungd9b3e122021-07-15 22:50:00 -07005987 pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04971",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005988 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
5989 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
5990 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
5991 string_VkImageViewType(view_type), string_VkImageType(image_type));
sfricke-samsungd9b3e122021-07-15 22:50:00 -07005992 } else if (pCreateInfo->subresourceRange.levelCount != 1) {
5993 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04970",
5994 "vkCreateImageView(): pCreateInfo->viewType %s is with image type %s must have a "
5995 "levelCount of 1 but it is %u.",
5996 string_VkImageViewType(view_type), string_VkImageType(image_type),
5997 pCreateInfo->subresourceRange.levelCount);
Jeremy Kniager846ab732017-07-10 13:12:04 -06005998 }
5999 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006000 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
6001 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
6002 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06006003 }
6004 }
6005 } else {
6006 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
sfricke-samsungd9b3e122021-07-15 22:50:00 -07006007 // Help point to VK_KHR_maintenance1
6008 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
6009 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
6010 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
6011 "without VK_KHR_maintenance1 enabled which was promoted in Vulkan 1.0.",
6012 string_VkImageViewType(view_type), string_VkImageType(image_type));
6013 } else {
6014 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
6015 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
6016 string_VkImageViewType(view_type), string_VkImageType(image_type));
6017 }
Jeremy Kniager846ab732017-07-10 13:12:04 -06006018 }
6019 }
6020 break;
6021 default:
6022 break;
6023 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06006024
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006025 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
sfricke-samsung45996a42021-09-16 13:45:27 -07006026 if (IsExtEnabled(device_extensions.vk_android_external_memory_android_hardware_buffer)) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07006027 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06006028 }
6029
Jeremy Gebben9f537102021-10-05 16:37:12 -06006030 skip |= ValidateImageViewFormatFeatures(image_state.get(), view_format, image_usage);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006031
sfricke-samsung828e59d2021-08-22 23:20:49 -07006032 if (enabled_features.shading_rate_image_features.shadingRateImage) {
Tobias Hector6663c9b2020-11-05 10:18:02 +00006033 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
6034 if (view_format != VK_FORMAT_R8_UINT) {
6035 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
6036 "vkCreateImageView() If image was created with usage containing "
6037 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
6038 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05006039 }
Tobias Hector6663c9b2020-11-05 10:18:02 +00006040 }
6041
sfricke-samsung828e59d2021-08-22 23:20:49 -07006042 if (enabled_features.shading_rate_image_features.shadingRateImage ||
Tobias Hector6663c9b2020-11-05 10:18:02 +00006043 enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
6044 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) {
6045 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
6046 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
6047 "vkCreateImageView() If image was created with usage containing "
6048 "VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR, viewType must be "
6049 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
6050 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05006051 }
6052 }
Jeff Bolz99e3f632020-03-24 22:59:22 -05006053
Tobias Hector6663c9b2020-11-05 10:18:02 +00006054 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate &&
6055 !phys_dev_ext_props.fragment_shading_rate_props.layeredShadingRateAttachments &&
sfricke-samsung20a8a372021-07-14 06:12:17 -07006056 image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR && layer_count != 1) {
Tobias Hector6663c9b2020-11-05 10:18:02 +00006057 skip |= LogError(device, "VUID-VkImageViewCreateInfo-usage-04551",
6058 "vkCreateImageView(): subresourceRange.layerCount is %u for a shading rate attachment image view.",
sfricke-samsung20a8a372021-07-14 06:12:17 -07006059 layer_count);
Tobias Hector6663c9b2020-11-05 10:18:02 +00006060 }
6061
sfricke-samsung20a8a372021-07-14 06:12:17 -07006062 if (layer_count == VK_REMAINING_ARRAY_LAYERS) {
6063 const uint32_t remaining_layers = image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer;
6064 if (view_type == VK_IMAGE_VIEW_TYPE_CUBE && remaining_layers != 6) {
Jeff Bolz99e3f632020-03-24 22:59:22 -05006065 skip |= LogError(device, "VUID-VkImageViewCreateInfo-viewType-02962",
6066 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be 6",
sfricke-samsung20a8a372021-07-14 06:12:17 -07006067 remaining_layers);
Jeff Bolz99e3f632020-03-24 22:59:22 -05006068 }
sfricke-samsung20a8a372021-07-14 06:12:17 -07006069 if (view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY && ((remaining_layers) % 6) != 0) {
Jeff Bolz99e3f632020-03-24 22:59:22 -05006070 skip |= LogError(
6071 device, "VUID-VkImageViewCreateInfo-viewType-02963",
6072 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be a multiple of 6",
sfricke-samsung20a8a372021-07-14 06:12:17 -07006073 remaining_layers);
6074 }
6075 if ((remaining_layers != 1) && ((view_type == VK_IMAGE_VIEW_TYPE_1D) || (view_type == VK_IMAGE_VIEW_TYPE_2D) ||
6076 (view_type == VK_IMAGE_VIEW_TYPE_3D))) {
6077 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-imageViewType-04974",
6078 "vkCreateImageView(): Using pCreateInfo->viewType %s and the subresourceRange.layerCount "
6079 "VK_REMAINING_ARRAY_LAYERS=(%d) and must 1 (try looking into VK_IMAGE_VIEW_TYPE_*_ARRAY).",
6080 string_VkImageViewType(view_type), remaining_layers);
6081 }
6082 } else {
6083 if ((layer_count != 1) && ((view_type == VK_IMAGE_VIEW_TYPE_1D) || (view_type == VK_IMAGE_VIEW_TYPE_2D) ||
6084 (view_type == VK_IMAGE_VIEW_TYPE_3D))) {
6085 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-imageViewType-04973",
ziga-lunargc9d29f72022-05-15 19:55:08 +02006086 "vkCreateImageView(): subresourceRange.layerCount (%" PRIu32
6087 ") must be 1 when using viewType %s (try looking into VK_IMAGE_VIEW_TYPE_*_ARRAY).",
6088 layer_count, string_VkImageViewType(view_type));
Jeff Bolz99e3f632020-03-24 22:59:22 -05006089 }
6090 }
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006091
6092 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
ziga-lunarga77a2832022-05-03 11:12:00 +02006093 const auto normalized_subresource_range = image_state->NormalizeSubresourceRange(pCreateInfo->subresourceRange);
6094 if (normalized_subresource_range.levelCount != 1) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06006095 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02571",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006096 "vkCreateImageView(): If image was created with usage containing "
6097 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, subresourceRange.levelCount (%d) must: be 1",
6098 pCreateInfo->subresourceRange.levelCount);
6099 }
6100 }
6101 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
6102 if (!enabled_features.fragment_density_map_features.fragmentDensityMapDynamic) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06006103 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-02572",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006104 "vkCreateImageView(): If the fragmentDensityMapDynamic feature is not enabled, "
6105 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
6106 }
6107 } else {
6108 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
6109 if (image_flags & (VK_IMAGE_CREATE_PROTECTED_BIT | VK_IMAGE_CREATE_SPARSE_BINDING_BIT |
6110 VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT)) {
Shannon McPherson8d0d1f92020-07-06 11:58:21 -06006111 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-04116",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006112 "vkCreateImageView(): If image was created with usage containing "
6113 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT flags must not contain any of "
6114 "VK_IMAGE_CREATE_PROTECTED_BIT, VK_IMAGE_CREATE_SPARSE_BINDING_BIT, "
6115 "VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or VK_IMAGE_CREATE_SPARSE_ALIASED_BIT");
6116 }
6117 }
6118 }
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07006119
ziga-lunarg966ac0e2021-07-18 11:51:44 +02006120 if (image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
6121 if (pCreateInfo->subresourceRange.levelCount != 1) {
6122 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01584",
6123 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit, "
6124 "but subresourcesRange.levelCount (%" PRIu32 ") is not 1.",
6125 pCreateInfo->subresourceRange.levelCount);
6126 }
6127 if (pCreateInfo->subresourceRange.layerCount != 1) {
6128 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01584",
6129 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit, "
6130 "but subresourcesRange.layerCount (%" PRIu32 ") is not 1.",
6131 pCreateInfo->subresourceRange.layerCount);
6132 }
ziga-lunarg966ac0e2021-07-18 11:51:44 +02006133
sfricke-samsungd750f812022-02-04 10:23:34 -08006134 if (!FormatIsCompressed(view_format) && pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_3D) {
6135 skip |=
6136 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04739",
ziga-lunargc290c7f2021-07-31 22:01:46 +02006137 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit and "
6138 "non-compressed format (%s), but pCreateInfo->viewType is VK_IMAGE_VIEW_TYPE_3D.",
6139 string_VkFormat(image_format));
sfricke-samsungd750f812022-02-04 10:23:34 -08006140 }
6141
6142 const bool class_compatible = FormatCompatibilityClass(view_format) == FormatCompatibilityClass(image_format);
6143 // "uncompressed format that is size-compatible" so if compressed, same as not being compatible
6144 const bool size_compatible =
6145 FormatIsCompressed(view_format) ? false : FormatElementSize(view_format) == FormatElementSize(image_format);
6146 if (!class_compatible && !size_compatible) {
6147 skip |=
6148 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01583",
6149 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit and "
6150 "format (%s), but pCreateInfo->format (%s) are not compatible.",
6151 string_VkFormat(image_format), string_VkFormat(view_format));
6152 }
ziga-lunargc290c7f2021-07-31 22:01:46 +02006153 }
6154
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02006155 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT) {
6156 if (!enabled_features.fragment_density_map2_features.fragmentDensityMapDeferred) {
6157 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03567",
6158 "vkCreateImageView(): If the fragmentDensityMapDeferred feature is not enabled, "
6159 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT");
6160 }
6161 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
6162 skip |=
6163 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03568",
6164 "vkCreateImageView(): If flags contains VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT, "
6165 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
6166 }
6167 }
sfricke-samsung45996a42021-09-16 13:45:27 -07006168 if (IsExtEnabled(device_extensions.vk_ext_fragment_density_map2)) {
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02006169 if ((image_flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) && (image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) &&
sfricke-samsung20a8a372021-07-14 06:12:17 -07006170 (layer_count > phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers)) {
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02006171 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-03569",
6172 "vkCreateImageView(): If image was created with flags containing "
6173 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT and usage containing VK_IMAGE_USAGE_SAMPLED_BIT "
6174 "subresourceRange.layerCount (%d) must: be less than or equal to maxSubsampledArrayLayers (%d)",
sfricke-samsung20a8a372021-07-14 06:12:17 -07006175 layer_count, phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers);
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02006176 }
6177 }
6178
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07006179 auto astc_decode_mode = LvlFindInChain<VkImageViewASTCDecodeModeEXT>(pCreateInfo->pNext);
sfricke-samsung45996a42021-09-16 13:45:27 -07006180 if (IsExtEnabled(device_extensions.vk_ext_astc_decode_mode) && (astc_decode_mode != nullptr)) {
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07006181 if ((enabled_features.astc_decode_features.decodeModeSharedExponent == VK_FALSE) &&
6182 (astc_decode_mode->decodeMode == VK_FORMAT_E5B9G9R9_UFLOAT_PACK32)) {
6183 skip |= LogError(device, "VUID-VkImageViewASTCDecodeModeEXT-decodeMode-02231",
6184 "vkCreateImageView(): decodeModeSharedExponent is not enabled but "
6185 "VkImageViewASTCDecodeModeEXT::decodeMode is VK_FORMAT_E5B9G9R9_UFLOAT_PACK32.");
6186 }
6187 }
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07006188
sfricke-samsung45996a42021-09-16 13:45:27 -07006189 if (IsExtEnabled(device_extensions.vk_khr_portability_subset)) {
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07006190 // If swizzling is disabled, make sure it isn't used
Nathaniel Cesario17d057e2021-06-21 22:58:45 -06006191 // NOTE: as of spec version 1.2.183, VUID 04465 states: "all elements of components _must_ be
6192 // VK_COMPONENT_SWIZZLE_IDENTITY."
6193 // However, issue https://github.com/KhronosGroup/Vulkan-Portability/issues/27 points out that the identity can
6194 // also be defined via R, G, B, A enums in the correct order.
6195 // Spec change is at https://gitlab.khronos.org/vulkan/vulkan/-/merge_requests/4600
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07006196 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatSwizzle) &&
Nathaniel Cesario17d057e2021-06-21 22:58:45 -06006197 !IsIdentitySwizzle(pCreateInfo->components)) {
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07006198 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatSwizzle-04465",
6199 "vkCreateImageView (portability error): swizzle is disabled for this device.");
6200 }
6201
6202 // Ensure ImageView's format has the same number of bits and components as Image's format if format reinterpretation is
6203 // disabled
6204 // TODO (ncesario): This is not correct for some cases (e.g., VK_FORMAT_B10G11R11_UFLOAT_PACK32 and
6205 // VK_FORMAT_E5B9G9R9_UFLOAT_PACK32), but requires additional information that should probably be generated from the
6206 // spec. See Github issue #2361.
6207 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatReinterpretation) &&
6208 ((FormatElementSize(pCreateInfo->format, VK_IMAGE_ASPECT_COLOR_BIT) !=
6209 FormatElementSize(image_state->createInfo.format, VK_IMAGE_ASPECT_COLOR_BIT)) ||
sfricke-samsunged028b02021-09-06 23:14:51 -07006210 (FormatComponentCount(pCreateInfo->format) != FormatComponentCount(image_state->createInfo.format)))) {
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07006211 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatReinterpretation-04466",
6212 "vkCreateImageView (portability error): ImageView format must have"
6213 " the same number of components and bits per component as the Image's format");
6214 }
6215 }
Tony-LunarG69604c42021-11-22 16:00:12 -07006216
6217 auto image_view_min_lod = LvlFindInChain<VkImageViewMinLodCreateInfoEXT>(pCreateInfo->pNext);
6218 if (image_view_min_lod) {
6219 if ((!enabled_features.image_view_min_lod_features.minLod) && (image_view_min_lod->minLod != 0)) {
6220 skip |= LogError(device, "VUID-VkImageViewMinLodCreateInfoEXT-minLod-06455",
6221 "vkCreateImageView(): VkImageViewMinLodCreateInfoEXT::minLod = %f, but the minLod feature is not "
6222 "enabled. If the minLod feature is not enabled, minLod must be 0.0",
6223 image_view_min_lod->minLod);
6224 }
6225 auto max_level = (pCreateInfo->subresourceRange.baseMipLevel + (pCreateInfo->subresourceRange.levelCount - 1));
6226 if (image_view_min_lod->minLod > max_level) {
6227 skip |= LogError(device, "VUID-VkImageViewMinLodCreateInfoEXT-minLod-06456",
6228 "vkCreateImageView(): minLod (%f) must be less or equal to the index of the last mipmap level "
6229 "accessible to the view (%" PRIu32 ")",
6230 image_view_min_lod->minLod, max_level);
6231 }
6232 }
sfricke-samsung0dae8952022-03-03 20:34:23 -06006233
6234 if (FormatRequiresYcbcrConversionExplicitly(view_format)) {
6235 const auto ycbcr_conversion = LvlFindInChain<VkSamplerYcbcrConversionInfo>(pCreateInfo->pNext);
6236 if (!ycbcr_conversion || ycbcr_conversion->conversion == VK_NULL_HANDLE) {
6237 skip |= LogError(
6238 device, "VUID-VkImageViewCreateInfo-format-06415",
6239 "vkCreateImageView(): Format %s requires a VkSamplerYcbcrConversion but one was not passed in the pNext chain.",
6240 string_VkFormat(view_format));
6241 }
6242 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07006243 }
6244 return skip;
6245}
6246
Jeff Leger178b1e52020-10-05 12:22:23 -04006247template <typename RegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006248bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
Tony-LunarGef035472021-11-02 10:23:33 -06006249 uint32_t regionCount, const RegionType *pRegions, CMD_TYPE cmd_type) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006250 bool skip = false;
Tony-LunarGef035472021-11-02 10:23:33 -06006251 const bool is_2 = (cmd_type == CMD_COPYBUFFER2KHR || cmd_type == CMD_COPYBUFFER2);
6252 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04006253 const char *vuid;
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006254
6255 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
6256 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
Aitor Camacho2542b9d2022-06-01 18:37:49 +02006257 bool are_buffers_sparse = src_buffer_state->sparse || dst_buffer_state->sparse;
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006258
6259 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006260 const RegionType region = pRegions[i];
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006261
6262 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
sfricke-samsung71f04e32022-03-16 01:21:21 -05006263 if (region.srcOffset >= src_buffer_size) {
Tony-LunarGef035472021-11-02 10:23:33 -06006264 vuid = is_2 ? "VUID-VkCopyBufferInfo2-srcOffset-00113" : "VUID-vkCmdCopyBuffer-srcOffset-00113";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006265 skip |= LogError(src_buffer_state->buffer(), vuid,
ziga-lunargd6b58ce2021-10-16 01:22:56 +02006266 "%s: pRegions[%" PRIu32 "].srcOffset (%" PRIuLEAST64
6267 ") is greater than size of srcBuffer (%" PRIuLEAST64 ").",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006268 func_name, i, region.srcOffset, src_buffer_size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006269 }
6270
6271 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
sfricke-samsung71f04e32022-03-16 01:21:21 -05006272 if (region.dstOffset >= dst_buffer_size) {
Tony-LunarGef035472021-11-02 10:23:33 -06006273 vuid = is_2 ? "VUID-VkCopyBufferInfo2-dstOffset-00114" : "VUID-vkCmdCopyBuffer-dstOffset-00114";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006274 skip |= LogError(dst_buffer_state->buffer(), vuid,
ziga-lunargd6b58ce2021-10-16 01:22:56 +02006275 "%s: pRegions[%" PRIu32 "].dstOffset (%" PRIuLEAST64
6276 ") is greater than size of dstBuffer (%" PRIuLEAST64 ").",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006277 func_name, i, region.dstOffset, dst_buffer_size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006278 }
6279
6280 // 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 -05006281 if (region.size > (src_buffer_size - region.srcOffset)) {
Tony-LunarGef035472021-11-02 10:23:33 -06006282 vuid = is_2 ? "VUID-VkCopyBufferInfo2-size-00115" : "VUID-vkCmdCopyBuffer-size-00115";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006283 skip |= LogError(src_buffer_state->buffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006284 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the source buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006285 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006286 func_name, i, region.size, src_buffer_size, i, region.srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006287 }
6288
6289 // 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 -05006290 if (region.size > (dst_buffer_size - region.dstOffset)) {
Tony-LunarGef035472021-11-02 10:23:33 -06006291 vuid = is_2 ? "VUID-VkCopyBufferInfo2-size-00116" : "VUID-vkCmdCopyBuffer-size-00116";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006292 skip |= LogError(dst_buffer_state->buffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006293 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the destination buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006294 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006295 func_name, i, region.size, dst_buffer_size, i, region.dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006296 }
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006297
ziga-lunargb94ff002022-03-23 23:30:19 +01006298 // 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 +02006299 if (!skip && !are_buffers_sparse) {
6300 auto src_region = sparse_container::range<VkDeviceSize>{region.srcOffset, region.srcOffset + region.size};
aitor-lunarg26fbbc22022-04-22 18:42:08 +02006301 for (uint32_t j = 0; j < regionCount; j++) {
Aitor Camacho2542b9d2022-06-01 18:37:49 +02006302 auto dst_region =
6303 sparse_container::range<VkDeviceSize>{pRegions[j].dstOffset, pRegions[j].dstOffset + pRegions[j].size};
6304 if (src_buffer_state->DoesResourceMemoryOverlap(src_region, dst_buffer_state, dst_region)) {
aitor-lunarg26fbbc22022-04-22 18:42:08 +02006305 vuid = is_2 ? "VUID-VkCopyBufferInfo2-pRegions-00117" : "VUID-vkCmdCopyBuffer-pRegions-00117";
6306 skip |= LogError(src_buffer_state->buffer(), vuid,
6307 "%s: Detected overlap between source and dest regions in memory.", func_name);
6308 }
ziga-lunargb94ff002022-03-23 23:30:19 +01006309 }
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006310 }
6311 }
6312
6313 return skip;
6314}
sfricke-samsung11813ab2021-10-20 14:53:37 -07006315template <typename RegionType>
6316bool CoreChecks::ValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer, uint32_t regionCount,
Tony-LunarGef035472021-11-02 10:23:33 -06006317 const RegionType *pRegions, CMD_TYPE cmd_type) const {
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07006318 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07006319 auto src_buffer_state = Get<BUFFER_STATE>(srcBuffer);
6320 auto dst_buffer_state = Get<BUFFER_STATE>(dstBuffer);
Tony-LunarGef035472021-11-02 10:23:33 -06006321 const bool is_2 = (cmd_type == CMD_COPYBUFFER2KHR || cmd_type == CMD_COPYBUFFER2);
sfricke-samsung11813ab2021-10-20 14:53:37 -07006322 const char *func_name = CommandTypeString(cmd_type);
6323 const char *vuid;
6324
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006325 bool skip = false;
Tony-LunarGef035472021-11-02 10:23:33 -06006326 vuid = is_2 ? "VUID-VkCopyBufferInfo2-srcBuffer-00119" : "VUID-vkCmdCopyBuffer-srcBuffer-00119";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006327 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state.get(), func_name, vuid);
Tony-LunarGef035472021-11-02 10:23:33 -06006328 vuid = is_2 ? "VUID-VkCopyBufferInfo2-dstBuffer-00121" : "VUID-vkCmdCopyBuffer-dstBuffer-00121";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006329 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state.get(), func_name, vuid);
sfricke-samsung11813ab2021-10-20 14:53:37 -07006330
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006331 // Validate that SRC & DST buffers have correct usage flags set
Tony-LunarGef035472021-11-02 10:23:33 -06006332 vuid = is_2 ? "VUID-VkCopyBufferInfo2-srcBuffer-00118" : "VUID-vkCmdCopyBuffer-srcBuffer-00118";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006333 skip |= ValidateBufferUsageFlags(src_buffer_state.get(), VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
sfricke-samsung11813ab2021-10-20 14:53:37 -07006334 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Tony-LunarGef035472021-11-02 10:23:33 -06006335 vuid = is_2 ? "VUID-VkCopyBufferInfo2-dstBuffer-00120" : "VUID-vkCmdCopyBuffer-dstBuffer-00120";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006336 skip |= ValidateBufferUsageFlags(dst_buffer_state.get(), VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
sfricke-samsung11813ab2021-10-20 14:53:37 -07006337 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
6338
Jeremy Gebben9f537102021-10-05 16:37:12 -06006339 skip |= ValidateCmd(cb_node.get(), cmd_type);
Tony-LunarGef035472021-11-02 10:23:33 -06006340 skip |= ValidateCmdCopyBufferBounds(src_buffer_state.get(), dst_buffer_state.get(), regionCount, pRegions, cmd_type);
sfricke-samsung11813ab2021-10-20 14:53:37 -07006341
Tony-LunarGef035472021-11-02 10:23:33 -06006342 vuid = is_2 ? "VUID-vkCmdCopyBuffer2-commandBuffer-01822" : "VUID-vkCmdCopyBuffer-commandBuffer-01822";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006343 skip |= ValidateProtectedBuffer(cb_node.get(), src_buffer_state.get(), func_name, vuid);
Tony-LunarGef035472021-11-02 10:23:33 -06006344 vuid = is_2 ? "VUID-vkCmdCopyBuffer2-commandBuffer-01823" : "VUID-vkCmdCopyBuffer-commandBuffer-01823";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006345 skip |= ValidateProtectedBuffer(cb_node.get(), dst_buffer_state.get(), func_name, vuid);
Tony-LunarGef035472021-11-02 10:23:33 -06006346 vuid = is_2 ? "VUID-vkCmdCopyBuffer2-commandBuffer-01824" : "VUID-vkCmdCopyBuffer-commandBuffer-01824";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006347 skip |= ValidateUnprotectedBuffer(cb_node.get(), dst_buffer_state.get(), func_name, vuid);
Tony-LunarGef035472021-11-02 10:23:33 -06006348
Mark Lobodzinski680421d2017-02-09 13:06:56 -07006349 return skip;
6350}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07006351
sfricke-samsung11813ab2021-10-20 14:53:37 -07006352bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
6353 uint32_t regionCount, const VkBufferCopy *pRegions) const {
Tony-LunarGef035472021-11-02 10:23:33 -06006354 return ValidateCmdCopyBuffer(commandBuffer, srcBuffer, dstBuffer, regionCount, pRegions, CMD_COPYBUFFER);
sfricke-samsung11813ab2021-10-20 14:53:37 -07006355}
6356
Jeff Leger178b1e52020-10-05 12:22:23 -04006357bool CoreChecks::PreCallValidateCmdCopyBuffer2KHR(VkCommandBuffer commandBuffer,
6358 const VkCopyBufferInfo2KHR *pCopyBufferInfos) const {
sfricke-samsung11813ab2021-10-20 14:53:37 -07006359 return ValidateCmdCopyBuffer(commandBuffer, pCopyBufferInfos->srcBuffer, pCopyBufferInfos->dstBuffer,
Tony-LunarGef035472021-11-02 10:23:33 -06006360 pCopyBufferInfos->regionCount, pCopyBufferInfos->pRegions, CMD_COPYBUFFER2KHR);
6361}
6362
6363bool CoreChecks::PreCallValidateCmdCopyBuffer2(VkCommandBuffer commandBuffer, const VkCopyBufferInfo2 *pCopyBufferInfos) const {
6364 return ValidateCmdCopyBuffer(commandBuffer, pCopyBufferInfos->srcBuffer, pCopyBufferInfos->dstBuffer,
6365 pCopyBufferInfos->regionCount, pCopyBufferInfos->pRegions, CMD_COPYBUFFER2);
Jeff Leger178b1e52020-10-05 12:22:23 -04006366}
6367
Aitor Camacho2542b9d2022-06-01 18:37:49 +02006368template <typename RegionType>
6369void CoreChecks::RecordCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer, uint32_t regionCount,
6370 const RegionType *pRegions, CMD_TYPE cmd_type) {
6371 const bool is_2 = (cmd_type == CMD_COPYBUFFER2KHR || cmd_type == CMD_COPYBUFFER2);
6372 const char *func_name = CommandTypeString(cmd_type);
6373 const char *vuid = is_2 ? "VUID-VkCopyBufferInfo2-pRegions-00117" : "VUID-vkCmdCopyBuffer-pRegions-00117";
6374
6375 auto src_buffer_state = Get<BUFFER_STATE>(srcBuffer);
6376 auto dst_buffer_state = Get<BUFFER_STATE>(dstBuffer);
6377 if (src_buffer_state->sparse || dst_buffer_state->sparse) {
6378 auto cb_node = Get<CMD_BUFFER_STATE>(commandBuffer);
6379
6380 std::vector<sparse_container::range<VkDeviceSize>> src_ranges;
6381 std::vector<sparse_container::range<VkDeviceSize>> dst_ranges;
6382
6383 for (uint32_t i = 0u; i < regionCount; ++i) {
6384 const RegionType &region = pRegions[i];
6385 src_ranges.emplace_back(sparse_container::range<VkDeviceSize>{region.srcOffset, region.srcOffset + region.size});
6386 dst_ranges.emplace_back(sparse_container::range<VkDeviceSize>{region.dstOffset, region.dstOffset + region.size});
6387 }
6388
6389 auto queue_submit_validation = [this, src_buffer_state, dst_buffer_state, src_ranges, dst_ranges, vuid, func_name](
6390 const ValidationStateTracker &device_data, const class QUEUE_STATE &queue_state,
6391 const CMD_BUFFER_STATE &cb_state) -> bool {
6392 bool skip = false;
6393 for (const auto &src : src_ranges) {
6394 for (const auto &dst : dst_ranges) {
6395 if (src_buffer_state->DoesResourceMemoryOverlap(src, dst_buffer_state.get(), dst)) {
6396 skip |= this->LogError(src_buffer_state->buffer(), vuid,
6397 "%s: Detected overlap between source and dest regions in memory.", func_name);
6398 }
6399 }
6400 }
6401
6402 return skip;
6403 };
6404
6405 cb_node->queue_submit_functions.emplace_back(queue_submit_validation);
6406 }
6407}
6408
6409void CoreChecks::PreCallRecordCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
6410 uint32_t regionCount, const VkBufferCopy *pRegions) {
6411 RecordCmdCopyBuffer(commandBuffer, srcBuffer, dstBuffer, regionCount, pRegions, CMD_COPYBUFFER);
6412}
6413
6414void CoreChecks::PreCallRecordCmdCopyBuffer2KHR(VkCommandBuffer commandBuffer, const VkCopyBufferInfo2KHR *pCopyBufferInfos) {
6415 RecordCmdCopyBuffer(commandBuffer, pCopyBufferInfos->srcBuffer, pCopyBufferInfos->dstBuffer, pCopyBufferInfos->regionCount,
6416 pCopyBufferInfos->pRegions, CMD_COPYBUFFER2KHR);
6417}
6418
6419void CoreChecks::PreCallRecordCmdCopyBuffer2(VkCommandBuffer commandBuffer, const VkCopyBufferInfo2 *pCopyBufferInfos) {
6420 RecordCmdCopyBuffer(commandBuffer, pCopyBufferInfos->srcBuffer, pCopyBufferInfos->dstBuffer, pCopyBufferInfos->regionCount,
6421 pCopyBufferInfos->pRegions, CMD_COPYBUFFER2);
6422}
6423
Jeff Bolz46c0ea02019-10-09 13:06:29 -05006424bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006425 bool skip = false;
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006426 auto buffer_state = Get<BUFFER_STATE>(buffer);
sfricke-samsung9c7d8552020-08-16 22:12:21 -07006427 if (buffer_state) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06006428 if (buffer_state->InUse()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006429 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
6430 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006431 }
6432 }
6433 return skip;
6434}
6435
Jeff Bolz5c801d12019-10-09 10:38:45 -05006436bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
6437 const VkAllocationCallbacks *pAllocator) const {
Jeremy Gebbenf4449392022-01-28 10:09:10 -07006438 auto image_view_state = Get<IMAGE_VIEW_STATE>(imageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07006439
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006440 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07006441 if (image_view_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06006442 skip |= ValidateObjectNotInUse(image_view_state.get(), "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006443 }
6444 return skip;
6445}
6446
Jeff Bolz5c801d12019-10-09 10:38:45 -05006447bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Jeremy Gebben9f537102021-10-05 16:37:12 -06006448 return ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006449}
6450
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006451bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006452 const VkAllocationCallbacks *pAllocator) const {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006453 auto buffer_view_state = Get<BUFFER_VIEW_STATE>(bufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006454 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07006455 if (buffer_view_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06006456 skip |= ValidateObjectNotInUse(buffer_view_state.get(), "vkDestroyBufferView", "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006457 }
6458 return skip;
6459}
6460
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006461bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006462 VkDeviceSize size, uint32_t data) const {
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07006463 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006464 auto buffer_state = Get<BUFFER_STATE>(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006465 bool skip = false;
Jeremy Gebben9f537102021-10-05 16:37:12 -06006466 skip |= ValidateMemoryIsBoundToBuffer(buffer_state.get(), "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
6467 skip |= ValidateCmd(cb_node.get(), CMD_FILLBUFFER);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006468 // Validate that DST buffer has correct usage flags set
Jeremy Gebben9f537102021-10-05 16:37:12 -06006469 skip |=
6470 ValidateBufferUsageFlags(buffer_state.get(), VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
6471 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006472
Jeremy Gebben9f537102021-10-05 16:37:12 -06006473 skip |=
6474 ValidateProtectedBuffer(cb_node.get(), buffer_state.get(), "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01811");
6475 skip |= ValidateUnprotectedBuffer(cb_node.get(), buffer_state.get(), "vkCmdFillBuffer()",
6476 "VUID-vkCmdFillBuffer-commandBuffer-01812");
sfricke-samsung022fa252020-07-24 03:26:16 -07006477
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006478 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006479 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
6480 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
6481 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
6482 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006483 }
6484
6485 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006486 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
6487 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
6488 ") minus dstOffset (0x%" PRIxLEAST64 ").",
6489 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006490 }
6491
sfricke-samsung45996a42021-09-16 13:45:27 -07006492 if (!IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06006493 skip |= ValidateCmdQueueFlags(cb_node.get(), "vkCmdFillBuffer()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
ziga-lunarg3c5c84e2021-08-04 15:18:56 +02006494 "VUID-vkCmdFillBuffer-commandBuffer-00030");
6495 }
6496
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006497 return skip;
6498}
6499
sfricke-samsung71f04e32022-03-16 01:21:21 -05006500template <typename RegionType>
6501bool CoreChecks::ValidateBufferImageCopyData(const CMD_BUFFER_STATE *cb_node, uint32_t regionCount, const RegionType *pRegions,
6502 const IMAGE_STATE *image_state, const char *function, CMD_TYPE cmd_type,
6503 bool image_to_buffer) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006504 bool skip = false;
Tony Barbour845d29b2021-11-09 11:43:14 -07006505 const bool is_2 = (cmd_type == CMD_COPYBUFFERTOIMAGE2KHR || cmd_type == CMD_COPYBUFFERTOIMAGE2);
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07006506 const char *vuid;
Jeff Leger178b1e52020-10-05 12:22:23 -04006507
sfricke-samsung125d2b42020-05-28 06:32:43 -07006508 assert(image_state != nullptr);
6509 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006510
6511 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006512 const RegionType region = pRegions[i];
6513 const VkImageAspectFlags region_aspect_mask = region.imageSubresource.aspectMask;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006514 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006515 if ((region.imageOffset.y != 0) || (region.imageExtent.height != 1)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006516 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00199", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006517 "%s: pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
6518 "and 1, respectively.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006519 function, i, region.imageOffset.y, region.imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006520 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006521 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006522
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006523 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006524 if ((region.imageOffset.z != 0) || (region.imageExtent.depth != 1)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006525 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00201", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006526 "%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 -07006527 "must be 0 and 1, respectively.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006528 function, i, region.imageOffset.z, region.imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006529 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006530 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006531
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006532 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006533 if ((0 != region.imageSubresource.baseArrayLayer) || (1 != region.imageSubresource.layerCount)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006534 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00213", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006535 "%s: pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006536 "For 3D images these must be 0 and 1, respectively.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006537 function, i, region.imageSubresource.baseArrayLayer, region.imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006538 }
6539 }
6540
6541 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07006542 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
sfricke-samsung73e755c2021-09-30 08:34:57 -07006543 const uint32_t element_size =
6544 FormatIsDepthOrStencil(image_format) ? 0 : FormatElementSize(image_format, region_aspect_mask);
sfricke-samsung71f04e32022-03-16 01:21:21 -05006545 const VkDeviceSize bufferOffset = region.bufferOffset;
Locke497739c2019-03-08 11:50:47 -07006546
sfricke-samsung8feecc12021-01-23 03:28:38 -08006547 if (FormatIsDepthOrStencil(image_format)) {
6548 if (SafeModulo(bufferOffset, 4) != 0) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006549 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("04053", image_to_buffer, is_2),
sfricke-samsung8feecc12021-01-23 03:28:38 -08006550 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6551 " must be a multiple 4 if using a depth/stencil format (%s).",
6552 function, i, bufferOffset, string_VkFormat(image_format));
6553 }
6554 } else {
6555 // If not depth/stencil and not multi-plane
6556 if (!FormatIsMultiplane(image_format) && (SafeModulo(bufferOffset, element_size) != 0)) {
sfricke-samsung45996a42021-09-16 13:45:27 -07006557 vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
Tony Barbour845d29b2021-11-09 11:43:14 -07006558 ? GetBufferImageCopyCommandVUID("01558", image_to_buffer, is_2)
6559 : GetBufferImageCopyCommandVUID("00193", image_to_buffer, is_2);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006560 skip |= LogError(image_state->image(), vuid,
sfricke-samsung8feecc12021-01-23 03:28:38 -08006561 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6562 " must be a multiple of this format's texel size (%" PRIu32 ").",
6563 function, i, bufferOffset, element_size);
6564 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006565 }
6566
sfricke-samsung5f11b0e2022-03-22 14:12:15 -05006567 // Make sure not a empty region
6568 if (region.imageExtent.width == 0) {
6569 vuid = is_2 ? "VUID-VkBufferImageCopy2-imageExtent-06659" : "VUID-VkBufferImageCopy-imageExtent-06659";
6570 LogObjectList objlist(cb_node->commandBuffer());
6571 objlist.add(image_state->image());
6572 skip |=
6573 LogError(objlist, vuid, "%s: pRegion[%" PRIu32 "] extent.width must not be zero as empty copies are not allowed.",
6574 function, i);
6575 }
6576 if (region.imageExtent.height == 0) {
6577 vuid = is_2 ? "VUID-VkBufferImageCopy2-imageExtent-06660" : "VUID-VkBufferImageCopy-imageExtent-06660";
6578 LogObjectList objlist(cb_node->commandBuffer());
6579 objlist.add(image_state->image());
6580 skip |=
6581 LogError(objlist, vuid, "%s: pRegion[%" PRIu32 "] extent.height must not be zero as empty copies are not allowed.",
6582 function, i);
6583 }
6584 if (region.imageExtent.depth == 0) {
6585 vuid = is_2 ? "VUID-VkBufferImageCopy2-imageExtent-06661" : "VUID-VkBufferImageCopy-imageExtent-06661";
6586 LogObjectList objlist(cb_node->commandBuffer());
6587 objlist.add(image_state->image());
6588 skip |=
6589 LogError(objlist, vuid, "%s: pRegion[%" PRIu32 "] extent.depth must not be zero as empty copies are not allowed.",
6590 function, i);
6591 }
6592
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006593 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
sfricke-samsung71f04e32022-03-16 01:21:21 -05006594 if ((region.bufferRowLength != 0) && (region.bufferRowLength < region.imageExtent.width)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006595 vuid = (is_2) ? "VUID-VkBufferImageCopy2-bufferRowLength-00195" : "VUID-VkBufferImageCopy-bufferRowLength-00195";
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06006596 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006597 LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006598 "%s: pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006599 function, i, region.bufferRowLength, region.imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006600 }
6601
6602 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
sfricke-samsung71f04e32022-03-16 01:21:21 -05006603 if ((region.bufferImageHeight != 0) && (region.bufferImageHeight < region.imageExtent.height)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006604 vuid = (is_2) ? "VUID-VkBufferImageCopy2-bufferImageHeight-00196" : "VUID-VkBufferImageCopy-bufferImageHeight-00196";
Jeff Leger178b1e52020-10-05 12:22:23 -04006605 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006606 LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006607 "%s: pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006608 function, i, region.bufferImageHeight, region.imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006609 }
6610
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006611 // Calculate adjusted image extent, accounting for multiplane image factors
sfricke-samsung71f04e32022-03-16 01:21:21 -05006612 VkExtent3D adjusted_image_extent = image_state->GetSubresourceExtent(region.imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006613 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
sfricke-samsung71f04e32022-03-16 01:21:21 -05006614 if ((region.imageOffset.x < 0) || (region.imageOffset.x > static_cast<int32_t>(adjusted_image_extent.width)) ||
6615 ((region.imageOffset.x + static_cast<int32_t>(region.imageExtent.width)) >
Mark Lobodzinski72b1a222020-03-18 11:36:10 -06006616 static_cast<int32_t>(adjusted_image_extent.width))) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006617 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00197", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006618 "%s: Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006619 "zero or <= image subresource width (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006620 function, i, region.imageOffset.x, (region.imageOffset.x + region.imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006621 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006622 }
6623
6624 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
sfricke-samsung71f04e32022-03-16 01:21:21 -05006625 if ((region.imageOffset.y < 0) || (region.imageOffset.y > static_cast<int32_t>(adjusted_image_extent.height)) ||
6626 ((region.imageOffset.y + static_cast<int32_t>(region.imageExtent.height)) >
Mark Lobodzinski72b1a222020-03-18 11:36:10 -06006627 static_cast<int32_t>(adjusted_image_extent.height))) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006628 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00198", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006629 "%s: Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006630 "zero or <= image subresource height (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006631 function, i, region.imageOffset.y, (region.imageOffset.y + region.imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006632 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006633 }
6634
6635 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
sfricke-samsung71f04e32022-03-16 01:21:21 -05006636 if ((region.imageOffset.z < 0) || (region.imageOffset.z > static_cast<int32_t>(adjusted_image_extent.depth)) ||
6637 ((region.imageOffset.z + static_cast<int32_t>(region.imageExtent.depth)) >
Mark Lobodzinski72b1a222020-03-18 11:36:10 -06006638 static_cast<int32_t>(adjusted_image_extent.depth))) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006639 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00200", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006640 "%s: Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006641 "zero or <= image subresource depth (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006642 function, i, region.imageOffset.z, (region.imageOffset.z + region.imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006643 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006644 }
6645
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006646 // subresource aspectMask must have exactly 1 bit set
6647 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
sfricke-samsung125d2b42020-05-28 06:32:43 -07006648 std::bitset<num_bits> aspect_mask_bits(region_aspect_mask);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006649 if (aspect_mask_bits.count() != 1) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006650 vuid = (is_2) ? "VUID-VkBufferImageCopy2-aspectMask-00212" : "VUID-VkBufferImageCopy-aspectMask-00212";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006651 skip |= LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006652 "%s: aspectMasks for imageSubresource in pRegion[%d] must have only a single bit set.", function, i);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006653 }
6654
6655 // image subresource aspect bit must match format
sfricke-samsung125d2b42020-05-28 06:32:43 -07006656 if (!VerifyAspectsPresent(region_aspect_mask, image_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006657 skip |=
Tony Barbour845d29b2021-11-09 11:43:14 -07006658 LogError(image_state->image(), GetBufferImageCopyCommandVUID("00211", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006659 "%s: pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
6660 function, i, region_aspect_mask, image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006661 }
6662
6663 // Checks that apply only to compressed images
sfricke-samsung01da6312021-10-20 07:51:32 -07006664 if (FormatIsBlockedImage(image_format)) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006665 auto block_size = FormatTexelBlockExtent(image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006666
6667 // BufferRowLength must be a multiple of block width
sfricke-samsung71f04e32022-03-16 01:21:21 -05006668 if (SafeModulo(region.bufferRowLength, block_size.width) != 0) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006669 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00203", image_to_buffer, is_2),
sfricke-samsung01da6312021-10-20 07:51:32 -07006670 "%s: pRegion[%d] bufferRowLength (%d) must be a multiple of the blocked image's texel width (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006671 function, i, region.bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006672 }
6673
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006674 // BufferRowHeight must be a multiple of block height
sfricke-samsung71f04e32022-03-16 01:21:21 -05006675 if (SafeModulo(region.bufferImageHeight, block_size.height) != 0) {
sfricke-samsung01da6312021-10-20 07:51:32 -07006676 skip |=
Tony Barbour845d29b2021-11-09 11:43:14 -07006677 LogError(image_state->image(), GetBufferImageCopyCommandVUID("00204", image_to_buffer, is_2),
sfricke-samsung01da6312021-10-20 07:51:32 -07006678 "%s: pRegion[%d] bufferImageHeight (%d) must be a multiple of the blocked image's texel height (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006679 function, i, region.bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006680 }
6681
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006682 // image offsets must be multiples of block dimensions
sfricke-samsung71f04e32022-03-16 01:21:21 -05006683 if ((SafeModulo(region.imageOffset.x, block_size.width) != 0) ||
6684 (SafeModulo(region.imageOffset.y, block_size.height) != 0) ||
6685 (SafeModulo(region.imageOffset.z, block_size.depth) != 0)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006686 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00205", image_to_buffer, is_2),
sfricke-samsung01da6312021-10-20 07:51:32 -07006687 "%s: pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the blocked image's texel "
Petr Krausb0d5e592021-05-21 23:37:11 +02006688 "width & height (%d, %d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006689 function, i, region.imageOffset.x, region.imageOffset.y, block_size.width, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006690 }
6691
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006692 // bufferOffset must be a multiple of block size (linear bytes)
sfricke-samsung73e755c2021-09-30 08:34:57 -07006693 if (SafeModulo(bufferOffset, element_size) != 0) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006694 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00206", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006695 "%s: pRegion[%d] bufferOffset (0x%" PRIxLEAST64
sfricke-samsung01da6312021-10-20 07:51:32 -07006696 ") must be a multiple of the blocked image's texel block size (%" PRIu32 ").",
sfricke-samsung73e755c2021-09-30 08:34:57 -07006697 function, i, bufferOffset, element_size);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006698 }
Dave Houlton67e9b532017-03-02 17:00:10 -07006699
6700 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
sfricke-samsung71f04e32022-03-16 01:21:21 -05006701 VkExtent3D mip_extent = image_state->GetSubresourceExtent(region.imageSubresource);
6702 if ((SafeModulo(region.imageExtent.width, block_size.width) != 0) &&
6703 (region.imageExtent.width + region.imageOffset.x != mip_extent.width)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006704 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00207", image_to_buffer, is_2),
sfricke-samsung01da6312021-10-20 07:51:32 -07006705 "%s: pRegion[%d] extent width (%d) must be a multiple of the blocked texture block width "
Petr Krausb0d5e592021-05-21 23:37:11 +02006706 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006707 function, i, region.imageExtent.width, block_size.width, region.imageOffset.x, mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07006708 }
6709
6710 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
sfricke-samsung71f04e32022-03-16 01:21:21 -05006711 if ((SafeModulo(region.imageExtent.height, block_size.height) != 0) &&
6712 (region.imageExtent.height + region.imageOffset.y != mip_extent.height)) {
6713 skip |=
6714 LogError(image_state->image(), GetBufferImageCopyCommandVUID("00208", image_to_buffer, is_2),
6715 "%s: pRegion[%d] extent height (%d) must be a multiple of the blocked texture block height "
6716 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d).",
6717 function, i, region.imageExtent.height, block_size.height, region.imageOffset.y, mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07006718 }
6719
6720 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
sfricke-samsung71f04e32022-03-16 01:21:21 -05006721 if ((SafeModulo(region.imageExtent.depth, block_size.depth) != 0) &&
6722 (region.imageExtent.depth + region.imageOffset.z != mip_extent.depth)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006723 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00209", image_to_buffer, is_2),
sfricke-samsung01da6312021-10-20 07:51:32 -07006724 "%s: pRegion[%d] extent width (%d) must be a multiple of the blocked texture block depth "
Petr Krausb0d5e592021-05-21 23:37:11 +02006725 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006726 function, i, region.imageExtent.depth, block_size.depth, region.imageOffset.z, mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07006727 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006728 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08006729
6730 // Checks that apply only to multi-planar format images
sfricke-samsung125d2b42020-05-28 06:32:43 -07006731 if (FormatIsMultiplane(image_format)) {
sfricke-samsung552d5e12020-01-07 22:00:20 -08006732 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
sfricke-samsung125d2b42020-05-28 06:32:43 -07006733 if ((FormatPlaneCount(image_format) < 3) && (region_aspect_mask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006734 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006735 "%s: pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006736 "format has three planes.",
6737 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08006738 }
6739
6740 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
sfricke-samsung125d2b42020-05-28 06:32:43 -07006741 if (0 ==
6742 (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 -07006743 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006744 "%s: pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006745 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
6746 function, i);
sfricke-samsung125d2b42020-05-28 06:32:43 -07006747 } else {
6748 // Know aspect mask is valid
6749 const VkFormat compatible_format = FindMultiplaneCompatibleFormat(image_format, region_aspect_mask);
6750 const uint32_t compatible_size = FormatElementSize(compatible_format);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006751 if (SafeModulo(bufferOffset, compatible_size) != 0) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006752 skip |= LogError(
Tony Barbour845d29b2021-11-09 11:43:14 -07006753 image_state->image(), GetBufferImageCopyCommandVUID("01559", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006754 "%s: pRegion[%d]->bufferOffset is 0x%" PRIxLEAST64
sfricke-samsung125d2b42020-05-28 06:32:43 -07006755 " 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 -08006756 function, i, bufferOffset, element_size, GetPlaneIndex(region_aspect_mask),
sfricke-samsung125d2b42020-05-28 06:32:43 -07006757 string_VkFormat(compatible_format));
6758 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08006759 }
6760 }
sfricke-samsung8feecc12021-01-23 03:28:38 -08006761
6762 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
Jeremy Gebbencd7fa282021-10-27 10:25:32 -06006763 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool;
sfricke-samsung8feecc12021-01-23 03:28:38 -08006764 assert(command_pool != nullptr);
6765 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006766 const VkQueueFlags queue_flags = physical_device_state->queue_family_properties[queue_family_index].queueFlags;
sfricke-samsung8feecc12021-01-23 03:28:38 -08006767 if (((queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT)) == 0) && (SafeModulo(bufferOffset, 4) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006768 LogObjectList objlist(cb_node->commandBuffer());
6769 objlist.add(command_pool->commandPool());
sfricke-samsung4389faa2022-03-23 01:19:42 -05006770 objlist.add(image_state->image());
6771 skip |= LogError(objlist, GetBufferImageCopyCommandVUID("04052", image_to_buffer, is_2),
sfricke-samsung8feecc12021-01-23 03:28:38 -08006772 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6773 " must be a multiple 4 because the command buffer %s was allocated from the command pool %s "
6774 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT or "
6775 "VK_QUEUE_COMPUTE_BIT flag.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006776 function, i, bufferOffset, report_data->FormatHandle(cb_node->commandBuffer()).c_str(),
6777 report_data->FormatHandle(command_pool->commandPool()).c_str(), queue_family_index);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006778 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006779 }
6780
6781 return skip;
6782}
6783
sfricke-samsung71f04e32022-03-16 01:21:21 -05006784template <typename RegionType>
6785bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount, const RegionType *pRegions,
6786 const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006787 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006788 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006789
6790 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006791 const RegionType region = pRegions[i];
6792 VkExtent3D extent = region.imageExtent;
6793 VkOffset3D offset = region.imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006794
sfricke-samsung71f04e32022-03-16 01:21:21 -05006795 VkExtent3D image_extent = image_state->GetSubresourceExtent(region.imageSubresource);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006796
sfricke-samsung01da6312021-10-20 07:51:32 -07006797 // If we're using a blocked image format, valid extent is rounded up to multiple of block size (per
6798 // vkspec.html#_common_operation)
6799 if (FormatIsBlockedImage(image_info->format)) {
Dave Houltona585d132019-01-18 13:05:42 -07006800 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006801 if (image_extent.width % block_extent.width) {
6802 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
6803 }
6804 if (image_extent.height % block_extent.height) {
6805 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
6806 }
6807 if (image_extent.depth % block_extent.depth) {
6808 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
6809 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006810 }
6811
Dave Houltonfc1a4052017-04-27 14:32:45 -06006812 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Petr Krausb0d5e592021-05-21 23:37:11 +02006813 skip |= LogError(image_state->image(), msg_code, "%s: pRegion[%d] exceeds image bounds.", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006814 }
6815 }
6816
6817 return skip;
6818}
6819
sfricke-samsung71f04e32022-03-16 01:21:21 -05006820template <typename RegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006821bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
sfricke-samsung71f04e32022-03-16 01:21:21 -05006822 const RegionType *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006823 bool skip = false;
6824
sfricke-samsung11d15ba2021-09-30 09:19:56 -07006825 const VkDeviceSize buffer_size = buff_state->createInfo.size;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006826
6827 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006828 const RegionType region = pRegions[i];
6829 const VkDeviceSize buffer_copy_size = GetBufferSizeFromCopyImage(region, image_state->createInfo.format);
sfricke-samsung11d15ba2021-09-30 09:19:56 -07006830 // This blocks against invalid VkBufferCopyImage that already have been caught elsewhere
6831 if (buffer_copy_size != 0) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006832 const VkDeviceSize max_buffer_copy = buffer_copy_size + region.bufferOffset;
sfricke-samsung11d15ba2021-09-30 09:19:56 -07006833 if (buffer_size < max_buffer_copy) {
6834 skip |= LogError(device, msg_code,
6835 "%s: pRegion[%" PRIu32 "] is trying to copy %" PRIu64 " bytes plus %" PRIu64
6836 " offset to/from the VkBuffer (%s) which exceeds the VkBuffer total size of %" PRIu64 " bytes.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006837 func_name, i, buffer_copy_size, region.bufferOffset,
sfricke-samsung11d15ba2021-09-30 09:19:56 -07006838 report_data->FormatHandle(buff_state->buffer()).c_str(), buffer_size);
6839 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006840 }
6841 }
6842
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006843 return skip;
6844}
6845
sfricke-samsung71f04e32022-03-16 01:21:21 -05006846template <typename RegionType>
Jeff Leger178b1e52020-10-05 12:22:23 -04006847bool CoreChecks::ValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
sfricke-samsung71f04e32022-03-16 01:21:21 -05006848 VkBuffer dstBuffer, uint32_t regionCount, const RegionType *pRegions,
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006849
6850 CMD_TYPE cmd_type) const {
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07006851 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07006852 auto src_image_state = Get<IMAGE_STATE>(srcImage);
6853 auto dst_buffer_state = Get<BUFFER_STATE>(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006854
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006855 const bool is_2 = (cmd_type == CMD_COPYIMAGETOBUFFER2KHR || cmd_type == CMD_COPYIMAGETOBUFFER2);
sfricke-samsung85584a72021-09-30 21:43:38 -07006856 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04006857 const char *vuid;
6858
Tony Barbour845d29b2021-11-09 11:43:14 -07006859 bool skip = ValidateBufferImageCopyData(cb_node.get(), regionCount, pRegions, src_image_state.get(), func_name, cmd_type, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006860
6861 // Validate command buffer state
Jeremy Gebben9f537102021-10-05 16:37:12 -06006862 skip |= ValidateCmd(cb_node.get(), cmd_type);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006863
6864 // Command pool must support graphics, compute, or transfer operations
Jeremy Gebbencd7fa282021-10-27 10:25:32 -06006865 const auto pool = cb_node->command_pool;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006866
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006867 VkQueueFlags queue_flags = physical_device_state->queue_family_properties[pool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07006868
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006869 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006870 vuid = is_2 ? "VUID-vkCmdCopyImageToBuffer2-commandBuffer-cmdpool" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool";
Jeff Leger178b1e52020-10-05 12:22:23 -04006871 skip |= LogError(cb_node->createInfo.commandPool, vuid,
6872 "Cannot call %s on a command buffer allocated from a pool without graphics, compute, "
6873 "or transfer capabilities.",
6874 func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006875 }
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006876
6877 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-pRegions-00182" : "VUID-vkCmdCopyImageToBuffer-pRegions-06220";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006878 skip |= ValidateImageBounds(src_image_state.get(), regionCount, pRegions, func_name, vuid);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006879 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-pRegions-00183" : "VUID-vkCmdCopyImageToBuffer-pRegions-00183";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006880 skip |= ValidateBufferBounds(src_image_state.get(), dst_buffer_state.get(), regionCount, pRegions, func_name, vuid);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006881
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006882 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImage-00188" : "VUID-vkCmdCopyImageToBuffer-srcImage-00188";
6883 std::string location = func_name;
6884 location.append("() : srcImage");
6885 skip |= ValidateImageSampleCount(src_image_state.get(), VK_SAMPLE_COUNT_1_BIT, location.c_str(), vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04006886
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006887 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImage-00187" : "VUID-vkCmdCopyImageToBuffer-srcImage-00187";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006888 skip |= ValidateMemoryIsBoundToImage(src_image_state.get(), func_name, vuid);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006889 vuid = is_2 ? "vkCmdCopyImageToBuffer-dstBuffer2-00192" : "vkCmdCopyImageToBuffer dstBuffer-00192";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006890 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state.get(), func_name, vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006891
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006892 // Validate that SRC image & DST buffer have correct usage flags set
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006893 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImage-00186" : "VUID-vkCmdCopyImageToBuffer-srcImage-00186";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006894 skip |= ValidateImageUsageFlags(src_image_state.get(), VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006895 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006896 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-dstBuffer-00191" : "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006897 skip |= ValidateBufferUsageFlags(dst_buffer_state.get(), VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006898 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006899 vuid = is_2 ? "VUID-vkCmdCopyImageToBuffer2-commandBuffer-01831" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01831";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006900 skip |= ValidateProtectedImage(cb_node.get(), src_image_state.get(), func_name, vuid);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006901 vuid = is_2 ? "VUID-vkCmdCopyImageToBuffer2-commandBuffer-01832" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01832";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006902 skip |= ValidateProtectedBuffer(cb_node.get(), dst_buffer_state.get(), func_name, vuid);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006903 vuid = is_2 ? "VUID-vkCmdCopyImageToBuffer2-commandBuffer-01833" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01833";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006904 skip |= ValidateUnprotectedBuffer(cb_node.get(), dst_buffer_state.get(), func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006905
6906 // Validation for VK_EXT_fragment_density_map
6907 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006908 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImage-02544" : "VUID-vkCmdCopyImageToBuffer-srcImage-02544";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006909 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006910 "%s: srcImage must not have been created with flags containing "
6911 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
6912 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006913 }
6914
sfricke-samsung45996a42021-09-16 13:45:27 -07006915 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006916 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImage-01998" : "VUID-vkCmdCopyImageToBuffer-srcImage-01998";
6917 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(), VK_FORMAT_FEATURE_2_TRANSFER_SRC_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04006918 }
Tobin Ehlisc8266452017-04-07 12:20:30 -06006919 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04006920
sfricke-samsung45996a42021-09-16 13:45:27 -07006921 const char *src_invalid_layout_vuid =
6922 (src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006923 ? (vuid =
6924 is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImageLayout-01397" : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397")
6925 : (vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImageLayout-00190"
6926 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190");
Jeff Leger178b1e52020-10-05 12:22:23 -04006927
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006928 for (uint32_t i = 0; i < regionCount; ++i) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006929 const RegionType region = pRegions[i];
6930 skip |= ValidateImageSubresourceLayers(cb_node.get(), &region.imageSubresource, func_name, "imageSubresource", i);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006931 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImageLayout-00189" : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189";
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06006932 skip |= VerifyImageLayout(*cb_node, *src_image_state, region.imageSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04006933 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, src_invalid_layout_vuid, vuid, &hit_error);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006934 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-imageOffset-01794" : "VUID-vkCmdCopyImageToBuffer-imageOffset-01794";
sfricke-samsung71f04e32022-03-16 01:21:21 -05006935 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node.get(), src_image_state.get(), &region, i, func_name,
6936 vuid);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006937 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-imageSubresource-01703" : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703";
sfricke-samsung71f04e32022-03-16 01:21:21 -05006938 skip |= ValidateImageMipLevel(cb_node.get(), src_image_state.get(), region.imageSubresource.mipLevel, i, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04006939 "imageSubresource", vuid);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006940 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-imageSubresource-01704" : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704";
sfricke-samsung71f04e32022-03-16 01:21:21 -05006941 skip |= ValidateImageArrayLayerRange(cb_node.get(), src_image_state.get(), region.imageSubresource.baseArrayLayer,
6942 region.imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006943 }
6944 return skip;
6945}
6946
Jeff Leger178b1e52020-10-05 12:22:23 -04006947bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6948 VkBuffer dstBuffer, uint32_t regionCount,
6949 const VkBufferImageCopy *pRegions) const {
6950 return ValidateCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions,
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006951 CMD_COPYIMAGETOBUFFER);
Jeff Leger178b1e52020-10-05 12:22:23 -04006952}
6953
6954bool CoreChecks::PreCallValidateCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
6955 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) const {
6956 return ValidateCmdCopyImageToBuffer(commandBuffer, pCopyImageToBufferInfo->srcImage, pCopyImageToBufferInfo->srcImageLayout,
6957 pCopyImageToBufferInfo->dstBuffer, pCopyImageToBufferInfo->regionCount,
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006958 pCopyImageToBufferInfo->pRegions, CMD_COPYIMAGETOBUFFER2KHR);
Jeff Leger178b1e52020-10-05 12:22:23 -04006959}
6960
Tony Barbour845d29b2021-11-09 11:43:14 -07006961bool CoreChecks::PreCallValidateCmdCopyImageToBuffer2(VkCommandBuffer commandBuffer,
6962 const VkCopyImageToBufferInfo2 *pCopyImageToBufferInfo) const {
6963 return ValidateCmdCopyImageToBuffer(commandBuffer, pCopyImageToBufferInfo->srcImage, pCopyImageToBufferInfo->srcImageLayout,
6964 pCopyImageToBufferInfo->dstBuffer, pCopyImageToBufferInfo->regionCount,
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006965 pCopyImageToBufferInfo->pRegions, CMD_COPYIMAGETOBUFFER2);
Tony Barbour845d29b2021-11-09 11:43:14 -07006966}
6967
John Zulauf1686f232019-07-09 16:27:11 -06006968void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6969 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
6970 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
6971
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07006972 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006973 auto src_image_state = Get<IMAGE_STATE>(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06006974 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006975 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06006976 cb_node->SetImageInitialLayout(*src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06006977 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006978}
6979
Jeff Leger178b1e52020-10-05 12:22:23 -04006980void CoreChecks::PreCallRecordCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
6981 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) {
6982 StateTracker::PreCallRecordCmdCopyImageToBuffer2KHR(commandBuffer, pCopyImageToBufferInfo);
6983
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07006984 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006985 auto src_image_state = Get<IMAGE_STATE>(pCopyImageToBufferInfo->srcImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04006986 // Make sure that all image slices record referenced layout
6987 for (uint32_t i = 0; i < pCopyImageToBufferInfo->regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06006988 cb_node->SetImageInitialLayout(*src_image_state, pCopyImageToBufferInfo->pRegions[i].imageSubresource,
6989 pCopyImageToBufferInfo->srcImageLayout);
Jeff Leger178b1e52020-10-05 12:22:23 -04006990 }
6991}
6992
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006993void CoreChecks::PreCallRecordCmdCopyImageToBuffer2(VkCommandBuffer commandBuffer,
6994 const VkCopyImageToBufferInfo2 *pCopyImageToBufferInfo) {
6995 StateTracker::PreCallRecordCmdCopyImageToBuffer2(commandBuffer, pCopyImageToBufferInfo);
6996
6997 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
6998 auto src_image_state = Get<IMAGE_STATE>(pCopyImageToBufferInfo->srcImage);
6999 // Make sure that all image slices record referenced layout
7000 for (uint32_t i = 0; i < pCopyImageToBufferInfo->regionCount; ++i) {
7001 cb_node->SetImageInitialLayout(*src_image_state, pCopyImageToBufferInfo->pRegions[i].imageSubresource,
7002 pCopyImageToBufferInfo->srcImageLayout);
7003 }
7004}
7005
Jeff Leger178b1e52020-10-05 12:22:23 -04007006template <typename RegionType>
7007bool CoreChecks::ValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
7008 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
Tony Barbour845d29b2021-11-09 11:43:14 -07007009 CMD_TYPE cmd_type) const {
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07007010 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07007011 auto src_buffer_state = Get<BUFFER_STATE>(srcBuffer);
7012 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07007013
Tony Barbour845d29b2021-11-09 11:43:14 -07007014 const bool is_2 = (cmd_type == CMD_COPYBUFFERTOIMAGE2KHR || cmd_type == CMD_COPYBUFFERTOIMAGE2);
sfricke-samsung85584a72021-09-30 21:43:38 -07007015 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04007016 const char *vuid;
7017
Tony Barbour845d29b2021-11-09 11:43:14 -07007018 bool skip =
7019 ValidateBufferImageCopyData(cb_node.get(), regionCount, pRegions, dst_image_state.get(), func_name, cmd_type, false);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07007020
7021 // Validate command buffer state
Jeremy Gebben9f537102021-10-05 16:37:12 -06007022 skip |= ValidateCmd(cb_node.get(), cmd_type);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07007023
Tony Barbour845d29b2021-11-09 11:43:14 -07007024 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-pRegions-00172" : "VUID-vkCmdCopyBufferToImage-pRegions-06217";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007025 skip |= ValidateImageBounds(dst_image_state.get(), regionCount, pRegions, func_name, vuid);
Tony Barbour845d29b2021-11-09 11:43:14 -07007026 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-pRegions-00171" : "VUID-vkCmdCopyBufferToImage-pRegions-00171";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007027 skip |= ValidateBufferBounds(dst_image_state.get(), src_buffer_state.get(), regionCount, pRegions, func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04007028
Tony Barbour845d29b2021-11-09 11:43:14 -07007029 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImage-00179" : "VUID-vkCmdCopyBufferToImage-dstImage-00179";
7030 std::string location = func_name;
7031 location.append("() : dstImage");
7032 skip |= ValidateImageSampleCount(dst_image_state.get(), VK_SAMPLE_COUNT_1_BIT, location.c_str(), vuid);
7033 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-srcBuffer-00176" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00176";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007034 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state.get(), func_name, vuid);
Tony Barbour845d29b2021-11-09 11:43:14 -07007035 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImage-00178" : "VUID-vkCmdCopyBufferToImage-dstImage-00178";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007036 skip |= ValidateMemoryIsBoundToImage(dst_image_state.get(), func_name, vuid);
Tony Barbour845d29b2021-11-09 11:43:14 -07007037 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-srcBuffer-00174" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00174";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007038 skip |= ValidateBufferUsageFlags(src_buffer_state.get(), VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06007039 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Tony Barbour845d29b2021-11-09 11:43:14 -07007040 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImage-00177" : "VUID-vkCmdCopyBufferToImage-dstImage-00177";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007041 skip |= ValidateImageUsageFlags(dst_image_state.get(), VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06007042 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Tony Barbour845d29b2021-11-09 11:43:14 -07007043 vuid = is_2 ? "VUID-vkCmdCopyBufferToImage2-commandBuffer-01828" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01828";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007044 skip |= ValidateProtectedBuffer(cb_node.get(), src_buffer_state.get(), func_name, vuid);
Tony Barbour845d29b2021-11-09 11:43:14 -07007045 vuid = is_2 ? "VUID-vkCmdCopyBufferToImage2-commandBuffer-01829" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01829";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007046 skip |= ValidateProtectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
Tony Barbour845d29b2021-11-09 11:43:14 -07007047 vuid = is_2 ? "VUID-vkCmdCopyBufferToImage-commandBuffer-01830" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01830";
Jeremy Gebben9f537102021-10-05 16:37:12 -06007048 skip |= ValidateUnprotectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02007049
7050 // Validation for VK_EXT_fragment_density_map
7051 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony Barbour845d29b2021-11-09 11:43:14 -07007052 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImage-02543" : "VUID-vkCmdCopyBufferToImage-dstImage-02543";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06007053 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04007054 "%s: dstImage must not have been created with flags containing "
7055 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
7056 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02007057 }
7058
sfricke-samsung45996a42021-09-16 13:45:27 -07007059 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07007060 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImage-01997" : "VUID-vkCmdCopyBufferToImage-dstImage-01997";
7061 skip |= ValidateImageFormatFeatureFlags(dst_image_state.get(), VK_FORMAT_FEATURE_2_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04007062 }
Tobin Ehlisc8266452017-04-07 12:20:30 -06007063 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04007064
sfricke-samsung45996a42021-09-16 13:45:27 -07007065 const char *dst_invalid_layout_vuid =
7066 (dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Tony Barbour845d29b2021-11-09 11:43:14 -07007067 ? (is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImageLayout-01396"
sfricke-samsung45996a42021-09-16 13:45:27 -07007068 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396")
Tony Barbour845d29b2021-11-09 11:43:14 -07007069 : (is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImageLayout-00181"
sfricke-samsung45996a42021-09-16 13:45:27 -07007070 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181");
Jeff Leger178b1e52020-10-05 12:22:23 -04007071
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07007072 for (uint32_t i = 0; i < regionCount; ++i) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05007073 const RegionType region = pRegions[i];
7074 skip |= ValidateImageSubresourceLayers(cb_node.get(), &region.imageSubresource, func_name, "imageSubresource", i);
Tony Barbour845d29b2021-11-09 11:43:14 -07007075 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImageLayout-00180" : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180";
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06007076 skip |= VerifyImageLayout(*cb_node, *dst_image_state, region.imageSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04007077 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, dst_invalid_layout_vuid, vuid, &hit_error);
Tony Barbour845d29b2021-11-09 11:43:14 -07007078 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-imageOffset-01793" : "VUID-vkCmdCopyBufferToImage-imageOffset-01793";
sfricke-samsung71f04e32022-03-16 01:21:21 -05007079 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node.get(), dst_image_state.get(), &region, i, func_name,
7080 vuid);
Tony Barbour845d29b2021-11-09 11:43:14 -07007081 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-imageSubresource-01701" : "VUID-vkCmdCopyBufferToImage-imageSubresource-01701";
sfricke-samsung71f04e32022-03-16 01:21:21 -05007082 skip |= ValidateImageMipLevel(cb_node.get(), dst_image_state.get(), region.imageSubresource.mipLevel, i, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04007083 "imageSubresource", vuid);
Tony Barbour845d29b2021-11-09 11:43:14 -07007084 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-imageSubresource-01702" : "VUID-vkCmdCopyBufferToImage-imageSubresource-01702";
sfricke-samsung71f04e32022-03-16 01:21:21 -05007085 skip |= ValidateImageArrayLayerRange(cb_node.get(), dst_image_state.get(), region.imageSubresource.baseArrayLayer,
7086 region.imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
sfricke-samsungea4fd142020-10-17 23:51:59 -07007087
7088 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
Jeremy Gebbencd7fa282021-10-27 10:25:32 -06007089 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool;
sfricke-samsungea4fd142020-10-17 23:51:59 -07007090 assert(command_pool != nullptr);
7091 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06007092 const VkQueueFlags queue_flags = physical_device_state->queue_family_properties[queue_family_index].queueFlags;
sfricke-samsung71f04e32022-03-16 01:21:21 -05007093 const VkImageAspectFlags region_aspect_mask = region.imageSubresource.aspectMask;
sfricke-samsungea4fd142020-10-17 23:51:59 -07007094 if (((queue_flags & VK_QUEUE_GRAPHICS_BIT) == 0) &&
7095 ((region_aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06007096 LogObjectList objlist(cb_node->commandBuffer());
7097 objlist.add(command_pool->commandPool());
sfricke-samsung4389faa2022-03-23 01:19:42 -05007098 objlist.add(dst_image_state->image());
Tony Barbour845d29b2021-11-09 11:43:14 -07007099 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-commandBuffer-04477"
sfricke-samsungea4fd142020-10-17 23:51:59 -07007100 : "VUID-vkCmdCopyBufferToImage-commandBuffer-04477";
sfricke-samsung4389faa2022-03-23 01:19:42 -05007101 skip |= LogError(objlist, vuid,
sfricke-samsungea4fd142020-10-17 23:51:59 -07007102 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies VK_IMAGE_ASPECT_DEPTH_BIT or "
7103 "VK_IMAGE_ASPECT_STENCIL_BIT but the command buffer %s was allocated from the command pool %s "
7104 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT flag.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06007105 func_name, i, region_aspect_mask, report_data->FormatHandle(cb_node->commandBuffer()).c_str(),
7106 report_data->FormatHandle(command_pool->commandPool()).c_str(), queue_family_index);
sfricke-samsungea4fd142020-10-17 23:51:59 -07007107 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07007108 }
7109 return skip;
7110}
7111
Jeff Leger178b1e52020-10-05 12:22:23 -04007112bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
7113 VkImageLayout dstImageLayout, uint32_t regionCount,
7114 const VkBufferImageCopy *pRegions) const {
7115 return ValidateCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions,
Tony Barbour845d29b2021-11-09 11:43:14 -07007116 CMD_COPYBUFFERTOIMAGE);
Jeff Leger178b1e52020-10-05 12:22:23 -04007117}
7118
7119bool CoreChecks::PreCallValidateCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
7120 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo) const {
7121 return ValidateCmdCopyBufferToImage(commandBuffer, pCopyBufferToImageInfo->srcBuffer, pCopyBufferToImageInfo->dstImage,
7122 pCopyBufferToImageInfo->dstImageLayout, pCopyBufferToImageInfo->regionCount,
Tony Barbour845d29b2021-11-09 11:43:14 -07007123 pCopyBufferToImageInfo->pRegions, CMD_COPYBUFFERTOIMAGE2KHR);
7124}
7125
7126bool CoreChecks::PreCallValidateCmdCopyBufferToImage2(VkCommandBuffer commandBuffer,
7127 const VkCopyBufferToImageInfo2 *pCopyBufferToImageInfo) const {
7128 return ValidateCmdCopyBufferToImage(commandBuffer, pCopyBufferToImageInfo->srcBuffer, pCopyBufferToImageInfo->dstImage,
7129 pCopyBufferToImageInfo->dstImageLayout, pCopyBufferToImageInfo->regionCount,
7130 pCopyBufferToImageInfo->pRegions, CMD_COPYBUFFERTOIMAGE2);
Jeff Leger178b1e52020-10-05 12:22:23 -04007131}
7132
John Zulauf1686f232019-07-09 16:27:11 -06007133void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
7134 VkImageLayout dstImageLayout, uint32_t regionCount,
7135 const VkBufferImageCopy *pRegions) {
7136 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
7137
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07007138 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06007139 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06007140 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07007141 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06007142 cb_node->SetImageInitialLayout(*dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06007143 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07007144}
Mike Weiblen672b58b2017-02-21 14:32:53 -07007145
Jeff Leger178b1e52020-10-05 12:22:23 -04007146void CoreChecks::PreCallRecordCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
7147 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo2KHR) {
7148 StateTracker::PreCallRecordCmdCopyBufferToImage2KHR(commandBuffer, pCopyBufferToImageInfo2KHR);
7149
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07007150 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06007151 auto dst_image_state = Get<IMAGE_STATE>(pCopyBufferToImageInfo2KHR->dstImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04007152 // Make sure that all image slices are record referenced layout
7153 for (uint32_t i = 0; i < pCopyBufferToImageInfo2KHR->regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06007154 cb_node->SetImageInitialLayout(*dst_image_state, pCopyBufferToImageInfo2KHR->pRegions[i].imageSubresource,
7155 pCopyBufferToImageInfo2KHR->dstImageLayout);
Jeff Leger178b1e52020-10-05 12:22:23 -04007156 }
7157}
Tony Barbour845d29b2021-11-09 11:43:14 -07007158
7159void CoreChecks::PreCallRecordCmdCopyBufferToImage2(VkCommandBuffer commandBuffer,
7160 const VkCopyBufferToImageInfo2 *pCopyBufferToImageInfo) {
7161 StateTracker::PreCallRecordCmdCopyBufferToImage2(commandBuffer, pCopyBufferToImageInfo);
7162
7163 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
7164 auto dst_image_state = Get<IMAGE_STATE>(pCopyBufferToImageInfo->dstImage);
7165 // Make sure that all image slices are record referenced layout
7166 for (uint32_t i = 0; i < pCopyBufferToImageInfo->regionCount; ++i) {
7167 cb_node->SetImageInitialLayout(*dst_image_state, pCopyBufferToImageInfo->pRegions[i].imageSubresource,
7168 pCopyBufferToImageInfo->dstImageLayout);
7169 }
7170}
7171
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07007172bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05007173 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07007174 bool skip = false;
7175 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
7176
Dave Houlton1d960ff2018-01-19 12:17:05 -07007177 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07007178 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
7179 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
7180 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07007181 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
7182 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07007183 }
7184
Jeremy Gebbenf4449392022-01-28 10:09:10 -07007185 auto image_entry = Get<IMAGE_STATE>(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07007186 if (!image_entry) {
7187 return skip;
7188 }
7189
Mark Lobodzinski6f358172019-10-02 11:09:12 -06007190 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
sfricke-samsung45996a42021-09-16 13:45:27 -07007191 if (IsExtEnabled(device_extensions.vk_ext_image_drm_format_modifier)) {
Mark Lobodzinski6f358172019-10-02 11:09:12 -06007192 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
7193 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07007194 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
7195 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
7196 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06007197 }
7198 } else {
7199 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07007200 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
7201 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06007202 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07007203 }
7204
Dave Houlton1d960ff2018-01-19 12:17:05 -07007205 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07007206 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07007207 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
7208 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
7209 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07007210 }
7211
Dave Houlton1d960ff2018-01-19 12:17:05 -07007212 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07007213 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07007214 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
7215 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
7216 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07007217 }
7218
Dave Houlton1d960ff2018-01-19 12:17:05 -07007219 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07007220 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06007221 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
7222 if (FormatIsMultiplane(img_format)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08007223 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06007224 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
7225 if (FormatPlaneCount(img_format) > 2u) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08007226 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06007227 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
7228 }
7229 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07007230 skip |= LogError(image, vuid,
7231 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
7232 ") must be a single-plane specifier flag.",
7233 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06007234 }
7235 } else if (FormatIsColor(img_format)) {
7236 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
ziga-lunargcc568bc2021-09-05 13:45:45 +02007237 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04461",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07007238 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
7239 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06007240 }
7241 } else if (FormatIsDepthOrStencil(img_format)) {
Nathaniel Cesario8c80f352021-07-15 15:06:48 -06007242 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06007243 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07007244 }
ziga-lunarg4ecbd5b2021-07-15 20:48:30 +02007245 if (!FormatIsDepthAndStencil(img_format) && !FormatIsDepthOnly(img_format)) {
7246 if (sub_aspect & VK_IMAGE_ASPECT_DEPTH_BIT) {
7247 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04464",
7248 "vkGetImageSubresourceLayout(): Image format (%s) does not contain a depth component, "
7249 "but VkImageSubresource.aspectMask contains VK_IMAGE_ASPECT_DEPTH_BIT.",
7250 string_VkFormat(img_format));
7251 }
7252 } else {
7253 if ((sub_aspect & VK_IMAGE_ASPECT_DEPTH_BIT) == 0) {
7254 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04462",
7255 "vkGetImageSubresourceLayout(): Image format (%s) contains a depth component, "
7256 "but VkImageSubresource.aspectMask does not contain VK_IMAGE_ASPECT_DEPTH_BIT.",
7257 string_VkFormat(img_format));
7258 }
7259 }
7260 if (!FormatIsDepthAndStencil(img_format) && !FormatIsStencilOnly(img_format)) {
7261 if (sub_aspect & VK_IMAGE_ASPECT_STENCIL_BIT) {
7262 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04464",
7263 "vkGetImageSubresourceLayout(): Image format (%s) does not contain a stencil component, "
7264 "but VkImageSubresource.aspectMask contains VK_IMAGE_ASPECT_STENCIL_BIT.",
7265 string_VkFormat(img_format));
7266 }
7267 } else {
7268 if ((sub_aspect & VK_IMAGE_ASPECT_STENCIL_BIT) == 0) {
7269 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04463",
7270 "vkGetImageSubresourceLayout(): Image format (%s) contains a stencil component, "
7271 "but VkImageSubresource.aspectMask does not contain VK_IMAGE_ASPECT_STENCIL_BIT.",
7272 string_VkFormat(img_format));
7273 }
7274 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06007275 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
7276 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
7277 (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 +02007278 skip |= LogError(
7279 image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
7280 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask (%s) must be VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.",
7281 string_VkImageAspectFlags(sub_aspect).c_str());
7282 } else {
7283 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
7284 assert(IsExtEnabled(device_extensions.vk_ext_image_drm_format_modifier));
7285 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = LvlInitStruct<VkImageDrmFormatModifierPropertiesEXT>();
7286 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image, &drm_format_properties);
7287
7288 auto fmt_drm_props = LvlInitStruct<VkDrmFormatModifierPropertiesListEXT>();
7289 auto fmt_props_2 = LvlInitStruct<VkFormatProperties2>(&fmt_drm_props);
7290 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_entry->createInfo.format, &fmt_props_2);
7291 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties{fmt_drm_props.drmFormatModifierCount};
7292 fmt_drm_props.pDrmFormatModifierProperties = drm_properties.data();
7293 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_entry->createInfo.format, &fmt_props_2);
7294
7295 uint32_t max_plane_count = 0u;
7296
7297 for (auto const &drm_property : drm_properties) {
7298 if (drm_format_properties.drmFormatModifier == drm_property.drmFormatModifier) {
7299 max_plane_count = drm_property.drmFormatModifierPlaneCount;
7300 break;
7301 }
7302 }
7303
7304 VkImageAspectFlagBits allowed_plane_indices[] = {
7305 VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT, VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT,
7306 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT, VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT};
7307
7308 bool is_valid = false;
7309
7310 for (uint32_t i = 0u; i < max_plane_count; ++i) {
7311 if (sub_aspect == allowed_plane_indices[i]) {
7312 is_valid = true;
7313 break;
7314 }
7315 }
7316
7317 if (!is_valid) {
7318 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
7319 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask (%s) must be "
7320 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT, with i being less than the "
7321 "VkDrmFormatModifierPropertiesEXT::drmFormatModifierPlaneCount (%" PRIu32
7322 ") associated with the image's format (%s) and "
7323 "VkImageDrmFormatModifierPropertiesEXT::drmFormatModifier (%" PRIu64 ").",
7324 string_VkImageAspectFlags(sub_aspect).c_str(), max_plane_count,
7325 string_VkFormat(image_entry->createInfo.format), drm_format_properties.drmFormatModifier);
7326 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07007327 }
7328 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06007329
sfricke-samsung45996a42021-09-16 13:45:27 -07007330 if (IsExtEnabled(device_extensions.vk_android_external_memory_android_hardware_buffer)) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07007331 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06007332 }
7333
Mike Weiblen672b58b2017-02-21 14:32:53 -07007334 return skip;
7335}
sfricke-samsung022fa252020-07-24 03:26:16 -07007336
7337// Validates the image is allowed to be protected
7338bool CoreChecks::ValidateProtectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06007339 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07007340 bool skip = false;
sfricke-samsung21286f82021-11-16 08:21:46 -08007341
7342 // if driver supports protectedNoFault the operation is valid, just has undefined values
7343 if ((!phys_dev_props_core11.protectedNoFault) && (cb_state->unprotected == true) && (image_state->unprotected == false)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06007344 LogObjectList objlist(cb_state->commandBuffer());
7345 objlist.add(image_state->image());
locke-lunarg351c9d82020-10-23 14:43:21 -06007346 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 -06007347 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
7348 report_data->FormatHandle(image_state->image()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07007349 }
7350 return skip;
7351}
7352
7353// Validates the image is allowed to be unprotected
7354bool CoreChecks::ValidateUnprotectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06007355 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07007356 bool skip = false;
sfricke-samsung21286f82021-11-16 08:21:46 -08007357
7358 // if driver supports protectedNoFault the operation is valid, just has undefined values
7359 if ((!phys_dev_props_core11.protectedNoFault) && (cb_state->unprotected == false) && (image_state->unprotected == true)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06007360 LogObjectList objlist(cb_state->commandBuffer());
7361 objlist.add(image_state->image());
locke-lunarg351c9d82020-10-23 14:43:21 -06007362 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 -06007363 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
7364 report_data->FormatHandle(image_state->image()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07007365 }
7366 return skip;
7367}
7368
7369// Validates the buffer is allowed to be protected
7370bool CoreChecks::ValidateProtectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06007371 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07007372 bool skip = false;
sfricke-samsung21286f82021-11-16 08:21:46 -08007373
7374 // if driver supports protectedNoFault the operation is valid, just has undefined values
7375 if ((!phys_dev_props_core11.protectedNoFault) && (cb_state->unprotected == true) && (buffer_state->unprotected == false)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06007376 LogObjectList objlist(cb_state->commandBuffer());
7377 objlist.add(buffer_state->buffer());
locke-lunarg351c9d82020-10-23 14:43:21 -06007378 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 -06007379 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
7380 report_data->FormatHandle(buffer_state->buffer()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07007381 }
7382 return skip;
7383}
7384
7385// Validates the buffer is allowed to be unprotected
7386bool CoreChecks::ValidateUnprotectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06007387 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07007388 bool skip = false;
sfricke-samsung21286f82021-11-16 08:21:46 -08007389
7390 // if driver supports protectedNoFault the operation is valid, just has undefined values
7391 if ((!phys_dev_props_core11.protectedNoFault) && (cb_state->unprotected == false) && (buffer_state->unprotected == true)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06007392 LogObjectList objlist(cb_state->commandBuffer());
7393 objlist.add(buffer_state->buffer());
locke-lunarg351c9d82020-10-23 14:43:21 -06007394 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 -06007395 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
7396 report_data->FormatHandle(buffer_state->buffer()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07007397 }
7398 return skip;
7399}