blob: 4e51e5219fdc41ca70bf2642960b21b27307f494 [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 Gebbenf33bcd12022-04-19 08:12:44 -060047using LayoutEntry = image_layout_map::ImageSubresourceLayoutMap::LayoutEntry;
48
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070049// All VUID from copy_bufferimage_to_imagebuffer_common.txt
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070050static const char *GetBufferImageCopyCommandVUID(std::string id, bool image_to_buffer, bool copy2) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070051 // clang-format off
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070052 static const std::map<std::string, std::array<const char *, 4>> copy_imagebuffer_vuid = {
53 {"00193", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070054 "VUID-vkCmdCopyBufferToImage-bufferOffset-00193", // !copy2 & !image_to_buffer
55 "VUID-vkCmdCopyImageToBuffer-bufferOffset-00193", // !copy2 & image_to_buffer
Tony Barbour845d29b2021-11-09 11:43:14 -070056 "VUID-VkCopyBufferToImageInfo2-bufferOffset-00193", // copy2 & !image_to_buffer
Tony-LunarGaf3632a2021-11-10 15:51:57 -070057 "VUID-VkCopyImageToBufferInfo2-bufferOffset-00193", // copy2 & image_to_buffer
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070058 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070059 {"01558", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070060 "VUID-vkCmdCopyBufferToImage-bufferOffset-01558",
61 "VUID-vkCmdCopyImageToBuffer-bufferOffset-01558",
Tony Barbour845d29b2021-11-09 11:43:14 -070062 "VUID-VkCopyBufferToImageInfo2-bufferOffset-01558",
Tony-LunarGaf3632a2021-11-10 15:51:57 -070063 "VUID-VkCopyImageToBufferInfo2-bufferOffset-01558",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070064 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070065 {"01559", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070066 "VUID-vkCmdCopyBufferToImage-bufferOffset-01559",
67 "VUID-vkCmdCopyImageToBuffer-bufferOffset-01559",
Tony Barbour845d29b2021-11-09 11:43:14 -070068 "VUID-VkCopyBufferToImageInfo2-bufferOffset-01559",
Tony-LunarGaf3632a2021-11-10 15:51:57 -070069 "VUID-VkCopyImageToBufferInfo2-bufferOffset-01559",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070070 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070071 {"00197", {
Mike Schuchardt7b152fa2021-08-03 16:30:27 -070072 "VUID-vkCmdCopyBufferToImage-pRegions-06218",
73 "VUID-vkCmdCopyImageToBuffer-pRegions-06221",
Tony Barbour845d29b2021-11-09 11:43:14 -070074 "VUID-VkCopyBufferToImageInfo2-pRegions-06223",
Tony-LunarGaf3632a2021-11-10 15:51:57 -070075 "VUID-VkCopyImageToBufferInfo2-imageOffset-00197",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070076 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070077 {"00198", {
Mike Schuchardt7b152fa2021-08-03 16:30:27 -070078 "VUID-vkCmdCopyBufferToImage-pRegions-06219",
79 "VUID-vkCmdCopyImageToBuffer-pRegions-06222",
Tony Barbour845d29b2021-11-09 11:43:14 -070080 "VUID-VkCopyBufferToImageInfo2-pRegions-06224",
Tony-LunarGaf3632a2021-11-10 15:51:57 -070081 "VUID-VkCopyImageToBufferInfo2-imageOffset-00198",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070082 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070083 {"00199", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070084 "VUID-vkCmdCopyBufferToImage-srcImage-00199",
85 "VUID-vkCmdCopyImageToBuffer-srcImage-00199",
Tony Barbour845d29b2021-11-09 11:43:14 -070086 "VUID-VkCopyBufferToImageInfo2-srcImage-00199",
Tony-LunarGaf3632a2021-11-10 15:51:57 -070087 "VUID-VkCopyImageToBufferInfo2-srcImage-00199",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070088 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070089 {"00200", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070090 "VUID-vkCmdCopyBufferToImage-imageOffset-00200",
91 "VUID-vkCmdCopyImageToBuffer-imageOffset-00200",
Tony Barbour845d29b2021-11-09 11:43:14 -070092 "VUID-VkCopyBufferToImageInfo2-imageOffset-00200",
Tony-LunarGaf3632a2021-11-10 15:51:57 -070093 "VUID-VkCopyImageToBufferInfo2-imageOffset-00200",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070094 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070095 {"00201", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070096 "VUID-vkCmdCopyBufferToImage-srcImage-00201",
97 "VUID-vkCmdCopyImageToBuffer-srcImage-00201",
Tony Barbour845d29b2021-11-09 11:43:14 -070098 "VUID-VkCopyBufferToImageInfo2-srcImage-00201",
Tony-LunarGaf3632a2021-11-10 15:51:57 -070099 "VUID-VkCopyImageToBufferInfo2-srcImage-00201",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700100 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700101 {"00203", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700102 "VUID-vkCmdCopyBufferToImage-bufferRowLength-00203",
103 "VUID-vkCmdCopyImageToBuffer-bufferRowLength-00203",
Tony Barbour845d29b2021-11-09 11:43:14 -0700104 "VUID-VkCopyBufferToImageInfo2-bufferRowLength-00203",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700105 "VUID-VkCopyImageToBufferInfo2-bufferRowLength-00203",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700106 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700107 {"00204", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700108 "VUID-vkCmdCopyBufferToImage-bufferImageHeight-00204",
109 "VUID-vkCmdCopyImageToBuffer-bufferImageHeight-00204",
Tony Barbour845d29b2021-11-09 11:43:14 -0700110 "VUID-VkCopyBufferToImageInfo2-bufferImageHeight-00204",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700111 "VUID-VkCopyImageToBufferInfo2-bufferImageHeight-00204",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700112 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700113 {"00205", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700114 "VUID-vkCmdCopyBufferToImage-imageOffset-00205",
115 "VUID-vkCmdCopyImageToBuffer-imageOffset-00205",
Tony Barbour845d29b2021-11-09 11:43:14 -0700116 "VUID-VkCopyBufferToImageInfo2-imageOffset-00205",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700117 "VUID-VkCopyImageToBufferInfo2-imageOffset-00205",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700118 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700119 {"00206", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700120 "VUID-vkCmdCopyBufferToImage-bufferOffset-00206",
121 "VUID-vkCmdCopyImageToBuffer-bufferOffset-00206",
Tony Barbour845d29b2021-11-09 11:43:14 -0700122 "VUID-VkCopyBufferToImageInfo2-bufferOffset-00206",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700123 "VUID-VkCopyImageToBufferInfo2-bufferOffset-00206",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700124 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700125 {"00207", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700126 "VUID-vkCmdCopyBufferToImage-imageExtent-00207",
127 "VUID-vkCmdCopyImageToBuffer-imageExtent-00207",
Tony Barbour845d29b2021-11-09 11:43:14 -0700128 "VUID-VkCopyBufferToImageInfo2-imageExtent-00207",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700129 "VUID-VkCopyImageToBufferInfo2-imageExtent-00207",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700130 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700131 {"00208", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700132 "VUID-vkCmdCopyBufferToImage-imageExtent-00208",
133 "VUID-vkCmdCopyImageToBuffer-imageExtent-00208",
Tony Barbour845d29b2021-11-09 11:43:14 -0700134 "VUID-VkCopyBufferToImageInfo2-imageExtent-00208",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700135 "VUID-VkCopyImageToBufferInfo2-imageExtent-00208",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700136 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700137 {"00209", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700138 "VUID-vkCmdCopyBufferToImage-imageExtent-00209",
139 "VUID-vkCmdCopyImageToBuffer-imageExtent-00209",
Tony Barbour845d29b2021-11-09 11:43:14 -0700140 "VUID-VkCopyBufferToImageInfo2-imageExtent-00209",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700141 "VUID-VkCopyImageToBufferInfo2-imageExtent-00209",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700142 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700143 {"00211", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700144 "VUID-vkCmdCopyBufferToImage-aspectMask-00211",
145 "VUID-vkCmdCopyImageToBuffer-aspectMask-00211",
Tony Barbour845d29b2021-11-09 11:43:14 -0700146 "VUID-VkCopyBufferToImageInfo2-aspectMask-00211",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700147 "VUID-VkCopyImageToBufferInfo2-aspectMask-00211",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700148 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700149 {"01560", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700150 "VUID-vkCmdCopyBufferToImage-aspectMask-01560",
151 "VUID-vkCmdCopyImageToBuffer-aspectMask-01560",
Tony Barbour845d29b2021-11-09 11:43:14 -0700152 "VUID-VkCopyBufferToImageInfo2-aspectMask-01560",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700153 "VUID-VkCopyImageToBufferInfo2-aspectMask-01560",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700154 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700155 {"00213", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700156 "VUID-vkCmdCopyBufferToImage-baseArrayLayer-00213",
157 "VUID-vkCmdCopyImageToBuffer-baseArrayLayer-00213",
Tony Barbour845d29b2021-11-09 11:43:14 -0700158 "VUID-VkCopyBufferToImageInfo2-baseArrayLayer-00213",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700159 "VUID-VkCopyImageToBufferInfo2-baseArrayLayer-00213",
sfricke-samsung8feecc12021-01-23 03:28:38 -0800160 }},
161 {"04052", {
162 "VUID-vkCmdCopyBufferToImage-commandBuffer-04052",
163 "VUID-vkCmdCopyImageToBuffer-commandBuffer-04052",
Tony Barbour845d29b2021-11-09 11:43:14 -0700164 "VUID-VkCopyBufferToImageInfo2-commandBuffer-04052",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700165 "VUID-VkCopyImageToBufferInfo2-commandBuffer-04052",
sfricke-samsung8feecc12021-01-23 03:28:38 -0800166 }},
167 {"04053", {
168 "VUID-vkCmdCopyBufferToImage-srcImage-04053",
169 "VUID-vkCmdCopyImageToBuffer-srcImage-04053",
Tony Barbour845d29b2021-11-09 11:43:14 -0700170 "VUID-VkCopyBufferToImageInfo2-srcImage-04053",
Tony-LunarGaf3632a2021-11-10 15:51:57 -0700171 "VUID-VkCopyImageToBufferInfo2-srcImage-04053",
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700172 }}
173 };
174 // clang-format on
175
176 uint8_t index = 0;
Artem Bolgar82d08362021-06-03 13:11:13 -0700177 index |= uint8_t((image_to_buffer) ? 0x1 : 0);
178 index |= uint8_t((copy2) ? 0x2 : 0);
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700179 return copy_imagebuffer_vuid.at(id).at(index);
180}
181
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700182static VkImageLayout NormalizeDepthImageLayout(VkImageLayout layout) {
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200183 switch (layout) {
184 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
185 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
186 return VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL;
187
188 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
189 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
190 return VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL;
191
192 default:
193 return layout;
194 }
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700195}
196
197static VkImageLayout NormalizeStencilImageLayout(VkImageLayout layout) {
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200198 switch (layout) {
199 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
200 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
201 return VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL;
202
203 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
204 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
205 return VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL;
206
207 default:
208 return layout;
209 }
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700210}
211
Jeremy Gebben579aaca2021-02-15 13:36:18 -0700212static VkImageLayout NormalizeSynchronization2Layout(const VkImageAspectFlags aspect_mask, VkImageLayout layout) {
213 if (layout == VK_IMAGE_LAYOUT_ATTACHMENT_OPTIMAL_KHR) {
214 if (aspect_mask == VK_IMAGE_ASPECT_COLOR_BIT) {
215 layout = VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL;
216 } else if (aspect_mask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
217 layout = VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL;
218 } else if (aspect_mask == VK_IMAGE_ASPECT_DEPTH_BIT) {
219 layout = VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL;
220 } else if (aspect_mask == VK_IMAGE_ASPECT_STENCIL_BIT) {
221 layout = VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL;
222 }
223 } else if (layout == VK_IMAGE_LAYOUT_READ_ONLY_OPTIMAL_KHR) {
224 if (aspect_mask == VK_IMAGE_ASPECT_COLOR_BIT) {
225 layout = VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL;
226 } else if (aspect_mask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
227 layout = VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL;
228 } else if (aspect_mask == VK_IMAGE_ASPECT_DEPTH_BIT) {
229 layout = VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL;
230 } else if (aspect_mask == VK_IMAGE_ASPECT_STENCIL_BIT) {
231 layout = VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL;
232 }
233 }
234 return layout;
235}
236
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700237static bool ImageLayoutMatches(const VkImageAspectFlags aspect_mask, VkImageLayout a, VkImageLayout b) {
238 bool matches = (a == b);
239 if (!matches) {
John Zulaufbea70432021-02-23 07:03:12 -0700240 a = NormalizeSynchronization2Layout(aspect_mask, a);
241 b = NormalizeSynchronization2Layout(aspect_mask, b);
242 matches = (a == b);
243 if (!matches) {
Hans-Kristian Arntzen94d97222021-07-05 12:46:37 +0200244 // Relaxed rules when referencing *only* the depth or stencil aspects.
245 // When accessing both, normalize layouts for aspects separately.
246 if (aspect_mask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
247 matches = NormalizeDepthImageLayout(a) == NormalizeDepthImageLayout(b) &&
248 NormalizeStencilImageLayout(a) == NormalizeStencilImageLayout(b);
249 } else if (aspect_mask == VK_IMAGE_ASPECT_DEPTH_BIT) {
John Zulaufbea70432021-02-23 07:03:12 -0700250 matches = NormalizeDepthImageLayout(a) == NormalizeDepthImageLayout(b);
251 } else if (aspect_mask == VK_IMAGE_ASPECT_STENCIL_BIT) {
252 matches = NormalizeStencilImageLayout(a) == NormalizeStencilImageLayout(b);
253 }
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700254 }
255 }
256 return matches;
257}
258
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600259// Utility type for checking Image layouts
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700260struct LayoutUseCheckAndMessage {
261 const static VkImageAspectFlags kDepthOrStencil = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600262 const VkImageLayout expected_layout;
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700263 const VkImageAspectFlags aspect_mask;
264 const char *message;
265 VkImageLayout layout;
266
267 LayoutUseCheckAndMessage() = delete;
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600268 LayoutUseCheckAndMessage(VkImageLayout expected, const VkImageAspectFlags aspect_mask_ = 0)
269 : expected_layout{expected}, aspect_mask{aspect_mask_}, message(nullptr), layout(kInvalidLayout) {}
270 bool Check(const LayoutEntry &layout_entry) {
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700271 message = nullptr;
272 layout = kInvalidLayout; // Success status
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600273 if (layout_entry.current_layout != kInvalidLayout) {
274 if (!ImageLayoutMatches(aspect_mask, expected_layout, layout_entry.current_layout)) {
275 message = "previous known";
276 layout = layout_entry.current_layout;
277 }
278 } else if (layout_entry.initial_layout != kInvalidLayout) {
279 if (!ImageLayoutMatches(aspect_mask, expected_layout, layout_entry.initial_layout)) {
280 assert(layout_entry.state); // If we have an initial layout, we better have a state for it
281 if (!((layout_entry.state->aspect_mask & kDepthOrStencil) &&
282 ImageLayoutMatches(layout_entry.state->aspect_mask, expected_layout, layout_entry.initial_layout))) {
283 message = "previously used";
284 layout = layout_entry.initial_layout;
285 }
Jeremy Gebben50e0b412021-02-18 10:39:41 -0700286 }
287 }
288 return layout == kInvalidLayout;
289 }
290};
291
locke-lunarg540b2252020-08-03 13:23:36 -0600292bool IMAGE_VIEW_STATE::OverlapSubresource(const IMAGE_VIEW_STATE &compare_view) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600293 if (image_view() == compare_view.image_view()) {
locke-lunarg540b2252020-08-03 13:23:36 -0600294 return true;
295 }
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600296 if (image_state->image() != compare_view.image_state->image()) {
locke-lunargdc287022020-08-21 12:03:57 -0600297 return false;
298 }
locke-lunarg540b2252020-08-03 13:23:36 -0600299 if (normalized_subresource_range.aspectMask != compare_view.normalized_subresource_range.aspectMask) {
300 return false;
301 }
302
303 // compare if overlap mip level
locke-lunarg540b2252020-08-03 13:23:36 -0600304 if ((normalized_subresource_range.baseMipLevel < compare_view.normalized_subresource_range.baseMipLevel) &&
locke-lunargdc287022020-08-21 12:03:57 -0600305 ((normalized_subresource_range.baseMipLevel + normalized_subresource_range.levelCount) <=
locke-lunarg540b2252020-08-03 13:23:36 -0600306 compare_view.normalized_subresource_range.baseMipLevel)) {
locke-lunargdc287022020-08-21 12:03:57 -0600307 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600308 }
309
310 if ((normalized_subresource_range.baseMipLevel > compare_view.normalized_subresource_range.baseMipLevel) &&
locke-lunargdc287022020-08-21 12:03:57 -0600311 (normalized_subresource_range.baseMipLevel >=
locke-lunarg540b2252020-08-03 13:23:36 -0600312 (compare_view.normalized_subresource_range.baseMipLevel + compare_view.normalized_subresource_range.levelCount))) {
locke-lunargdc287022020-08-21 12:03:57 -0600313 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600314 }
315
316 // compare if overlap array layer
locke-lunarg540b2252020-08-03 13:23:36 -0600317 if ((normalized_subresource_range.baseArrayLayer < compare_view.normalized_subresource_range.baseArrayLayer) &&
locke-lunargdc287022020-08-21 12:03:57 -0600318 ((normalized_subresource_range.baseArrayLayer + normalized_subresource_range.layerCount) <=
locke-lunarg540b2252020-08-03 13:23:36 -0600319 compare_view.normalized_subresource_range.baseArrayLayer)) {
locke-lunargdc287022020-08-21 12:03:57 -0600320 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600321 }
322
323 if ((normalized_subresource_range.baseArrayLayer > compare_view.normalized_subresource_range.baseArrayLayer) &&
locke-lunargdc287022020-08-21 12:03:57 -0600324 (normalized_subresource_range.baseArrayLayer >=
locke-lunarg540b2252020-08-03 13:23:36 -0600325 (compare_view.normalized_subresource_range.baseArrayLayer + compare_view.normalized_subresource_range.layerCount))) {
locke-lunargdc287022020-08-21 12:03:57 -0600326 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600327 }
locke-lunargdc287022020-08-21 12:03:57 -0600328 return true;
locke-lunarg540b2252020-08-03 13:23:36 -0600329}
330
Dave Houltond9611312018-11-19 17:03:36 -0700331uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
332 // uint cast applies floor()
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700333 return 1u + static_cast<uint32_t>(log2(std::max({height, width, depth})));
Dave Houltond9611312018-11-19 17:03:36 -0700334}
335
336uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
337
338uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
339
John Zulauf2d60a452021-03-04 15:12:03 -0700340bool CoreChecks::FindLayouts(const IMAGE_STATE &image_state, std::vector<VkImageLayout> &layouts) const {
Jeremy Gebben4a8881f2022-01-10 17:04:30 -0700341 const auto *layout_range_map = image_state.layout_range_map.get();
John Zulauf2076e812020-01-08 14:55:54 -0700342 if (!layout_range_map) return false;
Jeremy Gebben4a8881f2022-01-10 17:04:30 -0700343
344 auto guard = layout_range_map->ReadLock();
locke-lunargf155ccf2020-02-18 11:34:15 -0700345 // TODO: FindLayouts function should mutate into a ValidatePresentableLayout with the loop wrapping the LogError
346 // from the caller. You can then use decode to add the subresource of the range::begin to the error message.
347
John Zulauf2076e812020-01-08 14:55:54 -0700348 // TODO: what is this test and what is it supposed to do?! -- the logic doesn't match the comment below?!
349
350 // 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 -0700351 if (layout_range_map->size() >= (image_state.createInfo.arrayLayers * image_state.createInfo.mipLevels + 1)) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700352 return false;
353 }
locke-lunargcba7d5f2019-12-30 16:59:11 -0700354
John Zulauf79f06582021-02-27 18:38:39 -0700355 for (const auto &entry : *layout_range_map) {
John Zulauf2076e812020-01-08 14:55:54 -0700356 layouts.push_back(entry.second);
Tony Barbourdf013b92017-01-25 12:53:48 -0700357 }
358 return true;
359}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700360
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700361bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600362 const IMAGE_VIEW_STATE &image_view_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700363 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600364 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100365 bool skip = false;
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600366 const auto &image_view = image_view_state.Handle();
367 const auto *image_state = image_view_state.image_state.get();
368 const auto &image = image_state->Handle();
Tobias Hectorbbb12282018-10-22 15:17:59 +0100369 const char *vuid;
370 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700371 const char *function_name = use_rp2 ? "vkCmdBeginRenderPass2()" : "vkCmdBeginRenderPass()";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100372
373 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600374 LogObjectList objlist(image);
375 objlist.add(renderpass);
376 objlist.add(framebuffer);
377 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700378 skip |=
sfricke-samsung4389faa2022-03-23 01:19:42 -0500379 LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700380 "%s: RenderPass %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
381 function_name, report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
382 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100383 return skip;
384 }
385
386 auto image_usage = image_state->createInfo.usage;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700387 const auto stencil_usage_info = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Ricardo Garcia3f5984c2020-04-09 10:56:34 +0200388 if (stencil_usage_info) {
389 image_usage |= stencil_usage_info->stencilUsage;
390 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100391
392 // Check for layouts that mismatch image usages in the framebuffer
393 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800394 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600395 LogObjectList objlist(image);
396 objlist.add(renderpass);
397 objlist.add(framebuffer);
398 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700399 skip |= LogError(objlist, vuid,
400 "%s: Layout/usage mismatch for attachment %u in %s"
401 " - the %s is %s but the image attached to %s via %s"
402 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
403 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
404 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
405 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100406 }
407
408 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
409 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800410 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600411 LogObjectList objlist(image);
412 objlist.add(renderpass);
413 objlist.add(framebuffer);
414 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700415 skip |= LogError(objlist, vuid,
416 "%s: Layout/usage mismatch for attachment %u in %s"
417 " - the %s is %s but the image attached to %s via %s"
418 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
419 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
420 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
421 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100422 }
423
424 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800425 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600426 LogObjectList objlist(image);
427 objlist.add(renderpass);
428 objlist.add(framebuffer);
429 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700430 skip |= LogError(objlist, vuid,
431 "%s: Layout/usage mismatch for attachment %u in %s"
432 " - the %s is %s but the image attached to %s via %s"
433 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
434 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
435 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
436 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100437 }
438
439 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800440 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600441 LogObjectList objlist(image);
442 objlist.add(renderpass);
443 objlist.add(framebuffer);
444 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700445 skip |= LogError(objlist, vuid,
446 "%s: Layout/usage mismatch for attachment %u in %s"
447 " - the %s is %s but the image attached to %s via %s"
448 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
449 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
450 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
451 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100452 }
453
sfricke-samsung45996a42021-09-16 13:45:27 -0700454 if (IsExtEnabled(device_extensions.vk_khr_maintenance2)) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100455 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
456 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
457 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
458 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
459 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800460 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600461 LogObjectList objlist(image);
462 objlist.add(renderpass);
463 objlist.add(framebuffer);
464 objlist.add(image_view);
465 skip |= LogError(objlist, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700466 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700467 " - the %s is %s but the image attached to %s via %s"
468 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700469 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700470 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
471 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100472 }
473 } else {
474 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
475 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
476 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
477 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600478 LogObjectList objlist(image);
479 objlist.add(renderpass);
480 objlist.add(framebuffer);
481 objlist.add(image_view);
482 skip |= LogError(objlist, "VUID-vkCmdBeginRenderPass-initialLayout-00896",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700483 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700484 " - the %s is %s but the image attached to %s via %s"
485 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700486 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700487 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
488 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100489 }
490 }
491 return skip;
492}
493
John Zulauf17a01bb2019-08-09 16:41:19 -0600494bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700495 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600496 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600497 bool skip = false;
Jeremy Gebbenf4449392022-01-28 10:09:10 -0700498 auto render_pass_state = Get<RENDER_PASS_STATE>(pRenderPassBegin->renderPass);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600499 const auto *render_pass_info = render_pass_state->createInfo.ptr();
500 auto render_pass = render_pass_state->renderPass();
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700501 auto const &framebuffer_info = framebuffer_state->createInfo;
502 const VkImageView *attachments = framebuffer_info.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100503
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600504 auto framebuffer = framebuffer_state->framebuffer();
Tobias Hectorbbb12282018-10-22 15:17:59 +0100505
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700506 if (render_pass_info->attachmentCount != framebuffer_info.attachmentCount) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600507 skip |= LogError(pCB->commandBuffer(), kVUID_Core_DrawState_InvalidRenderpass,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700508 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700509 }
John Zulauf8e308292018-09-21 11:34:37 -0600510
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700511 const auto *attachment_info = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext);
Mike Schuchardt2df08912020-12-15 16:28:09 -0800512 if (((framebuffer_info.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) != 0) && attachment_info != nullptr) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700513 attachments = attachment_info->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100514 }
515
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600516 if (attachments == nullptr) {
517 return skip;
518 }
519 const auto *const_p_cb = static_cast<const CMD_BUFFER_STATE *>(pCB);
520 for (uint32_t i = 0; i < render_pass_info->attachmentCount && i < framebuffer_info.attachmentCount; ++i) {
521 auto image_view = attachments[i];
522 auto view_state = Get<IMAGE_VIEW_STATE>(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100523
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600524 if (!view_state) {
525 LogObjectList objlist(pRenderPassBegin->renderPass);
526 objlist.add(framebuffer_state->framebuffer());
527 objlist.add(image_view);
528 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
529 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
530 report_data->FormatHandle(framebuffer_state->framebuffer()).c_str(), i,
531 report_data->FormatHandle(image_view).c_str());
532 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100533 }
534
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600535 const VkImage image = view_state->create_info.image;
536 const auto *image_state = view_state->image_state.get();
Tobias Hectorbbb12282018-10-22 15:17:59 +0100537
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600538 if (!image_state) {
539 LogObjectList objlist(pRenderPassBegin->renderPass);
540 objlist.add(framebuffer_state->framebuffer());
541 objlist.add(image_view);
542 objlist.add(image);
543 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
544 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
545 report_data->FormatHandle(framebuffer_state->framebuffer()).c_str(), i,
546 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
547 continue;
548 }
549 auto attachment_initial_layout = render_pass_info->pAttachments[i].initialLayout;
550 auto final_layout = render_pass_info->pAttachments[i].finalLayout;
551
552 // Default to expecting stencil in the same layout.
553 auto attachment_stencil_initial_layout = attachment_initial_layout;
554
555 // If a separate layout is specified, look for that.
556 const auto *attachment_description_stencil_layout =
557 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(render_pass_info->pAttachments[i].pNext);
558 if (attachment_description_stencil_layout) {
559 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
560 }
561
562 const ImageSubresourceLayoutMap *subresource_map = nullptr;
563 bool has_queried_map = false;
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600564
565 for (uint32_t aspect_index = 0; aspect_index < 32; aspect_index++) {
566 VkImageAspectFlags test_aspect = 1u << aspect_index;
567 if ((view_state->normalized_subresource_range.aspectMask & test_aspect) == 0) {
568 continue;
569 }
570
571 // Allow for differing depth and stencil layouts
572 VkImageLayout check_layout = attachment_initial_layout;
573 if (test_aspect == VK_IMAGE_ASPECT_STENCIL_BIT) {
574 check_layout = attachment_stencil_initial_layout;
575 }
576
577 // If no layout information for image yet, will be checked at QueueSubmit time
578 if (check_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
579 continue;
580 }
581 if (!has_queried_map) {
582 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to
583 // something in common with the non-const version.) The lookup is expensive, so cache it.
584 subresource_map = const_p_cb->GetImageSubresourceLayoutMap(*image_state);
585 has_queried_map = true;
586 }
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600587 if (!subresource_map) {
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600588 // If no layout information for image yet, will be checked at QueueSubmit time
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600589 continue;
590 }
591 auto normalized_range = view_state->normalized_subresource_range;
592 normalized_range.aspectMask = test_aspect;
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600593 LayoutUseCheckAndMessage layout_check(check_layout, test_aspect);
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600594
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600595 skip |= subresource_map->AnyInRange(
596 normalized_range, [this, &layout_check, i](const VkImageSubresource &subres, const LayoutEntry &state) {
597 bool subres_skip = false;
598 if (!layout_check.Check(state)) {
599 subres_skip = LogError(device, kVUID_Core_DrawState_InvalidRenderpass,
600 "You cannot start a render pass using attachment %u where the render pass initial "
601 "layout is %s "
602 "and the %s layout of the attachment is %s. The layouts must match, or the render "
603 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
604 i, string_VkImageLayout(layout_check.expected_layout), layout_check.message,
605 string_VkImageLayout(layout_check.layout));
606 }
607 return subres_skip;
608 });
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600609 }
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600610 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, *view_state, framebuffer,
611 render_pass, i, "initial layout");
612
613 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, *view_state, framebuffer, render_pass, i,
614 "final layout");
615 }
616
617 for (uint32_t j = 0; j < render_pass_info->subpassCount; ++j) {
618 auto &subpass = render_pass_info->pSubpasses[j];
619 for (uint32_t k = 0; k < render_pass_info->pSubpasses[j].inputAttachmentCount; ++k) {
620 auto &attachment_ref = subpass.pInputAttachments[k];
621 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
622 auto image_view = attachments[attachment_ref.attachment];
623 auto view_state = Get<IMAGE_VIEW_STATE>(image_view);
624
625 if (view_state) {
626 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, *view_state,
627 framebuffer, render_pass, attachment_ref.attachment,
628 "input attachment layout");
629 }
630 }
631 }
632
633 for (uint32_t k = 0; k < render_pass_info->pSubpasses[j].colorAttachmentCount; ++k) {
634 auto &attachment_ref = subpass.pColorAttachments[k];
635 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
636 auto image_view = attachments[attachment_ref.attachment];
637 auto view_state = Get<IMAGE_VIEW_STATE>(image_view);
638
639 if (view_state) {
640 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, *view_state,
641 framebuffer, render_pass, attachment_ref.attachment,
642 "color attachment layout");
643 if (subpass.pResolveAttachments) {
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600644 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, *view_state,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700645 framebuffer, render_pass, attachment_ref.attachment,
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600646 "resolve attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100647 }
648 }
649 }
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600650 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100651
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600652 if (render_pass_info->pSubpasses[j].pDepthStencilAttachment) {
653 auto &attachment_ref = *subpass.pDepthStencilAttachment;
654 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
655 auto image_view = attachments[attachment_ref.attachment];
656 auto view_state = Get<IMAGE_VIEW_STATE>(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100657
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600658 if (view_state) {
659 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, *view_state,
660 framebuffer, render_pass, attachment_ref.attachment,
661 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100662 }
663 }
664 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700665 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600666 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700667}
668
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600669void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700670 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700671 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -0600672 IMAGE_VIEW_STATE *image_view = pCB->GetActiveAttachmentImageViewState(ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600673 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700674 VkImageLayout stencil_layout = kInvalidLayout;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700675 const auto *attachment_reference_stencil_layout = LvlFindInChain<VkAttachmentReferenceStencilLayout>(ref.pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700676 if (attachment_reference_stencil_layout) {
677 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
678 }
679
Jeremy Gebben1ec89332021-08-05 13:51:49 -0600680 pCB->SetImageViewLayout(*image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600681 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700682 }
683}
684
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600685void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
686 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700687 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700688
689 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700690 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700691 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700692 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700693 }
694 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700695 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700696 }
697 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700698 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700699 }
700 }
701}
702
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700703// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
704// 1. Transition into initialLayout state
705// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600706void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700707 FRAMEBUFFER_STATE *framebuffer_state) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700708 // First record expected initialLayout as a potential initial layout usage.
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700709 auto const rpci = render_pass_state->createInfo.ptr();
710 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -0600711 auto *view_state = cb_state->GetActiveAttachmentImageViewState(i);
John Zulauf8e308292018-09-21 11:34:37 -0600712 if (view_state) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700713 IMAGE_STATE *image_state = view_state->image_state.get();
714 const auto initial_layout = rpci->pAttachments[i].initialLayout;
Piers Daniell4fde9b72019-11-27 16:19:46 -0700715 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700716 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(rpci->pAttachments[i].pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700717 if (attachment_description_stencil_layout) {
John Zulauf81dd1f12021-01-26 16:49:16 -0700718 const auto stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
719 VkImageSubresourceRange sub_range = view_state->normalized_subresource_range;
720 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
Jeremy Gebben1ec89332021-08-05 13:51:49 -0600721 cb_state->SetImageInitialLayout(*image_state, sub_range, initial_layout);
John Zulauf81dd1f12021-01-26 16:49:16 -0700722 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
Jeremy Gebben1ec89332021-08-05 13:51:49 -0600723 cb_state->SetImageInitialLayout(*image_state, sub_range, stencil_initial_layout);
John Zulauf81dd1f12021-01-26 16:49:16 -0700724 } else {
Jeremy Gebben1ec89332021-08-05 13:51:49 -0600725 cb_state->SetImageInitialLayout(*image_state, view_state->normalized_subresource_range, initial_layout);
Piers Daniell4fde9b72019-11-27 16:19:46 -0700726 }
John Zulauf8e308292018-09-21 11:34:37 -0600727 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700728 }
729 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700730 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700731}
732
Dave Houlton10b39482017-03-16 13:18:15 -0600733bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600734 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600735 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600736 }
737 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600738 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600739 }
740 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600741 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600742 }
Mike Schuchardt2df08912020-12-15 16:28:09 -0800743 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 -0700744 if (FormatPlaneCount(format) == 1) return false;
745 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600746 return true;
747}
748
sfricke-samsung10b35ce2021-09-29 08:50:20 -0700749// There is a table in the Vulkan spec to list all formats that implicitly require YCbCr conversion,
750// but some features/extensions can explicitly turn that restriction off
751// The implicit check is done in format utils, while feature checks are done here in CoreChecks
752bool CoreChecks::FormatRequiresYcbcrConversionExplicitly(const VkFormat format) const {
753 if (format == VK_FORMAT_R10X6G10X6B10X6A10X6_UNORM_4PACK16 &&
754 enabled_features.rgba10x6_formats_features.formatRgba10x6WithoutYCbCrSampler) {
755 return false;
756 }
757 return FormatRequiresYcbcrConversion(format);
758}
759
Mike Weiblen62d08a32017-03-07 22:18:27 -0700760// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -0700761bool CoreChecks::ValidateBarrierLayoutToImageUsage(const Location &loc, VkImage image, VkImageLayout layout,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700762 VkImageUsageFlags usage_flags) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700763 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700764 bool is_error = false;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700765 switch (layout) {
766 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700767 is_error = ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700768 break;
769 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700770 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700771 break;
772 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700773 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700774 break;
775 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700776 is_error = ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700777 break;
778 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700779 is_error = ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700780 break;
781 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700782 is_error = ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700783 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600784 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700785 is_error = ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0);
Jeff Bolz9af91c52018-09-01 21:53:57 -0500786 break;
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700787 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700788 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700789 break;
790 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700791 is_error = ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0);
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700792 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700793 default:
794 // Other VkImageLayout values do not have VUs defined in this context.
795 break;
796 }
797
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700798 if (is_error) {
799 const auto &vuid = sync_vuid_maps::GetBadImageLayoutVUID(loc, layout);
800
801 skip |=
802 LogError(image, vuid, "%s Image barrier Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".",
803 loc.Message().c_str(), string_VkImageLayout(layout), report_data->FormatHandle(image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700804 }
805 return skip;
806}
807
808// Verify image barriers are compatible with the images they reference.
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700809template <typename ImageBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -0700810bool CoreChecks::ValidateBarriersToImages(const Location &outer_loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700811 uint32_t imageMemoryBarrierCount, const ImageBarrier *pImageMemoryBarriers) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700812 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700813 using sync_vuid_maps::GetImageBarrierVUID;
814 using sync_vuid_maps::ImageError;
Petr Krausad0096a2019-08-09 18:35:04 +0200815
John Zulauf463c51e2018-05-31 13:29:20 -0600816 // Scoreboard for duplicate layout transition barriers within the list
817 // 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 +0200818 const CommandBufferImageLayoutMap &current_map = cb_state->GetImageSubresourceLayoutMap();
819 CommandBufferImageLayoutMap layout_updates;
John Zulauf463c51e2018-05-31 13:29:20 -0600820
Mike Weiblen62d08a32017-03-07 22:18:27 -0700821 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700822 auto loc = outer_loc.dot(Field::pImageMemoryBarriers, i);
Petr Krausad0096a2019-08-09 18:35:04 +0200823 const auto &img_barrier = pImageMemoryBarriers[i];
Mike Weiblen62d08a32017-03-07 22:18:27 -0700824
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600825 auto image_state = Get<IMAGE_STATE>(img_barrier.image);
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600826 if (!image_state) {
827 continue;
828 }
829 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
830 skip |= ValidateBarrierLayoutToImageUsage(loc.dot(Field::oldLayout), img_barrier.image, img_barrier.oldLayout, usage_flags);
831 skip |= ValidateBarrierLayoutToImageUsage(loc.dot(Field::newLayout), img_barrier.image, img_barrier.newLayout, usage_flags);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600832
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600833 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
834 if (image_state->layout_locked) {
835 // TODO: Add unique id for error when available
836 skip |= LogError(
837 img_barrier.image, "VUID-Undefined",
838 "%s Attempting to transition shared presentable %s"
839 " from layout %s to layout %s, but image has already been presented and cannot have its layout transitioned.",
840 loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
841 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(img_barrier.newLayout));
842 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600843
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600844 const VkImageCreateInfo &image_create_info = image_state->createInfo;
845 const VkFormat image_format = image_create_info.format;
846 const VkImageAspectFlags aspect_mask = img_barrier.subresourceRange.aspectMask;
847 // For a Depth/Stencil image both aspects MUST be set
848 auto image_loc = loc.dot(Field::image);
849 if (FormatIsDepthAndStencil(image_format)) {
850 if (enabled_features.core12.separateDepthStencilLayouts) {
851 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
852 auto vuid = GetImageBarrierVUID(loc, ImageError::kNotDepthOrStencilAspect);
sfricke-samsung79b00482020-04-01 21:15:50 -0700853 skip |= LogError(img_barrier.image, vuid,
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600854 "%s references %s of format %s that must have either the depth or stencil "
855 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
856 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
857 string_VkFormat(image_format), aspect_mask);
858 }
859 } else {
860 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
861 if ((aspect_mask & ds_mask) != (ds_mask)) {
862 auto error = IsExtEnabled(device_extensions.vk_khr_separate_depth_stencil_layouts)
863 ? ImageError::kNotSeparateDepthAndStencilAspect
864 : ImageError::kNotDepthAndStencilAspect;
865 auto vuid = GetImageBarrierVUID(image_loc, error);
866 skip |= LogError(img_barrier.image, vuid,
867 "%s references %s of format %s that must have the depth and stencil "
868 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700869 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700870 string_VkFormat(image_format), aspect_mask);
871 }
872 }
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600873 }
sfricke-samsung79b00482020-04-01 21:15:50 -0700874
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600875 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
876 // TODO: Set memory invalid which is in mem_tracker currently
877 } else if (!QueueFamilyIsExternal(img_barrier.srcQueueFamilyIndex)) {
878 auto &write_subresource_map = layout_updates[image_state.get()];
879 bool new_write = false;
880 if (!write_subresource_map) {
881 write_subresource_map = std::make_shared<ImageSubresourceLayoutMap>(*image_state);
882 new_write = true;
883 }
884 const auto &current_subresource_map = current_map.find(image_state.get());
885 const auto &read_subresource_map = (new_write && current_subresource_map != current_map.end())
886 ? (*current_subresource_map).second
887 : write_subresource_map;
888
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600889 // Validate aspects in isolation.
890 // This is required when handling separate depth-stencil layouts.
891 for (uint32_t aspect_index = 0; aspect_index < 32; aspect_index++) {
892 VkImageAspectFlags test_aspect = 1u << aspect_index;
893 if ((img_barrier.subresourceRange.aspectMask & test_aspect) == 0) {
894 continue;
895 }
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600896 auto old_layout = NormalizeSynchronization2Layout(img_barrier.subresourceRange.aspectMask, img_barrier.oldLayout);
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600897
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600898 LayoutUseCheckAndMessage layout_check(old_layout, test_aspect);
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600899 auto normalized_isr = image_state->NormalizeSubresourceRange(img_barrier.subresourceRange);
900 normalized_isr.aspectMask = test_aspect;
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -0600901 skip |= read_subresource_map->AnyInRange(
902 normalized_isr, [this, cb_state, &layout_check, &loc, &img_barrier](const VkImageSubresource &subres,
903 const LayoutEntry &state) {
904 bool subres_skip = false;
905 if (!layout_check.Check(state)) {
906 const auto &vuid = GetImageBarrierVUID(loc, ImageError::kConflictingLayout);
907 subres_skip = LogError(
908 cb_state->commandBuffer(), vuid,
909 "%s %s cannot transition the layout of aspect=%d level=%d layer=%d from %s when the "
910 "%s layout is %s.",
911 loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(), subres.aspectMask,
912 subres.mipLevel, subres.arrayLayer, string_VkImageLayout(img_barrier.oldLayout),
913 layout_check.message, string_VkImageLayout(layout_check.layout));
914 }
915 return subres_skip;
916 });
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600917 write_subresource_map->SetSubresourceRangeLayout(*cb_state, normalized_isr, img_barrier.newLayout);
918 }
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600919 }
920
921 // checks color format and (single-plane or non-disjoint)
922 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
923 if ((FormatIsColor(image_format) == true) &&
924 ((FormatIsMultiplane(image_format) == false) || (image_state->disjoint == false))) {
925 if (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT) {
926 auto error = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion) ? ImageError::kNotColorAspect
927 : ImageError::kNotColorAspectYcbcr;
928 const auto &vuid = GetImageBarrierVUID(loc, error);
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700929 skip |= LogError(img_barrier.image, vuid,
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600930 "%s references %s of format %s that must be only VK_IMAGE_ASPECT_COLOR_BIT, "
931 "but its aspectMask is 0x%" PRIx32 ".",
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700932 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700933 string_VkFormat(image_format), aspect_mask);
934 }
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600935 }
sfricke-samsung79b00482020-04-01 21:15:50 -0700936
Jeremy Gebben3d6fc342022-04-19 10:03:12 -0600937 VkImageAspectFlags valid_disjoint_mask =
938 VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT | VK_IMAGE_ASPECT_COLOR_BIT;
939 if ((FormatIsMultiplane(image_format) == true) && (image_state->disjoint == true) &&
940 ((aspect_mask & valid_disjoint_mask) == 0)) {
941 const auto &vuid = GetImageBarrierVUID(image_loc, ImageError::kBadMultiplanarAspect);
942 skip |= LogError(img_barrier.image, vuid,
943 "%s references %s of format %s has aspectMask (0x%" PRIx32
944 ") but needs to include either an VK_IMAGE_ASPECT_PLANE_*_BIT or VK_IMAGE_ASPECT_COLOR_BIT.",
945 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
946 string_VkFormat(image_format), aspect_mask);
947 }
948
949 if ((FormatPlaneCount(image_format) == 2) && ((aspect_mask & VK_IMAGE_ASPECT_PLANE_2_BIT) != 0)) {
950 const auto &vuid = GetImageBarrierVUID(image_loc, ImageError::kBadPlaneCount);
951 skip |= LogError(img_barrier.image, vuid,
952 "%s references %s of format %s has only two planes but included "
953 "VK_IMAGE_ASPECT_PLANE_2_BIT in its aspectMask (0x%" PRIx32 ").",
954 image_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
955 string_VkFormat(image_format), aspect_mask);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700956 }
957 }
958 return skip;
959}
960
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700961template <typename Barrier, typename TransferBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -0700962bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const Location &loc, const CMD_BUFFER_STATE *cb_state, const Barrier &barrier,
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700963 const QFOTransferBarrierSets<TransferBarrier> &barrier_sets) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600964 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700965 const char *handle_name = TransferBarrier::HandleName();
John Zulauf6b4aae82018-05-09 13:03:36 -0600966 const char *transfer_type = nullptr;
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700967 if (!IsTransferOp(barrier)) {
968 return skip;
969 }
970 const TransferBarrier *barrier_record = nullptr;
Jeremy Gebben7ba56152021-06-18 10:40:10 -0600971 if (cb_state->IsReleaseOp(barrier) && !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700972 const auto found = barrier_sets.release.find(barrier);
973 if (found != barrier_sets.release.cend()) {
974 barrier_record = &(*found);
975 transfer_type = "releasing";
John Zulauf6b4aae82018-05-09 13:03:36 -0600976 }
Jeremy Gebben7ba56152021-06-18 10:40:10 -0600977 } else if (cb_state->IsAcquireOp(barrier) && !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700978 const auto found = barrier_sets.acquire.find(barrier);
979 if (found != barrier_sets.acquire.cend()) {
980 barrier_record = &(*found);
981 transfer_type = "acquiring";
John Zulauf6b4aae82018-05-09 13:03:36 -0600982 }
983 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700984 if (barrier_record != nullptr) {
985 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600986 LogWarning(cb_state->commandBuffer(), TransferBarrier::ErrMsgDuplicateQFOInCB(),
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700987 "%s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
988 " duplicates existing barrier recorded in this command buffer.",
989 loc.Message().c_str(), transfer_type, handle_name, report_data->FormatHandle(barrier_record->handle).c_str(),
990 barrier_record->srcQueueFamilyIndex, barrier_record->dstQueueFamilyIndex);
991 }
John Zulauf6b4aae82018-05-09 13:03:36 -0600992 return skip;
993}
994
John Zulaufa4472282019-08-22 14:44:34 -0600995VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
996 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
997}
998
Jeremy Gebbene60d4172021-02-02 15:42:15 -0700999VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier2KHR &barrier) {
1000 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1001}
1002
Jeremy Gebben9f537102021-10-05 16:37:12 -06001003std::shared_ptr<const IMAGE_STATE> BarrierHandleState(const ValidationStateTracker &device_state,
1004 const VkImageMemoryBarrier &barrier) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001005 return device_state.Get<IMAGE_STATE>(barrier.image);
John Zulaufa4472282019-08-22 14:44:34 -06001006}
1007
Jeremy Gebben9f537102021-10-05 16:37:12 -06001008std::shared_ptr<const IMAGE_STATE> BarrierHandleState(const ValidationStateTracker &device_state,
1009 const VkImageMemoryBarrier2KHR &barrier) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001010 return device_state.Get<IMAGE_STATE>(barrier.image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001011}
1012
John Zulaufa4472282019-08-22 14:44:34 -06001013VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
1014 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1015}
1016
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001017VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier2KHR &barrier) {
1018 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1019}
1020
Jeremy Gebben9f537102021-10-05 16:37:12 -06001021const std::shared_ptr<const BUFFER_STATE> BarrierHandleState(const ValidationStateTracker &device_state,
1022 const VkBufferMemoryBarrier &barrier) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001023 return device_state.Get<BUFFER_STATE>(barrier.buffer);
John Zulaufa4472282019-08-22 14:44:34 -06001024}
1025
Jeremy Gebben9f537102021-10-05 16:37:12 -06001026std::shared_ptr<const BUFFER_STATE> BarrierHandleState(const ValidationStateTracker &device_state,
1027 const VkBufferMemoryBarrier2KHR &barrier) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001028 return device_state.Get<BUFFER_STATE>(barrier.buffer);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001029}
John Zulaufa4472282019-08-22 14:44:34 -06001030
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001031template <typename Barrier, typename TransferBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001032void CoreChecks::RecordBarrierValidationInfo(const Location &loc, CMD_BUFFER_STATE *cb_state, const Barrier &barrier,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001033 QFOTransferBarrierSets<TransferBarrier> &barrier_sets) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001034 if (IsTransferOp(barrier)) {
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001035 if (cb_state->IsReleaseOp(barrier) && !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001036 barrier_sets.release.emplace(barrier);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06001037 } else if (cb_state->IsAcquireOp(barrier) && !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001038 barrier_sets.acquire.emplace(barrier);
John Zulaufa4472282019-08-22 14:44:34 -06001039 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001040 }
John Zulaufa4472282019-08-22 14:44:34 -06001041
David Zhao Akeleyd76df472021-05-15 17:25:59 -07001042 // 7.7.4: If the values of srcQueueFamilyIndex and dstQueueFamilyIndex are equal, no ownership transfer is performed, and the
1043 // barrier operates as if they were both set to VK_QUEUE_FAMILY_IGNORED.
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001044 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
1045 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
David Zhao Akeleyd76df472021-05-15 17:25:59 -07001046 const bool is_ownership_transfer = src_queue_family != dst_queue_family;
1047
1048 if (is_ownership_transfer) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001049 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
1050 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
1051 auto handle_state = BarrierHandleState(*this, barrier);
1052 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
1053 if (!mode_concurrent) {
1054 const auto typed_handle = BarrierTypedHandle(barrier);
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001055 core_error::LocationCapture loc_capture(loc);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001056 cb_state->queue_submit_functions.emplace_back(
Jeremy Gebbene5361dd2021-11-18 14:23:56 -07001057 [loc_capture, typed_handle, src_queue_family, dst_queue_family](
1058 const ValidationStateTracker &device_data, const QUEUE_STATE &queue_state, const CMD_BUFFER_STATE &cb_state) {
John Zulaufb4438f02021-02-20 20:22:16 -07001059 return ValidateConcurrentBarrierAtSubmit(loc_capture.Get(), device_data, queue_state, cb_state, typed_handle,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001060 src_queue_family, dst_queue_family);
1061 });
John Zulauf6b4aae82018-05-09 13:03:36 -06001062 }
1063 }
1064}
1065
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001066// Verify image barrier image state and that the image is consistent with FB image
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001067template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001068bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001069 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1070 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001071 const ImgBarrier &img_barrier, const CMD_BUFFER_STATE *primary_cb_state) const {
1072 using sync_vuid_maps::GetImageBarrierVUID;
1073 using sync_vuid_maps::ImageError;
1074
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001075 bool skip = false;
1076 const auto *fb_state = framebuffer;
1077 assert(fb_state);
1078 const auto img_bar_image = img_barrier.image;
1079 bool image_match = false;
1080 bool sub_image_found = false; // Do we find a corresponding subpass description
1081 VkImageLayout sub_image_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1082 uint32_t attach_index = 0;
1083 // Verify that a framebuffer image matches barrier image
1084 const auto attachment_count = fb_state->createInfo.attachmentCount;
1085 for (uint32_t attachment = 0; attachment < attachment_count; ++attachment) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06001086 auto view_state = primary_cb_state ? primary_cb_state->GetActiveAttachmentImageViewState(attachment) : cb_state->GetActiveAttachmentImageViewState(attachment);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001087 if (view_state && (img_bar_image == view_state->create_info.image)) {
1088 image_match = true;
1089 attach_index = attachment;
1090 break;
1091 }
1092 }
1093 if (image_match) { // Make sure subpass is referring to matching attachment
1094 if (sub_desc.pDepthStencilAttachment && sub_desc.pDepthStencilAttachment->attachment == attach_index) {
1095 sub_image_layout = sub_desc.pDepthStencilAttachment->layout;
1096 sub_image_found = true;
1097 }
sfricke-samsung45996a42021-09-16 13:45:27 -07001098 if (!sub_image_found && IsExtEnabled(device_extensions.vk_khr_depth_stencil_resolve)) {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001099 const auto *resolve = LvlFindInChain<VkSubpassDescriptionDepthStencilResolve>(sub_desc.pNext);
1100 if (resolve && resolve->pDepthStencilResolveAttachment &&
1101 resolve->pDepthStencilResolveAttachment->attachment == attach_index) {
1102 sub_image_layout = resolve->pDepthStencilResolveAttachment->layout;
1103 sub_image_found = true;
1104 }
1105 }
1106 if (!sub_image_found) {
1107 for (uint32_t j = 0; j < sub_desc.colorAttachmentCount; ++j) {
1108 if (sub_desc.pColorAttachments && sub_desc.pColorAttachments[j].attachment == attach_index) {
1109 sub_image_layout = sub_desc.pColorAttachments[j].layout;
1110 sub_image_found = true;
1111 break;
1112 }
1113 if (!sub_image_found && sub_desc.pResolveAttachments &&
1114 sub_desc.pResolveAttachments[j].attachment == attach_index) {
1115 sub_image_layout = sub_desc.pResolveAttachments[j].layout;
1116 sub_image_found = true;
1117 break;
1118 }
1119 }
1120 }
1121 if (!sub_image_found) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001122 auto img_loc = loc.dot(Field::image);
1123 const auto &vuid = GetImageBarrierVUID(img_loc, ImageError::kRenderPassMismatch);
1124 skip |=
1125 LogError(rp_handle, vuid,
1126 "%s Barrier for %s is not referenced by the VkSubpassDescription for active subpass (%d) of current %s.",
1127 img_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(), active_subpass,
1128 report_data->FormatHandle(rp_handle).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001129 }
1130 } else { // !image_match
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001131 auto img_loc = loc.dot(Field::image);
1132 const auto &vuid = GetImageBarrierVUID(img_loc, ImageError::kRenderPassMismatch);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001133 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 -07001134 img_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001135 report_data->FormatHandle(fb_state->framebuffer()).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001136 }
1137 if (img_barrier.oldLayout != img_barrier.newLayout) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001138 auto layout_loc = loc.dot(Field::oldLayout);
1139 const auto &vuid = GetImageBarrierVUID(layout_loc, ImageError::kRenderPassLayoutChange);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001140 skip |= LogError(cb_state->commandBuffer(), vuid,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001141 "%s As the Image Barrier for %s is being executed within a render pass instance, oldLayout must "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001142 "equal newLayout yet they are %s and %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001143 layout_loc.Message().c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001144 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(img_barrier.newLayout));
1145 } else {
1146 if (sub_image_found && sub_image_layout != img_barrier.oldLayout) {
1147 LogObjectList objlist(rp_handle);
1148 objlist.add(img_bar_image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001149 auto layout_loc = loc.dot(Field::oldLayout);
1150 const auto &vuid = GetImageBarrierVUID(layout_loc, ImageError::kRenderPassLayoutChange);
1151 skip |= LogError(objlist, vuid,
1152 "%s Barrier for %s is referenced by the VkSubpassDescription for active "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001153 "subpass (%d) of current %s as having layout %s, but image barrier has layout %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001154 layout_loc.Message().c_str(), report_data->FormatHandle(img_bar_image).c_str(), active_subpass,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001155 report_data->FormatHandle(rp_handle).c_str(), string_VkImageLayout(sub_image_layout),
1156 string_VkImageLayout(img_barrier.oldLayout));
1157 }
1158 }
1159 return skip;
1160}
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001161// explictly instantiate so these can be used in core_validation.cpp
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001162template bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001163 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1164 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
1165 const VkImageMemoryBarrier &img_barrier,
1166 const CMD_BUFFER_STATE *primary_cb_state) const;
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001167template bool CoreChecks::ValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE const *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001168 const FRAMEBUFFER_STATE *framebuffer, uint32_t active_subpass,
1169 const safe_VkSubpassDescription2 &sub_desc, const VkRenderPass rp_handle,
1170 const VkImageMemoryBarrier2KHR &img_barrier,
1171 const CMD_BUFFER_STATE *primary_cb_state) const;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001172
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001173template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001174void CoreChecks::EnqueueSubmitTimeValidateImageBarrierAttachment(const Location &loc, CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001175 const ImgBarrier &barrier) {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001176 // Secondary CBs can have null framebuffer so queue up validation in that case 'til FB is known
1177 if ((cb_state->activeRenderPass) && (VK_NULL_HANDLE == cb_state->activeFramebuffer) &&
1178 (VK_COMMAND_BUFFER_LEVEL_SECONDARY == cb_state->createInfo.level)) {
1179 const auto active_subpass = cb_state->activeSubpass;
1180 const auto rp_state = cb_state->activeRenderPass;
1181 const auto &sub_desc = rp_state->createInfo.pSubpasses[active_subpass];
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001182 // Secondary CB case w/o FB specified delay validation
1183 auto *this_ptr = this; // Required for older compilers with c++20 compatibility
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001184 core_error::LocationCapture loc_capture(loc);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001185 const auto render_pass = rp_state->renderPass();
John Zulaufb4438f02021-02-20 20:22:16 -07001186 cb_state->cmd_execute_commands_functions.emplace_back(
Jeremy Gebben057f9d52021-11-05 14:12:31 -06001187 [this_ptr, loc_capture, active_subpass, sub_desc, render_pass, barrier](
1188 const CMD_BUFFER_STATE &secondary_cb, const CMD_BUFFER_STATE *primary_cb, const FRAMEBUFFER_STATE *fb) {
1189 return this_ptr->ValidateImageBarrierAttachment(loc_capture.Get(), &secondary_cb, fb, active_subpass, sub_desc,
John Zulaufb4438f02021-02-20 20:22:16 -07001190 render_pass, barrier, primary_cb);
1191 });
Jeremy Gebben50e0b412021-02-18 10:39:41 -07001192 }
1193}
1194
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001195void CoreChecks::RecordBarriers(Func func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001196 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1197 const VkImageMemoryBarrier *pImageMemBarriers) {
1198 for (uint32_t i = 0; i < bufferBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001199 Location loc(func_name, Struct::VkBufferMemoryBarrier, Field::pBufferMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001200 RecordBarrierValidationInfo(loc, cb_state, pBufferMemBarriers[i], cb_state->qfo_transfer_buffer_barriers);
1201 }
1202 for (uint32_t i = 0; i < imageMemBarrierCount; i++) {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001203 Location loc(func_name, Struct::VkImageMemoryBarrier, Field::pImageMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001204 const auto &img_barrier = pImageMemBarriers[i];
1205 RecordBarrierValidationInfo(loc, cb_state, img_barrier, cb_state->qfo_transfer_image_barriers);
1206 EnqueueSubmitTimeValidateImageBarrierAttachment(loc, cb_state, img_barrier);
1207 }
1208}
1209
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07001210void CoreChecks::RecordBarriers(Func func_name, CMD_BUFFER_STATE *cb_state, const VkDependencyInfoKHR &dep_info) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001211 for (uint32_t i = 0; i < dep_info.bufferMemoryBarrierCount; i++) {
Tony-LunarG279601c2021-11-16 10:50:51 -07001212 Location loc(func_name, Struct::VkBufferMemoryBarrier2, Field::pBufferMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001213 RecordBarrierValidationInfo(loc, cb_state, dep_info.pBufferMemoryBarriers[i], cb_state->qfo_transfer_buffer_barriers);
1214 }
1215 for (uint32_t i = 0; i < dep_info.imageMemoryBarrierCount; i++) {
Tony-LunarG279601c2021-11-16 10:50:51 -07001216 Location loc(func_name, Struct::VkImageMemoryBarrier2, Field::pImageMemoryBarriers, i);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001217 const auto &img_barrier = dep_info.pImageMemoryBarriers[i];
1218 RecordBarrierValidationInfo(loc, cb_state, img_barrier, cb_state->qfo_transfer_image_barriers);
1219 EnqueueSubmitTimeValidateImageBarrierAttachment(loc, cb_state, img_barrier);
1220 }
1221}
1222
1223template <typename TransferBarrier, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001224bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001225 const char *operation, const TransferBarrier &barrier,
1226 Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001227 // Record to the scoreboard or report that we have a duplication
1228 bool skip = false;
Jeremy Gebbencbf22862021-03-03 12:01:22 -07001229 auto inserted = scoreboard->emplace(barrier, cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001230 if (!inserted.second && inserted.first->second != cb_state) {
1231 // 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 -06001232 LogObjectList objlist(cb_state->commandBuffer());
Mark Lobodzinskiea561582020-03-16 18:13:56 -06001233 objlist.add(barrier.handle);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001234 objlist.add(inserted.first->second->commandBuffer());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001235 skip = LogWarning(objlist, TransferBarrier::ErrMsgDuplicateQFOInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001236 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1237 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001238 "vkQueueSubmit()", TransferBarrier::BarrierName(), operation, TransferBarrier::HandleName(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001239 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001240 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer()).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001241 }
1242 return skip;
1243}
1244
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001245template <typename TransferBarrier>
1246bool CoreChecks::ValidateQueuedQFOTransferBarriers(
1247 const CMD_BUFFER_STATE *cb_state, QFOTransferCBScoreboards<TransferBarrier> *scoreboards,
1248 const GlobalQFOTransferBarrierMap<TransferBarrier> &global_release_barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001249 bool skip = false;
Jeremy Gebben159b3cc2021-06-03 09:09:03 -06001250 const auto &cb_barriers = cb_state->GetQFOBarrierSets(TransferBarrier());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001251 const char *barrier_name = TransferBarrier::BarrierName();
1252 const char *handle_name = TransferBarrier::HandleName();
John Zulauf6b4aae82018-05-09 13:03:36 -06001253 // No release should have an extant duplicate (WARNING)
1254 for (const auto &release : cb_barriers.release) {
1255 // Check the global pending release barriers
1256 const auto set_it = global_release_barriers.find(release.handle);
1257 if (set_it != global_release_barriers.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001258 const QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001259 const auto found = set_for_handle.find(release);
1260 if (found != set_for_handle.cend()) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001261 skip |= LogWarning(cb_state->commandBuffer(), TransferBarrier::ErrMsgDuplicateQFOSubmitted(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001262 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1263 " to dstQueueFamilyIndex %" PRIu32
1264 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1265 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1266 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001267 }
1268 }
1269 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1270 }
1271 // Each acquire must have a matching release (ERROR)
1272 for (const auto &acquire : cb_barriers.acquire) {
1273 const auto set_it = global_release_barriers.find(acquire.handle);
1274 bool matching_release_found = false;
1275 if (set_it != global_release_barriers.cend()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001276 const QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001277 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1278 }
1279 if (!matching_release_found) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001280 skip |= LogError(cb_state->commandBuffer(), TransferBarrier::ErrMsgMissingQFOReleaseInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001281 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1282 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1283 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1284 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001285 }
1286 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1287 }
1288 return skip;
1289}
1290
John Zulauf3b04ebd2019-07-18 14:08:11 -06001291bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001292 QFOTransferCBScoreboards<QFOImageTransferBarrier> *qfo_image_scoreboards,
1293 QFOTransferCBScoreboards<QFOBufferTransferBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001294 bool skip = false;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001295 skip |=
1296 ValidateQueuedQFOTransferBarriers<QFOImageTransferBarrier>(cb_state, qfo_image_scoreboards, qfo_release_image_barrier_map);
1297 skip |= ValidateQueuedQFOTransferBarriers<QFOBufferTransferBarrier>(cb_state, qfo_buffer_scoreboards,
1298 qfo_release_buffer_barrier_map);
John Zulauf6b4aae82018-05-09 13:03:36 -06001299 return skip;
1300}
1301
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001302template <typename TransferBarrier>
1303void RecordQueuedQFOTransferBarriers(QFOTransferBarrierSets<TransferBarrier> &cb_barriers,
1304 GlobalQFOTransferBarrierMap<TransferBarrier> &global_release_barriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001305 // Add release barriers from this submit to the global map
1306 for (const auto &release : cb_barriers.release) {
1307 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
Jeremy Gebben51499ca2022-01-11 08:36:13 -07001308 // NOTE: vl_concurrent_ordered_map::find() makes a thread safe copy of the result, so we must
1309 // copy back after updating.
1310 auto iter = global_release_barriers.find(release.handle);
1311 iter->second.insert(release);
1312 global_release_barriers.insert_or_assign(release.handle, iter->second);
John Zulauf6b4aae82018-05-09 13:03:36 -06001313 }
1314
1315 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1316 for (const auto &acquire : cb_barriers.acquire) {
1317 // NOTE: We're not using [] because we don't want to create entries for missing releases
1318 auto set_it = global_release_barriers.find(acquire.handle);
1319 if (set_it != global_release_barriers.end()) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001320 QFOTransferBarrierSet<TransferBarrier> &set_for_handle = set_it->second;
John Zulauf6b4aae82018-05-09 13:03:36 -06001321 set_for_handle.erase(acquire);
1322 if (set_for_handle.size() == 0) { // Clean up empty sets
Jeremy Gebben51499ca2022-01-11 08:36:13 -07001323 global_release_barriers.erase(acquire.handle);
1324 } else {
1325 // NOTE: vl_concurrent_ordered_map::find() makes a thread safe copy of the result, so we must
1326 // copy back after updating.
1327 global_release_barriers.insert_or_assign(acquire.handle, set_for_handle);
John Zulauf6b4aae82018-05-09 13:03:36 -06001328 }
1329 }
1330 }
1331}
1332
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001333void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001334 RecordQueuedQFOTransferBarriers<QFOImageTransferBarrier>(cb_state->qfo_transfer_image_barriers, qfo_release_image_barrier_map);
1335 RecordQueuedQFOTransferBarriers<QFOBufferTransferBarrier>(cb_state->qfo_transfer_buffer_barriers,
1336 qfo_release_buffer_barrier_map);
John Zulauf6b4aae82018-05-09 13:03:36 -06001337}
1338
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001339template <typename ImgBarrier>
1340void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count, const ImgBarrier *barriers) {
1341 // For ownership transfers, the barrier is specified twice; as a release
1342 // operation on the yielding queue family, and as an acquire operation
1343 // on the acquiring queue family. This barrier may also include a layout
1344 // transition, which occurs 'between' the two operations. For validation
1345 // purposes it doesn't seem important which side performs the layout
1346 // transition, but it must not be performed twice. We'll arbitrarily
1347 // choose to perform it as part of the acquire operation.
1348 //
1349 // However, we still need to record initial layout for the "initial layout" validation
1350 for (uint32_t i = 0; i < barrier_count; i++) {
1351 const auto &mem_barrier = barriers[i];
Jeremy Gebbenefead332021-06-18 08:22:44 -06001352 const bool is_release_op = cb_state->IsReleaseOp(mem_barrier);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001353 auto image_state = Get<IMAGE_STATE>(mem_barrier.image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001354 if (image_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06001355 RecordTransitionImageLayout(cb_state, image_state.get(), mem_barrier, is_release_op);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001356 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001357 }
1358}
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001359// explictly instantiate this template so it can be used in core_validation.cpp
1360template void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1361 const VkImageMemoryBarrier *barrier);
1362template void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1363 const VkImageMemoryBarrier2KHR *barrier);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001364
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001365VkImageLayout NormalizeSynchronization2Layout(const VkImageAspectFlags aspect_mask, VkImageLayout layout);
1366
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001367template <typename ImgBarrier>
unknown86bcb3a2019-07-11 13:05:36 -06001368void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07001369 const ImgBarrier &mem_barrier, bool is_release_op) {
Tony-LunarG273f32f2021-09-28 08:56:30 -06001370 if (enabled_features.core13.synchronization2) {
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001371 if (mem_barrier.oldLayout == mem_barrier.newLayout) {
1372 return;
1373 }
1374 }
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06001375 auto normalized_isr = image_state->NormalizeSubresourceRange(mem_barrier.subresourceRange);
unknown86bcb3a2019-07-11 13:05:36 -06001376
Jeremy Gebben579aaca2021-02-15 13:36:18 -07001377 VkImageLayout initial_layout = NormalizeSynchronization2Layout(mem_barrier.subresourceRange.aspectMask, mem_barrier.oldLayout);
1378 VkImageLayout new_layout = NormalizeSynchronization2Layout(mem_barrier.subresourceRange.aspectMask, mem_barrier.newLayout);
Michael Spang8af7c102020-05-03 20:50:09 -04001379
1380 // Layout transitions in external instance are not tracked, so don't validate initial layout.
John Zulaufcea64cb2020-06-10 17:17:27 -06001381 if (QueueFamilyIsExternal(mem_barrier.srcQueueFamilyIndex)) {
Michael Spang8af7c102020-05-03 20:50:09 -04001382 initial_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1383 }
1384
John Zulauf2be3fe02019-12-30 09:48:02 -07001385 if (is_release_op) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06001386 cb_state->SetImageInitialLayout(*image_state, normalized_isr, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001387 } else {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06001388 cb_state->SetImageLayout(*image_state, normalized_isr, new_layout, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001389 }
unknown86bcb3a2019-07-11 13:05:36 -06001390}
1391
John Zulauf15578df2022-06-02 13:50:03 -06001392template <typename RangeFactory>
1393bool CoreChecks::VerifyImageLayoutRange(const CMD_BUFFER_STATE &cb_node, const IMAGE_STATE &image_state,
1394 VkImageAspectFlags aspect_mask, VkImageLayout explicit_layout,
1395 const RangeFactory &range_factory, const char *caller, const char *layout_mismatch_msg_code,
1396 bool *error) const {
1397 bool skip = false;
1398 const auto *subresource_map = cb_node.GetImageSubresourceLayoutMap(image_state);
1399 if (!subresource_map) return skip;
1400
1401 LayoutUseCheckAndMessage layout_check(explicit_layout, aspect_mask);
1402 skip |= subresource_map->AnyInRange(
1403 range_factory(*subresource_map), [this, &cb_node, &image_state, &layout_check, layout_mismatch_msg_code, caller, error](
1404 const VkImageSubresource &subres, const LayoutEntry &state) {
1405 bool subres_skip = false;
1406 if (!layout_check.Check(state)) {
1407 *error = true;
1408 subres_skip |= LogError(cb_node.commandBuffer(), layout_mismatch_msg_code,
1409 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1410 "%s layout %s.",
1411 caller, report_data->FormatHandle(image_state.Handle()).c_str(), subres.arrayLayer,
1412 subres.mipLevel, string_VkImageLayout(layout_check.expected_layout), layout_check.message,
1413 string_VkImageLayout(layout_check.layout));
1414 }
1415 return subres_skip;
1416 });
1417
1418 return skip;
1419}
1420
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001421bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE &cb_node, const IMAGE_STATE &image_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001422 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1423 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1424 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06001425 if (disabled[image_layout_validation]) return false;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001426 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001427
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001428 VkImageSubresourceRange normalized_isr = image_state.NormalizeSubresourceRange(range);
John Zulauf15578df2022-06-02 13:50:03 -06001429 auto range_factory = [&normalized_isr](const ImageSubresourceLayoutMap &map) {
1430 return map.RangeGen(normalized_isr);
1431 };
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001432 skip |= VerifyImageLayoutRange(cb_node, image_state, aspect_mask, explicit_layout, range_factory, caller,
John Zulauf15578df2022-06-02 13:50:03 -06001433 layout_mismatch_msg_code, error);
John Zulauff660ad62019-03-23 07:16:05 -06001434
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001435 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1436 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1437 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001438 if (image_state.createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001439 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001440 skip |= LogPerformanceWarning(cb_node.commandBuffer(), kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001441 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001442 report_data->FormatHandle(image_state.Handle()).c_str(),
Jeremy Gebben6335df62021-11-01 10:50:13 -06001443 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001444 }
sfricke-samsung45996a42021-09-16 13:45:27 -07001445 } else if (IsExtEnabled(device_extensions.vk_khr_shared_presentable_image)) {
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001446 if (image_state.shared_presentable) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001447 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001448 skip |=
1449 LogError(device, layout_invalid_msg_code,
1450 "%s: Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1451 caller, string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001452 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001453 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001454 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001455 *error = true;
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001456 skip |= LogError(cb_node.commandBuffer(), layout_invalid_msg_code,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001457 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001458 report_data->FormatHandle(image_state.Handle()).c_str(), string_VkImageLayout(explicit_layout),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001459 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001460 }
1461 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001462 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001463}
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001464bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE &cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001465 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1466 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001467 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001468 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1469 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1470}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001471
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001472bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE &cb_node, const IMAGE_VIEW_STATE &image_view_state,
Jeremy Gebbene7b99fc2022-06-02 08:44:33 -06001473 VkImageLayout explicit_layout, const char *caller, const char *layout_mismatch_msg_code,
1474 bool *error) const {
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -06001475 if (disabled[image_layout_validation]) return false;
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001476 assert(image_view_state.image_state);
1477 auto range_factory = [&image_view_state](const ImageSubresourceLayoutMap &map) {
1478 return image_layout_map::RangeGenerator(image_view_state.range_generator);
John Zulauf15578df2022-06-02 13:50:03 -06001479 };
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -06001480
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06001481 return VerifyImageLayoutRange(cb_node, *image_view_state.image_state, image_view_state.create_info.subresourceRange.aspectMask,
1482 explicit_layout, range_factory, caller, layout_mismatch_msg_code, error);
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -06001483}
1484
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001485void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001486 FRAMEBUFFER_STATE *framebuffer_state) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001487 auto render_pass = Get<RENDER_PASS_STATE>(pRenderPassBegin->renderPass);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001488 if (!render_pass) return;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001489
Mike Schuchardt2df08912020-12-15 16:28:09 -08001490 const VkRenderPassCreateInfo2 *render_pass_info = render_pass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001491 if (framebuffer_state) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001492 for (uint32_t i = 0; i < render_pass_info->attachmentCount; ++i) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06001493 auto *view_state = pCB->GetActiveAttachmentImageViewState(i);
John Zulauf8e308292018-09-21 11:34:37 -06001494 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001495 VkImageLayout stencil_layout = kInvalidLayout;
1496 const auto *attachment_description_stencil_layout =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001497 LvlFindInChain<VkAttachmentDescriptionStencilLayout>(render_pass_info->pAttachments[i].pNext);
Piers Daniell4fde9b72019-11-27 16:19:46 -07001498 if (attachment_description_stencil_layout) {
1499 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1500 }
Jeremy Gebben1ec89332021-08-05 13:51:49 -06001501 pCB->SetImageViewLayout(*view_state, render_pass_info->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001502 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001503 }
1504 }
1505}
Dave Houltone19e20d2018-02-02 16:32:41 -07001506
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001507#ifdef VK_USE_PLATFORM_ANDROID_KHR
1508// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1509// This could also move into a seperate core_validation_android.cpp file... ?
1510
1511//
1512// AHB-specific validation within non-AHB APIs
1513//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001514bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001515 bool skip = false;
1516
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001517 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(create_info->pNext);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001518 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001519 if (0 != ext_fmt_android->externalFormat) {
1520 if (VK_FORMAT_UNDEFINED != create_info->format) {
1521 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001522 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1523 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1524 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001525 }
1526
1527 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001528 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1529 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1530 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001531 }
1532
1533 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001534 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1535 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06001536 "non-zero externalFormat, but usage includes bits (0x%" PRIx32 ") other than VK_IMAGE_USAGE_SAMPLED_BIT.",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001537 create_info->usage);
Dave Houltond9611312018-11-19 17:03:36 -07001538 }
1539
1540 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001541 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1542 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1543 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001544 }
1545 }
1546
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001547 if ((0 != ext_fmt_android->externalFormat) &&
1548 (ahb_ext_formats_map.find(ext_fmt_android->externalFormat) == ahb_ext_formats_map.end())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001549 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001550 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat (%" PRIu64
1551 ") which has "
1552 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().",
1553 ext_fmt_android->externalFormat);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001554 }
1555 }
1556
Dave Houltond9611312018-11-19 17:03:36 -07001557 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001558 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001559 skip |=
1560 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1561 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1562 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001563 }
1564 }
1565
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001566 const VkExternalMemoryImageCreateInfo *emici = LvlFindInChain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001567 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1568 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001569 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001570 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1571 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1572 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1573 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001574 }
1575
1576 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001577 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1578 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1579 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1580 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1581 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001582 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001583 }
1584
1585 return skip;
1586}
1587
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001588bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001589 bool skip = false;
Jeremy Gebbenf4449392022-01-28 10:09:10 -07001590 auto image_state = Get<IMAGE_STATE>(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001591
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06001592 if (image_state->HasAHBFormat()) {
Dave Houltond9611312018-11-19 17:03:36 -07001593 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001594 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1595 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001596 "format member is %s and must be VK_FORMAT_UNDEFINED.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001597 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001598 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001599
Dave Houltond9611312018-11-19 17:03:36 -07001600 // Chain must include a compatible ycbcr conversion
1601 bool conv_found = false;
1602 uint64_t external_format = 0;
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001603 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = LvlFindInChain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
Dave Houltond9611312018-11-19 17:03:36 -07001604 if (ycbcr_conv_info != nullptr) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001605 auto ycbcr_state = Get<SAMPLER_YCBCR_CONVERSION_STATE>(ycbcr_conv_info->conversion);
Jeremy Gebbenf4fb2a02021-07-08 09:57:46 -06001606 if (ycbcr_state) {
Dave Houltond9611312018-11-19 17:03:36 -07001607 conv_found = true;
Jeremy Gebbenf4fb2a02021-07-08 09:57:46 -06001608 external_format = ycbcr_state->external_format;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001609 }
Dave Houltond9611312018-11-19 17:03:36 -07001610 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001611 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001612 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001613 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1614 "an externalFormat (%" PRIu64
1615 ") but needs a chained VkSamplerYcbcrConversionInfo struct with a VkSamplerYcbcrConversion created "
1616 "with the same external format.",
1617 image_state->ahb_format);
Dave Houltond9611312018-11-19 17:03:36 -07001618 }
1619
1620 // Errors in create_info swizzles
sfricke-samsungbd0e8052020-06-06 01:36:39 -07001621 if (IsIdentitySwizzle(create_info->components) == false) {
1622 skip |= LogError(
1623 create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1624 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1625 "includes one or more non-identity component swizzles, r swizzle = %s, g swizzle = %s, b swizzle = %s, a swizzle "
1626 "= %s.",
1627 string_VkComponentSwizzle(create_info->components.r), string_VkComponentSwizzle(create_info->components.g),
1628 string_VkComponentSwizzle(create_info->components.b), string_VkComponentSwizzle(create_info->components.a));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001629 }
1630 }
Dave Houltond9611312018-11-19 17:03:36 -07001631
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001632 return skip;
1633}
1634
John Zulaufa26d3c82019-08-14 16:09:08 -06001635bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001636 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001637
Jeremy Gebbenf4449392022-01-28 10:09:10 -07001638 auto image_state = Get<IMAGE_STATE>(image);
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001639 if (image_state != nullptr) {
Aitor Camacho3294edd2022-05-16 22:34:19 +02001640 if (image_state->IsExternalAHB() && (0 == image_state->GetBoundMemoryStates().size())) {
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001641 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1642 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1643 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1644 "bound to memory.");
1645 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001646 }
1647 return skip;
1648}
1649
1650#else
1651
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001652bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001653 return false;
1654}
1655
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001656bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001657
John Zulaufa26d3c82019-08-14 16:09:08 -06001658bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001659
1660#endif // VK_USE_PLATFORM_ANDROID_KHR
1661
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001662bool CoreChecks::ValidateImageFormatFeatures(const VkImageCreateInfo *pCreateInfo) const {
1663 bool skip = false;
1664
1665 // validates based on imageCreateFormatFeatures from vkspec.html#resources-image-creation-limits
Lionel Landwerlin21719f62021-12-09 11:40:09 +02001666 VkFormatFeatureFlags2KHR tiling_features = 0;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001667 const VkImageTiling image_tiling = pCreateInfo->tiling;
1668 const VkFormat image_format = pCreateInfo->format;
1669
1670 if (image_format == VK_FORMAT_UNDEFINED) {
1671 // VU 01975 states format can't be undefined unless an android externalFormat
1672#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001673 const VkExternalFormatANDROID *ext_fmt_android = LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001674 if ((image_tiling == VK_IMAGE_TILING_OPTIMAL) && (ext_fmt_android != nullptr) && (0 != ext_fmt_android->externalFormat)) {
1675 auto it = ahb_ext_formats_map.find(ext_fmt_android->externalFormat);
1676 if (it != ahb_ext_formats_map.end()) {
1677 tiling_features = it->second;
1678 }
1679 }
1680#endif
1681 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
Lionel Landwerlin1da35792021-12-14 16:54:13 +02001682 layer_data::unordered_set<uint64_t> drm_format_modifiers;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001683 const VkImageDrmFormatModifierExplicitCreateInfoEXT *drm_explicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001684 LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001685 const VkImageDrmFormatModifierListCreateInfoEXT *drm_implicit =
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001686 LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001687
1688 if (drm_explicit != nullptr) {
Lionel Landwerlin1da35792021-12-14 16:54:13 +02001689 drm_format_modifiers.insert(drm_explicit->drmFormatModifier);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001690 } else {
1691 // VUID 02261 makes sure its only explict or implict in parameter checking
1692 assert(drm_implicit != nullptr);
1693 for (uint32_t i = 0; i < drm_implicit->drmFormatModifierCount; i++) {
Lionel Landwerlin1da35792021-12-14 16:54:13 +02001694 drm_format_modifiers.insert(drm_implicit->pDrmFormatModifiers[i]);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001695 }
1696 }
1697
Lionel Landwerlin1da35792021-12-14 16:54:13 +02001698 auto fmt_drm_props = LvlInitStruct<VkDrmFormatModifierPropertiesListEXT>();
1699 auto fmt_props_2 = LvlInitStruct<VkFormatProperties2>(&fmt_drm_props);
1700 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &fmt_props_2);
Lionel Landwerlin09351a72020-06-22 18:15:59 +03001701 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
Lionel Landwerlin1da35792021-12-14 16:54:13 +02001702 drm_properties.resize(fmt_drm_props.drmFormatModifierCount);
1703 fmt_drm_props.pDrmFormatModifierProperties = drm_properties.data();
1704 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &fmt_props_2);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001705
Lionel Landwerlin1da35792021-12-14 16:54:13 +02001706 for (uint32_t i = 0; i < fmt_drm_props.drmFormatModifierCount; i++) {
1707 if (drm_format_modifiers.find(fmt_drm_props.pDrmFormatModifierProperties[i].drmFormatModifier) !=
1708 drm_format_modifiers.end()) {
1709 tiling_features |= fmt_drm_props.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001710 }
1711 }
1712 } else {
Lionel Landwerlin21719f62021-12-09 11:40:09 +02001713 VkFormatProperties3KHR format_properties = GetPDFormatProperties(image_format);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001714 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
1715 : format_properties.optimalTilingFeatures;
1716 }
1717
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001718 // Lack of disjoint format feature support while using the flag
1719 if (FormatIsMultiplane(image_format) && ((pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT) != 0) &&
Lionel Landwerlin21719f62021-12-09 11:40:09 +02001720 ((tiling_features & VK_FORMAT_FEATURE_2_DISJOINT_BIT_KHR) == 0)) {
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001721 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateFormatFeatures-02260",
1722 "vkCreateImage(): can't use VK_IMAGE_CREATE_DISJOINT_BIT because %s doesn't support "
1723 "VK_FORMAT_FEATURE_DISJOINT_BIT based on imageCreateFormatFeatures.",
1724 string_VkFormat(pCreateInfo->format));
1725 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001726
1727 return skip;
1728}
1729
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001730bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001731 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001732 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001733
sfricke-samsung45996a42021-09-16 13:45:27 -07001734 if (IsExtEnabled(device_extensions.vk_android_external_memory_android_hardware_buffer)) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001735 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001736 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1737 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001738 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1739 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001740 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001741 }
1742
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001743 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1744 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001745 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1746 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1747 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001748 }
Dave Houlton130c0212018-01-29 13:39:56 -07001749 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001750
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001751 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001752 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1753 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1754 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001755 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001756 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width (%u) exceeds "
1757 "device maxFramebufferWidth (%u).",
1758 pCreateInfo->extent.width, device_limits->maxFramebufferWidth);
Dave Houlton130c0212018-01-29 13:39:56 -07001759 }
1760
1761 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001762 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08001763 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height (%u) exceeds "
1764 "device maxFramebufferHeight (%u).",
1765 pCreateInfo->extent.height, device_limits->maxFramebufferHeight);
Dave Houlton130c0212018-01-29 13:39:56 -07001766 }
1767
ziga-lunarg44cba6e2021-07-13 17:58:06 +02001768 VkImageCreateFlags sparseFlags =
1769 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
1770 if ((pCreateInfo->flags & sparseFlags) && (pCreateInfo->usage & VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT)) {
1771 skip |= LogError(
1772 device, "VUID-VkImageCreateInfo-None-01925",
1773 "vkCreateImage(): images using sparse memory cannot have VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT set");
1774 }
1775
Agarwal, Arpit78509112022-02-17 15:29:05 -07001776 if (!enabled_features.fragment_density_map_offset_features.fragmentDensityMapOffset) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001777 uint32_t ceiling_width = static_cast<uint32_t>(ceil(
1778 static_cast<float>(device_limits->maxFramebufferWidth) /
1779 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001780 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1781 skip |=
Agarwal, Arpit78509112022-02-17 15:29:05 -07001782 LogError(device, "VUID-VkImageCreateInfo-fragmentDensityMapOffset-06514",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001783 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1784 "ceiling of device "
1785 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1786 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1787 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001788 }
1789
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001790 uint32_t ceiling_height = static_cast<uint32_t>(ceil(
1791 static_cast<float>(device_limits->maxFramebufferHeight) /
1792 std::max(static_cast<float>(phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height), 1.0f)));
ByumjinConffx991b6062019-08-14 15:17:53 -07001793 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1794 skip |=
Agarwal, Arpit78509112022-02-17 15:29:05 -07001795 LogError(device, "VUID-VkImageCreateInfo-fragmentDensityMapOffset-06515",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001796 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1797 "ceiling of device "
1798 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1799 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1800 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001801 }
1802 }
1803
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001804 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001805 VkResult result = VK_SUCCESS;
1806 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1807 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1808 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1809 &format_limits);
1810 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001811 auto modifier_list = LvlFindInChain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1812 auto explicit_modifier = LvlFindInChain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001813 if (modifier_list) {
1814 for (uint32_t i = 0; i < modifier_list->drmFormatModifierCount; i++) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001815 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001816 drm_format_modifier.drmFormatModifier = modifier_list->pDrmFormatModifiers[i];
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001817 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001818 image_format_info.type = pCreateInfo->imageType;
1819 image_format_info.format = pCreateInfo->format;
1820 image_format_info.tiling = pCreateInfo->tiling;
1821 image_format_info.usage = pCreateInfo->usage;
1822 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001823 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001824
1825 result =
1826 DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1827 format_limits = image_format_properties.imageFormatProperties;
1828
1829 /* The application gives a list of modifier and the driver
1830 * selects one. If one is wrong, stop there.
1831 */
1832 if (result != VK_SUCCESS) break;
1833 }
1834 } else if (explicit_modifier) {
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001835 auto drm_format_modifier = LvlInitStruct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001836 drm_format_modifier.drmFormatModifier = explicit_modifier->drmFormatModifier;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001837 auto image_format_info = LvlInitStruct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001838 image_format_info.type = pCreateInfo->imageType;
1839 image_format_info.format = pCreateInfo->format;
1840 image_format_info.tiling = pCreateInfo->tiling;
1841 image_format_info.usage = pCreateInfo->usage;
1842 image_format_info.flags = pCreateInfo->flags;
Mark Lobodzinski6fe9e702020-12-30 15:36:39 -07001843 auto image_format_properties = LvlInitStruct<VkImageFormatProperties2>();
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001844
1845 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1846 format_limits = image_format_properties.imageFormatProperties;
1847 }
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001848 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001849
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001850 // 1. vkGetPhysicalDeviceImageFormatProperties[2] only success code is VK_SUCCESS
1851 // 2. If call returns an error, then "imageCreateImageFormatPropertiesList" is defined to be the empty list
1852 // 3. All values in 02251 are undefined if "imageCreateImageFormatPropertiesList" is empty.
1853 if (result != VK_SUCCESS) {
1854 // External memory will always have a "imageCreateImageFormatPropertiesList" so skip
Lockee87f87c2019-04-23 17:53:10 -06001855#ifdef VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001856 if (!LvlFindInChain<VkExternalFormatANDROID>(pCreateInfo->pNext)) {
Lockee87f87c2019-04-23 17:53:10 -06001857#endif // VK_USE_PLATFORM_ANDROID_KHR
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001858 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateMaxMipLevels-02251",
Spencer Frickec46fc6d2020-04-16 06:23:05 -07001859 "vkCreateImage(): Format %s is not supported for this combination of parameters and "
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001860 "VkGetPhysicalDeviceImageFormatProperties returned back %s.",
1861 string_VkFormat(pCreateInfo->format), string_VkResult(result));
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001862#ifdef VK_USE_PLATFORM_ANDROID_KHR
1863 }
1864#endif // VK_USE_PLATFORM_ANDROID_KHR
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001865 } else {
1866 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1867 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001868 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1869 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1870 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001871 }
Dave Houlton130c0212018-01-29 13:39:56 -07001872
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001873 uint64_t texel_count = static_cast<uint64_t>(pCreateInfo->extent.width) *
1874 static_cast<uint64_t>(pCreateInfo->extent.height) *
1875 static_cast<uint64_t>(pCreateInfo->extent.depth) * static_cast<uint64_t>(pCreateInfo->arrayLayers) *
1876 static_cast<uint64_t>(pCreateInfo->samples);
Dave Houlton130c0212018-01-29 13:39:56 -07001877
sfricke-samsung2e827212021-09-28 07:52:08 -07001878 // Depth/Stencil formats size can't be accurately calculated
1879 if (!FormatIsDepthAndStencil(pCreateInfo->format)) {
1880 uint64_t total_size =
1881 static_cast<uint64_t>(std::ceil(FormatTexelSize(pCreateInfo->format) * static_cast<double>(texel_count)));
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001882
sfricke-samsung2e827212021-09-28 07:52:08 -07001883 // Round up to imageGranularity boundary
1884 VkDeviceSize image_granularity = phys_dev_props.limits.bufferImageGranularity;
1885 uint64_t ig_mask = image_granularity - 1;
1886 total_size = (total_size + ig_mask) & ~ig_mask;
1887
1888 if (total_size > format_limits.maxResourceSize) {
1889 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
1890 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1891 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1892 total_size, format_limits.maxResourceSize);
1893 }
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001894 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001895
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001896 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001897 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
1898 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1899 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001900 }
1901
1902 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001903 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
1904 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
1905 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001906 }
sfricke-samsung612f3622020-06-20 20:42:46 -07001907
1908 if (pCreateInfo->extent.width > format_limits.maxExtent.width) {
1909 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02252",
1910 "vkCreateImage(): extent.width %u exceeds allowable maximum image extent width %u.",
1911 pCreateInfo->extent.width, format_limits.maxExtent.width);
1912 }
1913
1914 if (pCreateInfo->extent.height > format_limits.maxExtent.height) {
1915 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02253",
1916 "vkCreateImage(): extent.height %u exceeds allowable maximum image extent height %u.",
1917 pCreateInfo->extent.height, format_limits.maxExtent.height);
1918 }
1919
1920 if (pCreateInfo->extent.depth > format_limits.maxExtent.depth) {
1921 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02254",
1922 "vkCreateImage(): extent.depth %u exceeds allowable maximum image extent depth %u.",
1923 pCreateInfo->extent.depth, format_limits.maxExtent.depth);
1924 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001925 }
1926
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001927 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsung10b35ce2021-09-29 08:50:20 -07001928 if (FormatRequiresYcbcrConversionExplicitly(pCreateInfo->format)) {
sfricke-samsungcead0802020-01-30 22:20:10 -08001929 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
sfricke-samsung45996a42021-09-16 13:45:27 -07001930 const char *error_vuid = IsExtEnabled(device_extensions.vk_ext_ycbcr_image_arrays)
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07001931 ? "VUID-VkImageCreateInfo-format-06414"
1932 : "VUID-VkImageCreateInfo-format-06413";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001933 skip |= LogError(device, error_vuid,
1934 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
1935 "YCbCr Conversion format, arrayLayers must be 1",
1936 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001937 }
1938
1939 if (pCreateInfo->mipLevels != 1) {
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07001940 skip |= LogError(device, "VUID-VkImageCreateInfo-format-06410",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001941 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
tmerilehtica733542022-04-13 14:00:29 +03001942 pCreateInfo->mipLevels);
sfricke-samsungcead0802020-01-30 22:20:10 -08001943 }
1944
1945 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001946 skip |= LogError(
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07001947 device, "VUID-VkImageCreateInfo-format-06411",
sfricke-samsungcead0802020-01-30 22:20:10 -08001948 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
1949 string_VkSampleCountFlagBits(pCreateInfo->samples));
1950 }
1951
1952 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001953 skip |= LogError(
Mike Schuchardt37b8cc12021-10-05 14:31:11 -07001954 device, "VUID-VkImageCreateInfo-format-06412",
sfricke-samsungcead0802020-01-30 22:20:10 -08001955 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
1956 string_VkImageType(pCreateInfo->imageType));
1957 }
1958 }
1959
sfricke-samsung45996a42021-09-16 13:45:27 -07001960 if (IsExtEnabled(device_extensions.vk_khr_maintenance2)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001961 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
sfricke-samsung08796682021-09-13 07:47:20 -07001962 if (!FormatIsCompressed(pCreateInfo->format)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001963 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01572",
1964 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
sfricke-samsung08796682021-09-13 07:47:20 -07001965 "format must be a compressed image format, but is %s",
Spencer Fricke48db59b2020-03-23 10:31:46 -07001966 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001967 }
1968 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001969 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01573",
1970 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1971 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001972 }
1973 }
1974 }
1975
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001976 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
sfricke-samsung45996a42021-09-16 13:45:27 -07001977 const char *vuid = IsExtEnabled(device_extensions.vk_khr_get_physical_device_properties2)
1978 ? "VUID-VkImageCreateInfo-sharingMode-01420"
1979 : "VUID-VkImageCreateInfo-sharingMode-01392";
Mark Lobodzinski314b9162020-07-16 15:33:08 -06001980 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
ziga-lunarge2e283d2021-08-01 09:55:04 +02001981 "vkCreateImage", "pCreateInfo->pQueueFamilyIndices", vuid);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001982 }
1983
unknown2c877272019-07-11 12:56:50 -06001984 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
1985 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
1986 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001987 LogError(device, "VUID-VkImageCreateInfo-format-01577",
1988 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
1989 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06001990 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001991
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001992 const auto swapchain_create_info = LvlFindInChain<VkImageSwapchainCreateInfoKHR>(pCreateInfo->pNext);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07001993 if (swapchain_create_info != nullptr) {
1994 if (swapchain_create_info->swapchain != VK_NULL_HANDLE) {
Jeremy Gebbenf4449392022-01-28 10:09:10 -07001995 auto swapchain_state = Get<SWAPCHAIN_NODE>(swapchain_create_info->swapchain);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07001996 const VkSwapchainCreateFlagsKHR swapchain_flags = swapchain_state->createInfo.flags;
1997
1998 // Validate rest of Swapchain Image create check that require swapchain state
1999 const char *vuid = "VUID-VkImageSwapchainCreateInfoKHR-swapchain-00995";
2000 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR) != 0) &&
2001 ((pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) == 0)) {
2002 skip |= LogError(
2003 device, vuid,
2004 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR flag so "
2005 "all swapchain images must have the VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT flag set.");
2006 }
2007 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR) != 0) &&
2008 ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) == 0)) {
2009 skip |= LogError(device, vuid,
2010 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR flag so all "
2011 "swapchain images must have the VK_IMAGE_CREATE_PROTECTED_BIT flag set.");
2012 }
Mike Schuchardt2df08912020-12-15 16:28:09 -08002013 const VkImageCreateFlags mutable_flags = (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT | VK_IMAGE_CREATE_EXTENDED_USAGE_BIT);
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002014 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR) != 0) &&
2015 ((pCreateInfo->flags & mutable_flags) != mutable_flags)) {
2016 skip |= LogError(device, vuid,
2017 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR flag so "
2018 "all swapchain images must have the VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT and "
Mike Schuchardt2df08912020-12-15 16:28:09 -08002019 "VK_IMAGE_CREATE_EXTENDED_USAGE_BIT flags both set.");
sfricke-samsungddaf72b2020-06-23 21:39:28 -07002020 }
2021 }
2022 }
2023
sfricke-samsungedce77a2020-07-03 22:35:13 -07002024 if ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) != 0) {
2025 if (enabled_features.core11.protectedMemory == VK_FALSE) {
2026 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01890",
2027 "vkCreateImage(): the protectedMemory device feature is disabled: Images cannot be created with the "
2028 "VK_IMAGE_CREATE_PROTECTED_BIT set.");
2029 }
2030 const VkImageCreateFlags invalid_flags =
2031 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
2032 if ((pCreateInfo->flags & invalid_flags) != 0) {
2033 skip |= LogError(device, "VUID-VkImageCreateInfo-None-01891",
2034 "vkCreateImage(): VK_IMAGE_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at same "
2035 "time (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | "
2036 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT).");
2037 }
2038 }
2039
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002040 skip |= ValidateImageFormatFeatures(pCreateInfo);
2041
Nathaniel Cesarioc02c2512020-11-13 12:04:24 -07002042 // Check compatibility with VK_KHR_portability_subset
sfricke-samsung45996a42021-09-16 13:45:27 -07002043 if (IsExtEnabled(device_extensions.vk_khr_portability_subset)) {
Nathaniel Cesarioc02c2512020-11-13 12:04:24 -07002044 if (VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT & pCreateInfo->flags &&
2045 VK_FALSE == enabled_features.portability_subset_features.imageView2DOn3DImage) {
2046 skip |= LogError(device, "VUID-VkImageCreateInfo-imageView2DOn3DImage-04459",
2047 "vkCreateImage (portability error): VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT is not supported.");
2048 }
2049 if ((VK_SAMPLE_COUNT_1_BIT != pCreateInfo->samples) && (1 != pCreateInfo->arrayLayers) &&
2050 (VK_FALSE == enabled_features.portability_subset_features.multisampleArrayImage)) {
2051 skip |=
2052 LogError(device, "VUID-VkImageCreateInfo-multisampleArrayImage-04460",
2053 "vkCreateImage (portability error): Cannot create an image with samples/texel > 1 && arrayLayers != 1");
2054 }
2055 }
2056
ziga-lunarg63f8d7a2021-07-20 22:10:31 +02002057 const auto external_memory_create_info_nv = LvlFindInChain<VkExternalMemoryImageCreateInfoNV>(pCreateInfo->pNext);
ziga-lunarg62aa24f2021-10-09 11:58:30 +02002058 const auto external_memory_create_info = LvlFindInChain<VkExternalMemoryImageCreateInfo>(pCreateInfo->pNext);
2059 if (external_memory_create_info_nv != nullptr && external_memory_create_info != nullptr) {
2060 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-00988",
2061 "vkCreateImage(): VkImageCreateInfo struct has both VkExternalMemoryImageCreateInfoNV and "
2062 "VkExternalMemoryImageCreateInfo chained structs.");
2063 }
2064 if (external_memory_create_info) {
2065 if (external_memory_create_info->handleTypes != 0 && pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_UNDEFINED) {
2066 skip |= LogError(
2067 device, "VUID-VkImageCreateInfo-pNext-01443",
2068 "vkCreateImage: VkImageCreateInfo pNext chain includes VkExternalMemoryImageCreateInfo with handleTypes %" PRIu32
2069 " but pCreateInfo->initialLayout is %s.",
2070 external_memory_create_info->handleTypes, string_VkImageLayout(pCreateInfo->initialLayout));
2071 }
2072 } else if (external_memory_create_info_nv) {
2073 if (external_memory_create_info_nv->handleTypes != 0 && pCreateInfo->initialLayout != VK_IMAGE_LAYOUT_UNDEFINED) {
2074 skip |= LogError(
2075 device, "VUID-VkImageCreateInfo-pNext-01443",
2076 "vkCreateImage: VkImageCreateInfo pNext chain includes VkExternalMemoryImageCreateInfoNV with handleTypes %" PRIu32
2077 " but pCreateInfo->initialLayout is %s.",
2078 external_memory_create_info_nv->handleTypes, string_VkImageLayout(pCreateInfo->initialLayout));
ziga-lunarg63f8d7a2021-07-20 22:10:31 +02002079 }
2080 }
2081
ziga-lunarg374fd9a2021-07-18 10:32:52 +02002082 if (device_group_create_info.physicalDeviceCount == 1) {
2083 if (pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) {
2084 skip |= LogError(device, "VUID-VkImageCreateInfo-physicalDeviceCount-01421",
2085 "vkCreateImage: Device was created with VkDeviceGroupDeviceCreateInfo::physicalDeviceCount 1, but "
2086 "flags contain VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT bit.");
2087 }
2088 }
2089
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002090 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07002091}
2092
John Zulauf7eeb6f72019-06-17 11:56:36 -06002093void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
2094 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
2095 if (VK_SUCCESS != result) return;
2096
2097 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
Jeremy Gebben4a8881f2022-01-10 17:04:30 -07002098 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) != 0) {
2099 // non-sparse images set up their layout maps when memory is bound
2100 auto image_state = Get<IMAGE_STATE>(*pImage);
2101 image_state->SetInitialLayoutMap();
2102 }
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07002103}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002104
Jeff Bolz5c801d12019-10-09 10:38:45 -05002105bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeremy Gebbenf4449392022-01-28 10:09:10 -07002106 auto image_state = Get<IMAGE_STATE>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002107 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07002108 if (image_state) {
Jeremy Gebben82e11d52021-07-26 09:19:37 -06002109 if (image_state->IsSwapchainImage()) {
sfricke-samsung73452522021-06-17 08:44:46 -07002110 skip |= LogError(device, "VUID-vkDestroyImage-image-04882",
sfricke-samsung9056cc12021-04-18 22:51:00 -07002111 "vkDestroyImage(): %s is a presentable image and it is controlled by the implementation and is "
2112 "destroyed with vkDestroySwapchainKHR.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002113 report_data->FormatHandle(image_state->image()).c_str());
sfricke-samsung9056cc12021-04-18 22:51:00 -07002114 }
Jeremy Gebben9f537102021-10-05 16:37:12 -06002115 skip |= ValidateObjectNotInUse(image_state.get(), "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002116 }
2117 return skip;
2118}
2119
John Zulauf7eeb6f72019-06-17 11:56:36 -06002120void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
2121 // Clean up validation specific data
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002122 auto image_state = Get<IMAGE_STATE>(image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07002123 qfo_release_image_barrier_map.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06002124 // Clean up generic image state
2125 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002126}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002127
sfricke-samsungcd924d92020-05-20 23:51:17 -07002128bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range,
2129 const char *param_name) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002130 bool skip = false;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002131 const VkImage image = image_state->image();
sfricke-samsungcd924d92020-05-20 23:51:17 -07002132 const VkFormat format = image_state->createInfo.format;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002133
2134 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002135 skip |= LogError(image, "VUID-vkCmdClearColorImage-aspectMask-02498",
2136 "vkCmdClearColorImage(): %s.aspectMasks must only be set to VK_IMAGE_ASPECT_COLOR_BIT.", param_name);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002137 }
2138
sfricke-samsungcd924d92020-05-20 23:51:17 -07002139 if (FormatIsDepthOrStencil(format)) {
2140 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2141 "vkCmdClearColorImage(): %s called with image %s which has a depth/stencil format (%s).", param_name,
2142 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
2143 } else if (FormatIsCompressed(format)) {
2144 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2145 "vkCmdClearColorImage(): %s called with image %s which has a compressed format (%s).", param_name,
2146 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002147 }
2148
2149 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002150 skip |=
2151 LogError(image, "VUID-vkCmdClearColorImage-image-00002",
2152 "vkCmdClearColorImage() %s called with image %s which was created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.",
2153 param_name, report_data->FormatHandle(image).c_str());
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002154 }
2155 return skip;
2156}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002157
John Zulauf07288512019-07-05 11:09:50 -06002158bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
2159 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
2160 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002161 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002162 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2163 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002164 skip |= LogError(image_state->image(), "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002165 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2166 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002167 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002168
2169 } else {
2170 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
sfricke-samsung45996a42021-09-16 13:45:27 -07002171 if (!IsExtEnabled(device_extensions.vk_khr_shared_presentable_image)) {
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002172 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002173 skip |= LogError(image_state->image(), "VUID-vkCmdClearColorImage-imageLayout-00005",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002174 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2175 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002176 }
2177 } else {
2178 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
2179 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002180 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002181 image_state->image(), "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002182 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
2183 func_name, string_VkImageLayout(dest_image_layout));
2184 }
2185 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002186 }
2187
John Zulauff660ad62019-03-23 07:16:05 -06002188 // Cast to const to prevent creation at validate time.
Jeremy Gebben6335df62021-11-01 10:50:13 -06002189 const auto *subresource_map = cb_node->GetImageSubresourceLayoutMap(*image_state);
John Zulauff660ad62019-03-23 07:16:05 -06002190 if (subresource_map) {
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -06002191 LayoutUseCheckAndMessage layout_check(dest_image_layout);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002192 auto normalized_isr = image_state->NormalizeSubresourceRange(range);
Tony Barbour55688172020-09-23 15:19:50 -07002193 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
2194 // the next "constant value" range
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -06002195 skip |= subresource_map->AnyInRange(
2196 normalized_isr, [this, cb_node, &layout_check, func_name](const VkImageSubresource &subres, const LayoutEntry &state) {
2197 bool subres_skip = false;
2198 if (!layout_check.Check(state)) {
2199 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
2200 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2201 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
2202 } else {
2203 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
2204 }
2205 subres_skip |= LogError(cb_node->commandBuffer(), error_code,
2206 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
2207 func_name, string_VkImageLayout(layout_check.expected_layout), layout_check.message,
2208 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002209 }
Jeremy Gebbenf33bcd12022-04-19 08:12:44 -06002210 return subres_skip;
2211 });
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002212 }
2213
2214 return skip;
2215}
2216
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002217bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2218 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002219 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002220 bool skip = false;
2221 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07002222 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07002223 auto image_state = Get<IMAGE_STATE>(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002224 if (cb_node && image_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06002225 skip |= ValidateMemoryIsBoundToImage(image_state.get(), "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
2226 skip |= ValidateCmd(cb_node.get(), CMD_CLEARCOLORIMAGE);
sfricke-samsung45996a42021-09-16 13:45:27 -07002227 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Lionel Landwerlin21719f62021-12-09 11:40:09 +02002228 skip |= ValidateImageFormatFeatureFlags(image_state.get(), VK_FORMAT_FEATURE_2_TRANSFER_DST_BIT_KHR,
2229 "vkCmdClearColorImage", "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04002230 }
Jeremy Gebben9f537102021-10-05 16:37:12 -06002231 skip |= ValidateProtectedImage(cb_node.get(), image_state.get(), "vkCmdClearColorImage()",
2232 "VUID-vkCmdClearColorImage-commandBuffer-01805");
2233 skip |= ValidateUnprotectedImage(cb_node.get(), image_state.get(), "vkCmdClearColorImage()",
sfricke-samsung022fa252020-07-24 03:26:16 -07002234 "VUID-vkCmdClearColorImage-commandBuffer-01806");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002235 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002236 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Jeremy Gebben9f537102021-10-05 16:37:12 -06002237 skip |= ValidateCmdClearColorSubresourceRange(image_state.get(), pRanges[i], param_name.c_str());
2238 skip |= ValidateImageAttributes(image_state.get(), pRanges[i], param_name.c_str());
2239 skip |= VerifyClearImageLayout(cb_node.get(), image_state.get(), pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002240 }
sfricke-samsunge775d492020-02-28 09:02:25 -08002241 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsung10b35ce2021-09-29 08:50:20 -07002242 if (FormatRequiresYcbcrConversionExplicitly(image_state->createInfo.format)) {
sfricke-samsunge775d492020-02-28 09:02:25 -08002243 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
2244 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
2245 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
2246 string_VkFormat(image_state->createInfo.format));
2247 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002248 }
2249 return skip;
2250}
2251
John Zulaufeabb4462019-07-05 14:13:03 -06002252void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2253 const VkClearColorValue *pColor, uint32_t rangeCount,
2254 const VkImageSubresourceRange *pRanges) {
2255 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
2256
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07002257 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002258 auto image_state = Get<IMAGE_STATE>(image);
John Zulaufeabb4462019-07-05 14:13:03 -06002259 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002260 for (uint32_t i = 0; i < rangeCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06002261 cb_node->SetImageInitialLayout(image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002262 }
2263 }
2264}
2265
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002266bool CoreChecks::ValidateClearDepthStencilValue(VkCommandBuffer commandBuffer, VkClearDepthStencilValue clearValue,
2267 const char *apiName) const {
2268 bool skip = false;
2269
2270 // 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 -07002271 if (!IsExtEnabled(device_extensions.vk_ext_depth_range_unrestricted)) {
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002272 if (!(clearValue.depth >= 0.0) || !(clearValue.depth <= 1.0)) {
2273 // Also VUID-VkClearDepthStencilValue-depth-00022
2274 skip |= LogError(commandBuffer, "VUID-VkClearDepthStencilValue-depth-02506",
2275 "%s: VK_EXT_depth_range_unrestricted extension is not enabled and VkClearDepthStencilValue::depth "
2276 "(=%f) is not within the [0.0, 1.0] range.",
2277 apiName, clearValue.depth);
2278 }
2279 }
2280
2281 return skip;
2282}
2283
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002284bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2285 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002286 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002287 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002288
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002289 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07002290 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07002291 auto image_state = Get<IMAGE_STATE>(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002292 if (cb_node && image_state) {
sfricke-samsung30e325a2020-07-25 12:56:13 -07002293 const VkFormat image_format = image_state->createInfo.format;
Jeremy Gebben9f537102021-10-05 16:37:12 -06002294 skip |= ValidateMemoryIsBoundToImage(image_state.get(), "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002295 "VUID-vkCmdClearDepthStencilImage-image-00010");
Jeremy Gebben9f537102021-10-05 16:37:12 -06002296 skip |= ValidateCmd(cb_node.get(), CMD_CLEARDEPTHSTENCILIMAGE);
sfricke-samsung45996a42021-09-16 13:45:27 -07002297 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Lionel Landwerlin21719f62021-12-09 11:40:09 +02002298 skip |= ValidateImageFormatFeatureFlags(image_state.get(), VK_FORMAT_FEATURE_2_TRANSFER_DST_BIT_KHR,
Jeremy Gebben9f537102021-10-05 16:37:12 -06002299 "vkCmdClearDepthStencilImage", "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04002300 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08002301 skip |= ValidateClearDepthStencilValue(commandBuffer, *pDepthStencil, "vkCmdClearDepthStencilImage()");
Jeremy Gebben9f537102021-10-05 16:37:12 -06002302 skip |= ValidateProtectedImage(cb_node.get(), image_state.get(), "vkCmdClearDepthStencilImage()",
sfricke-samsung022fa252020-07-24 03:26:16 -07002303 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01807");
Jeremy Gebben9f537102021-10-05 16:37:12 -06002304 skip |= ValidateUnprotectedImage(cb_node.get(), image_state.get(), "vkCmdClearDepthStencilImage()",
sfricke-samsung022fa252020-07-24 03:26:16 -07002305 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01808");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002306
2307 bool any_include_aspect_depth_bit = false;
2308 bool any_include_aspect_stencil_bit = false;
2309
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002310 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002311 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Jeremy Gebben9f537102021-10-05 16:37:12 -06002312 skip |= ValidateCmdClearDepthSubresourceRange(image_state.get(), pRanges[i], param_name.c_str());
2313 skip |=
2314 VerifyClearImageLayout(cb_node.get(), image_state.get(), pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002315 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06002316 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
2317 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002318 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-aspectMask-02824",
2319 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask can only be VK_IMAGE_ASPECT_DEPTH_BIT "
2320 "and/or VK_IMAGE_ASPECT_STENCIL_BIT.",
2321 i);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002322 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002323 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
2324 any_include_aspect_depth_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002325 if (FormatHasDepth(image_format) == false) {
2326 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02826",
2327 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_DEPTH_BIT but %s "
2328 "doesn't have a depth component.",
2329 i, string_VkFormat(image_format));
2330 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002331 }
2332 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
2333 any_include_aspect_stencil_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002334 if (FormatHasStencil(image_format) == false) {
2335 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02825",
2336 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_STENCIL_BIT but "
2337 "%s doesn't have a stencil component.",
2338 i, string_VkFormat(image_format));
2339 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002340 }
2341 }
2342 if (any_include_aspect_stencil_bit) {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07002343 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05002344 if (image_stencil_struct != nullptr) {
2345 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
2346 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002347 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
2348 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
2349 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
2350 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002351 }
2352 } else {
2353 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002354 skip |= LogError(
2355 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05002356 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
2357 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
2358 "in VkImageCreateInfo::usage used to create image");
2359 }
2360 }
2361 }
2362 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002363 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
2364 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
2365 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002366 }
sfricke-samsung30e325a2020-07-25 12:56:13 -07002367 if (image_state && !FormatIsDepthOrStencil(image_format)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002368 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014",
2369 "vkCmdClearDepthStencilImage(): called with image %s which doesn't have a depth/stencil format (%s).",
sfricke-samsung30e325a2020-07-25 12:56:13 -07002370 report_data->FormatHandle(image).c_str(), string_VkFormat(image_format));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002371 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002372 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002373 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009",
2374 "vkCmdClearDepthStencilImage(): called with image %s which was not created with the "
2375 "VK_IMAGE_USAGE_TRANSFER_DST_BIT set.",
2376 report_data->FormatHandle(image).c_str());
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002377 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002378 }
2379 return skip;
2380}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002381
John Zulaufeabb4462019-07-05 14:13:03 -06002382void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2383 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
2384 const VkImageSubresourceRange *pRanges) {
2385 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07002386
2387 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002388 auto image_state = Get<IMAGE_STATE>(image);
John Zulaufeabb4462019-07-05 14:13:03 -06002389 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002390 for (uint32_t i = 0; i < rangeCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06002391 cb_node->SetImageInitialLayout(image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002392 }
2393 }
2394}
2395
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002396// Returns true if [x, xoffset] and [y, yoffset] overlap
2397static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
2398 bool result = false;
2399 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
2400 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
2401
2402 if (intersection_max > intersection_min) {
2403 result = true;
2404 }
2405 return result;
2406}
2407
Jeff Leger178b1e52020-10-05 12:22:23 -04002408// Returns true if source area of first vkImageCopy/vkImageCopy2KHR region intersects dest area of second region
Dave Houltonc991cc92018-03-06 11:08:51 -07002409// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
Jeff Leger178b1e52020-10-05 12:22:23 -04002410template <typename RegionType>
sfricke-samsung71f04e32022-03-16 01:21:21 -05002411static bool RegionIntersects(const RegionType *region0, const RegionType *region1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002412 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07002413
Dave Houltonc991cc92018-03-06 11:08:51 -07002414 // Separate planes within a multiplane image cannot intersect
sfricke-samsung71f04e32022-03-16 01:21:21 -05002415 if (is_multiplane && (region0->srcSubresource.aspectMask != region1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07002416 return result;
2417 }
2418
sfricke-samsung71f04e32022-03-16 01:21:21 -05002419 if ((region0->srcSubresource.mipLevel == region1->dstSubresource.mipLevel) &&
2420 (RangesIntersect(region0->srcSubresource.baseArrayLayer, region0->srcSubresource.layerCount,
2421 region1->dstSubresource.baseArrayLayer, region1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002422 result = true;
2423 switch (type) {
2424 case VK_IMAGE_TYPE_3D:
sfricke-samsung71f04e32022-03-16 01:21:21 -05002425 result &= RangesIntersect(region0->srcOffset.z, region0->extent.depth, region1->dstOffset.z, region1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002426 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002427 case VK_IMAGE_TYPE_2D:
sfricke-samsung71f04e32022-03-16 01:21:21 -05002428 result &=
2429 RangesIntersect(region0->srcOffset.y, region0->extent.height, region1->dstOffset.y, region1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002430 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002431 case VK_IMAGE_TYPE_1D:
sfricke-samsung71f04e32022-03-16 01:21:21 -05002432 result &= RangesIntersect(region0->srcOffset.x, region0->extent.width, region1->dstOffset.x, region1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002433 break;
2434 default:
2435 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2436 assert(false);
2437 }
2438 }
2439 return result;
2440}
2441
aitor-lunarg607fe732022-03-31 22:00:08 +02002442template <typename RegionType>
2443static bool RegionIntersectsBlit(const RegionType *region0, const RegionType *region1, VkImageType type, bool is_multiplane) {
2444 bool result = false;
2445
2446 // Separate planes within a multiplane image cannot intersect
2447 if (is_multiplane && (region0->srcSubresource.aspectMask != region1->dstSubresource.aspectMask)) {
2448 return result;
2449 }
2450
2451 if ((region0->srcSubresource.mipLevel == region1->dstSubresource.mipLevel) &&
2452 (RangesIntersect(region0->srcSubresource.baseArrayLayer, region0->srcSubresource.layerCount,
2453 region1->dstSubresource.baseArrayLayer, region1->dstSubresource.layerCount))) {
2454 result = true;
2455 switch (type) {
2456 case VK_IMAGE_TYPE_3D:
2457 result &= RangesIntersect(region0->srcOffsets[0].z, region0->srcOffsets[1].z - region0->srcOffsets[0].z,
2458 region1->dstOffsets[0].z, region1->dstOffsets[1].z - region1->dstOffsets[0].z);
2459 // fall through
2460 case VK_IMAGE_TYPE_2D:
2461 result &= RangesIntersect(region0->srcOffsets[0].y, region0->srcOffsets[1].y - region0->srcOffsets[0].y,
2462 region1->dstOffsets[0].y, region1->dstOffsets[1].y - region1->dstOffsets[0].y);
2463 // fall through
2464 case VK_IMAGE_TYPE_1D:
2465 result &= RangesIntersect(region0->srcOffsets[0].x, region0->srcOffsets[1].x - region0->srcOffsets[0].x,
2466 region1->dstOffsets[0].x, region1->dstOffsets[1].x - region1->dstOffsets[0].x);
2467 break;
2468 default:
2469 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2470 assert(false);
2471 }
2472 }
2473 return result;
2474}
2475
Dave Houltonfc1a4052017-04-27 14:32:45 -06002476// Returns non-zero if offset and extent exceed image extents
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002477static const uint32_t kXBit = 1;
2478static const uint32_t kYBit = 2;
2479static const uint32_t kZBit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002480static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002481 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002482 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002483 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2484 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002485 result |= kZBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002486 }
2487 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2488 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002489 result |= kYBit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002490 }
2491 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2492 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002493 result |= kXBit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002494 }
2495 return result;
2496}
2497
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002498// Test if two VkExtent3D structs are equivalent
2499static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2500 bool result = true;
2501 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2502 (extent->depth != other_extent->depth)) {
2503 result = false;
2504 }
2505 return result;
2506}
2507
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002508// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002509static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002510 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2511}
2512
2513// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002514VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002515 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2516 VkExtent3D granularity = {0, 0, 0};
Jeremy Gebbencd7fa282021-10-27 10:25:32 -06002517 const auto pool = cb_node->command_pool;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002518 if (pool) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002519 granularity = physical_device_state->queue_family_properties[pool->queueFamilyIndex].minImageTransferGranularity;
sfricke-samsung01da6312021-10-20 07:51:32 -07002520 if (FormatIsBlockedImage(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002521 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002522 granularity.width *= block_size.width;
2523 granularity.height *= block_size.height;
2524 }
2525 }
2526 return granularity;
2527}
2528
2529// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2530static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2531 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002532 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2533 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002534 valid = false;
2535 }
2536 return valid;
2537}
2538
2539// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002540bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002541 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002542 bool skip = false;
2543 VkExtent3D offset_extent = {};
2544 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2545 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2546 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002547 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002548 // 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 -07002549 if (IsExtentAllZeroes(&offset_extent) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002550 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002551 "%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 "
2552 "image transfer granularity is (w=0, h=0, d=0).",
2553 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002554 }
2555 } else {
2556 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2557 // integer multiples of the image transfer granularity.
2558 if (IsExtentAligned(&offset_extent, granularity) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002559 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002560 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2561 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2562 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2563 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002564 }
2565 }
2566 return skip;
2567}
2568
2569// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002570bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002571 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002572 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002573 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002574 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002575 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2576 // subresource extent.
2577 if (IsExtentEqual(extent, subresource_extent) == false) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002578 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002579 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2580 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2581 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2582 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002583 }
2584 } else {
2585 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2586 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2587 // subresource extent dimensions.
2588 VkExtent3D offset_extent_sum = {};
2589 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2590 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2591 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002592 bool x_ok = true;
2593 bool y_ok = true;
2594 bool z_ok = true;
2595 switch (image_type) {
2596 case VK_IMAGE_TYPE_3D:
2597 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2598 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002599 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002600 case VK_IMAGE_TYPE_2D:
2601 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2602 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002603 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002604 case VK_IMAGE_TYPE_1D:
2605 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2606 (subresource_extent->width == offset_extent_sum.width));
2607 break;
2608 default:
2609 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2610 assert(false);
2611 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002612 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002613 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002614 LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002615 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2616 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2617 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2618 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2619 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2620 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002621 }
2622 }
2623 return skip;
2624}
2625
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002626bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002627 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002628 bool skip = false;
2629 if (mip_level >= img->createInfo.mipLevels) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002630 skip |= LogError(cb_node->commandBuffer(), vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2631 function, i, member, mip_level, report_data->FormatHandle(img->image()).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002632 }
2633 return skip;
2634}
2635
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002636bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002637 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002638 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002639 bool skip = false;
2640 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2641 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002642 skip |= LogError(cb_node->commandBuffer(), vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002643 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2644 "%u, but provided %s has %u array layers.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002645 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image()).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002646 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002647 }
2648 return skip;
2649}
2650
Tony Barbour845d29b2021-11-09 11:43:14 -07002651// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy/VkBufferImageCopy2 structure
sfricke-samsung71f04e32022-03-16 01:21:21 -05002652template <typename RegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002653bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
sfricke-samsung71f04e32022-03-16 01:21:21 -05002654 const RegionType *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002655 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002656 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002657 VkExtent3D granularity = GetScaledItg(cb_node, img);
2658 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002659 VkExtent3D subresource_extent = img->GetSubresourceExtent(region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002660 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002661 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002662 return skip;
2663}
2664
Jeff Leger178b1e52020-10-05 12:22:23 -04002665// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy/VkImageCopy2KHR structure
2666template <typename RegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002667bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002668 const IMAGE_STATE *dst_img, const RegionType *region,
2669 const uint32_t i, const char *function,
Tony-LunarGb61514a2021-11-02 12:36:51 -06002670 CMD_TYPE cmd_type) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002671 bool skip = false;
Tony-LunarGb61514a2021-11-02 12:36:51 -06002672 const bool is_2 = (cmd_type == CMD_COPYIMAGE2KHR || cmd_type == CMD_COPYIMAGE2);
Jeff Leger178b1e52020-10-05 12:22:23 -04002673 const char *vuid;
2674
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002675 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002676 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
Tony-LunarGb61514a2021-11-02 12:36:51 -06002677 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
Jeff Leger178b1e52020-10-05 12:22:23 -04002678 skip |= CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", vuid);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002679 VkExtent3D subresource_extent = src_img->GetSubresourceExtent(region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002680 const VkExtent3D extent = region->extent;
Tony-LunarGb61514a2021-11-02 12:36:51 -06002681 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002682 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04002683 i, function, "extent", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002684
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002685 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002686 granularity = GetScaledItg(cb_node, dst_img);
Tony-LunarGb61514a2021-11-02 12:36:51 -06002687 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
Jeff Leger178b1e52020-10-05 12:22:23 -04002688 skip |= CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", vuid);
Dave Houltonee281a52017-12-08 13:51:02 -07002689 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002690 const VkExtent3D dest_effective_extent =
2691 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002692 subresource_extent = dst_img->GetSubresourceExtent(region->dstSubresource);
Tony-LunarGb61514a2021-11-02 12:36:51 -06002693 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002694 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Jeff Leger178b1e52020-10-05 12:22:23 -04002695 dst_img->createInfo.imageType, i, function, "extent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002696 return skip;
2697}
2698
Jeff Leger178b1e52020-10-05 12:22:23 -04002699// Validate contents of a VkImageCopy or VkImageCopy2KHR struct
sfricke-samsung71f04e32022-03-16 01:21:21 -05002700template <typename RegionType>
2701bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const RegionType *pRegions, const IMAGE_STATE *src_state,
2702 const IMAGE_STATE *dst_state, CMD_TYPE cmd_type) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002703 bool skip = false;
Tony-LunarGb61514a2021-11-02 12:36:51 -06002704 const bool is_2 = (cmd_type == CMD_COPYIMAGE2KHR || cmd_type == CMD_COPYIMAGE2);
2705 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04002706 const char *vuid;
Dave Houlton6f9059e2017-05-02 17:15:13 -06002707
2708 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05002709 const RegionType region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002710
2711 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002712 const VkExtent3D src_copy_extent = region.extent;
2713 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002714 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2715
Dave Houlton6f9059e2017-05-02 17:15:13 -06002716 bool slice_override = false;
2717 uint32_t depth_slices = 0;
2718
2719 // Special case for copying between a 1D/2D array and a 3D image
2720 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2721 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002722 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002723 slice_override = (depth_slices != 1);
2724 } 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 -07002725 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002726 slice_override = (depth_slices != 1);
2727 }
2728
2729 // Do all checks on source image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002730 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002731 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002732 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-00146" : "VUID-vkCmdCopyImage-srcImage-00146";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002733 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002734 "%s: pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2735 "be 0 and 1, respectively.",
2736 func_name, i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002737 }
2738 }
2739
Dave Houlton533be9f2018-03-26 17:08:30 -06002740 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 -06002741 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01785" : "VUID-vkCmdCopyImage-srcImage-01785";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002742 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002743 "%s: pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002744 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002745 func_name, i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002746 }
2747
Dave Houlton533be9f2018-03-26 17:08:30 -06002748 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002749 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01787" : "VUID-vkCmdCopyImage-srcImage-01787";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002750 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 -04002751 func_name, i, region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002752 }
2753
sfricke-samsung01da6312021-10-20 07:51:32 -07002754 // Source checks that apply only to "blocked images"
2755 if (FormatIsBlockedImage(src_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002756 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002757 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002758 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2759 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2760 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002761 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01727" : "VUID-vkCmdCopyImage-srcImage-01727";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002762 skip |= LogError(src_state->image(), vuid,
sfricke-samsung01da6312021-10-20 07:51:32 -07002763 "%s: pRegion[%d] srcOffset (%d, %d) must be multiples of the blocked image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002764 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002765 func_name, i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002766 }
2767
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002768 const VkExtent3D mip_extent = src_state->GetSubresourceExtent(region.srcSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07002769 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2770 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002771 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01728" : "VUID-vkCmdCopyImage-srcImage-01728";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002772 skip |= LogError(src_state->image(), vuid,
sfricke-samsung01da6312021-10-20 07:51:32 -07002773 "%s: pRegion[%d] extent width (%d) must be a multiple of the blocked texture block "
Jeff Leger178b1e52020-10-05 12:22:23 -04002774 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2775 func_name, i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002776 }
2777
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002778 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002779 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2780 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002781 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01729" : "VUID-vkCmdCopyImage-srcImage-01729";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002782 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002783 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2784 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2785 func_name, i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002786 }
2787
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002788 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002789 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2790 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002791 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01730" : "VUID-vkCmdCopyImage-srcImage-01730";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002792 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002793 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2794 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2795 func_name, i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002796 }
2797 } // Compressed
2798
2799 // Do all checks on dest image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002800 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002801 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002802 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-00152" : "VUID-vkCmdCopyImage-dstImage-00152";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002803 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002804 "%s: pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002805 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002806 func_name, i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002807 }
2808 }
2809
Dave Houlton533be9f2018-03-26 17:08:30 -06002810 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 -06002811 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01786" : "VUID-vkCmdCopyImage-dstImage-01786";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002812 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002813 "%s: pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2814 "and 1, respectively.",
2815 func_name, i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002816 }
2817
Dave Houlton533be9f2018-03-26 17:08:30 -06002818 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002819 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01788" : "VUID-vkCmdCopyImage-dstImage-01788";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002820 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 -04002821 func_name, i, region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002822 }
2823
sfricke-samsung30b094c2020-05-30 11:42:11 -07002824 // Handle difference between Maintenance 1
sfricke-samsung45996a42021-09-16 13:45:27 -07002825 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002826 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2827 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002828 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-04443" : "VUID-vkCmdCopyImage-srcImage-04443";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002829 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002830 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2831 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2832 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002833 }
2834 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002835 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002836 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002837 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-04444" : "VUID-vkCmdCopyImage-dstImage-04444";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002838 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002839 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2840 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2841 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002842 }
2843 }
2844 } else { // Pre maint 1
2845 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002846 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002847 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002848 skip |= LogError(src_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002849 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and "
sfricke-samsung30b094c2020-05-30 11:42:11 -07002850 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2851 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002852 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002853 }
Dave Houltonee281a52017-12-08 13:51:02 -07002854 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002855 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002856 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002857 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002858 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2859 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002860 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002861 }
2862 }
2863 }
2864
sfricke-samsung01da6312021-10-20 07:51:32 -07002865 // Dest checks that apply only to "blocked images"
2866 if (FormatIsBlockedImage(dst_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002867 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002868
2869 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002870 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2871 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2872 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002873 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01731" : "VUID-vkCmdCopyImage-dstImage-01731";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002874 skip |= LogError(dst_state->image(), vuid,
sfricke-samsung01da6312021-10-20 07:51:32 -07002875 "%s: pRegion[%d] dstOffset (%d, %d) must be multiples of the blocked image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002876 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002877 func_name, i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002878 }
2879
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06002880 const VkExtent3D mip_extent = dst_state->GetSubresourceExtent(region.dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07002881 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2882 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002883 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01732" : "VUID-vkCmdCopyImage-dstImage-01732";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002884 skip |= LogError(dst_state->image(), vuid,
sfricke-samsung01da6312021-10-20 07:51:32 -07002885 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the blocked texture "
Jeff Leger178b1e52020-10-05 12:22:23 -04002886 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2887 func_name, i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002888 }
2889
Dave Houltonee281a52017-12-08 13:51:02 -07002890 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2891 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2892 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002893 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01733" : "VUID-vkCmdCopyImage-dstImage-01733";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002894 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002895 "%s: pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002896 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2897 "height (%d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002898 func_name, i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002899 }
2900
Dave Houltonee281a52017-12-08 13:51:02 -07002901 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2902 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2903 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002904 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01734" : "VUID-vkCmdCopyImage-dstImage-01734";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002905 skip |= LogError(dst_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002906 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2907 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2908 func_name, i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002909 }
2910 } // Compressed
2911 }
2912 return skip;
2913}
2914
Jeff Leger178b1e52020-10-05 12:22:23 -04002915template <typename RegionType>
2916bool CoreChecks::ValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2917 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Tony-LunarGb61514a2021-11-02 12:36:51 -06002918 const RegionType *pRegions, CMD_TYPE cmd_type) const {
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07002919 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07002920 auto src_image_state = Get<IMAGE_STATE>(srcImage);
2921 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
sfricke-samsungdce5f692020-03-07 13:59:31 -08002922 const VkFormat src_format = src_image_state->createInfo.format;
2923 const VkFormat dst_format = dst_image_state->createInfo.format;
Tony-LunarGb61514a2021-11-02 12:36:51 -06002924 const bool is_2 = (cmd_type == CMD_COPYIMAGE2KHR || cmd_type == CMD_COPYIMAGE2);;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002925 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002926
sfricke-samsung85584a72021-09-30 21:43:38 -07002927 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04002928 const char *vuid;
Tony-LunarGb61514a2021-11-02 12:36:51 -06002929 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state.get(), dst_image_state.get(), cmd_type);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002930
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002931 VkCommandBuffer command_buffer = cb_node->commandBuffer();
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002932
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002933 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002934 const RegionType region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002935
2936 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2937 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08002938 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07002939
Dave Houlton6f9059e2017-05-02 17:15:13 -06002940 bool slice_override = false;
2941 uint32_t depth_slices = 0;
2942
2943 // Special case for copying between a 1D/2D array and a 3D image
2944 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2945 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2946 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002947 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002948 slice_override = (depth_slices != 1);
2949 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2950 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002951 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002952 slice_override = (depth_slices != 1);
2953 }
2954
Jeremy Gebben9f537102021-10-05 16:37:12 -06002955 skip |= ValidateImageSubresourceLayers(cb_node.get(), &region.srcSubresource, func_name, "srcSubresource", i);
2956 skip |= ValidateImageSubresourceLayers(cb_node.get(), &region.dstSubresource, func_name, "dstSubresource", i);
Tony-LunarGb61514a2021-11-02 12:36:51 -06002957 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcSubresource-01696" : "VUID-vkCmdCopyImage-srcSubresource-01696";
2958 skip |=
2959 ValidateImageMipLevel(cb_node.get(), src_image_state.get(), region.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
2960 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstSubresource-01697" : "VUID-vkCmdCopyImage-dstSubresource-01697";
2961 skip |=
2962 ValidateImageMipLevel(cb_node.get(), dst_image_state.get(), region.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
2963 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcSubresource-01698" : "VUID-vkCmdCopyImage-srcSubresource-01698";
Jeremy Gebben9f537102021-10-05 16:37:12 -06002964 skip |= ValidateImageArrayLayerRange(cb_node.get(), src_image_state.get(), region.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002965 region.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
Tony-LunarGb61514a2021-11-02 12:36:51 -06002966 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstSubresource-01699" : "VUID-vkCmdCopyImage-dstSubresource-01699";
Jeremy Gebben9f537102021-10-05 16:37:12 -06002967 skip |= ValidateImageArrayLayerRange(cb_node.get(), dst_image_state.get(), region.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002968 region.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002969
sfricke-samsung45996a42021-09-16 13:45:27 -07002970 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002971 // No chance of mismatch if we're overriding depth slice count
2972 if (!slice_override) {
2973 // The number of depth slices in srcSubresource and dstSubresource must match
2974 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2975 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002976 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2977 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002978 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002979 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2980 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002981 if (src_slices != dst_slices) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002982 vuid = is_2 ? "VUID-VkImageCopy2-extent-00140" : "VUID-VkImageCopy-extent-00140";
Jeff Leger178b1e52020-10-05 12:22:23 -04002983 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002984 "%s: number of depth slices in source (%u) and destination (%u) subresources for pRegions[%u] "
2985 "do not match.",
2986 func_name, src_slices, dst_slices, i);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002987 }
2988 }
2989 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002990 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002991 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06002992 vuid = is_2 ? "VUID-VkImageCopy2-layerCount-00138" : "VUID-VkImageCopy-layerCount-00138";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08002993 skip |=
2994 LogError(command_buffer, vuid,
2995 "%s: number of layers in source (%u) and destination (%u) subresources for pRegions[%u] do not match",
2996 func_name, region.srcSubresource.layerCount, region.dstSubresource.layerCount, i);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002997 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002998 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002999
Dave Houltonc991cc92018-03-06 11:08:51 -07003000 // Do multiplane-specific checks, if extension enabled
sfricke-samsung45996a42021-09-16 13:45:27 -07003001 if (IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)) {
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003002 if ((!FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format))) {
3003 // If neither image is multi-plane the aspectMask member of src and dst must match
3004 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003005 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01551" : "VUID-vkCmdCopyImage-srcImage-01551";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003006 skip |= LogError(command_buffer, vuid,
3007 "%s: Copy between non-multiplane images with differing aspectMasks in pRegions[%u] with "
3008 "source (0x%x) destination (0x%x).",
3009 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
3010 }
3011 } else {
3012 // Source image multiplane checks
3013 uint32_t planes = FormatPlaneCount(src_format);
3014 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
3015 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003016 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01552" : "VUID-vkCmdCopyImage-srcImage-01552";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003017 skip |= LogError(command_buffer, vuid,
3018 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
3019 i, aspect);
3020 }
3021 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
3022 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003023 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01553" : "VUID-vkCmdCopyImage-srcImage-01553";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003024 skip |= LogError(command_buffer, vuid,
3025 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
3026 i, aspect);
3027 }
3028 // Single-plane to multi-plane
3029 if ((!FormatIsMultiplane(src_format)) && (FormatIsMultiplane(dst_format)) &&
3030 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003031 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01557" : "VUID-vkCmdCopyImage-dstImage-01557";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003032 skip |= LogError(command_buffer, vuid,
3033 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
3034 func_name, i, aspect);
3035 }
Dave Houltonc991cc92018-03-06 11:08:51 -07003036
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003037 // Dest image multiplane checks
3038 planes = FormatPlaneCount(dst_format);
3039 aspect = region.dstSubresource.aspectMask;
3040 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003041 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01554" : "VUID-vkCmdCopyImage-dstImage-01554";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003042 skip |= LogError(command_buffer, vuid,
3043 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 2-plane format.", func_name,
3044 i, aspect);
3045 }
3046 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT) &&
3047 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003048 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01555" : "VUID-vkCmdCopyImage-dstImage-01555";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003049 skip |= LogError(command_buffer, vuid,
3050 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is invalid for 3-plane format.", func_name,
3051 i, aspect);
3052 }
3053 // Multi-plane to single-plane
3054 if ((FormatIsMultiplane(src_format)) && (!FormatIsMultiplane(dst_format)) &&
3055 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003056 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01556" : "VUID-vkCmdCopyImage-srcImage-01556";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003057 skip |= LogError(command_buffer, vuid,
3058 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) is not VK_IMAGE_ASPECT_COLOR_BIT.",
3059 func_name, i, aspect);
3060 }
3061 }
3062 } else {
3063 // !vk_khr_sampler_ycbcr_conversion
Dave Houltonf5217612018-02-02 16:18:52 -07003064 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
3065 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003066 vuid = is_2 ? "VUID-VkImageCopy2-aspectMask-00137" : "VUID-VkImageCopy-aspectMask-00137";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003067 skip |= LogError(
3068 command_buffer, vuid,
3069 "%s: Copy between images with differing aspectMasks in pRegions[%u] with source (0x%x) destination (0x%x).",
3070 func_name, i, region.srcSubresource.aspectMask, region.dstSubresource.aspectMask);
Dave Houltonf5217612018-02-02 16:18:52 -07003071 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003072 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003073
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003074 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08003075 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003076 vuid = is_2 ? "VUID-VkCopyImageInfo2-aspectMask-00142" : "VUID-vkCmdCopyImage-aspectMask-00142";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003077 skip |=
3078 LogError(command_buffer, vuid,
3079 "%s: pRegions[%u].srcSubresource.aspectMask (0x%x) cannot specify aspects not present in source image.",
3080 func_name, i, region.srcSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003081 }
3082
3083 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08003084 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003085 vuid = is_2 ? "VUID-VkCopyImageInfo2-aspectMask-00143" : "VUID-vkCmdCopyImage-aspectMask-00143";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003086 skip |= LogError(
3087 command_buffer, vuid,
3088 "%s: pRegions[%u].dstSubresource.aspectMask (0x%x) cannot specify aspects not present in destination image.",
3089 func_name, i, region.dstSubresource.aspectMask);
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06003090 }
3091
sfricke-samsung5f11b0e2022-03-22 14:12:15 -05003092 // Make sure not a empty region
3093 if (src_copy_extent.width == 0) {
3094 vuid = is_2 ? "VUID-VkImageCopy2-extent-06668" : "VUID-VkImageCopy-extent-06668";
3095 skip |=
3096 LogError(command_buffer, vuid,
3097 "%s: pRegion[%" PRIu32 "] extent.width must not be zero as empty copies are not allowed.", func_name, i);
3098 }
3099 if (src_copy_extent.height == 0) {
3100 vuid = is_2 ? "VUID-VkImageCopy2-extent-06669" : "VUID-VkImageCopy-extent-06669";
3101 skip |=
3102 LogError(command_buffer, vuid,
3103 "%s: pRegion[%" PRIu32 "] extent.height must not be zero as empty copies are not allowed.", func_name, i);
3104 }
3105 if (src_copy_extent.depth == 0) {
3106 vuid = is_2 ? "VUID-VkImageCopy2-extent-06670" : "VUID-VkImageCopy-extent-06670";
3107 skip |=
3108 LogError(command_buffer, vuid,
3109 "%s: pRegion[%" PRIu32 "] extent.depth must not be zero as empty copies are not allowed.", func_name, i);
3110 }
3111
Dave Houltonfc1a4052017-04-27 14:32:45 -06003112 // Each dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003113 VkExtent3D subresource_extent = src_image_state->GetSubresourceExtent(region.srcSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07003114 if (slice_override) src_copy_extent.depth = depth_slices;
3115 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003116 if (extent_check & kXBit) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003117 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcOffset-00144" : "VUID-vkCmdCopyImage-srcOffset-00144";
Jeff Leger178b1e52020-10-05 12:22:23 -04003118 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003119 "%s: Source image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003120 "width [%1d].",
3121 func_name, i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003122 }
3123
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003124 if (extent_check & kYBit) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003125 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcOffset-00145" : "VUID-vkCmdCopyImage-srcOffset-00145";
Jeff Leger178b1e52020-10-05 12:22:23 -04003126 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003127 "%s: Source image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003128 "height [%1d].",
3129 func_name, i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003130 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003131 if (extent_check & kZBit) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003132 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcOffset-00147" : "VUID-vkCmdCopyImage-srcOffset-00147";
Jeff Leger178b1e52020-10-05 12:22:23 -04003133 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003134 "%s: Source image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Jeff Leger178b1e52020-10-05 12:22:23 -04003135 "depth [%1d].",
3136 func_name, i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003137 }
3138
Dave Houltonee281a52017-12-08 13:51:02 -07003139 // Adjust dest extent if necessary
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003140 subresource_extent = dst_image_state->GetSubresourceExtent(region.dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07003141 if (slice_override) dst_copy_extent.depth = depth_slices;
3142
3143 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003144 if (extent_check & kXBit) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003145 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstOffset-00150" : "VUID-vkCmdCopyImage-dstOffset-00150";
Jeff Leger178b1e52020-10-05 12:22:23 -04003146 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003147 "%s: Dest image pRegion[%u] x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003148 "width [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003149 func_name, i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003150 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003151 if (extent_check & kYBit) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003152 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstOffset-00151" : "VUID-vkCmdCopyImage-dstOffset-00151";
Jeff Leger178b1e52020-10-05 12:22:23 -04003153 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003154 "%s): Dest image pRegion[%u] y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003155 "height [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003156 func_name, i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003157 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003158 if (extent_check & kZBit) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003159 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstOffset-00153" : "VUID-vkCmdCopyImage-dstOffset-00153";
Jeff Leger178b1e52020-10-05 12:22:23 -04003160 skip |= LogError(command_buffer, vuid,
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003161 "%s: Dest image pRegion[%u] z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003162 "depth [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003163 func_name, i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06003164 }
3165
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003166 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
3167 // must not overlap in memory
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003168 if (src_image_state->image() == dst_image_state->image()) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003169 for (uint32_t j = 0; j < regionCount; j++) {
3170 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
sfricke-samsungdce5f692020-03-07 13:59:31 -08003171 FormatIsMultiplane(src_format))) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003172 vuid = is_2 ? "VUID-VkCopyImageInfo2-pRegions-00124" : "VUID-vkCmdCopyImage-pRegions-00124";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003173 skip |= LogError(command_buffer, vuid, "%s: pRegion[%u] src overlaps with pRegions[%u].", func_name, i, j);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003174 }
3175 }
3176 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08003177
3178 // 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 -07003179 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
sfricke-samsung48172ca2020-02-13 23:38:11 -08003180 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3181 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3182 (src_copy_extent.depth != 1)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003183 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01790" : "VUID-vkCmdCopyImage-srcImage-01790";
Jeff Leger178b1e52020-10-05 12:22:23 -04003184 skip |= LogError(command_buffer, vuid,
3185 "%s: pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1",
3186 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003187 }
3188 } else {
3189 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
3190 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3191 (src_copy_extent.depth != 1)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003192 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01789" : "VUID-vkCmdCopyImage-srcImage-01789";
Jeff Leger178b1e52020-10-05 12:22:23 -04003193 skip |= LogError(command_buffer, vuid,
3194 "%s: pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1",
3195 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003196 }
3197 }
3198
3199 // Check if 2D with 3D and depth not equal to 2D layerCount
3200 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3201 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
3202 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003203 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01791" : "VUID-vkCmdCopyImage-srcImage-01791";
Jeff Leger178b1e52020-10-05 12:22:23 -04003204 skip |= LogError(command_buffer, vuid,
3205 "%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 -08003206 "srcSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003207 func_name, i, src_copy_extent.depth, region.srcSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003208 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
3209 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
3210 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003211 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01792" : "VUID-vkCmdCopyImage-dstImage-01792";
Jeff Leger178b1e52020-10-05 12:22:23 -04003212 skip |= LogError(command_buffer, vuid,
3213 "%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 -08003214 "dstSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003215 func_name, i, src_copy_extent.depth, region.dstSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003216 }
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003217
3218 // Check for multi-plane format compatiblity
3219 if (FormatIsMultiplane(src_format) || FormatIsMultiplane(dst_format)) {
sfricke-samsung73e755c2021-09-30 08:34:57 -07003220 const VkFormat src_plane_format = FormatIsMultiplane(src_format)
3221 ? FindMultiplaneCompatibleFormat(src_format, region.srcSubresource.aspectMask)
3222 : src_format;
3223 const VkFormat dst_plane_format = FormatIsMultiplane(dst_format)
3224 ? FindMultiplaneCompatibleFormat(dst_format, region.dstSubresource.aspectMask)
3225 : dst_format;
3226 const size_t src_format_size = FormatElementSize(src_plane_format);
3227 const size_t dst_format_size = FormatElementSize(dst_plane_format);
3228
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003229 // If size is still zero, then format is invalid and will be caught in another VU
3230 if ((src_format_size != dst_format_size) && (src_format_size != 0) && (dst_format_size != 0)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003231 vuid = is_2 ? "VUID-VkCopyImageInfo2-None-01549" : "VUID-vkCmdCopyImage-None-01549";
Jeff Leger178b1e52020-10-05 12:22:23 -04003232 skip |= LogError(command_buffer, vuid,
3233 "%s: pRegions[%u] called with non-compatible image formats. "
3234 "The src format %s with aspectMask %s is not compatible with dst format %s aspectMask %s.",
3235 func_name, i, string_VkFormat(src_format),
3236 string_VkImageAspectFlags(region.srcSubresource.aspectMask).c_str(), string_VkFormat(dst_format),
3237 string_VkImageAspectFlags(region.dstSubresource.aspectMask).c_str());
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003238 }
3239 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003240 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003241
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003242 // The formats of non-multiplane src_image and dst_image must be compatible. Formats are considered compatible if their texel
3243 // size in bytes is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT
3244 // because because both texels are 4 bytes in size.
3245 if (!FormatIsMultiplane(src_format) && !FormatIsMultiplane(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003246 const char *compatible_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003247 IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
Tony-LunarGb61514a2021-11-02 12:36:51 -06003248 ? (is_2 ? "VUID-VkCopyImageInfo2-srcImage-01548" : "VUID-vkCmdCopyImage-srcImage-01548")
3249 : (is_2 ? "VUID-VkCopyImageInfo2-srcImage-00135" : "VUID-vkCmdCopyImage-srcImage-00135");
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003250 // Depth/stencil formats must match exactly.
3251 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3252 if (src_format != dst_format) {
3253 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003254 "%s: Depth/stencil formats must match exactly for src (%s) and dst (%s).", func_name,
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003255 string_VkFormat(src_format), string_VkFormat(dst_format));
3256 }
3257 } else {
Jeff Leger178b1e52020-10-05 12:22:23 -04003258 if (FormatElementSize(src_format) != FormatElementSize(dst_format)) {
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003259 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003260 "%s: Unmatched image format sizes. "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06003261 "The src format %s has size of %" PRIu32 " and dst format %s has size of %" PRIu32 ".",
Jeff Leger178b1e52020-10-05 12:22:23 -04003262 func_name, string_VkFormat(src_format), FormatElementSize(src_format), string_VkFormat(dst_format),
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003263 FormatElementSize(dst_format));
3264 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003265 }
3266 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003267
Dave Houlton33c22b72017-02-28 13:16:02 -07003268 // Source and dest image sample counts must match
3269 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003270 std::stringstream ss;
3271 ss << func_name << " called on image pair with non-identical sample counts.";
Tony-LunarGb61514a2021-11-02 12:36:51 -06003272 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-00136" : "VUID-vkCmdCopyImage-srcImage-00136";
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08003273 skip |=
3274 LogError(command_buffer, vuid, "%s: The src image sample count (%s) dose not match the dst image sample count (%s).",
3275 func_name, string_VkSampleCountFlagBits(src_image_state->createInfo.samples),
3276 string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Dave Houlton33c22b72017-02-28 13:16:02 -07003277 }
3278
sfricke-samsung45996a42021-09-16 13:45:27 -07003279 vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
Tony-LunarGb61514a2021-11-02 12:36:51 -06003280 ? (is_2 ? "VUID-VkCopyImageInfo2-srcImage-01546" : "VUID-vkCmdCopyImage-srcImage-01546")
3281 : (is_2 ? "VUID-VkCopyImageInfo2-srcImage-00127" : "VUID-vkCmdCopyImage-srcImage-00127");
Jeremy Gebben9f537102021-10-05 16:37:12 -06003282 skip |= ValidateMemoryIsBoundToImage(src_image_state.get(), func_name, vuid);
sfricke-samsung45996a42021-09-16 13:45:27 -07003283 vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
Tony-LunarGb61514a2021-11-02 12:36:51 -06003284 ? (is_2 ? "VUID-VkCopyImageInfo2-dstImage-01547" : "VUID-vkCmdCopyImage-dstImage-01547")
3285 : (is_2 ? "VUID-VkCopyImageInfo2-dstImage-00132" : "VUID-vkCmdCopyImage-dstImage-00132");
Jeremy Gebben9f537102021-10-05 16:37:12 -06003286 skip |= ValidateMemoryIsBoundToImage(dst_image_state.get(), func_name, vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003287 // Validate that SRC & DST images have correct usage flags set
Tony-LunarGb61514a2021-11-02 12:36:51 -06003288 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-00126" : "VUID-vkCmdCopyImage-srcImage-00126";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003289 skip |= ValidateImageUsageFlags(src_image_state.get(), VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04003290 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tony-LunarGb61514a2021-11-02 12:36:51 -06003291 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-00131" : "VUID-vkCmdCopyImage-dstImage-00131";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003292 skip |= ValidateImageUsageFlags(dst_image_state.get(), VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04003293 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Tony-LunarGb61514a2021-11-02 12:36:51 -06003294 vuid = is_2 ? "VUID-vkCmdCopyImage2-commandBuffer-01825" : "VUID-vkCmdCopyImage-commandBuffer-01825";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003295 skip |= ValidateProtectedImage(cb_node.get(), src_image_state.get(), func_name, vuid);
Tony-LunarGb61514a2021-11-02 12:36:51 -06003296 vuid = is_2 ? "VUID-vkCmdCopyImage2-commandBuffer-01826" : "VUID-vkCmdCopyImage-commandBuffer-01826";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003297 skip |= ValidateProtectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
Tony-LunarGb61514a2021-11-02 12:36:51 -06003298 vuid = is_2 ? "VUID-vkCmdCopyImage2-commandBuffer-01827" : "VUID-vkCmdCopyImage-commandBuffer-01827";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003299 skip |= ValidateUnprotectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003300
3301 // Validation for VK_EXT_fragment_density_map
3302 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003303 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
Jeff Leger178b1e52020-10-05 12:22:23 -04003304 skip |=
3305 LogError(command_buffer, vuid,
3306 "%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 +02003307 }
3308 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003309 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
Jeff Leger178b1e52020-10-05 12:22:23 -04003310 skip |=
3311 LogError(command_buffer, vuid,
3312 "%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 +02003313 }
3314
sfricke-samsung45996a42021-09-16 13:45:27 -07003315 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Tony-LunarGb61514a2021-11-02 12:36:51 -06003316 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImage-01995" : "VUID-vkCmdCopyImage-srcImage-01995";
3317 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(), VK_FORMAT_FEATURE_2_TRANSFER_SRC_BIT, func_name, vuid);
3318 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImage-01996" : "VUID-vkCmdCopyImage-dstImage-01996";
3319 skip |= ValidateImageFormatFeatureFlags(dst_image_state.get(), VK_FORMAT_FEATURE_2_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003320 }
Jeremy Gebben9f537102021-10-05 16:37:12 -06003321 skip |= ValidateCmd(cb_node.get(), cmd_type);
Tobin Ehlisc8266452017-04-07 12:20:30 -06003322 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04003323
3324 const char *invalid_src_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003325 (src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Tony-LunarGb61514a2021-11-02 12:36:51 -06003326 ? (is_2 ? "VUID-VkCopyImageInfo2-srcImageLayout-01917" : "VUID-vkCmdCopyImage-srcImageLayout-01917")
3327 : (is_2 ? "VUID-VkCopyImageInfo2-srcImageLayout-00129" : "VUID-vkCmdCopyImage-srcImageLayout-00129");
Jeff Leger178b1e52020-10-05 12:22:23 -04003328 const char *invalid_dst_layout_vuid =
sfricke-samsung45996a42021-09-16 13:45:27 -07003329 (dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Tony-LunarGb61514a2021-11-02 12:36:51 -06003330 ? (is_2 ? "VUID-VkCopyImageInfo2-dstImageLayout-01395" : "VUID-vkCmdCopyImage-dstImageLayout-01395")
3331 : (is_2 ? "VUID-VkCopyImageInfo2-dstImageLayout-00134" : "VUID-vkCmdCopyImage-dstImageLayout-00134");
Jeff Leger178b1e52020-10-05 12:22:23 -04003332
aitor-lunargd0d85e12022-01-28 16:56:49 +01003333 bool same_image = (src_image_state == dst_image_state);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003334 for (uint32_t i = 0; i < regionCount; ++i) {
aitor-lunargd0d85e12022-01-28 16:56:49 +01003335 // When performing copy from and to same subresource, VK_IMAGE_LAYOUT_GENERAL is the only option
sfricke-samsung71f04e32022-03-16 01:21:21 -05003336 const RegionType region = pRegions[i];
3337 const auto &src_sub = region.srcSubresource;
3338 const auto &dst_sub = region.dstSubresource;
aitor-lunargd0d85e12022-01-28 16:56:49 +01003339 bool same_subresource =
3340 (same_image && (src_sub.mipLevel == dst_sub.mipLevel) && (src_sub.baseArrayLayer == dst_sub.baseArrayLayer));
3341 VkImageLayout source_optimal = (same_subresource ? VK_IMAGE_LAYOUT_GENERAL : VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL);
3342 VkImageLayout destination_optimal = (same_subresource ? VK_IMAGE_LAYOUT_GENERAL : VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL);
Tony-LunarGb61514a2021-11-02 12:36:51 -06003343 vuid = is_2 ? "VUID-VkCopyImageInfo2-srcImageLayout-00128" : "VUID-vkCmdCopyImage-srcImageLayout-00128";
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06003344 skip |= VerifyImageLayout(*cb_node, *src_image_state, region.srcSubresource, srcImageLayout, source_optimal, func_name,
3345 invalid_src_layout_vuid, vuid, &hit_error);
Tony-LunarGb61514a2021-11-02 12:36:51 -06003346 vuid = is_2 ? "VUID-VkCopyImageInfo2-dstImageLayout-00133" : "VUID-vkCmdCopyImage-dstImageLayout-00133";
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06003347 skip |= VerifyImageLayout(*cb_node, *dst_image_state, region.dstSubresource, dstImageLayout, destination_optimal, func_name,
3348 invalid_dst_layout_vuid, vuid, &hit_error);
Jeremy Gebben9f537102021-10-05 16:37:12 -06003349 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node.get(), src_image_state.get(), dst_image_state.get(),
sfricke-samsung71f04e32022-03-16 01:21:21 -05003350 &region, i, func_name, cmd_type);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003351 }
3352
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003353 return skip;
3354}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003355
Jeff Leger178b1e52020-10-05 12:22:23 -04003356bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3357 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3358 const VkImageCopy *pRegions) const {
3359 return ValidateCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
Tony-LunarGb61514a2021-11-02 12:36:51 -06003360 CMD_COPYIMAGE);
Jeff Leger178b1e52020-10-05 12:22:23 -04003361}
3362
3363bool CoreChecks::PreCallValidateCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) const {
3364 return ValidateCmdCopyImage(commandBuffer, pCopyImageInfo->srcImage, pCopyImageInfo->srcImageLayout, pCopyImageInfo->dstImage,
3365 pCopyImageInfo->dstImageLayout, pCopyImageInfo->regionCount, pCopyImageInfo->pRegions,
Tony-LunarGb61514a2021-11-02 12:36:51 -06003366 CMD_COPYIMAGE2KHR);
3367}
3368
3369bool CoreChecks::PreCallValidateCmdCopyImage2(VkCommandBuffer commandBuffer, const VkCopyImageInfo2 *pCopyImageInfo) const {
3370 return ValidateCmdCopyImage(commandBuffer, pCopyImageInfo->srcImage, pCopyImageInfo->srcImageLayout, pCopyImageInfo->dstImage,
3371 pCopyImageInfo->dstImageLayout, pCopyImageInfo->regionCount, pCopyImageInfo->pRegions,
3372 CMD_COPYIMAGE2);
Jeff Leger178b1e52020-10-05 12:22:23 -04003373}
3374
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003375void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3376 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3377 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003378 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3379 pRegions);
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07003380 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003381 auto src_image_state = Get<IMAGE_STATE>(srcImage);
3382 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003383
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003384 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003385 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06003386 cb_node->SetImageInitialLayout(*src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3387 cb_node->SetImageInitialLayout(*dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003388 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003389}
3390
sfricke-samsungd750f812022-02-04 10:23:34 -08003391void CoreChecks::RecordCmdCopyImage2(VkCommandBuffer commandBuffer, const VkCopyImageInfo2 *pCopyImageInfo) {
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07003392 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003393 auto src_image_state = Get<IMAGE_STATE>(pCopyImageInfo->srcImage);
3394 auto dst_image_state = Get<IMAGE_STATE>(pCopyImageInfo->dstImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04003395
3396 // Make sure that all image slices are updated to correct layout
3397 for (uint32_t i = 0; i < pCopyImageInfo->regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06003398 cb_node->SetImageInitialLayout(*src_image_state, pCopyImageInfo->pRegions[i].srcSubresource,
3399 pCopyImageInfo->srcImageLayout);
3400 cb_node->SetImageInitialLayout(*dst_image_state, pCopyImageInfo->pRegions[i].dstSubresource,
3401 pCopyImageInfo->dstImageLayout);
Jeff Leger178b1e52020-10-05 12:22:23 -04003402 }
3403}
3404
Tony-LunarGb61514a2021-11-02 12:36:51 -06003405void CoreChecks::PreCallRecordCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) {
3406 StateTracker::PreCallRecordCmdCopyImage2KHR(commandBuffer, pCopyImageInfo);
3407 RecordCmdCopyImage2(commandBuffer, pCopyImageInfo);
3408}
3409
3410void CoreChecks::PreCallRecordCmdCopyImage2(VkCommandBuffer commandBuffer, const VkCopyImageInfo2 *pCopyImageInfo) {
3411 StateTracker::PreCallRecordCmdCopyImage2(commandBuffer, pCopyImageInfo);
3412 RecordCmdCopyImage2(commandBuffer, pCopyImageInfo);
3413}
3414
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003415// Returns true if sub_rect is entirely contained within rect
3416static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
3417 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 -07003418 (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 -07003419 return false;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003420 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003421 return true;
3422}
3423
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003424bool CoreChecks::ValidateClearAttachmentExtent(const CMD_BUFFER_STATE &cb_node, uint32_t attachment_index,
amhagana448ea52021-11-02 14:09:14 -04003425 const IMAGE_VIEW_STATE* image_view_state,
3426 const VkRect2D &render_area, uint32_t rect_count, const VkClearRect *clear_rects) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07003427 bool skip = false;
John Zulauf3a548ef2019-02-01 16:14:07 -07003428
3429 for (uint32_t j = 0; j < rect_count; j++) {
3430 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003431 skip |= LogError(cb_node.Handle(), "VUID-vkCmdClearAttachments-pRects-00016",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003432 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
3433 "the current render pass instance.",
3434 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07003435 }
3436
3437 if (image_view_state) {
3438 // The layers specified by a given element of pRects must be contained within every attachment that
3439 // pAttachments refers to
ziga-lunargff6485c2021-10-08 18:18:32 +02003440 const uint32_t attachment_layer_count = image_view_state->GetAttachmentLayerCount();
John Zulauf3a548ef2019-02-01 16:14:07 -07003441 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
3442 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003443 skip |= LogError(cb_node.Handle(), "VUID-vkCmdClearAttachments-pRects-00017",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003444 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
3445 "of pAttachment[%d].",
3446 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07003447 }
3448 }
3449 }
3450 return skip;
3451}
3452
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003453bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3454 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003455 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003456 bool skip = false;
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07003457 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Petr Kraus2dffb382019-08-10 02:52:12 +02003458 if (!cb_node) return skip;
3459
Jeremy Gebben9f537102021-10-05 16:37:12 -06003460 skip |= ValidateCmd(cb_node.get(), CMD_CLEARATTACHMENTS);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003461
3462 // Validate that attachment is in reference list of active subpass
3463 if (cb_node->activeRenderPass) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08003464 const VkRenderPassCreateInfo2 *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07003465 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Mike Schuchardt2df08912020-12-15 16:28:09 -08003466 const VkSubpassDescription2 *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
locke-lunargaecf2152020-05-12 17:15:41 -06003467 const auto *framebuffer = cb_node->activeFramebuffer.get();
Aaron Hagan1656b2b2021-12-21 11:52:41 -05003468 const auto &render_area = (cb_node->activeRenderPass->use_dynamic_rendering) ?
3469 cb_node->activeRenderPass->dynamic_rendering_begin_rendering_info.renderArea :
3470 cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003471
John Zulauf3a548ef2019-02-01 16:14:07 -07003472 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3473 auto clear_desc = &pAttachments[attachment_index];
3474 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003475 const VkImageAspectFlags aspect_mask = clear_desc->aspectMask;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003476
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003477 if (aspect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
3478 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020",
3479 "vkCmdClearAttachments() pAttachments[%u] mask contains VK_IMAGE_ASPECT_METADATA_BIT",
3480 attachment_index);
3481 } else if (aspect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
3482 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
3483 skip |=
3484 LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-02246",
3485 "vkCmdClearAttachments() pAttachments[%u] mask contains a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit",
3486 attachment_index);
3487 } else if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07003488 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
Aaron Haganc6bafff2021-11-29 23:30:07 -05003489 if (subpass_desc) {
amhagana448ea52021-11-02 14:09:14 -04003490 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
3491 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3492 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
3493 skip |= LogError(
3494 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3495 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
3496 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
3497 attachment_index, clear_desc->colorAttachment,
3498 report_data->FormatHandle(cb_node->activeRenderPass->renderPass()).c_str(), cb_node->activeSubpass,
3499 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07003500
amhagana448ea52021-11-02 14:09:14 -04003501 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
3502 }
3503 } else {
3504 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3505 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
3506 " subpass %u. colorAttachmentCount=%u",
3507 attachment_index, clear_desc->colorAttachment,
3508 report_data->FormatHandle(cb_node->activeRenderPass->renderPass()).c_str(),
3509 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
John Zulauff2582972019-02-09 14:53:30 -07003510 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003511 }
John Zulauff2582972019-02-09 14:53:30 -07003512 fb_attachment = color_attachment;
3513
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003514 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
3515 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
3516 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019",
3517 "vkCmdClearAttachments() pAttachments[%u] aspectMask must set only VK_IMAGE_ASPECT_COLOR_BIT "
3518 "of a color attachment.",
3519 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003520 }
3521 } else { // Must be depth and/or stencil
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003522 bool subpass_depth = false;
3523 bool subpass_stencil = false;
amhagana448ea52021-11-02 14:09:14 -04003524 if (subpass_desc) {
3525 if (subpass_desc->pDepthStencilAttachment &&
3526 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3527 auto index = subpass_desc->pDepthStencilAttachment->attachment;
3528 subpass_depth = FormatHasDepth(renderpass_create_info->pAttachments[index].format);
3529 subpass_stencil = FormatHasStencil(renderpass_create_info->pAttachments[index].format);
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003530 }
amhagana448ea52021-11-02 14:09:14 -04003531 if (!subpass_desc->pDepthStencilAttachment ||
3532 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3533 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) && !subpass_depth) {
3534 skip |= LogError(
3535 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02502",
3536 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_DEPTH_BIT but there is no "
3537 "depth attachment in subpass",
3538 attachment_index);
3539 }
3540 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) && !subpass_stencil) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003541 skip |= LogError(
3542 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02503",
3543 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_STENCIL_BIT but there is no "
amhagana448ea52021-11-02 14:09:14 -04003544 "stencil attachment in subpass",
3545 attachment_index);
3546 }
3547 } else {
3548 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003549 }
amhagana448ea52021-11-02 14:09:14 -04003550 if (subpass_depth) {
3551 skip |= ValidateClearDepthStencilValue(commandBuffer, clear_desc->clearValue.depthStencil,
3552 "vkCmdClearAttachments()");
3553 }
sfricke-samsung03f11ef2021-01-23 02:02:15 -08003554 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003555 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003556 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
amhagana448ea52021-11-02 14:09:14 -04003557 const IMAGE_VIEW_STATE* image_view_state = nullptr;
3558 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
3559 image_view_state = cb_node->GetActiveAttachmentImageViewState(fb_attachment);
3560 }
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003561 skip |= ValidateClearAttachmentExtent(*cb_node, attachment_index, image_view_state, render_area,
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003562 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06003563 }
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003564
3565 // Once the framebuffer attachment is found, can get the image view state
3566 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) &&
3567 (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003568 const auto *image_view_state = cb_node->GetActiveAttachmentImageViewState(fb_attachment);
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003569 if (image_view_state != nullptr) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06003570 skip |= ValidateProtectedImage(cb_node.get(), image_view_state->image_state.get(), "vkCmdClearAttachments()",
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003571 "VUID-vkCmdClearAttachments-commandBuffer-02504");
Jeremy Gebben9f537102021-10-05 16:37:12 -06003572 skip |= ValidateUnprotectedImage(cb_node.get(), image_view_state->image_state.get(), "vkCmdClearAttachments()",
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003573 "VUID-vkCmdClearAttachments-commandBuffer-02505");
3574 }
3575 }
ziga-lunargfa335aa2021-08-05 16:59:39 +02003576
amhagana448ea52021-11-02 14:09:14 -04003577 // When a subpass uses a non-zero view mask, multiview functionality is considered to be enabled
3578 if (subpass_desc && (subpass_desc->viewMask > 0)) {
3579 for (uint32_t i = 0; i < rectCount; ++i) {
3580 if (pRects[i].baseArrayLayer != 0 || pRects[i].layerCount != 1) {
3581 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-baseArrayLayer-00018",
3582 "vkCmdClearAttachments(): pRects[%" PRIu32 "] baseArrayLayer is %" PRIu32
3583 " and layerCount is %" PRIu32 ", but the render pass instance uses multiview.",
3584 i, pRects[i].baseArrayLayer, pRects[i].layerCount);
3585 }
ziga-lunargfa335aa2021-08-05 16:59:39 +02003586 }
3587 }
3588 }
John Zulauf441558b2019-08-12 11:47:39 -06003589 }
3590 return skip;
3591}
3592
3593void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3594 const VkClearAttachment *pAttachments, uint32_t rectCount,
3595 const VkClearRect *pRects) {
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07003596 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
John Zulauf441558b2019-08-12 11:47:39 -06003597 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
John Zulauf441558b2019-08-12 11:47:39 -06003598 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
Aaron Haganc6bafff2021-11-29 23:30:07 -05003599 if (cb_node->activeRenderPass->use_dynamic_rendering_inherited) {
3600 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3601 const auto clear_desc = &pAttachments[attachment_index];
3602 auto colorAttachmentCount = cb_node->activeRenderPass->inheritance_rendering_info.colorAttachmentCount;
3603 int image_index = -1;
3604 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3605 (clear_desc->colorAttachment < colorAttachmentCount)) {
3606 image_index = cb_node->GetDynamicColorAttachmentImageIndex(clear_desc->colorAttachment);
3607 }
3608 else if (clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT)) {
3609 image_index = cb_node->GetDynamicDepthAttachmentImageIndex();
3610 }
3611 else if (clear_desc->aspectMask & (VK_IMAGE_ASPECT_STENCIL_BIT)) {
3612 image_index = cb_node->GetDynamicStencilAttachmentImageIndex();
3613 }
amhagana448ea52021-11-02 14:09:14 -04003614
Aaron Haganc6bafff2021-11-29 23:30:07 -05003615 if (image_index != -1) {
3616 if (!clear_rect_copy) {
3617 // We need a copy of the clear rectangles that will persist until the last lambda executes
3618 // but we want to create it as lazily as possible
3619 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
amhagana448ea52021-11-02 14:09:14 -04003620 }
Aaron Haganc6bafff2021-11-29 23:30:07 -05003621 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3622 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
3623 auto val_fn = [this, attachment_index, image_index, rectCount, clear_rect_copy](
3624 const CMD_BUFFER_STATE &secondary, const CMD_BUFFER_STATE *prim_cb,
3625 const FRAMEBUFFER_STATE *fb) {
3626 assert(rectCount == clear_rect_copy->size());
3627 bool skip = false;
3628 const IMAGE_VIEW_STATE* image_view_state = nullptr;
3629 if (image_index != -1) {
3630 image_view_state = (*prim_cb->active_attachments)[image_index];
3631 }
3632 skip = ValidateClearAttachmentExtent(secondary, attachment_index, image_view_state,
3633 prim_cb->activeRenderPass->dynamic_rendering_begin_rendering_info.renderArea,
3634 rectCount, clear_rect_copy->data());
3635 return skip;
3636 };
3637 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003638 }
amhagana448ea52021-11-02 14:09:14 -04003639 }
3640 }
Aaron Haganc6bafff2021-11-29 23:30:07 -05003641 else if (cb_node->activeRenderPass->use_dynamic_rendering == false)
amhagana448ea52021-11-02 14:09:14 -04003642 {
3643 const VkRenderPassCreateInfo2* renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3644 const VkSubpassDescription2* subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
sfricke-samsung21286f82021-11-16 08:21:46 -08003645
amhagana448ea52021-11-02 14:09:14 -04003646 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3647 const auto clear_desc = &pAttachments[attachment_index];
3648 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3649 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3650 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3651 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3652 }
3653 else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3654 subpass_desc->pDepthStencilAttachment) {
3655 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3656 }
3657 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
3658 if (!clear_rect_copy) {
3659 // We need a copy of the clear rectangles that will persist until the last lambda executes
3660 // but we want to create it as lazily as possible
3661 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
3662 }
3663 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3664 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003665 auto val_fn = [this, attachment_index, fb_attachment, rectCount, clear_rect_copy](
3666 const CMD_BUFFER_STATE &secondary, const CMD_BUFFER_STATE *prim_cb,
3667 const FRAMEBUFFER_STATE *fb) {
amhagana448ea52021-11-02 14:09:14 -04003668 assert(rectCount == clear_rect_copy->size());
3669 const auto& render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3670 bool skip = false;
3671 const IMAGE_VIEW_STATE* image_view_state = nullptr;
3672 if (fb && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < fb->createInfo.attachmentCount)) {
3673 image_view_state = prim_cb->GetActiveAttachmentImageViewState(fb_attachment);
3674 }
Jeremy Gebben057f9d52021-11-05 14:12:31 -06003675 skip = ValidateClearAttachmentExtent(secondary, attachment_index, image_view_state, render_area, rectCount,
3676 clear_rect_copy->data());
amhagana448ea52021-11-02 14:09:14 -04003677 return skip;
3678 };
3679 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
3680 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003681 }
3682 }
3683 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003684}
3685
Jeff Leger178b1e52020-10-05 12:22:23 -04003686template <typename RegionType>
3687bool CoreChecks::ValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3688 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Tony-LunarG562fc102021-11-12 13:58:35 -07003689 const RegionType *pRegions, CMD_TYPE cmd_type) const {
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07003690 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07003691 auto src_image_state = Get<IMAGE_STATE>(srcImage);
3692 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Tony-LunarG562fc102021-11-12 13:58:35 -07003693 const bool is_2 = (cmd_type == CMD_RESOLVEIMAGE2KHR || cmd_type == CMD_RESOLVEIMAGE2);
sfricke-samsung85584a72021-09-30 21:43:38 -07003694 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04003695 const char *vuid;
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003696
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003697 bool skip = false;
3698 if (cb_node && src_image_state && dst_image_state) {
Tony-LunarG562fc102021-11-12 13:58:35 -07003699 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-00256" : "VUID-vkCmdResolveImage-srcImage-00256";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003700 skip |= ValidateMemoryIsBoundToImage(src_image_state.get(), func_name, vuid);
Tony-LunarG562fc102021-11-12 13:58:35 -07003701 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-00258" : "VUID-vkCmdResolveImage-dstImage-00258";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003702 skip |= ValidateMemoryIsBoundToImage(dst_image_state.get(), func_name, vuid);
3703 skip |= ValidateCmd(cb_node.get(), cmd_type);
Tony-LunarG562fc102021-11-12 13:58:35 -07003704 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-02003" : "VUID-vkCmdResolveImage-dstImage-02003";
3705 skip |= ValidateImageFormatFeatureFlags(dst_image_state.get(), VK_FORMAT_FEATURE_2_COLOR_ATTACHMENT_BIT, func_name, vuid);
3706 vuid = is_2 ? "VUID-vkCmdResolveImage2-commandBuffer-01837" : "VUID-vkCmdResolveImage-commandBuffer-01837";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003707 skip |= ValidateProtectedImage(cb_node.get(), src_image_state.get(), func_name, vuid);
Tony-LunarG562fc102021-11-12 13:58:35 -07003708 vuid = is_2 ? "VUID-vkCmdResolveImage2-commandBuffer-01838" : "VUID-vkCmdResolveImage-commandBuffer-01838";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003709 skip |= ValidateProtectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
Tony-LunarG562fc102021-11-12 13:58:35 -07003710 vuid = is_2 ? "VUID-vkCmdResolveImage2-commandBuffer-01839" : "VUID-vkCmdResolveImage-commandBuffer-01839";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003711 skip |= ValidateUnprotectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
ziga-lunarg73154fd2022-05-18 14:36:33 +02003712 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-06762" : "VUID-vkCmdResolveImage-srcImage-06762";
3713 skip |= ValidateImageUsageFlags(src_image_state.get(), VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3714 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3715 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-06763" : "VUID-vkCmdResolveImage-srcImage-06763";
3716 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(), VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
3717 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-06764" : "VUID-vkCmdResolveImage-dstImage-06764";
3718 skip |= ValidateImageUsageFlags(dst_image_state.get(), VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3719 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3720 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-06765" : "VUID-vkCmdResolveImage-dstImage-06765";
3721 skip |= ValidateImageFormatFeatureFlags(dst_image_state.get(), VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003722
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003723 // Validation for VK_EXT_fragment_density_map
3724 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony-LunarG562fc102021-11-12 13:58:35 -07003725 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003726 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003727 "%s: srcImage must not have been created with flags containing "
3728 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3729 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003730 }
3731 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony-LunarG562fc102021-11-12 13:58:35 -07003732 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003733 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003734 "%s: dstImage must not have been created with flags containing "
3735 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3736 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003737 }
3738
Cort Stratton7df30962018-05-17 19:45:57 -07003739 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003740 const char *invalid_src_layout_vuid =
Tony-LunarG562fc102021-11-12 13:58:35 -07003741 is_2 ? ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
3742 ? "VUID-VkResolveImageInfo2-srcImageLayout-01400"
3743 : "VUID-VkResolveImageInfo2-srcImageLayout-00261")
sfricke-samsung45996a42021-09-16 13:45:27 -07003744 : ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003745 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3746 : "VUID-vkCmdResolveImage-srcImageLayout-00261");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003747 const char *invalid_dst_layout_vuid =
Tony-LunarG562fc102021-11-12 13:58:35 -07003748 is_2 ? ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
3749 ? "VUID-VkResolveImageInfo2-dstImageLayout-01401"
3750 : "VUID-VkResolveImageInfo2-dstImageLayout-00263")
sfricke-samsung45996a42021-09-16 13:45:27 -07003751 : ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04003752 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3753 : "VUID-vkCmdResolveImage-dstImageLayout-00263");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003754 // For each region, the number of layers in the image subresource should not be zero
3755 // For each region, src and dest image aspect must be color only
3756 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003757 const RegionType region = pRegions[i];
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003758 const VkImageSubresourceLayers src_subresource = region.srcSubresource;
3759 const VkImageSubresourceLayers dst_subresource = region.dstSubresource;
Tony-LunarG562fc102021-11-12 13:58:35 -07003760
Jeremy Gebben9f537102021-10-05 16:37:12 -06003761 skip |= ValidateImageSubresourceLayers(cb_node.get(), &src_subresource, func_name, "srcSubresource", i);
3762 skip |= ValidateImageSubresourceLayers(cb_node.get(), &dst_subresource, func_name, "dstSubresource", i);
Tony-LunarG562fc102021-11-12 13:58:35 -07003763 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImageLayout-00260" : "VUID-vkCmdResolveImage-srcImageLayout-00260";
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06003764 skip |= VerifyImageLayout(*cb_node, *src_image_state, src_subresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003765 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
Tony-LunarG562fc102021-11-12 13:58:35 -07003766 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImageLayout-00262" : "VUID-vkCmdResolveImage-dstImageLayout-00262";
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06003767 skip |= VerifyImageLayout(*cb_node, *dst_image_state, dst_subresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003768 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
Tony-LunarG562fc102021-11-12 13:58:35 -07003769 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcSubresource-01709" : "VUID-vkCmdResolveImage-srcSubresource-01709";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003770 skip |= ValidateImageMipLevel(cb_node.get(), src_image_state.get(), src_subresource.mipLevel, i, func_name,
3771 "srcSubresource", vuid);
Tony-LunarG562fc102021-11-12 13:58:35 -07003772 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstSubresource-01710" : "VUID-vkCmdResolveImage-dstSubresource-01710";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003773 skip |= ValidateImageMipLevel(cb_node.get(), dst_image_state.get(), dst_subresource.mipLevel, i, func_name,
3774 "dstSubresource", vuid);
Tony-LunarG562fc102021-11-12 13:58:35 -07003775 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcSubresource-01711" : "VUID-vkCmdResolveImage-srcSubresource-01711";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003776 skip |= ValidateImageArrayLayerRange(cb_node.get(), src_image_state.get(), src_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003777 src_subresource.layerCount, i, func_name, "srcSubresource", vuid);
Tony-LunarG562fc102021-11-12 13:58:35 -07003778 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstSubresource-01712" : "VUID-vkCmdResolveImage-dstSubresource-01712";
Jeremy Gebben9f537102021-10-05 16:37:12 -06003779 skip |= ValidateImageArrayLayerRange(cb_node.get(), dst_image_state.get(), dst_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003780 dst_subresource.layerCount, i, func_name, "srcSubresource", vuid);
Cort Stratton7df30962018-05-17 19:45:57 -07003781
3782 // layer counts must match
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003783 if (src_subresource.layerCount != dst_subresource.layerCount) {
Tony-LunarG562fc102021-11-12 13:58:35 -07003784 vuid = is_2 ? "VUID-VkImageResolve2-layerCount-00267" : "VUID-VkImageResolve-layerCount-00267";
Jeff Leger178b1e52020-10-05 12:22:23 -04003785 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003786 LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003787 "%s: layerCount in source and destination subresource of pRegions[%u] does not match.", func_name, i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003788 }
Cort Stratton7df30962018-05-17 19:45:57 -07003789 // For each region, src and dest image aspect must be color only
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003790 if ((src_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3791 (dst_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
Tony-LunarG562fc102021-11-12 13:58:35 -07003792 vuid = is_2 ? "VUID-VkImageResolve2-aspectMask-00266" : "VUID-VkImageResolve-aspectMask-00266";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003793 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003794 "%s: src and dest aspectMasks for pRegions[%u] must specify only VK_IMAGE_ASPECT_COLOR_BIT.",
3795 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003796 }
3797
3798 const VkImageType src_image_type = src_image_state->createInfo.imageType;
3799 const VkImageType dst_image_type = dst_image_state->createInfo.imageType;
3800
3801 if ((VK_IMAGE_TYPE_3D == src_image_type) || (VK_IMAGE_TYPE_3D == dst_image_type)) {
Shannon McPherson74b341c2020-09-08 15:43:05 -06003802 if ((0 != src_subresource.baseArrayLayer) || (1 != src_subresource.layerCount)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003803 LogObjectList objlist(cb_node->commandBuffer());
3804 objlist.add(src_image_state->image());
3805 objlist.add(dst_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003806 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-04446" : "VUID-vkCmdResolveImage-srcImage-04446";
Jeff Leger178b1e52020-10-05 12:22:23 -04003807 skip |= LogError(objlist, vuid,
3808 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
Shannon McPherson74b341c2020-09-08 15:43:05 -06003809 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003810 func_name, i);
Shannon McPherson74b341c2020-09-08 15:43:05 -06003811 }
3812 if ((0 != dst_subresource.baseArrayLayer) || (1 != dst_subresource.layerCount)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003813 LogObjectList objlist(cb_node->commandBuffer());
3814 objlist.add(src_image_state->image());
3815 objlist.add(dst_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003816 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-04447" : "VUID-vkCmdResolveImage-srcImage-04447";
Jeff Leger178b1e52020-10-05 12:22:23 -04003817 skip |= LogError(objlist, vuid,
3818 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003819 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003820 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003821 }
3822 }
3823
3824 if (VK_IMAGE_TYPE_1D == src_image_type) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05003825 if ((region.srcOffset.y != 0) || (region.extent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003826 LogObjectList objlist(cb_node->commandBuffer());
3827 objlist.add(src_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003828 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-00271" : "VUID-vkCmdResolveImage-srcImage-00271";
Jeff Leger178b1e52020-10-05 12:22:23 -04003829 skip |= LogError(objlist, vuid,
3830 "%s: srcImage (%s) is 1D but pRegions[%u] srcOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003831 "extent.height (%u) is not 1.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05003832 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.y,
3833 region.extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003834 }
3835 }
3836 if ((VK_IMAGE_TYPE_1D == src_image_type) || (VK_IMAGE_TYPE_2D == src_image_type)) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05003837 if ((region.srcOffset.z != 0) || (region.extent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003838 LogObjectList objlist(cb_node->commandBuffer());
3839 objlist.add(src_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003840 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-00273" : "VUID-vkCmdResolveImage-srcImage-00273";
Jeff Leger178b1e52020-10-05 12:22:23 -04003841 skip |= LogError(objlist, vuid,
3842 "%s: srcImage (%s) is 2D but pRegions[%u] srcOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003843 "extent.depth (%u) is not 1.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05003844 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.z,
3845 region.extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003846 }
3847 }
3848
3849 if (VK_IMAGE_TYPE_1D == dst_image_type) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05003850 if ((region.dstOffset.y != 0) || (region.extent.height != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003851 LogObjectList objlist(cb_node->commandBuffer());
3852 objlist.add(dst_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003853 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-00276" : "VUID-vkCmdResolveImage-dstImage-00276";
Jeff Leger178b1e52020-10-05 12:22:23 -04003854 skip |= LogError(objlist, vuid,
3855 "%s: dstImage (%s) is 1D but pRegions[%u] dstOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003856 "extent.height (%u) is not 1.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05003857 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.dstOffset.y,
3858 region.extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003859 }
3860 }
3861 if ((VK_IMAGE_TYPE_1D == dst_image_type) || (VK_IMAGE_TYPE_2D == dst_image_type)) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05003862 if ((region.dstOffset.z != 0) || (region.extent.depth != 1)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003863 LogObjectList objlist(cb_node->commandBuffer());
3864 objlist.add(dst_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003865 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-00278" : "VUID-vkCmdResolveImage-dstImage-00278";
Jeff Leger178b1e52020-10-05 12:22:23 -04003866 skip |= LogError(objlist, vuid,
3867 "%s: dstImage (%s) is 2D but pRegions[%u] dstOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003868 "extent.depth (%u) is not 1.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05003869 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.dstOffset.z,
3870 region.extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003871 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003872 }
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003873
3874 // Each srcImage dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003875 VkExtent3D subresource_extent = src_image_state->GetSubresourceExtent(src_subresource);
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003876 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3877 // developer
3878 if (src_subresource.mipLevel < src_image_state->createInfo.mipLevels) {
3879 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003880 if ((extent_check & kXBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003881 LogObjectList objlist(cb_node->commandBuffer());
3882 objlist.add(src_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003883 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcOffset-00269" : "VUID-vkCmdResolveImage-srcOffset-00269";
Jeff Leger178b1e52020-10-05 12:22:23 -04003884 skip |= LogError(objlist, vuid,
3885 "%s: srcImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003886 "exceeds subResource width [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003887 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003888 region.extent.width, subresource_extent.width);
3889 }
3890
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003891 if ((extent_check & kYBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003892 LogObjectList objlist(cb_node->commandBuffer());
3893 objlist.add(src_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003894 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcOffset-00270" : "VUID-vkCmdResolveImage-srcOffset-00270";
Jeff Leger178b1e52020-10-05 12:22:23 -04003895 skip |= LogError(objlist, vuid,
3896 "%s: srcImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003897 "exceeds subResource height [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003898 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003899 region.extent.height, subresource_extent.height);
3900 }
3901
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003902 if ((extent_check & kZBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003903 LogObjectList objlist(cb_node->commandBuffer());
3904 objlist.add(src_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003905 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcOffset-00272" : "VUID-vkCmdResolveImage-srcOffset-00272";
Jeff Leger178b1e52020-10-05 12:22:23 -04003906 skip |= LogError(objlist, vuid,
3907 "%s: srcImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003908 "exceeds subResource depth [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003909 func_name, report_data->FormatHandle(src_image_state->image()).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003910 region.extent.depth, subresource_extent.depth);
3911 }
3912 }
3913
3914 // Each dstImage dimension offset + extent limits must fall with image subresource extent
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06003915 subresource_extent = dst_image_state->GetSubresourceExtent(dst_subresource);
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003916 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3917 // developer
3918 if (dst_subresource.mipLevel < dst_image_state->createInfo.mipLevels) {
3919 uint32_t extent_check = ExceedsBounds(&(region.dstOffset), &(region.extent), &subresource_extent);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003920 if ((extent_check & kXBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003921 LogObjectList objlist(cb_node->commandBuffer());
3922 objlist.add(dst_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003923 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstOffset-00274" : "VUID-vkCmdResolveImage-dstOffset-00274";
Jeff Leger178b1e52020-10-05 12:22:23 -04003924 skip |= LogError(objlist, vuid,
3925 "%s: dstImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003926 "exceeds subResource width [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003927 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003928 region.extent.width, subresource_extent.width);
3929 }
3930
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003931 if ((extent_check & kYBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003932 LogObjectList objlist(cb_node->commandBuffer());
3933 objlist.add(dst_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003934 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstOffset-00275" : "VUID-vkCmdResolveImage-dstOffset-00275";
Jeff Leger178b1e52020-10-05 12:22:23 -04003935 skip |= LogError(objlist, vuid,
3936 "%s: dstImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003937 "exceeds subResource height [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003938 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003939 region.extent.height, subresource_extent.height);
3940 }
3941
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003942 if ((extent_check & kZBit) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003943 LogObjectList objlist(cb_node->commandBuffer());
3944 objlist.add(dst_image_state->image());
Tony-LunarG562fc102021-11-12 13:58:35 -07003945 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstOffset-00277" : "VUID-vkCmdResolveImage-dstOffset-00277";
Jeff Leger178b1e52020-10-05 12:22:23 -04003946 skip |= LogError(objlist, vuid,
3947 "%s: dstImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003948 "exceeds subResource depth [%u].",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003949 func_name, report_data->FormatHandle(dst_image_state->image()).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003950 region.extent.depth, subresource_extent.depth);
3951 }
3952 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003953 }
3954
3955 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
Tony-LunarG562fc102021-11-12 13:58:35 -07003956 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-01386" : "VUID-vkCmdResolveImage-srcImage-01386";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003957 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 -04003958 func_name, string_VkFormat(src_image_state->createInfo.format),
3959 string_VkFormat(dst_image_state->createInfo.format));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003960 }
3961 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003962 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_MismatchedImageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04003963 "%s: srcImage type (%s) and dstImage type (%s) are not the same.", func_name,
sfricke-samsungc26350e2020-05-30 12:31:31 -07003964 string_VkImageType(src_image_state->createInfo.imageType),
3965 string_VkImageType(dst_image_state->createInfo.imageType));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003966 }
3967 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
Tony-LunarG562fc102021-11-12 13:58:35 -07003968 vuid = is_2 ? "VUID-VkResolveImageInfo2-srcImage-00257" : "VUID-vkCmdResolveImage-srcImage-00257";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003969 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 -07003970 }
3971 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
Tony-LunarG562fc102021-11-12 13:58:35 -07003972 vuid = is_2 ? "VUID-VkResolveImageInfo2-dstImage-00259" : "VUID-vkCmdResolveImage-dstImage-00259";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003973 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 -04003974 func_name, string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003975 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003976 } else {
3977 assert(0);
3978 }
3979 return skip;
3980}
3981
Jeff Leger178b1e52020-10-05 12:22:23 -04003982bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3983 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3984 const VkImageResolve *pRegions) const {
3985 return ValidateCmdResolveImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
Tony-LunarG562fc102021-11-12 13:58:35 -07003986 CMD_RESOLVEIMAGE);
Jeff Leger178b1e52020-10-05 12:22:23 -04003987}
3988
3989bool CoreChecks::PreCallValidateCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
3990 const VkResolveImageInfo2KHR *pResolveImageInfo) const {
3991 return ValidateCmdResolveImage(commandBuffer, pResolveImageInfo->srcImage, pResolveImageInfo->srcImageLayout,
3992 pResolveImageInfo->dstImage, pResolveImageInfo->dstImageLayout, pResolveImageInfo->regionCount,
Tony-LunarG562fc102021-11-12 13:58:35 -07003993 pResolveImageInfo->pRegions, CMD_RESOLVEIMAGE2KHR);
3994}
3995
3996bool CoreChecks::PreCallValidateCmdResolveImage2(VkCommandBuffer commandBuffer,
3997 const VkResolveImageInfo2 *pResolveImageInfo) const {
3998 return ValidateCmdResolveImage(commandBuffer, pResolveImageInfo->srcImage, pResolveImageInfo->srcImageLayout,
3999 pResolveImageInfo->dstImage, pResolveImageInfo->dstImageLayout, pResolveImageInfo->regionCount,
4000 pResolveImageInfo->pRegions, CMD_RESOLVEIMAGE2);
Jeff Leger178b1e52020-10-05 12:22:23 -04004001}
4002
4003template <typename RegionType>
4004bool CoreChecks::ValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4005 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Tony-LunarG542ae912021-11-04 16:06:44 -06004006 const RegionType *pRegions, VkFilter filter, CMD_TYPE cmd_type) const {
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07004007 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07004008 auto src_image_state = Get<IMAGE_STATE>(srcImage);
4009 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Tony-LunarG542ae912021-11-04 16:06:44 -06004010 const bool is_2 = (cmd_type == CMD_BLITIMAGE2KHR || cmd_type == CMD_BLITIMAGE2);
sfricke-samsung85584a72021-09-30 21:43:38 -07004011 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04004012
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004013 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07004014 if (cb_node) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06004015 skip |= ValidateCmd(cb_node.get(), cmd_type);
John Zulauf5c2750c2018-01-30 15:04:56 -07004016 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004017 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004018 const char *vuid;
Tony-LunarG542ae912021-11-04 16:06:44 -06004019 std::string loc_head = std::string(func_name);
4020 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00233" : "VUID-vkCmdBlitImage-srcImage-00233";
4021 const char *location1 = is_2 ? loc_head.append("(): pBlitImageInfo->srcImage").c_str() : "vkCmdBlitImage(): srcImage";
4022 skip |= ValidateImageSampleCount(src_image_state.get(), VK_SAMPLE_COUNT_1_BIT, location1, vuid);
4023 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-00234" : "VUID-vkCmdBlitImage-dstImage-00234";
4024 loc_head = std::string(func_name);
4025 const char *location2 = is_2 ? loc_head.append("(): pBlitImageInfo->dstImage").c_str() : "vkCmdBlitImage(): dstImage";
4026 skip |= ValidateImageSampleCount(dst_image_state.get(), VK_SAMPLE_COUNT_1_BIT, location2, vuid);
4027 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00220" : "VUID-vkCmdBlitImage-srcImage-00220";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004028 skip |= ValidateMemoryIsBoundToImage(src_image_state.get(), func_name, vuid);
Tony-LunarG542ae912021-11-04 16:06:44 -06004029 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-00225" : "VUID-vkCmdBlitImage-dstImage-00225";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004030 skip |= ValidateMemoryIsBoundToImage(dst_image_state.get(), func_name, vuid);
Tony-LunarG542ae912021-11-04 16:06:44 -06004031 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00219" : "VUID-vkCmdBlitImage-srcImage-00219";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004032 skip |= ValidateImageUsageFlags(src_image_state.get(), VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04004033 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tony-LunarG542ae912021-11-04 16:06:44 -06004034 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-00224" : "VUID-vkCmdBlitImage-dstImage-00224";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004035 skip |= ValidateImageUsageFlags(dst_image_state.get(), VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04004036 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Jeremy Gebben9f537102021-10-05 16:37:12 -06004037 skip |= ValidateCmd(cb_node.get(), cmd_type);
Tony-LunarG542ae912021-11-04 16:06:44 -06004038 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-01999" : "VUID-vkCmdBlitImage-srcImage-01999";
4039 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(), VK_FORMAT_FEATURE_2_BLIT_SRC_BIT, func_name, vuid);
4040 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-02000" : "VUID-vkCmdBlitImage-dstImage-02000";
4041 skip |= ValidateImageFormatFeatureFlags(dst_image_state.get(), VK_FORMAT_FEATURE_2_BLIT_DST_BIT, func_name, vuid);
4042 vuid = is_2 ? "VUID-vkCmdBlitImage2-commandBuffer-01834" : "VUID-vkCmdBlitImage-commandBuffer-01834";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004043 skip |= ValidateProtectedImage(cb_node.get(), src_image_state.get(), func_name, vuid);
Tony-LunarG542ae912021-11-04 16:06:44 -06004044 vuid = is_2 ? "VUID-vkCmdBlitImage2-commandBuffer-01835" : "VUID-vkCmdBlitImage-commandBuffer-01835";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004045 skip |= ValidateProtectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
Tony-LunarG542ae912021-11-04 16:06:44 -06004046 vuid = is_2 ? "VUID-vkCmdBlitImage2-commandBuffer-01836" : "VUID-vkCmdBlitImage-commandBuffer-01836";
Jeremy Gebben9f537102021-10-05 16:37:12 -06004047 skip |= ValidateUnprotectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
sfricke-samsung022fa252020-07-24 03:26:16 -07004048
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02004049 // Validation for VK_EXT_fragment_density_map
4050 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004051 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004052 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004053 "%s: srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
4054 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02004055 }
4056 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004057 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004058 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004059 "%s: dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
4060 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02004061 }
4062
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06004063 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004064
Dave Houlton33c2d252017-06-09 17:08:32 -06004065 VkFormat src_format = src_image_state->createInfo.format;
4066 VkFormat dst_format = dst_image_state->createInfo.format;
4067 VkImageType src_type = src_image_state->createInfo.imageType;
4068 VkImageType dst_type = dst_image_state->createInfo.imageType;
4069
Cort Stratton186b1a22018-05-01 20:18:06 -04004070 if (VK_FILTER_LINEAR == filter) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004071 vuid = is_2 ? "VUID-VkBlitImageInfo2-filter-02001" : "VUID-vkCmdBlitImage-filter-02001";
4072 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(), VK_FORMAT_FEATURE_2_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Jeremy Gebben9f537102021-10-05 16:37:12 -06004073 func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04004074 } else if (VK_FILTER_CUBIC_IMG == filter) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004075 vuid = is_2 ? "VUID-VkBlitImageInfo2-filter-02002" : "VUID-vkCmdBlitImage-filter-02002";
4076 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(), VK_FORMAT_FEATURE_2_SAMPLED_IMAGE_FILTER_CUBIC_BIT,
Jeff Leger178b1e52020-10-05 12:22:23 -04004077 func_name, vuid);
Dave Houlton33c2d252017-06-09 17:08:32 -06004078 }
4079
sfricke-samsung10b35ce2021-09-29 08:50:20 -07004080 if (FormatRequiresYcbcrConversionExplicitly(src_format)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004081 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-06421" : "VUID-vkCmdBlitImage-srcImage-06421";
Jeff Leger178b1e52020-10-05 12:22:23 -04004082 skip |= LogError(device, vuid,
4083 "%s: srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004084 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04004085 func_name, string_VkFormat(src_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004086 }
4087
sfricke-samsung10b35ce2021-09-29 08:50:20 -07004088 if (FormatRequiresYcbcrConversionExplicitly(dst_format)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004089 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-06422" : "VUID-vkCmdBlitImage-dstImage-06422";
Jeff Leger178b1e52020-10-05 12:22:23 -04004090 skip |= LogError(device, vuid,
4091 "%s: dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004092 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04004093 func_name, string_VkFormat(dst_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07004094 }
4095
ziga-lunarg52604a12021-09-09 16:02:05 +02004096 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_2D != src_type)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004097 vuid = is_2 ? "VUID-VkBlitImageInfo2-filter-00237" : "VUID-vkCmdBlitImage-filter-00237";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004098 skip |= LogError(cb_node->commandBuffer(), vuid,
ziga-lunarg52604a12021-09-09 16:02:05 +02004099 "%s: source image type must be VK_IMAGE_TYPE_2D when cubic filtering is specified.", func_name);
Dave Houlton33c2d252017-06-09 17:08:32 -06004100 }
4101
Dave Houlton33c2d252017-06-09 17:08:32 -06004102 // Validate consistency for unsigned formats
sfricke-samsunge3086292021-11-18 23:02:35 -08004103 if (FormatIsUINT(src_format) != FormatIsUINT(dst_format)) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004104 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004105 ss << func_name << ": If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06004106 << "the other one must also have unsigned integer format. "
4107 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Tony-LunarG542ae912021-11-04 16:06:44 -06004108 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00230" : "VUID-vkCmdBlitImage-srcImage-00230";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004109 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004110 }
4111
4112 // Validate consistency for signed formats
sfricke-samsunge3086292021-11-18 23:02:35 -08004113 if (FormatIsSINT(src_format) != FormatIsSINT(dst_format)) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004114 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004115 ss << func_name << ": If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06004116 << "the other one must also have signed integer format. "
4117 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Tony-LunarG542ae912021-11-04 16:06:44 -06004118 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00229" : "VUID-vkCmdBlitImage-srcImage-00229";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004119 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004120 }
4121
4122 // Validate filter for Depth/Stencil formats
4123 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
4124 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004125 ss << func_name << ": If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06004126 << "then filter must be VK_FILTER_NEAREST.";
Tony-LunarG542ae912021-11-04 16:06:44 -06004127 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00232" : "VUID-vkCmdBlitImage-srcImage-00232";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004128 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004129 }
4130
4131 // Validate aspect bits and formats for depth/stencil images
4132 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
4133 if (src_format != dst_format) {
4134 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004135 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 -06004136 << "stencil, the other one must have exactly the same format. "
4137 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
4138 << string_VkFormat(dst_format);
Tony-LunarG542ae912021-11-04 16:06:44 -06004139 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00231" : "VUID-vkCmdBlitImage-srcImage-00231";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004140 skip |= LogError(cb_node->commandBuffer(), vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06004141 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004142 } // Depth or Stencil
4143
4144 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004145 const char *invalid_src_layout_vuid =
Tony-LunarG542ae912021-11-04 16:06:44 -06004146 is_2 ? ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
4147 ? "VUID-VkBlitImageInfo2-srcImageLayout-01398"
4148 : "VUID-VkBlitImageInfo2-srcImageLayout-00222")
sfricke-samsung45996a42021-09-16 13:45:27 -07004149 : ((src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04004150 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
4151 : "VUID-vkCmdBlitImage-srcImageLayout-00222");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004152 const char *invalid_dst_layout_vuid =
Tony-LunarG542ae912021-11-04 16:06:44 -06004153 is_2 ? ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
4154 ? "VUID-VkBlitImageInfo2-dstImageLayout-01399"
4155 : "VUID-VkBlitImageInfo2-dstImageLayout-00227")
sfricke-samsung45996a42021-09-16 13:45:27 -07004156 : ((dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Jeff Leger178b1e52020-10-05 12:22:23 -04004157 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
4158 : "VUID-vkCmdBlitImage-dstImageLayout-00227");
Aitor Camachoc22c3602022-06-07 20:45:50 +02004159
4160 bool same_image = (src_image_state == dst_image_state);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004161 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05004162 const RegionType region = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004163 bool hit_error = false;
Tony-LunarG542ae912021-11-04 16:06:44 -06004164
Aitor Camachoc22c3602022-06-07 20:45:50 +02004165 // When performing blit from and to same subresource, VK_IMAGE_LAYOUT_GENERAL is the only option
4166 const auto &src_sub = pRegions[i].srcSubresource;
4167 const auto &dst_sub = pRegions[i].dstSubresource;
4168 bool same_subresource =
4169 (same_image && (src_sub.mipLevel == dst_sub.mipLevel) && (src_sub.baseArrayLayer == dst_sub.baseArrayLayer));
4170 VkImageLayout source_optimal = (same_subresource ? VK_IMAGE_LAYOUT_GENERAL : VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL);
4171 VkImageLayout destination_optimal = (same_subresource ? VK_IMAGE_LAYOUT_GENERAL : VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL);
4172
Tony-LunarG542ae912021-11-04 16:06:44 -06004173 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImageLayout-00221" : "VUID-vkCmdBlitImage-srcImageLayout-00221";
Aitor Camachoc22c3602022-06-07 20:45:50 +02004174 skip |= VerifyImageLayout(*cb_node, *src_image_state, region.srcSubresource, srcImageLayout, source_optimal, func_name,
4175 invalid_src_layout_vuid, vuid, &hit_error);
Tony-LunarG542ae912021-11-04 16:06:44 -06004176 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImageLayout-00226" : "VUID-vkCmdBlitImage-dstImageLayout-00226";
Aitor Camachoc22c3602022-06-07 20:45:50 +02004177 skip |= VerifyImageLayout(*cb_node, *dst_image_state, region.dstSubresource, dstImageLayout, destination_optimal,
4178 func_name, invalid_dst_layout_vuid, vuid, &hit_error);
sfricke-samsung71f04e32022-03-16 01:21:21 -05004179 skip |= ValidateImageSubresourceLayers(cb_node.get(), &region.srcSubresource, func_name, "srcSubresource", i);
4180 skip |= ValidateImageSubresourceLayers(cb_node.get(), &region.dstSubresource, func_name, "dstSubresource", i);
Tony-LunarG542ae912021-11-04 16:06:44 -06004181 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcSubresource-01705" : "VUID-vkCmdBlitImage-srcSubresource-01705";
sfricke-samsung71f04e32022-03-16 01:21:21 -05004182 skip |= ValidateImageMipLevel(cb_node.get(), src_image_state.get(), region.srcSubresource.mipLevel, i, func_name,
Jeremy Gebben9f537102021-10-05 16:37:12 -06004183 "srcSubresource", vuid);
Tony-LunarG542ae912021-11-04 16:06:44 -06004184 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstSubresource-01706" : "VUID-vkCmdBlitImage-dstSubresource-01706";
sfricke-samsung71f04e32022-03-16 01:21:21 -05004185 skip |= ValidateImageMipLevel(cb_node.get(), dst_image_state.get(), region.dstSubresource.mipLevel, i, func_name,
Jeremy Gebben9f537102021-10-05 16:37:12 -06004186 "dstSubresource", vuid);
Tony-LunarG542ae912021-11-04 16:06:44 -06004187 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcSubresource-01707" : "VUID-vkCmdBlitImage-srcSubresource-01707";
sfricke-samsung71f04e32022-03-16 01:21:21 -05004188 skip |= ValidateImageArrayLayerRange(cb_node.get(), src_image_state.get(), region.srcSubresource.baseArrayLayer,
4189 region.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
Tony-LunarG542ae912021-11-04 16:06:44 -06004190 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstSubresource-01708" : "VUID-vkCmdBlitImage-dstSubresource-01708";
sfricke-samsung71f04e32022-03-16 01:21:21 -05004191 skip |= ValidateImageArrayLayerRange(cb_node.get(), dst_image_state.get(), region.dstSubresource.baseArrayLayer,
4192 region.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004193 // Warn for zero-sized regions
sfricke-samsung71f04e32022-03-16 01:21:21 -05004194 if ((region.srcOffsets[0].x == region.srcOffsets[1].x) || (region.srcOffsets[0].y == region.srcOffsets[1].y) ||
4195 (region.srcOffsets[0].z == region.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004196 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004197 ss << func_name << ": pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004198 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004199 }
sfricke-samsung71f04e32022-03-16 01:21:21 -05004200 if ((region.dstOffsets[0].x == region.dstOffsets[1].x) || (region.dstOffsets[0].y == region.dstOffsets[1].y) ||
4201 (region.dstOffsets[0].z == region.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004202 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04004203 ss << func_name << ": pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004204 skip |= LogWarning(cb_node->commandBuffer(), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004205 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004206
4207 // Check that src/dst layercounts match
sfricke-samsung71f04e32022-03-16 01:21:21 -05004208 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004209 vuid = is_2 ? "VUID-VkImageBlit2-layerCount-00239" : "VUID-VkImageBlit-layerCount-00239";
Jeff Leger178b1e52020-10-05 12:22:23 -04004210 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004211 LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004212 "%s: layerCount in source and destination subresource of pRegions[%d] does not match.", func_name, i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07004213 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07004214
sfricke-samsung71f04e32022-03-16 01:21:21 -05004215 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004216 vuid = is_2 ? "VUID-VkImageBlit2-aspectMask-00238" : "VUID-VkImageBlit-aspectMask-00238";
Jeff Leger178b1e52020-10-05 12:22:23 -04004217 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004218 LogError(cb_node->commandBuffer(), vuid, "%s: aspectMask members for pRegion[%d] do not match.", func_name, i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07004219 }
Dave Houlton48989f32017-05-26 15:01:46 -06004220
sfricke-samsung71f04e32022-03-16 01:21:21 -05004221 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004222 vuid = is_2 ? "VUID-VkBlitImageInfo2-aspectMask-00241" : "VUID-vkCmdBlitImage-aspectMask-00241";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004223 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004224 "%s: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004225 "image format %s.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004226 func_name, i, region.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004227 }
4228
sfricke-samsung71f04e32022-03-16 01:21:21 -05004229 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004230 vuid = is_2 ? "VUID-VkBlitImageInfo2-aspectMask-00242" : "VUID-vkCmdBlitImage-aspectMask-00242";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004231 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004232 "%s: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004233 func_name, i, region.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06004234 }
4235
Dave Houlton48989f32017-05-26 15:01:46 -06004236 // Validate source image offsets
sfricke-samsung71f04e32022-03-16 01:21:21 -05004237 VkExtent3D src_extent = src_image_state->GetSubresourceExtent(region.srcSubresource);
Dave Houlton33c2d252017-06-09 17:08:32 -06004238 if (VK_IMAGE_TYPE_1D == src_type) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05004239 if ((0 != region.srcOffsets[0].y) || (1 != region.srcOffsets[1].y)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004240 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00245" : "VUID-vkCmdBlitImage-srcImage-00245";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004241 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004242 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
4243 "of (%1d, %1d). These must be (0, 1).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004244 func_name, i, region.srcOffsets[0].y, region.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004245 }
4246 }
4247
Dave Houlton33c2d252017-06-09 17:08:32 -06004248 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05004249 if ((0 != region.srcOffsets[0].z) || (1 != region.srcOffsets[1].z)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004250 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00247" : "VUID-vkCmdBlitImage-srcImage-00247";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004251 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004252 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
4253 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004254 func_name, i, region.srcOffsets[0].z, region.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004255 }
4256 }
4257
Dave Houlton33c2d252017-06-09 17:08:32 -06004258 bool oob = false;
sfricke-samsung71f04e32022-03-16 01:21:21 -05004259 if ((region.srcOffsets[0].x < 0) || (region.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
4260 (region.srcOffsets[1].x < 0) || (region.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004261 oob = true;
Tony-LunarG542ae912021-11-04 16:06:44 -06004262 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcOffset-00243" : "VUID-vkCmdBlitImage-srcOffset-00243";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004263 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004264 "%s: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004265 func_name, i, region.srcOffsets[0].x, region.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004266 }
sfricke-samsung71f04e32022-03-16 01:21:21 -05004267 if ((region.srcOffsets[0].y < 0) || (region.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
4268 (region.srcOffsets[1].y < 0) || (region.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004269 oob = true;
Tony-LunarG542ae912021-11-04 16:06:44 -06004270 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcOffset-00244" : "VUID-vkCmdBlitImage-srcOffset-00244";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004271 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004272 "%s: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004273 func_name, i, region.srcOffsets[0].y, region.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004274 }
sfricke-samsung71f04e32022-03-16 01:21:21 -05004275 if ((region.srcOffsets[0].z < 0) || (region.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
4276 (region.srcOffsets[1].z < 0) || (region.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004277 oob = true;
Tony-LunarG542ae912021-11-04 16:06:44 -06004278 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcOffset-00246" : "VUID-vkCmdBlitImage-srcOffset-00246";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004279 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004280 "%s: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004281 func_name, i, region.srcOffsets[0].z, region.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004282 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004283 if (oob) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004284 vuid = is_2 ? "VUID-VkBlitImageInfo2-pRegions-00215" : "VUID-vkCmdBlitImage-pRegions-00215";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004285 skip |= LogError(cb_node->commandBuffer(), vuid, "%s: region [%d] source image blit region exceeds image dimensions.",
Jeff Leger178b1e52020-10-05 12:22:23 -04004286 func_name, i);
Dave Houlton33c2d252017-06-09 17:08:32 -06004287 }
Dave Houlton48989f32017-05-26 15:01:46 -06004288
4289 // Validate dest image offsets
sfricke-samsung71f04e32022-03-16 01:21:21 -05004290 VkExtent3D dst_extent = dst_image_state->GetSubresourceExtent(region.dstSubresource);
Dave Houlton33c2d252017-06-09 17:08:32 -06004291 if (VK_IMAGE_TYPE_1D == dst_type) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05004292 if ((0 != region.dstOffsets[0].y) || (1 != region.dstOffsets[1].y)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004293 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-00250" : "VUID-vkCmdBlitImage-dstImage-00250";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004294 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004295 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
4296 "(%1d, %1d). These must be (0, 1).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004297 func_name, i, region.dstOffsets[0].y, region.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004298 }
4299 }
4300
Dave Houlton33c2d252017-06-09 17:08:32 -06004301 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05004302 if ((0 != region.dstOffsets[0].z) || (1 != region.dstOffsets[1].z)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004303 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstImage-00252" : "VUID-vkCmdBlitImage-dstImage-00252";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004304 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004305 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004306 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004307 func_name, i, region.dstOffsets[0].z, region.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004308 }
4309 }
4310
Dave Houlton33c2d252017-06-09 17:08:32 -06004311 oob = false;
sfricke-samsung71f04e32022-03-16 01:21:21 -05004312 if ((region.dstOffsets[0].x < 0) || (region.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
4313 (region.dstOffsets[1].x < 0) || (region.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004314 oob = true;
Tony-LunarG542ae912021-11-04 16:06:44 -06004315 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstOffset-00248" : "VUID-vkCmdBlitImage-dstOffset-00248";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004316 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004317 "%s: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004318 func_name, i, region.dstOffsets[0].x, region.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004319 }
sfricke-samsung71f04e32022-03-16 01:21:21 -05004320 if ((region.dstOffsets[0].y < 0) || (region.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
4321 (region.dstOffsets[1].y < 0) || (region.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004322 oob = true;
Tony-LunarG542ae912021-11-04 16:06:44 -06004323 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstOffset-00249" : "VUID-vkCmdBlitImage-dstOffset-00249";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004324 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004325 "%s: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004326 func_name, i, region.dstOffsets[0].y, region.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004327 }
sfricke-samsung71f04e32022-03-16 01:21:21 -05004328 if ((region.dstOffsets[0].z < 0) || (region.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
4329 (region.dstOffsets[1].z < 0) || (region.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004330 oob = true;
Tony-LunarG542ae912021-11-04 16:06:44 -06004331 vuid = is_2 ? "VUID-VkBlitImageInfo2-dstOffset-00251" : "VUID-vkCmdBlitImage-dstOffset-00251";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004332 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004333 "%s: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05004334 func_name, i, region.dstOffsets[0].z, region.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004335 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004336 if (oob) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004337 vuid = is_2 ? "VUID-VkBlitImageInfo2-pRegions-00216" : "VUID-vkCmdBlitImage-pRegions-00216";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004338 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004339 "%s: region [%d] destination image blit region exceeds image dimensions.", func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004340 }
4341
Dave Houlton33c2d252017-06-09 17:08:32 -06004342 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05004343 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount) ||
4344 (0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Tony-LunarG542ae912021-11-04 16:06:44 -06004345 vuid = is_2 ? "VUID-VkBlitImageInfo2-srcImage-00240" : "VUID-vkCmdBlitImage-srcImage-00240";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004346 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04004347 "%s: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
4348 "layerCount other than 1.",
4349 func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004350 }
4351 }
aitor-lunarg607fe732022-03-31 22:00:08 +02004352
4353 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
4354 // must not overlap in memory
4355 if (srcImage == dstImage) {
4356 for (uint32_t j = 0; j < regionCount; j++) {
4357 if (RegionIntersectsBlit(&region, &pRegions[j], src_image_state->createInfo.imageType,
4358 FormatIsMultiplane(src_format))) {
4359 vuid = is_2 ? "VUID-VkBlitImageInfo2-pRegions-00217" : "VUID-vkCmdBlitImage-pRegions-00217";
4360 skip |= LogError(cb_node->commandBuffer(), vuid,
4361 "%s: pRegion[%" PRIu32 "] src overlaps with pRegions[%" PRIu32 "] dst.", func_name, i, j);
4362 }
4363 }
4364 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004365 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004366 } else {
4367 assert(0);
4368 }
4369 return skip;
4370}
4371
Jeff Leger178b1e52020-10-05 12:22:23 -04004372bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4373 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4374 const VkImageBlit *pRegions, VkFilter filter) const {
4375 return ValidateCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter,
Tony-LunarG542ae912021-11-04 16:06:44 -06004376 CMD_BLITIMAGE);
Jeff Leger178b1e52020-10-05 12:22:23 -04004377}
4378
4379bool CoreChecks::PreCallValidateCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) const {
4380 return ValidateCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4381 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
Tony-LunarG542ae912021-11-04 16:06:44 -06004382 pBlitImageInfo->filter, CMD_BLITIMAGE2KHR);
4383}
4384
4385bool CoreChecks::PreCallValidateCmdBlitImage2(VkCommandBuffer commandBuffer, const VkBlitImageInfo2 *pBlitImageInfo) const {
4386 return ValidateCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4387 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4388 pBlitImageInfo->filter, CMD_BLITIMAGE2);
Jeff Leger178b1e52020-10-05 12:22:23 -04004389}
4390
4391template <typename RegionType>
4392void CoreChecks::RecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
4393 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
4394 VkFilter filter) {
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07004395 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06004396 auto src_image_state = Get<IMAGE_STATE>(srcImage);
4397 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004398
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004399 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004400 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06004401 cb_node->SetImageInitialLayout(*src_image_state, pRegions[i].srcSubresource, srcImageLayout);
4402 cb_node->SetImageInitialLayout(*dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004403 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004404}
4405
Jeff Leger178b1e52020-10-05 12:22:23 -04004406void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4407 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4408 const VkImageBlit *pRegions, VkFilter filter) {
4409 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
4410 pRegions, filter);
4411 RecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter);
4412}
4413
4414void CoreChecks::PreCallRecordCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) {
4415 StateTracker::PreCallRecordCmdBlitImage2KHR(commandBuffer, pBlitImageInfo);
4416 RecordCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4417 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4418 pBlitImageInfo->filter);
4419}
4420
Tony-LunarG542ae912021-11-04 16:06:44 -06004421void CoreChecks::PreCallRecordCmdBlitImage2(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) {
4422 StateTracker::PreCallRecordCmdBlitImage2(commandBuffer, pBlitImageInfo);
4423 RecordCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4424 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4425 pBlitImageInfo->filter);
4426}
4427
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004428GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap &map, const IMAGE_STATE &image_state) {
John Zulauf2076e812020-01-08 14:55:54 -07004429 // This approach allows for a single hash lookup or/create new
Jeremy Gebben6335df62021-11-01 10:50:13 -06004430 auto &layout_map = map[&image_state];
John Zulauf17708d02021-02-22 11:20:58 -07004431 if (!layout_map) {
4432 layout_map.emplace(image_state.subresource_encoder.SubresourceCount());
John Zulauf2076e812020-01-08 14:55:54 -07004433 }
John Zulauf17708d02021-02-22 11:20:58 -07004434 return &layout_map;
John Zulauf2076e812020-01-08 14:55:54 -07004435}
4436
Jeremy Gebben6335df62021-11-01 10:50:13 -06004437const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, const IMAGE_STATE &image_state) {
4438 auto it = map.find(&image_state);
John Zulauf2076e812020-01-08 14:55:54 -07004439 if (it != map.end()) {
John Zulauf17708d02021-02-22 11:20:58 -07004440 return &it->second;
John Zulauf2076e812020-01-08 14:55:54 -07004441 }
4442 return nullptr;
4443}
4444
Jeremy Gebben53631302021-04-13 16:46:37 -06004445// Helper to update the Global or Overlay layout map
4446struct GlobalLayoutUpdater {
4447 bool update(VkImageLayout &dst, const image_layout_map::ImageSubresourceLayoutMap::LayoutEntry &src) const {
4448 if (src.current_layout != image_layout_map::kInvalidLayout && dst != src.current_layout) {
4449 dst = src.current_layout;
4450 return true;
4451 }
4452 return false;
4453 }
4454
4455 layer_data::optional<VkImageLayout> insert(const image_layout_map::ImageSubresourceLayoutMap::LayoutEntry &src) const {
4456 layer_data::optional<VkImageLayout> result;
4457 if (src.current_layout != image_layout_map::kInvalidLayout) {
4458 result.emplace(src.current_layout);
4459 }
4460 return result;
4461 }
4462};
4463
Shannon McPherson449fa9c2018-10-25 11:51:07 -06004464// 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 -07004465bool CoreChecks::ValidateCmdBufImageLayouts(const Location &loc, const CMD_BUFFER_STATE *pCB,
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004466 GlobalImageLayoutMap &overlayLayoutMap) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06004467 if (disabled[image_layout_validation]) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004468 bool skip = false;
John Zulauff660ad62019-03-23 07:16:05 -06004469 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07004470 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06004471 for (const auto &layout_map_entry : pCB->image_layout_map) {
Jeremy Gebben6335df62021-11-01 10:50:13 -06004472 const auto *image_state = layout_map_entry.first;
unknown089cdb82019-07-11 12:58:43 -06004473 const auto &subres_map = layout_map_entry.second;
Jeremy Gebben53631302021-04-13 16:46:37 -06004474 const auto &layout_map = subres_map->GetLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06004475 // Validate the initial_uses for each subresource referenced
Jeremy Gebben53631302021-04-13 16:46:37 -06004476 if (layout_map.empty()) continue;
John Zulauf2076e812020-01-08 14:55:54 -07004477
Jeremy Gebbenb6c18132021-03-17 17:00:20 -06004478 auto *overlay_map = GetLayoutRangeMap(overlayLayoutMap, *image_state);
Jeremy Gebben4a8881f2022-01-10 17:04:30 -07004479 const auto *global_map = image_state->layout_range_map.get();
4480 assert(global_map);
4481 auto global_map_guard = global_map->ReadLock();
John Zulauf2076e812020-01-08 14:55:54 -07004482
4483 // Note: don't know if it would matter
4484 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
4485
Jeremy Gebben53631302021-04-13 16:46:37 -06004486 auto pos = layout_map.begin();
4487 const auto end = layout_map.end();
4488 sparse_container::parallel_iterator<const GlobalImageLayoutRangeMap> current_layout(*overlay_map, *global_map,
4489 pos->first.begin);
John Zulauf2076e812020-01-08 14:55:54 -07004490 while (pos != end) {
Jeremy Gebben53631302021-04-13 16:46:37 -06004491 VkImageLayout initial_layout = pos->second.initial_layout;
4492 assert(initial_layout != image_layout_map::kInvalidLayout);
4493 if (initial_layout == image_layout_map::kInvalidLayout) {
4494 continue;
4495 }
4496
John Zulauf2076e812020-01-08 14:55:54 -07004497 VkImageLayout image_layout = kInvalidLayout;
Jeremy Gebben53631302021-04-13 16:46:37 -06004498
John Zulauf2076e812020-01-08 14:55:54 -07004499 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 -07004500 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004501 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07004502 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004503 image_layout = current_layout->pos_B->lower_bound->second;
4504 }
4505 const auto intersected_range = pos->first & current_layout->range;
4506 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
4507 // TODO: Set memory invalid which is in mem_tracker currently
4508 } else if (image_layout != initial_layout) {
Hans-Kristian Arntzen6cb03492021-07-05 16:57:31 +02004509 const auto aspect_mask = image_state->subresource_encoder.Decode(intersected_range.begin).aspectMask;
4510 bool matches = ImageLayoutMatches(aspect_mask, image_layout, initial_layout);
John Zulauf2076e812020-01-08 14:55:54 -07004511 if (!matches) {
John Zulauf2076e812020-01-08 14:55:54 -07004512 // We can report all the errors for the intersected range directly
4513 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
locke-lunarg296a3c92020-03-25 01:04:29 -06004514 const auto subresource = image_state->subresource_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004515 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004516 pCB->commandBuffer(), kVUID_Core_DrawState_InvalidImageLayout,
sfricke-samsung6b447aa2021-07-26 09:42:26 -07004517 "%s command buffer %s expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004518 "to be in layout %s--instead, current layout is %s.",
sfricke-samsung6b447aa2021-07-26 09:42:26 -07004519 loc.Message().c_str(), report_data->FormatHandle(pCB->commandBuffer()).c_str(),
Jeremy Gebben6335df62021-11-01 10:50:13 -06004520 report_data->FormatHandle(image_state->Handle()).c_str(), subresource.aspectMask, subresource.arrayLayer,
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004521 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
John Zulaufb61ed972019-04-09 16:12:35 -06004522 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004523 }
4524 }
John Zulauf2076e812020-01-08 14:55:54 -07004525 if (pos->first.includes(intersected_range.end)) {
4526 current_layout.seek(intersected_range.end);
4527 } else {
4528 ++pos;
4529 if (pos != end) {
4530 current_layout.seek(pos->first.begin);
4531 }
4532 }
John Zulauff660ad62019-03-23 07:16:05 -06004533 }
locke-lunargf155ccf2020-02-18 11:34:15 -07004534 // Update all layout set operations (which will be a subset of the initial_layouts)
Jeremy Gebben53631302021-04-13 16:46:37 -06004535 sparse_container::splice(*overlay_map, subres_map->GetLayoutMap(), GlobalLayoutUpdater());
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004536 }
John Zulauff660ad62019-03-23 07:16:05 -06004537
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004538 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004539}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07004540
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004541void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06004542 for (const auto &layout_map_entry : pCB->image_layout_map) {
Jeremy Gebben6335df62021-11-01 10:50:13 -06004543 const auto *image_state = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07004544 const auto &subres_map = layout_map_entry.second;
Jeremy Gebben4a8881f2022-01-10 17:04:30 -07004545 auto guard = image_state->layout_range_map->WriteLock();
4546 sparse_container::splice(*image_state->layout_range_map, subres_map->GetLayoutMap(), GlobalLayoutUpdater());
Tony Barbourdf013b92017-01-25 12:53:48 -07004547 }
4548}
4549
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004550// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004551// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
4552// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004553bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
4554 const VkImageLayout first_layout, const uint32_t attachment,
Mike Schuchardt2df08912020-12-15 16:28:09 -08004555 const VkAttachmentDescription2 &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004556 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004557 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
4558
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004559 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
sfricke-samsung55f01952020-03-24 08:16:41 -07004560 // for both loadOp and stencilLoaOp rp2 has it in 1 VU while rp1 has it in 2 VU with half behind Maintenance2 extension
4561 // Each is VUID is below in following order: rp2 -> rp1 with Maintenance2 -> rp1 with no extenstion
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004562 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07004563 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4564 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4565 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004566 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004567 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004568 string_VkImageLayout(first_layout));
sfricke-samsung45996a42021-09-16 13:45:27 -07004569 } else if ((use_rp2 == false) && IsExtEnabled(device_extensions.vk_khr_maintenance2) &&
sfricke-samsung55f01952020-03-24 08:16:41 -07004570 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL)) {
4571 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01566",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004572 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004573 string_VkImageLayout(first_layout));
4574 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4575 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004576 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004577 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004578 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004579 }
4580 }
sfricke-samsung55f01952020-03-24 08:16:41 -07004581
4582 // Same as above for loadOp, but for stencilLoadOp
4583 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
4584 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4585 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4586 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL))) {
4587 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02523",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004588 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004589 string_VkImageLayout(first_layout));
sfricke-samsung45996a42021-09-16 13:45:27 -07004590 } else if ((use_rp2 == false) && IsExtEnabled(device_extensions.vk_khr_maintenance2) &&
sfricke-samsung55f01952020-03-24 08:16:41 -07004591 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL)) {
4592 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01567",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004593 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004594 string_VkImageLayout(first_layout));
4595 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4596 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
4597 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-02511",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004598 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004599 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02004600 }
4601 }
4602
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004603 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004604}
4605
Mark Lobodzinski96210742017-02-09 10:33:46 -07004606// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4607// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004608template <typename T1>
4609bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
4610 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
4611 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004612 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004613 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004614 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004615 if (strict) {
4616 correct_usage = ((actual & desired) == desired);
4617 } else {
4618 correct_usage = ((actual & desired) != 0);
4619 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004620
Mark Lobodzinski96210742017-02-09 10:33:46 -07004621 if (!correct_usage) {
sfricke-samsungbb971942020-09-10 22:11:56 -07004622 // All callers should have a valid VUID
4623 assert(msgCode != kVUIDUndefined);
4624 skip =
4625 LogError(object, msgCode, "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4626 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004627 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004628 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004629}
4630
4631// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4632// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004633bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004634 char const *func_name, char const *usage_string) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004635 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image(),
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06004636 image_state->Handle(), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004637}
4638
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004639bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags2KHR desired,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004640 char const *func_name, const char *vuid) const {
Cort Stratton186b1a22018-05-01 20:18:06 -04004641 bool skip = false;
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004642 const VkFormatFeatureFlags2KHR image_format_features = image_state->format_features;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004643 if ((image_format_features & desired) != desired) {
4644 // Same error, but more details if it was an AHB external format
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06004645 if (image_state->HasAHBFormat()) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004646 skip |= LogError(image_state->image(), vuid,
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004647 "In %s, VkFormatFeatureFlags (0x%" PRIxLEAST64 ") does not support required feature %s for the external format "
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004648 "found in VkAndroidHardwareBufferFormatPropertiesANDROID::formatFeatures used by %s.",
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004649 func_name, image_format_features, string_VkFormatFeatureFlags2KHR(desired).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004650 report_data->FormatHandle(image_state->image()).c_str());
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004651 } else {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004652 skip |= LogError(image_state->image(), vuid,
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004653 "In %s, VkFormatFeatureFlags (0x%" PRIxLEAST64 ") does not support required feature %s for format %u used by %s "
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004654 "with tiling %s.",
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004655 func_name, image_format_features, string_VkFormatFeatureFlags2KHR(desired).c_str(),
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004656 image_state->createInfo.format, report_data->FormatHandle(image_state->image()).c_str(),
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004657 string_VkImageTiling(image_state->createInfo.tiling));
Cort Stratton186b1a22018-05-01 20:18:06 -04004658 }
4659 }
4660 return skip;
4661}
4662
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004663bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004664 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004665 bool skip = false;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004666 const VkImageAspectFlags apsect_mask = subresource_layers->aspectMask;
Cort Strattond619a302018-05-17 19:46:32 -07004667 // layerCount must not be zero
4668 if (subresource_layers->layerCount == 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004669 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-layerCount-01700",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004670 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004671 }
4672 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004673 if (apsect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004674 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-00168",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004675 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004676 }
4677 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004678 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 -06004679 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-00167",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004680 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4681 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4682 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004683 }
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004684 // aspectMask must not contain VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT
4685 if (apsect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
4686 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004687 skip |= LogError(cb_node->commandBuffer(), "VUID-VkImageSubresourceLayers-aspectMask-02247",
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004688 "In %s, pRegions[%u].%s.aspectMask has a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit set.", func_name, i,
4689 member);
4690 }
Cort Strattond619a302018-05-17 19:46:32 -07004691 return skip;
4692}
4693
Mark Lobodzinski96210742017-02-09 10:33:46 -07004694// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4695// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004696bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004697 char const *func_name, char const *usage_string) const {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004698 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer(),
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06004699 buffer_state->Handle(), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004700}
4701
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004702bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004703 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004704 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004705
4706 const VkDeviceSize &range = pCreateInfo->range;
4707 if (range != VK_WHOLE_SIZE) {
4708 // Range must be greater than 0
4709 if (range <= 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004710 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00928",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004711 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004712 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4713 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004714 }
4715 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004716 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4717 if (SafeModulo(range, format_size) != 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004718 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00929",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004719 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004720 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4721 "(%" PRIu32 ").",
4722 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004723 }
4724 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004725 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004726 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-00930",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004727 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004728 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4729 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4730 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004731 }
4732 // The sum of range and offset must be less than or equal to the size of buffer
4733 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004734 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-offset-00931",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004735 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004736 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4737 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4738 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004739 }
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004740 } else {
4741 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4742
4743 // Size of buffer - offset, divided by the element size of format must be less than or equal to
4744 // VkPhysicalDeviceLimits::maxTexelBufferElements
4745 if (SafeDivision(buffer_state->createInfo.size - pCreateInfo->offset, format_size) >
4746 device_limits->maxTexelBufferElements) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004747 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-range-04059",
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004748 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
4749 ") equals VK_WHOLE_SIZE, the buffer's size (%" PRIuLEAST64 ") minus the offset (%" PRIuLEAST64
4750 "), divided by the element size of the format (%" PRIu32
4751 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4752 range, buffer_state->createInfo.size, pCreateInfo->offset, format_size,
4753 device_limits->maxTexelBufferElements);
4754 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004755 }
4756 return skip;
4757}
4758
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004759bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004760 bool skip = false;
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004761 const VkFormatProperties3KHR format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004762 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004763 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_2_UNIFORM_TEXEL_BUFFER_BIT_KHR)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004764 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-00933",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004765 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004766 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format (%s) must "
4767 "be supported for uniform texel buffers",
4768 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004769 }
4770 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
Lionel Landwerlin21719f62021-12-09 11:40:09 +02004771 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_2_STORAGE_TEXEL_BUFFER_BIT_KHR)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004772 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-00934",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004773 "vkCreateBufferView(): If buffer was created with `usage` containing "
sfricke-samsungf3a9b5b2021-01-13 13:05:52 -08004774 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format (%s) must "
4775 "be supported for storage texel buffers",
4776 string_VkFormat(pCreateInfo->format));
Shannon McPherson265383a2018-06-21 15:37:52 -06004777 }
4778 return skip;
4779}
4780
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004781bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004782 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004783 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004784
Dave Houltond8ed0212018-05-16 17:18:24 -06004785 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004786
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004787 auto chained_devaddr_struct = LvlFindInChain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
Jeff Bolz87697532019-01-11 22:54:00 -06004788 if (chained_devaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004789 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz87697532019-01-11 22:54:00 -06004790 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004791 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4792 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004793 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004794 }
4795 }
4796
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07004797 auto chained_opaqueaddr_struct = LvlFindInChain<VkBufferOpaqueCaptureAddressCreateInfo>(pCreateInfo->pNext);
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004798 if (chained_opaqueaddr_struct) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08004799 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004800 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004801 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
Mike Schuchardt2df08912020-12-15 16:28:09 -08004802 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfo::opaqueCaptureAddress"
4803 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004804 }
4805 }
4806
ziga-lunarg2e2be1e2021-07-18 23:09:15 +02004807 auto dedicated_allocation_buffer = LvlFindInChain<VkDedicatedAllocationBufferCreateInfoNV>(pCreateInfo->pNext);
4808 if (dedicated_allocation_buffer && dedicated_allocation_buffer->dedicatedAllocation == VK_TRUE) {
4809 if (pCreateInfo->flags &
4810 (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT)) {
4811 skip |= LogError(device, "VUID-VkBufferCreateInfo-pNext-01571",
4812 "vkCreateBuffer(): pCreateInfos->flags must not include VK_BUFFER_CREATE_SPARSE_BINDING_BIT, "
4813 "VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT, or VK_BUFFER_CREATE_SPARSE_ALIASED_BIT when "
4814 "VkDedicatedAllocationBufferCreateInfoNV is in pNext chain with dedicatedAllocation VK_TRUE.");
4815 }
4816 }
4817
Mike Schuchardt2df08912020-12-15 16:28:09 -08004818 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT) &&
Jeff Bolz33fc6722020-03-31 12:58:16 -05004819 !enabled_features.core12.bufferDeviceAddressCaptureReplay &&
sfricke-samsung828e59d2021-08-22 23:20:49 -07004820 !enabled_features.buffer_device_address_ext_features.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004821 skip |= LogError(
4822 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004823 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
Mike Schuchardt2df08912020-12-15 16:28:09 -08004824 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT set.");
Jeff Bolz87697532019-01-11 22:54:00 -06004825 }
4826
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004827 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
sfricke-samsung45996a42021-09-16 13:45:27 -07004828 const char *vuid = IsExtEnabled(device_extensions.vk_khr_get_physical_device_properties2)
4829 ? "VUID-VkBufferCreateInfo-sharingMode-01419"
4830 : "VUID-VkBufferCreateInfo-sharingMode-01391";
Mark Lobodzinski314b9162020-07-16 15:33:08 -06004831 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
ziga-lunarga0b4f8a2021-07-28 13:23:02 +02004832 "vkCreateBuffer", "pCreateInfo->pQueueFamilyIndices", vuid);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004833 }
4834
sfricke-samsungedce77a2020-07-03 22:35:13 -07004835 if ((pCreateInfo->flags & VK_BUFFER_CREATE_PROTECTED_BIT) != 0) {
4836 if (enabled_features.core11.protectedMemory == VK_FALSE) {
4837 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-01887",
4838 "vkCreateBuffer(): the protectedMemory device feature is disabled: Buffers cannot be created with the "
4839 "VK_BUFFER_CREATE_PROTECTED_BIT set.");
4840 }
4841 const VkBufferCreateFlags invalid_flags =
4842 VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT;
4843 if ((pCreateInfo->flags & invalid_flags) != 0) {
4844 skip |= LogError(device, "VUID-VkBufferCreateInfo-None-01888",
4845 "vkCreateBuffer(): VK_BUFFER_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at "
4846 "same time (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | "
4847 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT).");
4848 }
4849 }
4850
ziga-lunargfe74b8d2022-04-18 17:37:46 +02004851 if ((pCreateInfo->usage & (VK_BUFFER_USAGE_VIDEO_DECODE_SRC_BIT_KHR | VK_BUFFER_USAGE_VIDEO_DECODE_DST_BIT_KHR)) > 0) {
4852 bool has_decode_codec_operation = false;
4853 const auto* video_profiles = LvlFindInChain<VkVideoProfilesKHR>(pCreateInfo->pNext);
4854 if (video_profiles) {
4855 for (uint32_t i = 0; i < video_profiles->profileCount; ++i) {
4856 if (video_profiles->pProfiles[i].videoCodecOperation &
4857 (VK_VIDEO_CODEC_OPERATION_DECODE_H264_BIT_EXT | VK_VIDEO_CODEC_OPERATION_DECODE_H265_BIT_EXT)) {
4858 has_decode_codec_operation = true;
4859 break;
4860 }
4861 }
4862 }
4863 if (!has_decode_codec_operation) {
4864 skip |= LogError(device, "VUID-VkBufferCreateInfo-usage-04813",
4865 "vkCreateBuffer(): pCreateInfo->usage is %s, but pNext chain does not include VkVideoProfilesKHR with "
4866 "a decode codec-operation.",
4867 string_VkBufferUsageFlags(pCreateInfo->usage).c_str());
4868 }
4869 }
4870 if ((pCreateInfo->usage & (VK_BUFFER_USAGE_VIDEO_ENCODE_SRC_BIT_KHR | VK_BUFFER_USAGE_VIDEO_ENCODE_DST_BIT_KHR)) > 0) {
4871 bool has_encode_codec_operation = false;
4872 const auto *video_profiles = LvlFindInChain<VkVideoProfilesKHR>(pCreateInfo->pNext);
4873 if (video_profiles) {
4874 for (uint32_t i = 0; i < video_profiles->profileCount; ++i) {
4875 if (video_profiles->pProfiles[i].videoCodecOperation &
4876 (VK_VIDEO_CODEC_OPERATION_ENCODE_H264_BIT_EXT | VK_VIDEO_CODEC_OPERATION_ENCODE_H265_BIT_EXT)) {
4877 has_encode_codec_operation = true;
4878 break;
4879 }
4880 }
4881 }
4882 if (!has_encode_codec_operation) {
4883 skip |= LogError(device, "VUID-VkBufferCreateInfo-usage-04814",
4884 "vkCreateBuffer(): pCreateInfo->usage is %s, but pNext chain does not include VkVideoProfilesKHR with "
4885 "an encode codec-operation.",
4886 string_VkBufferUsageFlags(pCreateInfo->usage).c_str());
4887 }
4888 }
4889
Mark Lobodzinski96210742017-02-09 10:33:46 -07004890 return skip;
4891}
4892
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004893bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004894 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004895 bool skip = false;
Jeremy Gebbenf4449392022-01-28 10:09:10 -07004896 auto buffer_state = Get<BUFFER_STATE>(pCreateInfo->buffer);
sfricke-samsung2e827212021-09-28 07:52:08 -07004897
4898 if (FormatIsDepthOrStencil(pCreateInfo->format)) {
4899 // Should never hopefully get here, but there are known driver advertising the wrong feature flags
4900 // see https://gitlab.khronos.org/vulkan/vulkan/-/merge_requests/4849
4901 skip |= LogError(device, kVUID_Core_invalidDepthStencilFormat,
4902 "vkCreateBufferView(): format is a depth/stencil format (%s) but depth/stencil formats do not have a "
4903 "defined sizes for alignment, replace with a color format.",
4904 string_VkFormat(pCreateInfo->format));
4905 }
4906
Mark Lobodzinski96210742017-02-09 10:33:46 -07004907 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4908 if (buffer_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06004909 skip |=
4910 ValidateMemoryIsBoundToBuffer(buffer_state.get(), "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004911 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4912 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Jeremy Gebben9f537102021-10-05 16:37:12 -06004913 skip |= ValidateBufferUsageFlags(buffer_state.get(),
Dave Houltond8ed0212018-05-16 17:18:24 -06004914 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4915 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4916 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004917
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004918 // Buffer view offset must be less than the size of buffer
4919 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004920 skip |= LogError(buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-offset-00925",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004921 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004922 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4923 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004924 }
4925
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004926 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004927 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4928 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4929 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
sfricke-samsung45996a42021-09-16 13:45:27 -07004930 const char *vuid = IsExtEnabled(device_extensions.vk_ext_texel_buffer_alignment)
4931 ? "VUID-VkBufferViewCreateInfo-offset-02749"
4932 : "VUID-VkBufferViewCreateInfo-offset-00926";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004933 skip |= LogError(buffer_state->buffer(), vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004934 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004935 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4936 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004937 }
4938
4939 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004940 VkDeviceSize element_size = FormatElementSize(pCreateInfo->format);
4941 if ((element_size % 3) == 0) {
4942 element_size /= 3;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004943 }
4944 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004945 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05004946 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4947 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004948 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004949 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004950 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004951 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004952 buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-02750",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004953 "vkCreateBufferView(): If buffer was created with usage containing "
4954 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004955 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4956 ") must be a multiple of the lesser of "
4957 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4958 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4959 "(%" PRId32
4960 ") is VK_TRUE, the size of a texel of the requested format. "
4961 "If the size of a texel is a multiple of three bytes, then the size of a "
4962 "single component of format is used instead",
4963 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4964 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4965 }
4966 }
4967 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004968 VkDeviceSize alignment_requirement =
Jeff Bolzd5554e62019-07-19 13:23:52 -05004969 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4970 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004971 alignment_requirement = std::min(alignment_requirement, element_size);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004972 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004973 if (SafeModulo(pCreateInfo->offset, alignment_requirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004974 skip |= LogError(
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004975 buffer_state->buffer(), "VUID-VkBufferViewCreateInfo-buffer-02751",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004976 "vkCreateBufferView(): If buffer was created with usage containing "
4977 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004978 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4979 ") must be a multiple of the lesser of "
4980 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4981 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4982 "(%" PRId32
4983 ") is VK_TRUE, the size of a texel of the requested format. "
4984 "If the size of a texel is a multiple of three bytes, then the size of a "
4985 "single component of format is used instead",
4986 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4987 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4988 }
4989 }
4990 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004991
Jeremy Gebben9f537102021-10-05 16:37:12 -06004992 skip |= ValidateBufferViewRange(buffer_state.get(), pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004993
Jeremy Gebben9f537102021-10-05 16:37:12 -06004994 skip |= ValidateBufferViewBuffer(buffer_state.get(), pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004995 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004996 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004997}
4998
Mark Lobodzinski602de982017-02-09 11:01:33 -07004999// For the given format verify that the aspect masks make sense
Aitor Camachoeb35fed2022-06-07 14:07:42 +02005000bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, bool is_image_disjoint,
5001 const char *func_name, const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005002 bool skip = false;
sfricke-samsung79b00482020-04-01 21:15:50 -07005003 // checks color format and (single-plane or non-disjoint)
5004 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
Aitor Camachoeb35fed2022-06-07 14:07:42 +02005005 if ((FormatIsColor(format)) && ((FormatIsMultiplane(format) == false) || (is_image_disjoint == false))) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005006 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08005007 skip |= LogError(
5008 image, vuid,
5009 "%s: Using format (%s) with aspect flags (%s) but color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.",
5010 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005011 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08005012 skip |= LogError(image, vuid,
5013 "%s: Using format (%s) with aspect flags (%s) but color image formats must have ONLY the "
5014 "VK_IMAGE_ASPECT_COLOR_BIT set.",
5015 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005016 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06005017 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005018 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005019 skip |= LogError(image, vuid,
sfricke-samsung7687a482021-01-29 23:19:22 -08005020 "%s: Using format (%s) with aspect flags (%s) but depth/stencil image formats must have at least one "
5021 "of VK_IMAGE_ASPECT_DEPTH_BIT and VK_IMAGE_ASPECT_STENCIL_BIT set.",
5022 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005023 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005024 skip |= LogError(image, vuid,
sfricke-samsung7687a482021-01-29 23:19:22 -08005025 "%s: Using format (%s) with aspect flags (%s) but combination depth/stencil image formats can have "
5026 "only the VK_IMAGE_ASPECT_DEPTH_BIT and VK_IMAGE_ASPECT_STENCIL_BIT set.",
5027 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005028 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06005029 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005030 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08005031 skip |= LogError(image, vuid,
5032 "%s: Using format (%s) with aspect flags (%s) but depth-only image formats must have the "
5033 "VK_IMAGE_ASPECT_DEPTH_BIT set.",
5034 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005035 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08005036 skip |= LogError(image, vuid,
5037 "%s: Using format (%s) with aspect flags (%s) but depth-only image formats can have only the "
5038 "VK_IMAGE_ASPECT_DEPTH_BIT set.",
5039 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005040 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06005041 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005042 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
sfricke-samsung7687a482021-01-29 23:19:22 -08005043 skip |= LogError(image, vuid,
5044 "%s: Using format (%s) with aspect flags (%s) but stencil-only image formats must have the "
5045 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
5046 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005047 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08005048 skip |= LogError(image, vuid,
5049 "%s: Using format (%s) with aspect flags (%s) but stencil-only image formats can have only the "
5050 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
5051 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005052 }
Dave Houlton501b15b2018-03-30 15:07:41 -06005053 } else if (FormatIsMultiplane(format)) {
5054 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
5055 if (3 == FormatPlaneCount(format)) {
5056 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
5057 }
5058 if ((aspect_mask & valid_flags) != aspect_mask) {
sfricke-samsung7687a482021-01-29 23:19:22 -08005059 skip |= LogError(image, vuid,
5060 "%s: Using format (%s) with aspect flags (%s) but multi-plane image formats may have only "
5061 "VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs set, where n = [0, 1, 2].",
5062 func_name, string_VkFormat(format), string_VkImageAspectFlags(aspect_mask).c_str());
Dave Houlton501b15b2018-03-30 15:07:41 -06005063 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005064 }
5065 return skip;
5066}
5067
ziga-lunarg69aa72f2022-03-29 15:24:35 +02005068bool CoreChecks::ValidateImageAcquired(IMAGE_STATE const &image_state, const char *func_name) const {
ziga-lunarg04e94b32021-10-03 01:42:37 +02005069 bool skip = false;
5070
ziga-lunarg04e94b32021-10-03 01:42:37 +02005071 return skip;
5072}
5073
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005074bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
5075 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005076 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
Jeremy Gebben5573a8c2021-06-04 08:55:10 -06005077 const SubresourceRangeErrorCodes &errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005078 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02005079
5080 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02005081 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005082 skip |= LogError(image, errorCodes.base_mip_err,
5083 "%s: %s.baseMipLevel (= %" PRIu32
5084 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
5085 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02005086 }
Petr Kraus4d718682017-05-18 03:38:41 +02005087
Petr Krausffa94af2017-08-08 21:46:02 +02005088 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
5089 if (subresourceRange.levelCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07005090 skip |=
5091 LogError(image, "VUID-VkImageSubresourceRange-levelCount-01720", "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02005092 } else {
5093 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02005094
Petr Krausffa94af2017-08-08 21:46:02 +02005095 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005096 skip |= LogError(image, errorCodes.mip_count_err,
5097 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
5098 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
5099 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
5100 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02005101 }
Petr Kraus4d718682017-05-18 03:38:41 +02005102 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005103 }
Petr Kraus4d718682017-05-18 03:38:41 +02005104
5105 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02005106 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005107 skip |= LogError(image, errorCodes.base_layer_err,
5108 "%s: %s.baseArrayLayer (= %" PRIu32
5109 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
5110 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02005111 }
Petr Kraus4d718682017-05-18 03:38:41 +02005112
Petr Krausffa94af2017-08-08 21:46:02 +02005113 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
5114 if (subresourceRange.layerCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07005115 skip |=
5116 LogError(image, "VUID-VkImageSubresourceRange-layerCount-01721", "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02005117 } else {
5118 const uint64_t necessary_layer_count =
5119 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02005120
Petr Krausffa94af2017-08-08 21:46:02 +02005121 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005122 skip |= LogError(image, errorCodes.layer_count_err,
5123 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
5124 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
5125 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
5126 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02005127 }
Petr Kraus4d718682017-05-18 03:38:41 +02005128 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005129 }
Petr Kraus4d718682017-05-18 03:38:41 +02005130
ziga-lunargb4e90752021-08-02 13:58:29 +02005131 if (subresourceRange.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
5132 if (subresourceRange.aspectMask &
5133 (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT)) {
5134 skip |= LogError(image, "VUID-VkImageSubresourceRange-aspectMask-01670",
5135 "%s: aspectMask includes both VK_IMAGE_ASPECT_COLOR_BIT and one of VK_IMAGE_ASPECT_PLANE_0_BIT, "
5136 "VK_IMAGE_ASPECT_PLANE_1_BIT, or VK_IMAGE_ASPECT_PLANE_2_BIT.",
5137 cmd_name);
5138 }
5139 }
5140
Mark Lobodzinski602de982017-02-09 11:01:33 -07005141 return skip;
5142}
5143
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005144bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005145 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07005146 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Tony-LunarGbe956362022-04-05 13:34:31 -06005147 bool is_2d_compatible = (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT) ? true : false;
5148 if (device_extensions.vk_ext_image_2d_view_of_3d)
5149 is_2d_compatible |= (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_VIEW_COMPATIBLE_BIT_EXT) ? true : false;
5150 bool is_image_slicable =
5151 (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) && is_2d_compatible;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005152 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 +02005153
David McFarland2853f2f2020-11-30 15:50:39 -04005154 uint32_t image_layer_count;
5155
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005156 if (is_3_d_to_2_d_map) {
David McFarland2853f2f2020-11-30 15:50:39 -04005157 const auto layers = LayersFromRange(subresourceRange);
Jeremy Gebben1dfbd172021-05-19 14:00:58 -06005158 const auto extent = image_state->GetSubresourceExtent(layers);
David McFarland2853f2f2020-11-30 15:50:39 -04005159 image_layer_count = extent.depth;
5160 } else {
5161 image_layer_count = image_state->createInfo.arrayLayers;
5162 }
5163
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005164 const auto image_layer_count_var_name = is_3_d_to_2_d_map ? "extent.depth" : "arrayLayers";
Petr Krausffa94af2017-08-08 21:46:02 +02005165
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005166 SubresourceRangeErrorCodes subresource_range_error_codes = {};
5167 subresource_range_error_codes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
5168 subresource_range_error_codes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
5169 subresource_range_error_codes.base_layer_err =
5170 is_khr_maintenance1
Tony-LunarGbe956362022-04-05 13:34:31 -06005171 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-image-02724"
5172 : (device_extensions.vk_ext_image_2d_view_of_3d ? "VUID-VkImageViewCreateInfo-image-06724"
5173 : "VUID-VkImageViewCreateInfo-image-01482"))
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005174 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
Tony-LunarGbe956362022-04-05 13:34:31 -06005175 subresource_range_error_codes.layer_count_err =
5176 is_khr_maintenance1
5177 ? (is_3_d_to_2_d_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
5178 : (device_extensions.vk_ext_image_2d_view_of_3d ? "VUID-VkImageViewCreateInfo-subresourceRange-06725"
5179 : "VUID-VkImageViewCreateInfo-subresourceRange-01483"))
5180 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02005181
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005182 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02005183 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005184 image_state->image(), subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02005185}
5186
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005187bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06005188 const VkImageSubresourceRange &subresourceRange,
5189 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005190 SubresourceRangeErrorCodes subresource_range_error_codes = {};
5191 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
5192 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
5193 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
5194 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02005195
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005196 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005197 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image(),
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005198 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02005199}
5200
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005201bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06005202 const VkImageSubresourceRange &subresourceRange,
5203 const char *param_name) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005204 SubresourceRangeErrorCodes subresource_range_error_codes = {};
5205 subresource_range_error_codes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
5206 subresource_range_error_codes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
5207 subresource_range_error_codes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
5208 subresource_range_error_codes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02005209
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005210 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005211 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image(),
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07005212 subresource_range_error_codes);
Petr Krausffa94af2017-08-08 21:46:02 +02005213}
5214
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005215bool CoreChecks::ValidateImageBarrierSubresourceRange(const Location &loc, const IMAGE_STATE *image_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005216 const VkImageSubresourceRange &subresourceRange) const {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005217 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005218 loc.StringFunc().c_str(), loc.StringField().c_str(), "arrayLayers", image_state->image(),
Jeremy Gebbenbb845612021-02-18 18:16:05 -07005219 sync_vuid_maps::GetSubResourceVUIDs(loc));
Petr Krausffa94af2017-08-08 21:46:02 +02005220}
5221
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005222namespace barrier_queue_families {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005223using sync_vuid_maps::GetBarrierQueueVUID;
5224using sync_vuid_maps::kQueueErrorSummary;
5225using sync_vuid_maps::QueueError;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005226
5227class ValidatorState {
5228 public:
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005229 ValidatorState(const ValidationStateTracker *device_data, LogObjectList &&obj, const core_error::Location &location,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005230 const VulkanTypedHandle &barrier_handle, const VkSharingMode sharing_mode)
5231 : device_data_(device_data),
John Zulaufbea70432021-02-23 07:03:12 -07005232 objects_(std::move(obj)),
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005233 loc_(location),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005234 barrier_handle_(barrier_handle),
5235 sharing_mode_(sharing_mode),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005236 limit_(static_cast<uint32_t>(device_data->physical_device_state->queue_family_properties.size())),
5237 mem_ext_(IsExtEnabled(device_data->device_extensions.vk_khr_external_memory)) {}
5238
5239 // Log the messages using boilerplate from object state, and Vu specific information from the template arg
5240 // 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 -07005241 bool LogMsg(QueueError vu_index, uint32_t family, const char *param_name) const {
5242 const std::string val_code = GetBarrierQueueVUID(loc_, vu_index);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005243 const char *annotation = GetFamilyAnnotation(family);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005244 return device_data_->LogError(objects_, val_code, "%s Barrier using %s %s created with sharingMode %s, has %s %u%s. %s",
5245 loc_.Message().c_str(), GetTypeString(),
5246 device_data_->report_data->FormatHandle(barrier_handle_).c_str(), GetModeString(), param_name,
5247 family, annotation, kQueueErrorSummary.at(vu_index).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005248 }
5249
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005250 bool LogMsg(QueueError vu_index, uint32_t src_family, uint32_t dst_family) const {
5251 const std::string val_code = GetBarrierQueueVUID(loc_, vu_index);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005252 const char *src_annotation = GetFamilyAnnotation(src_family);
5253 const char *dst_annotation = GetFamilyAnnotation(dst_family);
5254 return device_data_->LogError(
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005255 objects_, val_code,
5256 "%s Barrier using %s %s created with sharingMode %s, has srcQueueFamilyIndex %u%s and dstQueueFamilyIndex %u%s. %s",
5257 loc_.Message().c_str(), GetTypeString(), device_data_->report_data->FormatHandle(barrier_handle_).c_str(),
5258 GetModeString(), src_family, src_annotation, dst_family, dst_annotation, kQueueErrorSummary.at(vu_index).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005259 }
5260
5261 // This abstract Vu can only be tested at submit time, thus we need a callback from the closure containing the needed
5262 // data. Note that the mem_barrier is copied to the closure as the lambda lifespan exceed the guarantees of validity for
5263 // application input.
5264 static bool ValidateAtQueueSubmit(const QUEUE_STATE *queue_state, const ValidationStateTracker *device_data,
5265 uint32_t src_family, uint32_t dst_family, const ValidatorState &val) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005266 auto error_code = QueueError::kSubmitQueueMustMatchSrcOrDst;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005267 uint32_t queue_family = queue_state->queueFamilyIndex;
5268 if ((src_family != queue_family) && (dst_family != queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005269 const std::string val_code = GetBarrierQueueVUID(val.loc_, error_code);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005270 const char *src_annotation = val.GetFamilyAnnotation(src_family);
5271 const char *dst_annotation = val.GetFamilyAnnotation(dst_family);
5272 return device_data->LogError(
Jeremy Gebben63f3cb02021-09-07 15:16:32 -06005273 queue_state->Handle(), val_code,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005274 "%s Barrier submitted to queue with family index %u, using %s %s created with sharingMode %s, has "
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005275 "srcQueueFamilyIndex %u%s and dstQueueFamilyIndex %u%s. %s",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005276 val.loc_.Message().c_str(), queue_family, val.GetTypeString(),
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005277 device_data->report_data->FormatHandle(val.barrier_handle_).c_str(), val.GetModeString(), src_family,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005278 src_annotation, dst_family, dst_annotation, kQueueErrorSummary.at(error_code).c_str());
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005279 }
5280 return false;
5281 }
5282 // Logical helpers for semantic clarity
5283 inline bool KhrExternalMem() const { return mem_ext_; }
5284 inline bool IsValid(uint32_t queue_family) const { return (queue_family < limit_); }
5285 inline bool IsValidOrSpecial(uint32_t queue_family) const {
5286 return IsValid(queue_family) || (mem_ext_ && QueueFamilyIsExternal(queue_family));
5287 }
5288
5289 // Helpers for LogMsg
5290 const char *GetModeString() const { return string_VkSharingMode(sharing_mode_); }
5291
5292 // Descriptive text for the various types of queue family index
5293 const char *GetFamilyAnnotation(uint32_t family) const {
5294 const char *external = " (VK_QUEUE_FAMILY_EXTERNAL)";
5295 const char *foreign = " (VK_QUEUE_FAMILY_FOREIGN_EXT)";
5296 const char *ignored = " (VK_QUEUE_FAMILY_IGNORED)";
5297 const char *valid = " (VALID)";
5298 const char *invalid = " (INVALID)";
5299 switch (family) {
5300 case VK_QUEUE_FAMILY_EXTERNAL:
5301 return external;
5302 case VK_QUEUE_FAMILY_FOREIGN_EXT:
5303 return foreign;
5304 case VK_QUEUE_FAMILY_IGNORED:
5305 return ignored;
5306 default:
5307 if (IsValid(family)) {
5308 return valid;
5309 }
5310 return invalid;
5311 };
5312 }
5313 const char *GetTypeString() const { return object_string[barrier_handle_.type]; }
5314 VkSharingMode GetSharingMode() const { return sharing_mode_; }
5315
5316 protected:
5317 const ValidationStateTracker *device_data_;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005318 const LogObjectList objects_;
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005319 const core_error::Location loc_;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005320 const VulkanTypedHandle barrier_handle_;
5321 const VkSharingMode sharing_mode_;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005322 const uint32_t limit_;
5323 const bool mem_ext_;
5324};
5325
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005326bool Validate(const CoreChecks *device_data, const CMD_BUFFER_STATE *cb_state, const ValidatorState &val,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005327 const uint32_t src_queue_family, const uint32_t dst_queue_family) {
5328 bool skip = false;
5329
5330 const bool mode_concurrent = val.GetSharingMode() == VK_SHARING_MODE_CONCURRENT;
5331 const bool src_ignored = QueueFamilyIsIgnored(src_queue_family);
5332 const bool dst_ignored = QueueFamilyIsIgnored(dst_queue_family);
5333 if (val.KhrExternalMem()) {
5334 if (mode_concurrent) {
Tony-LunarG273f32f2021-09-28 08:56:30 -06005335 bool sync2 = device_data->enabled_features.core13.synchronization2 != 0;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005336 // this requirement is removed by VK_KHR_synchronization2
5337 if (!(src_ignored || dst_ignored) && !sync2) {
5338 skip |= val.LogMsg(QueueError::kSrcOrDstMustBeIgnore, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005339 }
5340 if ((src_ignored && !(dst_ignored || QueueFamilyIsExternal(dst_queue_family))) ||
5341 (dst_ignored && !(src_ignored || QueueFamilyIsExternal(src_queue_family)))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005342 skip |= val.LogMsg(QueueError::kSpecialOrIgnoreOnly, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005343 }
5344 } else {
5345 // VK_SHARING_MODE_EXCLUSIVE
5346 if (src_queue_family != dst_queue_family) {
5347 if (!val.IsValidOrSpecial(dst_queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005348 skip |= val.LogMsg(QueueError::kSrcAndDstValidOrSpecial, dst_queue_family, "dstQueueFamilyIndex");
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005349 }
5350 if (!val.IsValidOrSpecial(src_queue_family)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005351 skip |= val.LogMsg(QueueError::kSrcAndDstValidOrSpecial, src_queue_family, "srcQueueFamilyIndex");
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005352 }
5353 }
5354 }
5355 } else {
5356 // No memory extension
5357 if (mode_concurrent) {
Tony-LunarG273f32f2021-09-28 08:56:30 -06005358 bool sync2 = device_data->enabled_features.core13.synchronization2 != 0;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005359 // this requirement is removed by VK_KHR_synchronization2
5360 if ((!src_ignored || !dst_ignored) && !sync2) {
5361 skip |= val.LogMsg(QueueError::kSrcAndDestMustBeIgnore, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005362 }
5363 } else {
5364 // VK_SHARING_MODE_EXCLUSIVE
5365 if ((src_queue_family != dst_queue_family) && !(val.IsValid(src_queue_family) && val.IsValid(dst_queue_family))) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005366 skip |= val.LogMsg(QueueError::kSrcAndDstBothValid, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005367 }
5368 }
5369 }
5370 return skip;
5371}
5372} // namespace barrier_queue_families
5373
Jeremy Gebbene5361dd2021-11-18 14:23:56 -07005374bool CoreChecks::ValidateConcurrentBarrierAtSubmit(const Location &loc, const ValidationStateTracker &state_data,
5375 const QUEUE_STATE &queue_state, const CMD_BUFFER_STATE &cb_state,
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005376 const VulkanTypedHandle &typed_handle, uint32_t src_queue_family,
5377 uint32_t dst_queue_family) {
5378 using barrier_queue_families::ValidatorState;
Jeremy Gebbene5361dd2021-11-18 14:23:56 -07005379 ValidatorState val(&state_data, LogObjectList(cb_state.Handle()), loc, typed_handle, VK_SHARING_MODE_CONCURRENT);
5380 return ValidatorState::ValidateAtQueueSubmit(&queue_state, &state_data, src_queue_family, dst_queue_family, val);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005381}
5382
5383// Type specific wrapper for image barriers
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005384template <typename ImgBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005385bool CoreChecks::ValidateBarrierQueueFamilies(const Location &loc, const CMD_BUFFER_STATE *cb_state, const ImgBarrier &barrier,
5386 const IMAGE_STATE *state_data) const {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005387 // State data is required
5388 if (!state_data) {
5389 return false;
5390 }
5391
5392 // Create the validator state from the image state
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005393 barrier_queue_families::ValidatorState val(this, LogObjectList(cb_state->commandBuffer()), loc,
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06005394 state_data->Handle(), state_data->createInfo.sharingMode);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005395 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
5396 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005397 return barrier_queue_families::Validate(this, cb_state, val, src_queue_family, dst_queue_family);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005398}
5399
5400// Type specific wrapper for buffer barriers
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005401template <typename BufBarrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005402bool CoreChecks::ValidateBarrierQueueFamilies(const Location &loc, const CMD_BUFFER_STATE *cb_state, const BufBarrier &barrier,
5403 const BUFFER_STATE *state_data) const {
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005404 // State data is required
5405 if (!state_data) {
5406 return false;
5407 }
5408
5409 // Create the validator state from the buffer state
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005410 barrier_queue_families::ValidatorState val(this, LogObjectList(cb_state->commandBuffer()), loc,
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06005411 state_data->Handle(), state_data->createInfo.sharingMode);
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005412 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
5413 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005414 return barrier_queue_families::Validate(this, cb_state, val, src_queue_family, dst_queue_family);
5415}
5416
5417template <typename Barrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005418bool CoreChecks::ValidateBufferBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005419 const Barrier &mem_barrier) const {
5420 using sync_vuid_maps::BufferError;
5421 using sync_vuid_maps::GetBufferBarrierVUID;
5422
5423 bool skip = false;
5424
5425 skip |= ValidateQFOTransferBarrierUniqueness(loc, cb_state, mem_barrier, cb_state->qfo_transfer_buffer_barriers);
5426
5427 // Validate buffer barrier queue family indices
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06005428 auto buffer_state = Get<BUFFER_STATE>(mem_barrier.buffer);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005429 if (buffer_state) {
5430 auto buf_loc = loc.dot(Field::buffer);
5431 const auto &mem_vuid = GetBufferBarrierVUID(buf_loc, BufferError::kNoMemory);
Jeremy Gebben9f537102021-10-05 16:37:12 -06005432 skip |= ValidateMemoryIsBoundToBuffer(buffer_state.get(), loc.StringFunc().c_str(), mem_vuid.c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005433
Jeremy Gebben9f537102021-10-05 16:37:12 -06005434 skip |= ValidateBarrierQueueFamilies(buf_loc, cb_state, mem_barrier, buffer_state.get());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005435
5436 auto buffer_size = buffer_state->createInfo.size;
5437 if (mem_barrier.offset >= buffer_size) {
5438 auto offset_loc = loc.dot(Field::offset);
5439 const auto &vuid = GetBufferBarrierVUID(offset_loc, BufferError::kOffsetTooBig);
5440
5441 skip |= LogError(objects, vuid, "%s %s has offset 0x%" PRIx64 " which is not less than total size 0x%" PRIx64 ".",
5442 offset_loc.Message().c_str(), report_data->FormatHandle(mem_barrier.buffer).c_str(),
5443 HandleToUint64(mem_barrier.offset), HandleToUint64(buffer_size));
5444 } else if (mem_barrier.size != VK_WHOLE_SIZE && (mem_barrier.offset + mem_barrier.size > buffer_size)) {
5445 auto size_loc = loc.dot(Field::size);
5446 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kSizeOutOfRange);
5447 skip |= LogError(objects, vuid,
5448 "%s %s has offset 0x%" PRIx64 " and size 0x%" PRIx64 " whose sum is greater than total size 0x%" PRIx64
5449 ".",
5450 size_loc.Message().c_str(), report_data->FormatHandle(mem_barrier.buffer).c_str(),
5451 HandleToUint64(mem_barrier.offset), HandleToUint64(mem_barrier.size), HandleToUint64(buffer_size));
5452 }
5453 if (mem_barrier.size == 0) {
5454 auto size_loc = loc.dot(Field::size);
5455 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kSizeZero);
5456 skip |= LogError(objects, vuid, "%s %s has a size of 0.", loc.Message().c_str(),
5457 report_data->FormatHandle(mem_barrier.buffer).c_str());
5458 }
5459 }
ziga-lunarg8e2506c2022-04-18 20:06:00 +02005460
5461 if (mem_barrier.srcQueueFamilyIndex == VK_QUEUE_FAMILY_EXTERNAL &&
5462 mem_barrier.dstQueueFamilyIndex == VK_QUEUE_FAMILY_EXTERNAL) {
5463 auto size_loc = loc.dot(Field::srcQueueFamilyIndex);
5464 const auto &vuid = GetBufferBarrierVUID(size_loc, BufferError::kQueueFamilyExternal);
5465 skip |= LogError(objects, vuid, "Both srcQueueFamilyIndex and dstQueueFamilyIndex are VK_QUEUE_FAMILY_EXTERNAL.");
5466 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005467 return skip;
5468}
5469
5470template <typename Barrier>
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005471bool CoreChecks::ValidateImageBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005472 const Barrier &mem_barrier) const {
5473 bool skip = false;
5474
5475 skip |= ValidateQFOTransferBarrierUniqueness(loc, cb_state, mem_barrier, cb_state->qfo_transfer_image_barriers);
5476
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005477 bool is_ilt = true;
Tony-LunarG273f32f2021-09-28 08:56:30 -06005478 if (enabled_features.core13.synchronization2) {
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005479 is_ilt = mem_barrier.oldLayout != mem_barrier.newLayout;
5480 }
5481
5482 if (is_ilt) {
5483 if (mem_barrier.newLayout == VK_IMAGE_LAYOUT_UNDEFINED || mem_barrier.newLayout == VK_IMAGE_LAYOUT_PREINITIALIZED) {
5484 auto layout_loc = loc.dot(Field::newLayout);
5485 const auto &vuid = sync_vuid_maps::GetImageBarrierVUID(loc, sync_vuid_maps::ImageError::kBadLayout);
5486 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005487 LogError(cb_state->commandBuffer(), vuid, "%s Image Layout cannot be transitioned to UNDEFINED or PREINITIALIZED.",
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005488 layout_loc.Message().c_str());
Jeremy Gebben579aaca2021-02-15 13:36:18 -07005489 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005490 }
5491
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06005492 auto image_data = Get<IMAGE_STATE>(mem_barrier.image);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005493 if (image_data) {
5494 auto image_loc = loc.dot(Field::image);
5495
Jeremy Gebben9f537102021-10-05 16:37:12 -06005496 skip |= ValidateMemoryIsBoundToImage(image_data.get(), loc);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005497
Jeremy Gebben9f537102021-10-05 16:37:12 -06005498 skip |= ValidateBarrierQueueFamilies(image_loc, cb_state, mem_barrier, image_data.get());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005499
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005500 skip |= ValidateImageAspectMask(image_data->image(), image_data->createInfo.format, mem_barrier.subresourceRange.aspectMask,
Aitor Camachoeb35fed2022-06-07 14:07:42 +02005501 image_data->disjoint, loc.StringFunc().c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005502
Jeremy Gebben9f537102021-10-05 16:37:12 -06005503 skip |=
5504 ValidateImageBarrierSubresourceRange(loc.dot(Field::subresourceRange), image_data.get(), mem_barrier.subresourceRange);
ziga-lunarg69aa72f2022-03-29 15:24:35 +02005505 skip |= ValidateImageAcquired(*image_data, loc.StringFunc().c_str());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005506 }
5507 return skip;
5508}
5509
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005510bool CoreChecks::ValidateBarriers(const Location &outer_loc, const CMD_BUFFER_STATE *cb_state, VkPipelineStageFlags src_stage_mask,
5511 VkPipelineStageFlags dst_stage_mask, uint32_t memBarrierCount,
5512 const VkMemoryBarrier *pMemBarriers, uint32_t bufferBarrierCount,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005513 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
5514 const VkImageMemoryBarrier *pImageMemBarriers) const {
5515 bool skip = false;
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005516 LogObjectList objects(cb_state->commandBuffer());
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005517
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005518 for (uint32_t i = 0; i < memBarrierCount; ++i) {
5519 const auto &mem_barrier = pMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005520 auto loc = outer_loc.dot(Struct::VkMemoryBarrier, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005521 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005522 }
5523 for (uint32_t i = 0; i < imageMemBarrierCount; ++i) {
5524 const auto &mem_barrier = pImageMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005525 auto loc = outer_loc.dot(Struct::VkImageMemoryBarrier, Field::pImageMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005526 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005527 skip |= ValidateImageBarrier(objects, loc, cb_state, mem_barrier);
5528 }
5529 {
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005530 Location loc(outer_loc.function, Struct::VkImageMemoryBarrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005531 skip |= ValidateBarriersToImages(loc, cb_state, imageMemBarrierCount, pImageMemBarriers);
5532 }
5533 for (uint32_t i = 0; i < bufferBarrierCount; ++i) {
5534 const auto &mem_barrier = pBufferMemBarriers[i];
Jeremy Gebbend5bf0be2021-03-02 14:37:48 -07005535 auto loc = outer_loc.dot(Struct::VkBufferMemoryBarrier, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005536 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier, src_stage_mask, dst_stage_mask);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005537 skip |= ValidateBufferBarrier(objects, loc, cb_state, mem_barrier);
5538 }
5539 return skip;
5540}
5541
Jeremy Gebbenbe60dd22021-03-02 16:36:47 -07005542bool CoreChecks::ValidateDependencyInfo(const LogObjectList &objects, const Location &outer_loc, const CMD_BUFFER_STATE *cb_state,
Jeremy Gebbenefead332021-06-18 08:22:44 -06005543 const VkDependencyInfoKHR *dep_info) const {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005544 bool skip = false;
5545
5546 if (cb_state->activeRenderPass) {
5547 skip |= ValidateRenderPassPipelineBarriers(outer_loc, cb_state, dep_info);
5548 if (skip) return true; // Early return to avoid redundant errors from below calls
5549 }
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005550 for (uint32_t i = 0; i < dep_info->memoryBarrierCount; ++i) {
5551 const auto &mem_barrier = dep_info->pMemoryBarriers[i];
Tony-LunarG279601c2021-11-16 10:50:51 -07005552 auto loc = outer_loc.dot(Struct::VkMemoryBarrier2, Field::pMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005553 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005554 }
5555 for (uint32_t i = 0; i < dep_info->imageMemoryBarrierCount; ++i) {
5556 const auto &mem_barrier = dep_info->pImageMemoryBarriers[i];
Tony-LunarG279601c2021-11-16 10:50:51 -07005557 auto loc = outer_loc.dot(Struct::VkImageMemoryBarrier2, Field::pImageMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005558 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005559 skip |= ValidateImageBarrier(objects, loc, cb_state, mem_barrier);
5560 }
5561 {
Tony-LunarG279601c2021-11-16 10:50:51 -07005562 Location loc(outer_loc.function, Struct::VkImageMemoryBarrier2);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005563 skip |= ValidateBarriersToImages(loc, cb_state, dep_info->imageMemoryBarrierCount, dep_info->pImageMemoryBarriers);
5564 }
5565
5566 for (uint32_t i = 0; i < dep_info->bufferMemoryBarrierCount; ++i) {
5567 const auto &mem_barrier = dep_info->pBufferMemoryBarriers[i];
Tony-LunarG279601c2021-11-16 10:50:51 -07005568 auto loc = outer_loc.dot(Struct::VkBufferMemoryBarrier2, Field::pBufferMemoryBarriers, i);
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005569 skip |= ValidateMemoryBarrier(objects, loc, cb_state, mem_barrier);
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005570 skip |= ValidateBufferBarrier(objects, loc, cb_state, mem_barrier);
5571 }
5572
5573 return skip;
5574}
5575
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005576// template to check all original barrier structures
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005577template <typename Barrier>
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005578bool CoreChecks::ValidateMemoryBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
5579 const Barrier &barrier, VkPipelineStageFlags src_stage_mask,
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005580 VkPipelineStageFlags dst_stage_mask) const {
5581 bool skip = false;
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005582 assert(cb_state);
5583 auto queue_flags = cb_state->GetQueueFlags();
5584
5585 if (!cb_state->IsAcquireOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005586 skip |= ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), queue_flags, barrier.srcAccessMask, src_stage_mask);
5587 }
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005588 if (!cb_state->IsReleaseOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005589 skip |= ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), queue_flags, barrier.dstAccessMask, dst_stage_mask);
5590 }
5591 return skip;
5592}
5593
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005594// template to check all synchronization2 barrier structures
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005595template <typename Barrier>
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005596bool CoreChecks::ValidateMemoryBarrier(const LogObjectList &objects, const Location &loc, const CMD_BUFFER_STATE *cb_state,
5597 const Barrier &barrier) const {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005598 bool skip = false;
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005599 assert(cb_state);
5600 auto queue_flags = cb_state->GetQueueFlags();
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005601
Jeremy Gebbenefead332021-06-18 08:22:44 -06005602 skip |= ValidatePipelineStage(objects, loc.dot(Field::srcStageMask), queue_flags, barrier.srcStageMask);
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005603 if (!cb_state->IsAcquireOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005604 skip |=
5605 ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), queue_flags, barrier.srcAccessMask, barrier.srcStageMask);
5606 }
Jeremy Gebbenefead332021-06-18 08:22:44 -06005607
Jeremy Gebben7ba56152021-06-18 10:40:10 -06005608 skip |= ValidatePipelineStage(objects, loc.dot(Field::dstStageMask), queue_flags, barrier.dstStageMask);
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005609 if (!cb_state->IsReleaseOp(barrier)) {
Jeremy Gebbene60d4172021-02-02 15:42:15 -07005610 skip |=
5611 ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), queue_flags, barrier.dstAccessMask, barrier.dstStageMask);
5612 }
5613 return skip;
5614}
5615
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005616// VkSubpassDependency validation happens when vkCreateRenderPass() is called.
5617// Dependencies between subpasses can only use pipeline stages compatible with VK_QUEUE_GRAPHICS_BIT,
5618// for external subpasses we don't have a yet command buffer so we have to assume all of them are valid.
5619static inline VkQueueFlags SubpassToQueueFlags(uint32_t subpass) {
5620 return subpass == VK_SUBPASS_EXTERNAL ? sync_utils::kAllQueueTypes : static_cast<VkQueueFlags>(VK_QUEUE_GRAPHICS_BIT);
5621}
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005622
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005623bool CoreChecks::ValidateSubpassDependency(const LogObjectList &objects, const Location &in_loc,
5624 const VkSubpassDependency2 &dependency) const {
5625 bool skip = false;
5626 Location loc = in_loc;
5627 VkMemoryBarrier2KHR converted_barrier;
5628 const auto *mem_barrier = LvlFindInChain<VkMemoryBarrier2KHR>(dependency.pNext);
5629
Tony-LunarG273f32f2021-09-28 08:56:30 -06005630 if (mem_barrier && enabled_features.core13.synchronization2) {
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005631 if (dependency.srcAccessMask != 0) {
5632 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-srcAccessMask",
5633 "%s is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5634 loc.dot(Field::srcAccessMask).Message().c_str());
5635 }
5636 if (dependency.dstAccessMask != 0) {
5637 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-dstAccessMask",
5638 "%s dstAccessMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5639 loc.dot(Field::dstAccessMask).Message().c_str());
5640 }
5641 if (dependency.srcStageMask != 0) {
5642 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-srcStageMask",
5643 "%s srcStageMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5644 loc.dot(Field::srcStageMask).Message().c_str());
5645 }
5646 if (dependency.dstStageMask != 0) {
5647 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-dstStageMask",
5648 "%s dstStageMask is non-zero when a VkMemoryBarrier2KHR is present in pNext.",
5649 loc.dot(Field::dstStageMask).Message().c_str());
5650 }
5651 loc = in_loc.dot(Field::pNext);
5652 converted_barrier = *mem_barrier;
5653 } else {
5654 if (mem_barrier) {
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005655 skip |= LogError(objects, "UNASSIGNED-CoreChecks-VkSubpassDependency2-pNext",
5656 "%s a VkMemoryBarrier2KHR is present in pNext but synchronization2 is not enabled.",
5657 loc.Message().c_str());
5658 }
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005659 // use the subpass dependency flags, upconverted into wider synchronization2 fields.
5660 converted_barrier.srcStageMask = dependency.srcStageMask;
5661 converted_barrier.dstStageMask = dependency.dstStageMask;
5662 converted_barrier.srcAccessMask = dependency.srcAccessMask;
5663 converted_barrier.dstAccessMask = dependency.dstAccessMask;
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005664 }
Jeremy Gebbenbd7c9952021-06-23 10:14:06 -06005665 auto src_queue_flags = SubpassToQueueFlags(dependency.srcSubpass);
5666 skip |= ValidatePipelineStage(objects, loc.dot(Field::srcStageMask), src_queue_flags, converted_barrier.srcStageMask);
5667 skip |= ValidateAccessMask(objects, loc.dot(Field::srcAccessMask), src_queue_flags, converted_barrier.srcAccessMask,
5668 converted_barrier.srcStageMask);
5669
5670 auto dst_queue_flags = SubpassToQueueFlags(dependency.dstSubpass);
5671 skip |= ValidatePipelineStage(objects, loc.dot(Field::dstStageMask), dst_queue_flags, converted_barrier.dstStageMask);
5672 skip |= ValidateAccessMask(objects, loc.dot(Field::dstAccessMask), dst_queue_flags, converted_barrier.dstAccessMask,
5673 converted_barrier.dstStageMask);
Jeremy Gebbenec9ee972021-02-17 14:09:00 -07005674 return skip;
Jeremy Gebben50e0b412021-02-18 10:39:41 -07005675}
5676
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005677bool CoreChecks::ValidateImageViewFormatFeatures(const IMAGE_STATE *image_state, const VkFormat view_format,
5678 const VkImageUsageFlags image_usage) const {
5679 // Pass in image_usage here instead of extracting it from image_state in case there's a chained VkImageViewUsageCreateInfo
5680 bool skip = false;
5681
Lionel Landwerlin21719f62021-12-09 11:40:09 +02005682 VkFormatFeatureFlags2KHR tiling_features = 0;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005683 const VkImageTiling image_tiling = image_state->createInfo.tiling;
5684
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06005685 if (image_state->HasAHBFormat()) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005686 // AHB image view and image share same feature sets
5687 tiling_features = image_state->format_features;
5688 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5689 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
sfricke-samsung45996a42021-09-16 13:45:27 -07005690 assert(IsExtEnabled(device_extensions.vk_ext_image_drm_format_modifier));
sjfrickee9b39372022-05-22 13:02:17 +09005691 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = LvlInitStruct<VkImageDrmFormatModifierPropertiesEXT>();
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005692 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image_state->image(), &drm_format_properties);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005693
Lionel Landwerlin1da35792021-12-14 16:54:13 +02005694 auto fmt_drm_props = LvlInitStruct<VkDrmFormatModifierPropertiesListEXT>();
5695 auto fmt_props_2 = LvlInitStruct<VkFormatProperties2>(&fmt_drm_props);
5696 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &fmt_props_2);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005697
nyorain38a9d232021-03-06 13:06:12 +01005698 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
Lionel Landwerlin1da35792021-12-14 16:54:13 +02005699 drm_properties.resize(fmt_drm_props.drmFormatModifierCount);
5700 fmt_drm_props.pDrmFormatModifierProperties = drm_properties.data();
nyorain38a9d232021-03-06 13:06:12 +01005701
Lionel Landwerlin1da35792021-12-14 16:54:13 +02005702 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &fmt_props_2);
nyorain38a9d232021-03-06 13:06:12 +01005703
Lionel Landwerlin1da35792021-12-14 16:54:13 +02005704 for (uint32_t i = 0; i < fmt_drm_props.drmFormatModifierCount; i++) {
5705 if (fmt_drm_props.pDrmFormatModifierProperties[i].drmFormatModifier == drm_format_properties.drmFormatModifier) {
5706 tiling_features = fmt_drm_props.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
5707 break;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005708 }
5709 }
5710 } else {
Lionel Landwerlin21719f62021-12-09 11:40:09 +02005711 VkFormatProperties3KHR format_properties = GetPDFormatProperties(view_format);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005712 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
5713 : format_properties.optimalTilingFeatures;
5714 }
5715
5716 if (tiling_features == 0) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005717 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-None-02273",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005718 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
5719 "physical device.",
5720 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5721 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005722 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02274",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005723 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5724 "VK_IMAGE_USAGE_SAMPLED_BIT.",
5725 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5726 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005727 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02275",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005728 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5729 "VK_IMAGE_USAGE_STORAGE_BIT.",
5730 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5731 } 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 -06005732 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02276",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005733 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5734 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
5735 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5736 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
5737 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005738 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02277",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005739 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5740 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5741 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5742 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
5743 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005744 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-02652",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005745 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5746 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5747 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Tobias Hector6663c9b2020-11-05 10:18:02 +00005748 } else if ((image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) &&
5749 !(tiling_features & VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR)) {
5750 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06005751 skip |= LogError(image_state->image(), "VUID-VkImageViewCreateInfo-usage-04550",
Tobias Hector6663c9b2020-11-05 10:18:02 +00005752 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
5753 "VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR.",
5754 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5755 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005756 }
5757
5758 return skip;
5759}
5760
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005761bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005762 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005763 bool skip = false;
Jeremy Gebbenf4449392022-01-28 10:09:10 -07005764 auto image_state = Get<IMAGE_STATE>(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005765 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005766 skip |=
Jeremy Gebben9f537102021-10-05 16:37:12 -06005767 ValidateImageUsageFlags(image_state.get(),
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005768 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
5769 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
sfricke-samsungbb971942020-09-10 22:11:56 -07005770 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV |
5771 VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
5772 false, "VUID-VkImageViewCreateInfo-image-04441", "vkCreateImageView()",
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005773 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
sfricke-samsungbb971942020-09-10 22:11:56 -07005774 "TRANSIENT_ATTACHMENT|SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005775 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Jeremy Gebben9f537102021-10-05 16:37:12 -06005776 skip |= ValidateMemoryIsBoundToImage(image_state.get(), "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005777 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02005778 skip |= ValidateCreateImageViewSubresourceRange(
Jeremy Gebben9f537102021-10-05 16:37:12 -06005779 image_state.get(),
5780 pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005781 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005782
5783 VkImageCreateFlags image_flags = image_state->createInfo.flags;
5784 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005785 VkImageUsageFlags image_usage = image_state->createInfo.usage;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005786 VkFormat view_format = pCreateInfo->format;
5787 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06005788 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005789 VkImageViewType view_type = pCreateInfo->viewType;
sfricke-samsung20a8a372021-07-14 06:12:17 -07005790 uint32_t layer_count = pCreateInfo->subresourceRange.layerCount;
Mark Lobodzinski602de982017-02-09 11:01:33 -07005791
Dave Houltonbd2e2622018-04-10 16:41:14 -06005792 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005793 auto chained_ivuci_struct = LvlFindInChain<VkImageViewUsageCreateInfo>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06005794 if (chained_ivuci_struct) {
sfricke-samsung45996a42021-09-16 13:45:27 -07005795 if (IsExtEnabled(device_extensions.vk_khr_maintenance2)) {
5796 if (!IsExtEnabled(device_extensions.vk_ext_separate_stencil_usage)) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05005797 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005798 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
5799 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
5800 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05005801 }
5802 } else {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07005803 const auto image_stencil_struct = LvlFindInChain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
Andrew Fobel3abeb992020-01-20 16:33:22 -05005804 if (image_stencil_struct == nullptr) {
5805 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005806 skip |= LogError(
5807 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005808 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
5809 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
5810 "any bits that were not set in VkImageCreateInfo::usage used to create image");
5811 }
5812 } else {
5813 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
5814 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
5815 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005816 skip |= LogError(
5817 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005818 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5819 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5820 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
5821 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
5822 }
5823 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
5824 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005825 skip |= LogError(
5826 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005827 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5828 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5829 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
5830 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
5831 }
5832 }
5833 }
5834 }
5835
Dave Houltonbd2e2622018-04-10 16:41:14 -06005836 image_usage = chained_ivuci_struct->usage;
5837 }
5838
sfricke-samsungf60b6c82021-04-05 22:59:20 -07005839 // If image used VkImageFormatListCreateInfo need to make sure a format from list is used
5840 const auto format_list_info = LvlFindInChain<VkImageFormatListCreateInfo>(image_state->createInfo.pNext);
5841 if (format_list_info && (format_list_info->viewFormatCount > 0)) {
5842 bool foundFormat = false;
5843 for (uint32_t i = 0; i < format_list_info->viewFormatCount; i++) {
5844 if (format_list_info->pViewFormats[i] == view_format) {
5845 foundFormat = true;
5846 break;
5847 }
5848 }
5849 if (foundFormat == false) {
5850 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-01585",
5851 "vkCreateImageView(): image was created with a VkImageFormatListCreateInfo in pNext of "
5852 "vkImageCreateInfo, but none of the formats match the VkImageViewCreateInfo::format (%s).",
5853 string_VkFormat(view_format));
5854 }
5855 }
5856
Dave Houlton6f5f20a2018-05-04 12:37:44 -06005857 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
5858 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005859 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01005860 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06005861 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01005862 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06005863 std::stringstream ss;
5864 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01005865 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06005866 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005867 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005868 }
5869 } else {
Mike Schuchardt2df08912020-12-15 16:28:09 -08005870 if (!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005871 // 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 -06005872 auto image_class = FormatCompatibilityClass(image_format);
5873 auto view_class = FormatCompatibilityClass(view_format);
5874 // Need to only check if one is NONE to handle edge case both are NONE
5875 if ((image_class != view_class) || (image_class == FORMAT_COMPATIBILITY_CLASS::NONE)) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005876 const char *error_vuid;
sfricke-samsung45996a42021-09-16 13:45:27 -07005877 if ((!IsExtEnabled(device_extensions.vk_khr_maintenance2)) &&
5878 (!IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion))) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005879 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
sfricke-samsung45996a42021-09-16 13:45:27 -07005880 } else 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-01759";
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-01760";
5886 } else {
5887 // both enabled
5888 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
5889 }
Dave Houltonc7988072018-04-16 11:46:56 -06005890 std::stringstream ss;
5891 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06005892 << " is not in the same format compatibility class as "
5893 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06005894 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
5895 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005896 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005897 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06005898 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005899 }
5900 } else {
5901 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07005902 // Unless it is a multi-planar color bit aspect
5903 if ((image_format != view_format) &&
5904 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
sfricke-samsung45996a42021-09-16 13:45:27 -07005905 const char *vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
5906 ? "VUID-VkImageViewCreateInfo-image-01762"
5907 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07005908 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06005909 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07005910 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07005911 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07005912 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005913 }
5914 }
5915
ziga-lunargebb32de2021-08-29 21:24:30 +02005916 if (image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT && view_type != VK_IMAGE_VIEW_TYPE_2D &&
5917 view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5918 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04972",
5919 "vkCreateImageView(): image was created with sample count %s, but pCreateInfo->viewType is %s.",
5920 string_VkSampleCountFlagBits(image_state->createInfo.samples), string_VkImageViewType(view_type));
5921 }
5922
Mark Lobodzinski602de982017-02-09 11:01:33 -07005923 // Validate correct image aspect bits for desired formats and format consistency
Aitor Camachoeb35fed2022-06-07 14:07:42 +02005924 skip |=
5925 ValidateImageAspectMask(image_state->image(), image_format, aspect_mask, image_state->disjoint, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06005926
sfricke-samsung20a8a372021-07-14 06:12:17 -07005927 // Valdiate Image/ImageView type compatibility #resources-image-views-compatibility
Jeremy Kniager846ab732017-07-10 13:12:04 -06005928 switch (image_type) {
5929 case VK_IMAGE_TYPE_1D:
5930 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005931 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5932 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5933 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005934 }
5935 break;
5936 case VK_IMAGE_TYPE_2D:
5937 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5938 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
5939 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005940 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
5941 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5942 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005943 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005944 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5945 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5946 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005947 }
5948 }
5949 break;
5950 case VK_IMAGE_TYPE_3D:
sfricke-samsung45996a42021-09-16 13:45:27 -07005951 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06005952 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
5953 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
Tony-LunarGbe956362022-04-05 13:34:31 -06005954 if (device_extensions.vk_ext_image_2d_view_of_3d) {
5955 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT)) {
5956 if (view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5957 skip |= LogError(
5958 pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-06723",
5959 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type "
5960 "%s since the image doesn't have VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT flag set.",
5961 string_VkImageViewType(view_type), string_VkImageType(image_type));
5962 } else if (view_type == VK_IMAGE_VIEW_TYPE_2D &&
5963 !(image_flags & VK_IMAGE_CREATE_2D_VIEW_COMPATIBLE_BIT_EXT)) {
5964 skip |= LogError(
5965 pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-06728",
5966 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type "
5967 "%s since the image doesn't have VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT or "
5968 "VK_IMAGE_CREATE_2D_VIEW_COMPATIBLE_BIT_EXT flag set.",
5969 string_VkImageViewType(view_type), string_VkImageType(image_type));
5970 }
5971 }
5972 } else if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT) &&
5973 (view_type == VK_IMAGE_VIEW_TYPE_2D)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005974 skip |=
Tony-LunarGbe956362022-04-05 13:34:31 -06005975 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-06727",
5976 "vkCreateImageView(): pCreateInfo->viewType VK_IMAGE_VIEW_TYPE_2D is not compatible "
5977 "with image type "
sfricke-samsungd9b3e122021-07-15 22:50:00 -07005978 "%s since the image doesn't have VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT flag set.",
Tony-LunarGbe956362022-04-05 13:34:31 -06005979 string_VkImageType(image_type));
5980 }
5981 if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
Jeremy Kniager846ab732017-07-10 13:12:04 -06005982 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005983 skip |= LogError(
sfricke-samsungd9b3e122021-07-15 22:50:00 -07005984 pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04971",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005985 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
5986 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
5987 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
5988 string_VkImageViewType(view_type), string_VkImageType(image_type));
sfricke-samsungd9b3e122021-07-15 22:50:00 -07005989 } else if (pCreateInfo->subresourceRange.levelCount != 1) {
5990 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04970",
5991 "vkCreateImageView(): pCreateInfo->viewType %s is with image type %s must have a "
5992 "levelCount of 1 but it is %u.",
5993 string_VkImageViewType(view_type), string_VkImageType(image_type),
5994 pCreateInfo->subresourceRange.levelCount);
Jeremy Kniager846ab732017-07-10 13:12:04 -06005995 }
5996 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005997 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5998 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5999 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06006000 }
6001 }
6002 } else {
6003 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
sfricke-samsungd9b3e122021-07-15 22:50:00 -07006004 // Help point to VK_KHR_maintenance1
6005 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
6006 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
6007 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
6008 "without VK_KHR_maintenance1 enabled which was promoted in Vulkan 1.0.",
6009 string_VkImageViewType(view_type), string_VkImageType(image_type));
6010 } else {
6011 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
6012 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
6013 string_VkImageViewType(view_type), string_VkImageType(image_type));
6014 }
Jeremy Kniager846ab732017-07-10 13:12:04 -06006015 }
6016 }
6017 break;
6018 default:
6019 break;
6020 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06006021
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006022 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
sfricke-samsung45996a42021-09-16 13:45:27 -07006023 if (IsExtEnabled(device_extensions.vk_android_external_memory_android_hardware_buffer)) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07006024 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06006025 }
6026
Jeremy Gebben9f537102021-10-05 16:37:12 -06006027 skip |= ValidateImageViewFormatFeatures(image_state.get(), view_format, image_usage);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006028
sfricke-samsung828e59d2021-08-22 23:20:49 -07006029 if (enabled_features.shading_rate_image_features.shadingRateImage) {
Tobias Hector6663c9b2020-11-05 10:18:02 +00006030 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
6031 if (view_format != VK_FORMAT_R8_UINT) {
6032 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
6033 "vkCreateImageView() If image was created with usage containing "
6034 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
6035 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05006036 }
Tobias Hector6663c9b2020-11-05 10:18:02 +00006037 }
6038
sfricke-samsung828e59d2021-08-22 23:20:49 -07006039 if (enabled_features.shading_rate_image_features.shadingRateImage ||
Tobias Hector6663c9b2020-11-05 10:18:02 +00006040 enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate) {
6041 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR) {
6042 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
6043 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
6044 "vkCreateImageView() If image was created with usage containing "
6045 "VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR, viewType must be "
6046 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
6047 }
Jeff Bolz9af91c52018-09-01 21:53:57 -05006048 }
6049 }
Jeff Bolz99e3f632020-03-24 22:59:22 -05006050
Tobias Hector6663c9b2020-11-05 10:18:02 +00006051 if (enabled_features.fragment_shading_rate_features.attachmentFragmentShadingRate &&
6052 !phys_dev_ext_props.fragment_shading_rate_props.layeredShadingRateAttachments &&
sfricke-samsung20a8a372021-07-14 06:12:17 -07006053 image_usage & VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR && layer_count != 1) {
Tobias Hector6663c9b2020-11-05 10:18:02 +00006054 skip |= LogError(device, "VUID-VkImageViewCreateInfo-usage-04551",
6055 "vkCreateImageView(): subresourceRange.layerCount is %u for a shading rate attachment image view.",
sfricke-samsung20a8a372021-07-14 06:12:17 -07006056 layer_count);
Tobias Hector6663c9b2020-11-05 10:18:02 +00006057 }
6058
sfricke-samsung20a8a372021-07-14 06:12:17 -07006059 if (layer_count == VK_REMAINING_ARRAY_LAYERS) {
6060 const uint32_t remaining_layers = image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer;
6061 if (view_type == VK_IMAGE_VIEW_TYPE_CUBE && remaining_layers != 6) {
Jeff Bolz99e3f632020-03-24 22:59:22 -05006062 skip |= LogError(device, "VUID-VkImageViewCreateInfo-viewType-02962",
6063 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be 6",
sfricke-samsung20a8a372021-07-14 06:12:17 -07006064 remaining_layers);
Jeff Bolz99e3f632020-03-24 22:59:22 -05006065 }
sfricke-samsung20a8a372021-07-14 06:12:17 -07006066 if (view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY && ((remaining_layers) % 6) != 0) {
Jeff Bolz99e3f632020-03-24 22:59:22 -05006067 skip |= LogError(
6068 device, "VUID-VkImageViewCreateInfo-viewType-02963",
6069 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be a multiple of 6",
sfricke-samsung20a8a372021-07-14 06:12:17 -07006070 remaining_layers);
6071 }
6072 if ((remaining_layers != 1) && ((view_type == VK_IMAGE_VIEW_TYPE_1D) || (view_type == VK_IMAGE_VIEW_TYPE_2D) ||
6073 (view_type == VK_IMAGE_VIEW_TYPE_3D))) {
6074 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-imageViewType-04974",
6075 "vkCreateImageView(): Using pCreateInfo->viewType %s and the subresourceRange.layerCount "
6076 "VK_REMAINING_ARRAY_LAYERS=(%d) and must 1 (try looking into VK_IMAGE_VIEW_TYPE_*_ARRAY).",
6077 string_VkImageViewType(view_type), remaining_layers);
6078 }
6079 } else {
6080 if ((layer_count != 1) && ((view_type == VK_IMAGE_VIEW_TYPE_1D) || (view_type == VK_IMAGE_VIEW_TYPE_2D) ||
6081 (view_type == VK_IMAGE_VIEW_TYPE_3D))) {
6082 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-imageViewType-04973",
ziga-lunargc9d29f72022-05-15 19:55:08 +02006083 "vkCreateImageView(): subresourceRange.layerCount (%" PRIu32
6084 ") must be 1 when using viewType %s (try looking into VK_IMAGE_VIEW_TYPE_*_ARRAY).",
6085 layer_count, string_VkImageViewType(view_type));
Jeff Bolz99e3f632020-03-24 22:59:22 -05006086 }
6087 }
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006088
6089 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
ziga-lunarga77a2832022-05-03 11:12:00 +02006090 const auto normalized_subresource_range = image_state->NormalizeSubresourceRange(pCreateInfo->subresourceRange);
6091 if (normalized_subresource_range.levelCount != 1) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06006092 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02571",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006093 "vkCreateImageView(): If image was created with usage containing "
6094 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, subresourceRange.levelCount (%d) must: be 1",
6095 pCreateInfo->subresourceRange.levelCount);
6096 }
6097 }
6098 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
6099 if (!enabled_features.fragment_density_map_features.fragmentDensityMapDynamic) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06006100 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-02572",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006101 "vkCreateImageView(): If the fragmentDensityMapDynamic feature is not enabled, "
6102 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
6103 }
6104 } else {
6105 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
6106 if (image_flags & (VK_IMAGE_CREATE_PROTECTED_BIT | VK_IMAGE_CREATE_SPARSE_BINDING_BIT |
6107 VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT)) {
Shannon McPherson8d0d1f92020-07-06 11:58:21 -06006108 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-04116",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006109 "vkCreateImageView(): If image was created with usage containing "
6110 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT flags must not contain any of "
6111 "VK_IMAGE_CREATE_PROTECTED_BIT, VK_IMAGE_CREATE_SPARSE_BINDING_BIT, "
6112 "VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or VK_IMAGE_CREATE_SPARSE_ALIASED_BIT");
6113 }
6114 }
6115 }
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07006116
ziga-lunarg966ac0e2021-07-18 11:51:44 +02006117 if (image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
6118 if (pCreateInfo->subresourceRange.levelCount != 1) {
6119 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01584",
6120 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit, "
6121 "but subresourcesRange.levelCount (%" PRIu32 ") is not 1.",
6122 pCreateInfo->subresourceRange.levelCount);
6123 }
6124 if (pCreateInfo->subresourceRange.layerCount != 1) {
6125 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01584",
6126 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit, "
6127 "but subresourcesRange.layerCount (%" PRIu32 ") is not 1.",
6128 pCreateInfo->subresourceRange.layerCount);
6129 }
ziga-lunarg966ac0e2021-07-18 11:51:44 +02006130
sfricke-samsungd750f812022-02-04 10:23:34 -08006131 if (!FormatIsCompressed(view_format) && pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_3D) {
6132 skip |=
6133 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-04739",
ziga-lunargc290c7f2021-07-31 22:01:46 +02006134 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit and "
6135 "non-compressed format (%s), but pCreateInfo->viewType is VK_IMAGE_VIEW_TYPE_3D.",
6136 string_VkFormat(image_format));
sfricke-samsungd750f812022-02-04 10:23:34 -08006137 }
6138
6139 const bool class_compatible = FormatCompatibilityClass(view_format) == FormatCompatibilityClass(image_format);
6140 // "uncompressed format that is size-compatible" so if compressed, same as not being compatible
6141 const bool size_compatible =
6142 FormatIsCompressed(view_format) ? false : FormatElementSize(view_format) == FormatElementSize(image_format);
6143 if (!class_compatible && !size_compatible) {
6144 skip |=
6145 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01583",
6146 "vkCreateImageView(): Image was created with VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT bit and "
6147 "format (%s), but pCreateInfo->format (%s) are not compatible.",
6148 string_VkFormat(image_format), string_VkFormat(view_format));
6149 }
ziga-lunargc290c7f2021-07-31 22:01:46 +02006150 }
6151
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02006152 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT) {
6153 if (!enabled_features.fragment_density_map2_features.fragmentDensityMapDeferred) {
6154 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03567",
6155 "vkCreateImageView(): If the fragmentDensityMapDeferred feature is not enabled, "
6156 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT");
6157 }
6158 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
6159 skip |=
6160 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03568",
6161 "vkCreateImageView(): If flags contains VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT, "
6162 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
6163 }
6164 }
sfricke-samsung45996a42021-09-16 13:45:27 -07006165 if (IsExtEnabled(device_extensions.vk_ext_fragment_density_map2)) {
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02006166 if ((image_flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) && (image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) &&
sfricke-samsung20a8a372021-07-14 06:12:17 -07006167 (layer_count > phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers)) {
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02006168 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-03569",
6169 "vkCreateImageView(): If image was created with flags containing "
6170 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT and usage containing VK_IMAGE_USAGE_SAMPLED_BIT "
6171 "subresourceRange.layerCount (%d) must: be less than or equal to maxSubsampledArrayLayers (%d)",
sfricke-samsung20a8a372021-07-14 06:12:17 -07006172 layer_count, phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers);
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02006173 }
6174 }
6175
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07006176 auto astc_decode_mode = LvlFindInChain<VkImageViewASTCDecodeModeEXT>(pCreateInfo->pNext);
sfricke-samsung45996a42021-09-16 13:45:27 -07006177 if (IsExtEnabled(device_extensions.vk_ext_astc_decode_mode) && (astc_decode_mode != nullptr)) {
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07006178 if ((enabled_features.astc_decode_features.decodeModeSharedExponent == VK_FALSE) &&
6179 (astc_decode_mode->decodeMode == VK_FORMAT_E5B9G9R9_UFLOAT_PACK32)) {
6180 skip |= LogError(device, "VUID-VkImageViewASTCDecodeModeEXT-decodeMode-02231",
6181 "vkCreateImageView(): decodeModeSharedExponent is not enabled but "
6182 "VkImageViewASTCDecodeModeEXT::decodeMode is VK_FORMAT_E5B9G9R9_UFLOAT_PACK32.");
6183 }
6184 }
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07006185
sfricke-samsung45996a42021-09-16 13:45:27 -07006186 if (IsExtEnabled(device_extensions.vk_khr_portability_subset)) {
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07006187 // If swizzling is disabled, make sure it isn't used
Nathaniel Cesario17d057e2021-06-21 22:58:45 -06006188 // NOTE: as of spec version 1.2.183, VUID 04465 states: "all elements of components _must_ be
6189 // VK_COMPONENT_SWIZZLE_IDENTITY."
6190 // However, issue https://github.com/KhronosGroup/Vulkan-Portability/issues/27 points out that the identity can
6191 // also be defined via R, G, B, A enums in the correct order.
6192 // Spec change is at https://gitlab.khronos.org/vulkan/vulkan/-/merge_requests/4600
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07006193 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatSwizzle) &&
Nathaniel Cesario17d057e2021-06-21 22:58:45 -06006194 !IsIdentitySwizzle(pCreateInfo->components)) {
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07006195 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatSwizzle-04465",
6196 "vkCreateImageView (portability error): swizzle is disabled for this device.");
6197 }
6198
6199 // Ensure ImageView's format has the same number of bits and components as Image's format if format reinterpretation is
6200 // disabled
6201 // TODO (ncesario): This is not correct for some cases (e.g., VK_FORMAT_B10G11R11_UFLOAT_PACK32 and
6202 // VK_FORMAT_E5B9G9R9_UFLOAT_PACK32), but requires additional information that should probably be generated from the
6203 // spec. See Github issue #2361.
6204 if ((VK_FALSE == enabled_features.portability_subset_features.imageViewFormatReinterpretation) &&
6205 ((FormatElementSize(pCreateInfo->format, VK_IMAGE_ASPECT_COLOR_BIT) !=
6206 FormatElementSize(image_state->createInfo.format, VK_IMAGE_ASPECT_COLOR_BIT)) ||
sfricke-samsunged028b02021-09-06 23:14:51 -07006207 (FormatComponentCount(pCreateInfo->format) != FormatComponentCount(image_state->createInfo.format)))) {
Nathaniel Cesariofe1d5832020-11-13 12:05:55 -07006208 skip |= LogError(device, "VUID-VkImageViewCreateInfo-imageViewFormatReinterpretation-04466",
6209 "vkCreateImageView (portability error): ImageView format must have"
6210 " the same number of components and bits per component as the Image's format");
6211 }
6212 }
Tony-LunarG69604c42021-11-22 16:00:12 -07006213
6214 auto image_view_min_lod = LvlFindInChain<VkImageViewMinLodCreateInfoEXT>(pCreateInfo->pNext);
6215 if (image_view_min_lod) {
6216 if ((!enabled_features.image_view_min_lod_features.minLod) && (image_view_min_lod->minLod != 0)) {
6217 skip |= LogError(device, "VUID-VkImageViewMinLodCreateInfoEXT-minLod-06455",
6218 "vkCreateImageView(): VkImageViewMinLodCreateInfoEXT::minLod = %f, but the minLod feature is not "
6219 "enabled. If the minLod feature is not enabled, minLod must be 0.0",
6220 image_view_min_lod->minLod);
6221 }
6222 auto max_level = (pCreateInfo->subresourceRange.baseMipLevel + (pCreateInfo->subresourceRange.levelCount - 1));
6223 if (image_view_min_lod->minLod > max_level) {
6224 skip |= LogError(device, "VUID-VkImageViewMinLodCreateInfoEXT-minLod-06456",
6225 "vkCreateImageView(): minLod (%f) must be less or equal to the index of the last mipmap level "
6226 "accessible to the view (%" PRIu32 ")",
6227 image_view_min_lod->minLod, max_level);
6228 }
6229 }
sfricke-samsung0dae8952022-03-03 20:34:23 -06006230
6231 if (FormatRequiresYcbcrConversionExplicitly(view_format)) {
6232 const auto ycbcr_conversion = LvlFindInChain<VkSamplerYcbcrConversionInfo>(pCreateInfo->pNext);
6233 if (!ycbcr_conversion || ycbcr_conversion->conversion == VK_NULL_HANDLE) {
6234 skip |= LogError(
6235 device, "VUID-VkImageViewCreateInfo-format-06415",
6236 "vkCreateImageView(): Format %s requires a VkSamplerYcbcrConversion but one was not passed in the pNext chain.",
6237 string_VkFormat(view_format));
6238 }
6239 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07006240 }
6241 return skip;
6242}
6243
Jeff Leger178b1e52020-10-05 12:22:23 -04006244template <typename RegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006245bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
Tony-LunarGef035472021-11-02 10:23:33 -06006246 uint32_t regionCount, const RegionType *pRegions, CMD_TYPE cmd_type) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006247 bool skip = false;
Tony-LunarGef035472021-11-02 10:23:33 -06006248 const bool is_2 = (cmd_type == CMD_COPYBUFFER2KHR || cmd_type == CMD_COPYBUFFER2);
6249 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04006250 const char *vuid;
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006251
6252 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
6253 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006254
6255 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006256 const RegionType region = pRegions[i];
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006257
6258 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
sfricke-samsung71f04e32022-03-16 01:21:21 -05006259 if (region.srcOffset >= src_buffer_size) {
Tony-LunarGef035472021-11-02 10:23:33 -06006260 vuid = is_2 ? "VUID-VkCopyBufferInfo2-srcOffset-00113" : "VUID-vkCmdCopyBuffer-srcOffset-00113";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006261 skip |= LogError(src_buffer_state->buffer(), vuid,
ziga-lunargd6b58ce2021-10-16 01:22:56 +02006262 "%s: pRegions[%" PRIu32 "].srcOffset (%" PRIuLEAST64
6263 ") is greater than size of srcBuffer (%" PRIuLEAST64 ").",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006264 func_name, i, region.srcOffset, src_buffer_size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006265 }
6266
6267 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
sfricke-samsung71f04e32022-03-16 01:21:21 -05006268 if (region.dstOffset >= dst_buffer_size) {
Tony-LunarGef035472021-11-02 10:23:33 -06006269 vuid = is_2 ? "VUID-VkCopyBufferInfo2-dstOffset-00114" : "VUID-vkCmdCopyBuffer-dstOffset-00114";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006270 skip |= LogError(dst_buffer_state->buffer(), vuid,
ziga-lunargd6b58ce2021-10-16 01:22:56 +02006271 "%s: pRegions[%" PRIu32 "].dstOffset (%" PRIuLEAST64
6272 ") is greater than size of dstBuffer (%" PRIuLEAST64 ").",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006273 func_name, i, region.dstOffset, dst_buffer_size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006274 }
6275
6276 // 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 -05006277 if (region.size > (src_buffer_size - region.srcOffset)) {
Tony-LunarGef035472021-11-02 10:23:33 -06006278 vuid = is_2 ? "VUID-VkCopyBufferInfo2-size-00115" : "VUID-vkCmdCopyBuffer-size-00115";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006279 skip |= LogError(src_buffer_state->buffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006280 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the source buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006281 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006282 func_name, i, region.size, src_buffer_size, i, region.srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006283 }
6284
6285 // 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 -05006286 if (region.size > (dst_buffer_size - region.dstOffset)) {
Tony-LunarGef035472021-11-02 10:23:33 -06006287 vuid = is_2 ? "VUID-VkCopyBufferInfo2-size-00116" : "VUID-vkCmdCopyBuffer-size-00116";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006288 skip |= LogError(dst_buffer_state->buffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006289 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the destination buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006290 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006291 func_name, i, region.size, dst_buffer_size, i, region.dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006292 }
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006293
aitor-lunargb66a5fa2022-04-20 00:15:31 +02006294 // Perf improvement potential here
ziga-lunargb94ff002022-03-23 23:30:19 +01006295 // The union of the source regions, and the union of the destination regions, must not overlap in memory
aitor-lunarg26fbbc22022-04-22 18:42:08 +02006296 if (src_buffer_state->buffer() == dst_buffer_state->buffer()) {
6297 VkDeviceSize src_min = region.srcOffset;
6298 VkDeviceSize src_max = region.srcOffset + region.size;
6299 for (uint32_t j = 0; j < regionCount; j++) {
6300 VkDeviceSize dst_min = pRegions[j].dstOffset;
6301 VkDeviceSize dst_max = pRegions[j].dstOffset + region.size;
6302 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max)) ||
6303 ((src_min == dst_min && src_max == dst_max))) {
6304 vuid = is_2 ? "VUID-VkCopyBufferInfo2-pRegions-00117" : "VUID-vkCmdCopyBuffer-pRegions-00117";
6305 skip |= LogError(src_buffer_state->buffer(), vuid,
6306 "%s: Detected overlap between source and dest regions in memory.", func_name);
6307 }
ziga-lunargb94ff002022-03-23 23:30:19 +01006308 }
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006309 }
6310 }
6311
ziga-lunargb94ff002022-03-23 23:30:19 +01006312
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06006313 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
Jeff Bolz46c0ea02019-10-09 13:06:29 -05006368bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006369 bool skip = false;
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006370 auto buffer_state = Get<BUFFER_STATE>(buffer);
sfricke-samsung9c7d8552020-08-16 22:12:21 -07006371 if (buffer_state) {
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06006372 if (buffer_state->InUse()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006373 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
6374 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006375 }
6376 }
6377 return skip;
6378}
6379
Jeff Bolz5c801d12019-10-09 10:38:45 -05006380bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
6381 const VkAllocationCallbacks *pAllocator) const {
Jeremy Gebbenf4449392022-01-28 10:09:10 -07006382 auto image_view_state = Get<IMAGE_VIEW_STATE>(imageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07006383
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006384 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07006385 if (image_view_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06006386 skip |= ValidateObjectNotInUse(image_view_state.get(), "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006387 }
6388 return skip;
6389}
6390
Jeff Bolz5c801d12019-10-09 10:38:45 -05006391bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Jeremy Gebben9f537102021-10-05 16:37:12 -06006392 return ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006393}
6394
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006395bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006396 const VkAllocationCallbacks *pAllocator) const {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006397 auto buffer_view_state = Get<BUFFER_VIEW_STATE>(bufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006398 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07006399 if (buffer_view_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06006400 skip |= ValidateObjectNotInUse(buffer_view_state.get(), "vkDestroyBufferView", "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07006401 }
6402 return skip;
6403}
6404
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07006405bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05006406 VkDeviceSize size, uint32_t data) const {
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07006407 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006408 auto buffer_state = Get<BUFFER_STATE>(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006409 bool skip = false;
Jeremy Gebben9f537102021-10-05 16:37:12 -06006410 skip |= ValidateMemoryIsBoundToBuffer(buffer_state.get(), "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
6411 skip |= ValidateCmd(cb_node.get(), CMD_FILLBUFFER);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006412 // Validate that DST buffer has correct usage flags set
Jeremy Gebben9f537102021-10-05 16:37:12 -06006413 skip |=
6414 ValidateBufferUsageFlags(buffer_state.get(), VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
6415 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006416
Jeremy Gebben9f537102021-10-05 16:37:12 -06006417 skip |=
6418 ValidateProtectedBuffer(cb_node.get(), buffer_state.get(), "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01811");
6419 skip |= ValidateUnprotectedBuffer(cb_node.get(), buffer_state.get(), "vkCmdFillBuffer()",
6420 "VUID-vkCmdFillBuffer-commandBuffer-01812");
sfricke-samsung022fa252020-07-24 03:26:16 -07006421
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006422 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006423 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
6424 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
6425 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
6426 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006427 }
6428
6429 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006430 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
6431 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
6432 ") minus dstOffset (0x%" PRIxLEAST64 ").",
6433 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07006434 }
6435
sfricke-samsung45996a42021-09-16 13:45:27 -07006436 if (!IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06006437 skip |= ValidateCmdQueueFlags(cb_node.get(), "vkCmdFillBuffer()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
ziga-lunarg3c5c84e2021-08-04 15:18:56 +02006438 "VUID-vkCmdFillBuffer-commandBuffer-00030");
6439 }
6440
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07006441 return skip;
6442}
6443
sfricke-samsung71f04e32022-03-16 01:21:21 -05006444template <typename RegionType>
6445bool CoreChecks::ValidateBufferImageCopyData(const CMD_BUFFER_STATE *cb_node, uint32_t regionCount, const RegionType *pRegions,
6446 const IMAGE_STATE *image_state, const char *function, CMD_TYPE cmd_type,
6447 bool image_to_buffer) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006448 bool skip = false;
Tony Barbour845d29b2021-11-09 11:43:14 -07006449 const bool is_2 = (cmd_type == CMD_COPYBUFFERTOIMAGE2KHR || cmd_type == CMD_COPYBUFFERTOIMAGE2);
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07006450 const char *vuid;
Jeff Leger178b1e52020-10-05 12:22:23 -04006451
sfricke-samsung125d2b42020-05-28 06:32:43 -07006452 assert(image_state != nullptr);
6453 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006454
6455 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006456 const RegionType region = pRegions[i];
6457 const VkImageAspectFlags region_aspect_mask = region.imageSubresource.aspectMask;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006458 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006459 if ((region.imageOffset.y != 0) || (region.imageExtent.height != 1)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006460 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00199", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006461 "%s: pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
6462 "and 1, respectively.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006463 function, i, region.imageOffset.y, region.imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006464 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006465 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006466
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006467 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006468 if ((region.imageOffset.z != 0) || (region.imageExtent.depth != 1)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006469 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00201", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006470 "%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 -07006471 "must be 0 and 1, respectively.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006472 function, i, region.imageOffset.z, region.imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006473 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006474 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006475
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006476 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006477 if ((0 != region.imageSubresource.baseArrayLayer) || (1 != region.imageSubresource.layerCount)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006478 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00213", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006479 "%s: pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006480 "For 3D images these must be 0 and 1, respectively.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006481 function, i, region.imageSubresource.baseArrayLayer, region.imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006482 }
6483 }
6484
6485 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07006486 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
sfricke-samsung73e755c2021-09-30 08:34:57 -07006487 const uint32_t element_size =
6488 FormatIsDepthOrStencil(image_format) ? 0 : FormatElementSize(image_format, region_aspect_mask);
sfricke-samsung71f04e32022-03-16 01:21:21 -05006489 const VkDeviceSize bufferOffset = region.bufferOffset;
Locke497739c2019-03-08 11:50:47 -07006490
sfricke-samsung8feecc12021-01-23 03:28:38 -08006491 if (FormatIsDepthOrStencil(image_format)) {
6492 if (SafeModulo(bufferOffset, 4) != 0) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006493 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("04053", image_to_buffer, is_2),
sfricke-samsung8feecc12021-01-23 03:28:38 -08006494 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6495 " must be a multiple 4 if using a depth/stencil format (%s).",
6496 function, i, bufferOffset, string_VkFormat(image_format));
6497 }
6498 } else {
6499 // If not depth/stencil and not multi-plane
6500 if (!FormatIsMultiplane(image_format) && (SafeModulo(bufferOffset, element_size) != 0)) {
sfricke-samsung45996a42021-09-16 13:45:27 -07006501 vuid = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion)
Tony Barbour845d29b2021-11-09 11:43:14 -07006502 ? GetBufferImageCopyCommandVUID("01558", image_to_buffer, is_2)
6503 : GetBufferImageCopyCommandVUID("00193", image_to_buffer, is_2);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006504 skip |= LogError(image_state->image(), vuid,
sfricke-samsung8feecc12021-01-23 03:28:38 -08006505 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6506 " must be a multiple of this format's texel size (%" PRIu32 ").",
6507 function, i, bufferOffset, element_size);
6508 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006509 }
6510
sfricke-samsung5f11b0e2022-03-22 14:12:15 -05006511 // Make sure not a empty region
6512 if (region.imageExtent.width == 0) {
6513 vuid = is_2 ? "VUID-VkBufferImageCopy2-imageExtent-06659" : "VUID-VkBufferImageCopy-imageExtent-06659";
6514 LogObjectList objlist(cb_node->commandBuffer());
6515 objlist.add(image_state->image());
6516 skip |=
6517 LogError(objlist, vuid, "%s: pRegion[%" PRIu32 "] extent.width must not be zero as empty copies are not allowed.",
6518 function, i);
6519 }
6520 if (region.imageExtent.height == 0) {
6521 vuid = is_2 ? "VUID-VkBufferImageCopy2-imageExtent-06660" : "VUID-VkBufferImageCopy-imageExtent-06660";
6522 LogObjectList objlist(cb_node->commandBuffer());
6523 objlist.add(image_state->image());
6524 skip |=
6525 LogError(objlist, vuid, "%s: pRegion[%" PRIu32 "] extent.height must not be zero as empty copies are not allowed.",
6526 function, i);
6527 }
6528 if (region.imageExtent.depth == 0) {
6529 vuid = is_2 ? "VUID-VkBufferImageCopy2-imageExtent-06661" : "VUID-VkBufferImageCopy-imageExtent-06661";
6530 LogObjectList objlist(cb_node->commandBuffer());
6531 objlist.add(image_state->image());
6532 skip |=
6533 LogError(objlist, vuid, "%s: pRegion[%" PRIu32 "] extent.depth must not be zero as empty copies are not allowed.",
6534 function, i);
6535 }
6536
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006537 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
sfricke-samsung71f04e32022-03-16 01:21:21 -05006538 if ((region.bufferRowLength != 0) && (region.bufferRowLength < region.imageExtent.width)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006539 vuid = (is_2) ? "VUID-VkBufferImageCopy2-bufferRowLength-00195" : "VUID-VkBufferImageCopy-bufferRowLength-00195";
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06006540 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006541 LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006542 "%s: pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006543 function, i, region.bufferRowLength, region.imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006544 }
6545
6546 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
sfricke-samsung71f04e32022-03-16 01:21:21 -05006547 if ((region.bufferImageHeight != 0) && (region.bufferImageHeight < region.imageExtent.height)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006548 vuid = (is_2) ? "VUID-VkBufferImageCopy2-bufferImageHeight-00196" : "VUID-VkBufferImageCopy-bufferImageHeight-00196";
Jeff Leger178b1e52020-10-05 12:22:23 -04006549 skip |=
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006550 LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006551 "%s: pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006552 function, i, region.bufferImageHeight, region.imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006553 }
6554
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006555 // Calculate adjusted image extent, accounting for multiplane image factors
sfricke-samsung71f04e32022-03-16 01:21:21 -05006556 VkExtent3D adjusted_image_extent = image_state->GetSubresourceExtent(region.imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006557 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
sfricke-samsung71f04e32022-03-16 01:21:21 -05006558 if ((region.imageOffset.x < 0) || (region.imageOffset.x > static_cast<int32_t>(adjusted_image_extent.width)) ||
6559 ((region.imageOffset.x + static_cast<int32_t>(region.imageExtent.width)) >
Mark Lobodzinski72b1a222020-03-18 11:36:10 -06006560 static_cast<int32_t>(adjusted_image_extent.width))) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006561 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00197", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006562 "%s: Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006563 "zero or <= image subresource width (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006564 function, i, region.imageOffset.x, (region.imageOffset.x + region.imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006565 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006566 }
6567
6568 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
sfricke-samsung71f04e32022-03-16 01:21:21 -05006569 if ((region.imageOffset.y < 0) || (region.imageOffset.y > static_cast<int32_t>(adjusted_image_extent.height)) ||
6570 ((region.imageOffset.y + static_cast<int32_t>(region.imageExtent.height)) >
Mark Lobodzinski72b1a222020-03-18 11:36:10 -06006571 static_cast<int32_t>(adjusted_image_extent.height))) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006572 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00198", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006573 "%s: Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006574 "zero or <= image subresource height (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006575 function, i, region.imageOffset.y, (region.imageOffset.y + region.imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006576 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006577 }
6578
6579 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
sfricke-samsung71f04e32022-03-16 01:21:21 -05006580 if ((region.imageOffset.z < 0) || (region.imageOffset.z > static_cast<int32_t>(adjusted_image_extent.depth)) ||
6581 ((region.imageOffset.z + static_cast<int32_t>(region.imageExtent.depth)) >
Mark Lobodzinski72b1a222020-03-18 11:36:10 -06006582 static_cast<int32_t>(adjusted_image_extent.depth))) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006583 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00200", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006584 "%s: Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006585 "zero or <= image subresource depth (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006586 function, i, region.imageOffset.z, (region.imageOffset.z + region.imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06006587 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06006588 }
6589
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006590 // subresource aspectMask must have exactly 1 bit set
6591 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
sfricke-samsung125d2b42020-05-28 06:32:43 -07006592 std::bitset<num_bits> aspect_mask_bits(region_aspect_mask);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006593 if (aspect_mask_bits.count() != 1) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006594 vuid = (is_2) ? "VUID-VkBufferImageCopy2-aspectMask-00212" : "VUID-VkBufferImageCopy-aspectMask-00212";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006595 skip |= LogError(image_state->image(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006596 "%s: aspectMasks for imageSubresource in pRegion[%d] must have only a single bit set.", function, i);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006597 }
6598
6599 // image subresource aspect bit must match format
sfricke-samsung125d2b42020-05-28 06:32:43 -07006600 if (!VerifyAspectsPresent(region_aspect_mask, image_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04006601 skip |=
Tony Barbour845d29b2021-11-09 11:43:14 -07006602 LogError(image_state->image(), GetBufferImageCopyCommandVUID("00211", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006603 "%s: pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
6604 function, i, region_aspect_mask, image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006605 }
6606
6607 // Checks that apply only to compressed images
sfricke-samsung01da6312021-10-20 07:51:32 -07006608 if (FormatIsBlockedImage(image_format)) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006609 auto block_size = FormatTexelBlockExtent(image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006610
6611 // BufferRowLength must be a multiple of block width
sfricke-samsung71f04e32022-03-16 01:21:21 -05006612 if (SafeModulo(region.bufferRowLength, block_size.width) != 0) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006613 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00203", image_to_buffer, is_2),
sfricke-samsung01da6312021-10-20 07:51:32 -07006614 "%s: pRegion[%d] bufferRowLength (%d) must be a multiple of the blocked image's texel width (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006615 function, i, region.bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006616 }
6617
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006618 // BufferRowHeight must be a multiple of block height
sfricke-samsung71f04e32022-03-16 01:21:21 -05006619 if (SafeModulo(region.bufferImageHeight, block_size.height) != 0) {
sfricke-samsung01da6312021-10-20 07:51:32 -07006620 skip |=
Tony Barbour845d29b2021-11-09 11:43:14 -07006621 LogError(image_state->image(), GetBufferImageCopyCommandVUID("00204", image_to_buffer, is_2),
sfricke-samsung01da6312021-10-20 07:51:32 -07006622 "%s: pRegion[%d] bufferImageHeight (%d) must be a multiple of the blocked image's texel height (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006623 function, i, region.bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006624 }
6625
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006626 // image offsets must be multiples of block dimensions
sfricke-samsung71f04e32022-03-16 01:21:21 -05006627 if ((SafeModulo(region.imageOffset.x, block_size.width) != 0) ||
6628 (SafeModulo(region.imageOffset.y, block_size.height) != 0) ||
6629 (SafeModulo(region.imageOffset.z, block_size.depth) != 0)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006630 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00205", image_to_buffer, is_2),
sfricke-samsung01da6312021-10-20 07:51:32 -07006631 "%s: pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the blocked image's texel "
Petr Krausb0d5e592021-05-21 23:37:11 +02006632 "width & height (%d, %d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006633 function, i, region.imageOffset.x, region.imageOffset.y, block_size.width, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006634 }
6635
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006636 // bufferOffset must be a multiple of block size (linear bytes)
sfricke-samsung73e755c2021-09-30 08:34:57 -07006637 if (SafeModulo(bufferOffset, element_size) != 0) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006638 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00206", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006639 "%s: pRegion[%d] bufferOffset (0x%" PRIxLEAST64
sfricke-samsung01da6312021-10-20 07:51:32 -07006640 ") must be a multiple of the blocked image's texel block size (%" PRIu32 ").",
sfricke-samsung73e755c2021-09-30 08:34:57 -07006641 function, i, bufferOffset, element_size);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006642 }
Dave Houlton67e9b532017-03-02 17:00:10 -07006643
6644 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
sfricke-samsung71f04e32022-03-16 01:21:21 -05006645 VkExtent3D mip_extent = image_state->GetSubresourceExtent(region.imageSubresource);
6646 if ((SafeModulo(region.imageExtent.width, block_size.width) != 0) &&
6647 (region.imageExtent.width + region.imageOffset.x != mip_extent.width)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006648 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00207", image_to_buffer, is_2),
sfricke-samsung01da6312021-10-20 07:51:32 -07006649 "%s: pRegion[%d] extent width (%d) must be a multiple of the blocked texture block width "
Petr Krausb0d5e592021-05-21 23:37:11 +02006650 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006651 function, i, region.imageExtent.width, block_size.width, region.imageOffset.x, mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07006652 }
6653
6654 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
sfricke-samsung71f04e32022-03-16 01:21:21 -05006655 if ((SafeModulo(region.imageExtent.height, block_size.height) != 0) &&
6656 (region.imageExtent.height + region.imageOffset.y != mip_extent.height)) {
6657 skip |=
6658 LogError(image_state->image(), GetBufferImageCopyCommandVUID("00208", image_to_buffer, is_2),
6659 "%s: pRegion[%d] extent height (%d) must be a multiple of the blocked texture block height "
6660 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d).",
6661 function, i, region.imageExtent.height, block_size.height, region.imageOffset.y, mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07006662 }
6663
6664 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
sfricke-samsung71f04e32022-03-16 01:21:21 -05006665 if ((SafeModulo(region.imageExtent.depth, block_size.depth) != 0) &&
6666 (region.imageExtent.depth + region.imageOffset.z != mip_extent.depth)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006667 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("00209", image_to_buffer, is_2),
sfricke-samsung01da6312021-10-20 07:51:32 -07006668 "%s: pRegion[%d] extent width (%d) must be a multiple of the blocked texture block depth "
Petr Krausb0d5e592021-05-21 23:37:11 +02006669 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d).",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006670 function, i, region.imageExtent.depth, block_size.depth, region.imageOffset.z, mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07006671 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006672 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08006673
6674 // Checks that apply only to multi-planar format images
sfricke-samsung125d2b42020-05-28 06:32:43 -07006675 if (FormatIsMultiplane(image_format)) {
sfricke-samsung552d5e12020-01-07 22:00:20 -08006676 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
sfricke-samsung125d2b42020-05-28 06:32:43 -07006677 if ((FormatPlaneCount(image_format) < 3) && (region_aspect_mask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006678 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006679 "%s: pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006680 "format has three planes.",
6681 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08006682 }
6683
6684 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
sfricke-samsung125d2b42020-05-28 06:32:43 -07006685 if (0 ==
6686 (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 -07006687 skip |= LogError(image_state->image(), GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006688 "%s: pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006689 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
6690 function, i);
sfricke-samsung125d2b42020-05-28 06:32:43 -07006691 } else {
6692 // Know aspect mask is valid
6693 const VkFormat compatible_format = FindMultiplaneCompatibleFormat(image_format, region_aspect_mask);
6694 const uint32_t compatible_size = FormatElementSize(compatible_format);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006695 if (SafeModulo(bufferOffset, compatible_size) != 0) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07006696 skip |= LogError(
Tony Barbour845d29b2021-11-09 11:43:14 -07006697 image_state->image(), GetBufferImageCopyCommandVUID("01559", image_to_buffer, is_2),
Jeff Leger178b1e52020-10-05 12:22:23 -04006698 "%s: pRegion[%d]->bufferOffset is 0x%" PRIxLEAST64
sfricke-samsung125d2b42020-05-28 06:32:43 -07006699 " 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 -08006700 function, i, bufferOffset, element_size, GetPlaneIndex(region_aspect_mask),
sfricke-samsung125d2b42020-05-28 06:32:43 -07006701 string_VkFormat(compatible_format));
6702 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08006703 }
6704 }
sfricke-samsung8feecc12021-01-23 03:28:38 -08006705
6706 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
Jeremy Gebbencd7fa282021-10-27 10:25:32 -06006707 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool;
sfricke-samsung8feecc12021-01-23 03:28:38 -08006708 assert(command_pool != nullptr);
6709 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006710 const VkQueueFlags queue_flags = physical_device_state->queue_family_properties[queue_family_index].queueFlags;
sfricke-samsung8feecc12021-01-23 03:28:38 -08006711 if (((queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT)) == 0) && (SafeModulo(bufferOffset, 4) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006712 LogObjectList objlist(cb_node->commandBuffer());
6713 objlist.add(command_pool->commandPool());
sfricke-samsung4389faa2022-03-23 01:19:42 -05006714 objlist.add(image_state->image());
6715 skip |= LogError(objlist, GetBufferImageCopyCommandVUID("04052", image_to_buffer, is_2),
sfricke-samsung8feecc12021-01-23 03:28:38 -08006716 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
6717 " must be a multiple 4 because the command buffer %s was allocated from the command pool %s "
6718 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT or "
6719 "VK_QUEUE_COMPUTE_BIT flag.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006720 function, i, bufferOffset, report_data->FormatHandle(cb_node->commandBuffer()).c_str(),
6721 report_data->FormatHandle(command_pool->commandPool()).c_str(), queue_family_index);
sfricke-samsung8feecc12021-01-23 03:28:38 -08006722 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006723 }
6724
6725 return skip;
6726}
6727
sfricke-samsung71f04e32022-03-16 01:21:21 -05006728template <typename RegionType>
6729bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount, const RegionType *pRegions,
6730 const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006731 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006732 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006733
6734 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006735 const RegionType region = pRegions[i];
6736 VkExtent3D extent = region.imageExtent;
6737 VkOffset3D offset = region.imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006738
sfricke-samsung71f04e32022-03-16 01:21:21 -05006739 VkExtent3D image_extent = image_state->GetSubresourceExtent(region.imageSubresource);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006740
sfricke-samsung01da6312021-10-20 07:51:32 -07006741 // If we're using a blocked image format, valid extent is rounded up to multiple of block size (per
6742 // vkspec.html#_common_operation)
6743 if (FormatIsBlockedImage(image_info->format)) {
Dave Houltona585d132019-01-18 13:05:42 -07006744 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07006745 if (image_extent.width % block_extent.width) {
6746 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
6747 }
6748 if (image_extent.height % block_extent.height) {
6749 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
6750 }
6751 if (image_extent.depth % block_extent.depth) {
6752 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
6753 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006754 }
6755
Dave Houltonfc1a4052017-04-27 14:32:45 -06006756 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Petr Krausb0d5e592021-05-21 23:37:11 +02006757 skip |= LogError(image_state->image(), msg_code, "%s: pRegion[%d] exceeds image bounds.", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006758 }
6759 }
6760
6761 return skip;
6762}
6763
sfricke-samsung71f04e32022-03-16 01:21:21 -05006764template <typename RegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006765bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
sfricke-samsung71f04e32022-03-16 01:21:21 -05006766 const RegionType *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006767 bool skip = false;
6768
sfricke-samsung11d15ba2021-09-30 09:19:56 -07006769 const VkDeviceSize buffer_size = buff_state->createInfo.size;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006770
6771 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006772 const RegionType region = pRegions[i];
6773 const VkDeviceSize buffer_copy_size = GetBufferSizeFromCopyImage(region, image_state->createInfo.format);
sfricke-samsung11d15ba2021-09-30 09:19:56 -07006774 // This blocks against invalid VkBufferCopyImage that already have been caught elsewhere
6775 if (buffer_copy_size != 0) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006776 const VkDeviceSize max_buffer_copy = buffer_copy_size + region.bufferOffset;
sfricke-samsung11d15ba2021-09-30 09:19:56 -07006777 if (buffer_size < max_buffer_copy) {
6778 skip |= LogError(device, msg_code,
6779 "%s: pRegion[%" PRIu32 "] is trying to copy %" PRIu64 " bytes plus %" PRIu64
6780 " offset to/from the VkBuffer (%s) which exceeds the VkBuffer total size of %" PRIu64 " bytes.",
sfricke-samsung71f04e32022-03-16 01:21:21 -05006781 func_name, i, buffer_copy_size, region.bufferOffset,
sfricke-samsung11d15ba2021-09-30 09:19:56 -07006782 report_data->FormatHandle(buff_state->buffer()).c_str(), buffer_size);
6783 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006784 }
6785 }
6786
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07006787 return skip;
6788}
6789
sfricke-samsung71f04e32022-03-16 01:21:21 -05006790template <typename RegionType>
Jeff Leger178b1e52020-10-05 12:22:23 -04006791bool CoreChecks::ValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
sfricke-samsung71f04e32022-03-16 01:21:21 -05006792 VkBuffer dstBuffer, uint32_t regionCount, const RegionType *pRegions,
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006793
6794 CMD_TYPE cmd_type) const {
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07006795 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07006796 auto src_image_state = Get<IMAGE_STATE>(srcImage);
6797 auto dst_buffer_state = Get<BUFFER_STATE>(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006798
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006799 const bool is_2 = (cmd_type == CMD_COPYIMAGETOBUFFER2KHR || cmd_type == CMD_COPYIMAGETOBUFFER2);
sfricke-samsung85584a72021-09-30 21:43:38 -07006800 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04006801 const char *vuid;
6802
Tony Barbour845d29b2021-11-09 11:43:14 -07006803 bool skip = ValidateBufferImageCopyData(cb_node.get(), regionCount, pRegions, src_image_state.get(), func_name, cmd_type, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006804
6805 // Validate command buffer state
Jeremy Gebben9f537102021-10-05 16:37:12 -06006806 skip |= ValidateCmd(cb_node.get(), cmd_type);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006807
6808 // Command pool must support graphics, compute, or transfer operations
Jeremy Gebbencd7fa282021-10-27 10:25:32 -06006809 const auto pool = cb_node->command_pool;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006810
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006811 VkQueueFlags queue_flags = physical_device_state->queue_family_properties[pool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07006812
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006813 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006814 vuid = is_2 ? "VUID-vkCmdCopyImageToBuffer2-commandBuffer-cmdpool" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool";
Jeff Leger178b1e52020-10-05 12:22:23 -04006815 skip |= LogError(cb_node->createInfo.commandPool, vuid,
6816 "Cannot call %s on a command buffer allocated from a pool without graphics, compute, "
6817 "or transfer capabilities.",
6818 func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006819 }
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006820
6821 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-pRegions-00182" : "VUID-vkCmdCopyImageToBuffer-pRegions-06220";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006822 skip |= ValidateImageBounds(src_image_state.get(), regionCount, pRegions, func_name, vuid);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006823 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-pRegions-00183" : "VUID-vkCmdCopyImageToBuffer-pRegions-00183";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006824 skip |= ValidateBufferBounds(src_image_state.get(), dst_buffer_state.get(), regionCount, pRegions, func_name, vuid);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006825
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006826 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImage-00188" : "VUID-vkCmdCopyImageToBuffer-srcImage-00188";
6827 std::string location = func_name;
6828 location.append("() : srcImage");
6829 skip |= ValidateImageSampleCount(src_image_state.get(), VK_SAMPLE_COUNT_1_BIT, location.c_str(), vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04006830
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006831 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImage-00187" : "VUID-vkCmdCopyImageToBuffer-srcImage-00187";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006832 skip |= ValidateMemoryIsBoundToImage(src_image_state.get(), func_name, vuid);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006833 vuid = is_2 ? "vkCmdCopyImageToBuffer-dstBuffer2-00192" : "vkCmdCopyImageToBuffer dstBuffer-00192";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006834 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state.get(), func_name, vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006835
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006836 // Validate that SRC image & DST buffer have correct usage flags set
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006837 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImage-00186" : "VUID-vkCmdCopyImageToBuffer-srcImage-00186";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006838 skip |= ValidateImageUsageFlags(src_image_state.get(), VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006839 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006840 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-dstBuffer-00191" : "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006841 skip |= ValidateBufferUsageFlags(dst_buffer_state.get(), VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006842 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006843 vuid = is_2 ? "VUID-vkCmdCopyImageToBuffer2-commandBuffer-01831" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01831";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006844 skip |= ValidateProtectedImage(cb_node.get(), src_image_state.get(), func_name, vuid);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006845 vuid = is_2 ? "VUID-vkCmdCopyImageToBuffer2-commandBuffer-01832" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01832";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006846 skip |= ValidateProtectedBuffer(cb_node.get(), dst_buffer_state.get(), func_name, vuid);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006847 vuid = is_2 ? "VUID-vkCmdCopyImageToBuffer2-commandBuffer-01833" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01833";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006848 skip |= ValidateUnprotectedBuffer(cb_node.get(), dst_buffer_state.get(), func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006849
6850 // Validation for VK_EXT_fragment_density_map
6851 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006852 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImage-02544" : "VUID-vkCmdCopyImageToBuffer-srcImage-02544";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006853 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006854 "%s: srcImage must not have been created with flags containing "
6855 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
6856 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006857 }
6858
sfricke-samsung45996a42021-09-16 13:45:27 -07006859 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006860 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImage-01998" : "VUID-vkCmdCopyImageToBuffer-srcImage-01998";
6861 skip |= ValidateImageFormatFeatureFlags(src_image_state.get(), VK_FORMAT_FEATURE_2_TRANSFER_SRC_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04006862 }
Tobin Ehlisc8266452017-04-07 12:20:30 -06006863 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04006864
sfricke-samsung45996a42021-09-16 13:45:27 -07006865 const char *src_invalid_layout_vuid =
6866 (src_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006867 ? (vuid =
6868 is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImageLayout-01397" : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397")
6869 : (vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImageLayout-00190"
6870 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190");
Jeff Leger178b1e52020-10-05 12:22:23 -04006871
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006872 for (uint32_t i = 0; i < regionCount; ++i) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05006873 const RegionType region = pRegions[i];
6874 skip |= ValidateImageSubresourceLayers(cb_node.get(), &region.imageSubresource, func_name, "imageSubresource", i);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006875 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-srcImageLayout-00189" : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189";
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06006876 skip |= VerifyImageLayout(*cb_node, *src_image_state, region.imageSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04006877 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, src_invalid_layout_vuid, vuid, &hit_error);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006878 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-imageOffset-01794" : "VUID-vkCmdCopyImageToBuffer-imageOffset-01794";
sfricke-samsung71f04e32022-03-16 01:21:21 -05006879 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node.get(), src_image_state.get(), &region, i, func_name,
6880 vuid);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006881 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-imageSubresource-01703" : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703";
sfricke-samsung71f04e32022-03-16 01:21:21 -05006882 skip |= ValidateImageMipLevel(cb_node.get(), src_image_state.get(), region.imageSubresource.mipLevel, i, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04006883 "imageSubresource", vuid);
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006884 vuid = is_2 ? "VUID-VkCopyImageToBufferInfo2-imageSubresource-01704" : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704";
sfricke-samsung71f04e32022-03-16 01:21:21 -05006885 skip |= ValidateImageArrayLayerRange(cb_node.get(), src_image_state.get(), region.imageSubresource.baseArrayLayer,
6886 region.imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07006887 }
6888 return skip;
6889}
6890
Jeff Leger178b1e52020-10-05 12:22:23 -04006891bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6892 VkBuffer dstBuffer, uint32_t regionCount,
6893 const VkBufferImageCopy *pRegions) const {
6894 return ValidateCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions,
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006895 CMD_COPYIMAGETOBUFFER);
Jeff Leger178b1e52020-10-05 12:22:23 -04006896}
6897
6898bool CoreChecks::PreCallValidateCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
6899 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) const {
6900 return ValidateCmdCopyImageToBuffer(commandBuffer, pCopyImageToBufferInfo->srcImage, pCopyImageToBufferInfo->srcImageLayout,
6901 pCopyImageToBufferInfo->dstBuffer, pCopyImageToBufferInfo->regionCount,
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006902 pCopyImageToBufferInfo->pRegions, CMD_COPYIMAGETOBUFFER2KHR);
Jeff Leger178b1e52020-10-05 12:22:23 -04006903}
6904
Tony Barbour845d29b2021-11-09 11:43:14 -07006905bool CoreChecks::PreCallValidateCmdCopyImageToBuffer2(VkCommandBuffer commandBuffer,
6906 const VkCopyImageToBufferInfo2 *pCopyImageToBufferInfo) const {
6907 return ValidateCmdCopyImageToBuffer(commandBuffer, pCopyImageToBufferInfo->srcImage, pCopyImageToBufferInfo->srcImageLayout,
6908 pCopyImageToBufferInfo->dstBuffer, pCopyImageToBufferInfo->regionCount,
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006909 pCopyImageToBufferInfo->pRegions, CMD_COPYIMAGETOBUFFER2);
Tony Barbour845d29b2021-11-09 11:43:14 -07006910}
6911
John Zulauf1686f232019-07-09 16:27:11 -06006912void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
6913 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
6914 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
6915
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07006916 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006917 auto src_image_state = Get<IMAGE_STATE>(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06006918 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006919 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06006920 cb_node->SetImageInitialLayout(*src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06006921 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006922}
6923
Jeff Leger178b1e52020-10-05 12:22:23 -04006924void CoreChecks::PreCallRecordCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
6925 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) {
6926 StateTracker::PreCallRecordCmdCopyImageToBuffer2KHR(commandBuffer, pCopyImageToBufferInfo);
6927
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07006928 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06006929 auto src_image_state = Get<IMAGE_STATE>(pCopyImageToBufferInfo->srcImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04006930 // Make sure that all image slices record referenced layout
6931 for (uint32_t i = 0; i < pCopyImageToBufferInfo->regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06006932 cb_node->SetImageInitialLayout(*src_image_state, pCopyImageToBufferInfo->pRegions[i].imageSubresource,
6933 pCopyImageToBufferInfo->srcImageLayout);
Jeff Leger178b1e52020-10-05 12:22:23 -04006934 }
6935}
6936
Tony-LunarGaf3632a2021-11-10 15:51:57 -07006937void CoreChecks::PreCallRecordCmdCopyImageToBuffer2(VkCommandBuffer commandBuffer,
6938 const VkCopyImageToBufferInfo2 *pCopyImageToBufferInfo) {
6939 StateTracker::PreCallRecordCmdCopyImageToBuffer2(commandBuffer, pCopyImageToBufferInfo);
6940
6941 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
6942 auto src_image_state = Get<IMAGE_STATE>(pCopyImageToBufferInfo->srcImage);
6943 // Make sure that all image slices record referenced layout
6944 for (uint32_t i = 0; i < pCopyImageToBufferInfo->regionCount; ++i) {
6945 cb_node->SetImageInitialLayout(*src_image_state, pCopyImageToBufferInfo->pRegions[i].imageSubresource,
6946 pCopyImageToBufferInfo->srcImageLayout);
6947 }
6948}
6949
Jeff Leger178b1e52020-10-05 12:22:23 -04006950template <typename RegionType>
6951bool CoreChecks::ValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
6952 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
Tony Barbour845d29b2021-11-09 11:43:14 -07006953 CMD_TYPE cmd_type) const {
Jeremy Gebbenb68fa022022-01-28 10:08:37 -07006954 auto cb_node = GetRead<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenf4449392022-01-28 10:09:10 -07006955 auto src_buffer_state = Get<BUFFER_STATE>(srcBuffer);
6956 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07006957
Tony Barbour845d29b2021-11-09 11:43:14 -07006958 const bool is_2 = (cmd_type == CMD_COPYBUFFERTOIMAGE2KHR || cmd_type == CMD_COPYBUFFERTOIMAGE2);
sfricke-samsung85584a72021-09-30 21:43:38 -07006959 const char *func_name = CommandTypeString(cmd_type);
Jeff Leger178b1e52020-10-05 12:22:23 -04006960 const char *vuid;
6961
Tony Barbour845d29b2021-11-09 11:43:14 -07006962 bool skip =
6963 ValidateBufferImageCopyData(cb_node.get(), regionCount, pRegions, dst_image_state.get(), func_name, cmd_type, false);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006964
6965 // Validate command buffer state
Jeremy Gebben9f537102021-10-05 16:37:12 -06006966 skip |= ValidateCmd(cb_node.get(), cmd_type);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07006967
Tony Barbour845d29b2021-11-09 11:43:14 -07006968 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-pRegions-00172" : "VUID-vkCmdCopyBufferToImage-pRegions-06217";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006969 skip |= ValidateImageBounds(dst_image_state.get(), regionCount, pRegions, func_name, vuid);
Tony Barbour845d29b2021-11-09 11:43:14 -07006970 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-pRegions-00171" : "VUID-vkCmdCopyBufferToImage-pRegions-00171";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006971 skip |= ValidateBufferBounds(dst_image_state.get(), src_buffer_state.get(), regionCount, pRegions, func_name, vuid);
Jeff Leger178b1e52020-10-05 12:22:23 -04006972
Tony Barbour845d29b2021-11-09 11:43:14 -07006973 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImage-00179" : "VUID-vkCmdCopyBufferToImage-dstImage-00179";
6974 std::string location = func_name;
6975 location.append("() : dstImage");
6976 skip |= ValidateImageSampleCount(dst_image_state.get(), VK_SAMPLE_COUNT_1_BIT, location.c_str(), vuid);
6977 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-srcBuffer-00176" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00176";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006978 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state.get(), func_name, vuid);
Tony Barbour845d29b2021-11-09 11:43:14 -07006979 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImage-00178" : "VUID-vkCmdCopyBufferToImage-dstImage-00178";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006980 skip |= ValidateMemoryIsBoundToImage(dst_image_state.get(), func_name, vuid);
Tony Barbour845d29b2021-11-09 11:43:14 -07006981 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-srcBuffer-00174" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00174";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006982 skip |= ValidateBufferUsageFlags(src_buffer_state.get(), VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006983 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Tony Barbour845d29b2021-11-09 11:43:14 -07006984 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImage-00177" : "VUID-vkCmdCopyBufferToImage-dstImage-00177";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006985 skip |= ValidateImageUsageFlags(dst_image_state.get(), VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06006986 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Tony Barbour845d29b2021-11-09 11:43:14 -07006987 vuid = is_2 ? "VUID-vkCmdCopyBufferToImage2-commandBuffer-01828" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01828";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006988 skip |= ValidateProtectedBuffer(cb_node.get(), src_buffer_state.get(), func_name, vuid);
Tony Barbour845d29b2021-11-09 11:43:14 -07006989 vuid = is_2 ? "VUID-vkCmdCopyBufferToImage2-commandBuffer-01829" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01829";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006990 skip |= ValidateProtectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
Tony Barbour845d29b2021-11-09 11:43:14 -07006991 vuid = is_2 ? "VUID-vkCmdCopyBufferToImage-commandBuffer-01830" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01830";
Jeremy Gebben9f537102021-10-05 16:37:12 -06006992 skip |= ValidateUnprotectedImage(cb_node.get(), dst_image_state.get(), func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02006993
6994 // Validation for VK_EXT_fragment_density_map
6995 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Tony Barbour845d29b2021-11-09 11:43:14 -07006996 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImage-02543" : "VUID-vkCmdCopyBufferToImage-dstImage-02543";
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06006997 skip |= LogError(cb_node->commandBuffer(), vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04006998 "%s: dstImage must not have been created with flags containing "
6999 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
7000 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02007001 }
7002
sfricke-samsung45996a42021-09-16 13:45:27 -07007003 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
Tony Barbour845d29b2021-11-09 11:43:14 -07007004 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImage-01997" : "VUID-vkCmdCopyBufferToImage-dstImage-01997";
7005 skip |= ValidateImageFormatFeatureFlags(dst_image_state.get(), VK_FORMAT_FEATURE_2_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04007006 }
Tobin Ehlisc8266452017-04-07 12:20:30 -06007007 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04007008
sfricke-samsung45996a42021-09-16 13:45:27 -07007009 const char *dst_invalid_layout_vuid =
7010 (dst_image_state->shared_presentable && IsExtEnabled(device_extensions.vk_khr_shared_presentable_image))
Tony Barbour845d29b2021-11-09 11:43:14 -07007011 ? (is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImageLayout-01396"
sfricke-samsung45996a42021-09-16 13:45:27 -07007012 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396")
Tony Barbour845d29b2021-11-09 11:43:14 -07007013 : (is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImageLayout-00181"
sfricke-samsung45996a42021-09-16 13:45:27 -07007014 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181");
Jeff Leger178b1e52020-10-05 12:22:23 -04007015
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07007016 for (uint32_t i = 0; i < regionCount; ++i) {
sfricke-samsung71f04e32022-03-16 01:21:21 -05007017 const RegionType region = pRegions[i];
7018 skip |= ValidateImageSubresourceLayers(cb_node.get(), &region.imageSubresource, func_name, "imageSubresource", i);
Tony Barbour845d29b2021-11-09 11:43:14 -07007019 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-dstImageLayout-00180" : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180";
Jeremy Gebbenaeb6c282022-06-03 10:17:59 -06007020 skip |= VerifyImageLayout(*cb_node, *dst_image_state, region.imageSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04007021 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, dst_invalid_layout_vuid, vuid, &hit_error);
Tony Barbour845d29b2021-11-09 11:43:14 -07007022 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-imageOffset-01793" : "VUID-vkCmdCopyBufferToImage-imageOffset-01793";
sfricke-samsung71f04e32022-03-16 01:21:21 -05007023 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node.get(), dst_image_state.get(), &region, i, func_name,
7024 vuid);
Tony Barbour845d29b2021-11-09 11:43:14 -07007025 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-imageSubresource-01701" : "VUID-vkCmdCopyBufferToImage-imageSubresource-01701";
sfricke-samsung71f04e32022-03-16 01:21:21 -05007026 skip |= ValidateImageMipLevel(cb_node.get(), dst_image_state.get(), region.imageSubresource.mipLevel, i, func_name,
Jeff Leger178b1e52020-10-05 12:22:23 -04007027 "imageSubresource", vuid);
Tony Barbour845d29b2021-11-09 11:43:14 -07007028 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-imageSubresource-01702" : "VUID-vkCmdCopyBufferToImage-imageSubresource-01702";
sfricke-samsung71f04e32022-03-16 01:21:21 -05007029 skip |= ValidateImageArrayLayerRange(cb_node.get(), dst_image_state.get(), region.imageSubresource.baseArrayLayer,
7030 region.imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
sfricke-samsungea4fd142020-10-17 23:51:59 -07007031
7032 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
Jeremy Gebbencd7fa282021-10-27 10:25:32 -06007033 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool;
sfricke-samsungea4fd142020-10-17 23:51:59 -07007034 assert(command_pool != nullptr);
7035 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06007036 const VkQueueFlags queue_flags = physical_device_state->queue_family_properties[queue_family_index].queueFlags;
sfricke-samsung71f04e32022-03-16 01:21:21 -05007037 const VkImageAspectFlags region_aspect_mask = region.imageSubresource.aspectMask;
sfricke-samsungea4fd142020-10-17 23:51:59 -07007038 if (((queue_flags & VK_QUEUE_GRAPHICS_BIT) == 0) &&
7039 ((region_aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != 0)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06007040 LogObjectList objlist(cb_node->commandBuffer());
7041 objlist.add(command_pool->commandPool());
sfricke-samsung4389faa2022-03-23 01:19:42 -05007042 objlist.add(dst_image_state->image());
Tony Barbour845d29b2021-11-09 11:43:14 -07007043 vuid = is_2 ? "VUID-VkCopyBufferToImageInfo2-commandBuffer-04477"
sfricke-samsungea4fd142020-10-17 23:51:59 -07007044 : "VUID-vkCmdCopyBufferToImage-commandBuffer-04477";
sfricke-samsung4389faa2022-03-23 01:19:42 -05007045 skip |= LogError(objlist, vuid,
sfricke-samsungea4fd142020-10-17 23:51:59 -07007046 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies VK_IMAGE_ASPECT_DEPTH_BIT or "
7047 "VK_IMAGE_ASPECT_STENCIL_BIT but the command buffer %s was allocated from the command pool %s "
7048 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT flag.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06007049 func_name, i, region_aspect_mask, report_data->FormatHandle(cb_node->commandBuffer()).c_str(),
7050 report_data->FormatHandle(command_pool->commandPool()).c_str(), queue_family_index);
sfricke-samsungea4fd142020-10-17 23:51:59 -07007051 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07007052 }
7053 return skip;
7054}
7055
Jeff Leger178b1e52020-10-05 12:22:23 -04007056bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
7057 VkImageLayout dstImageLayout, uint32_t regionCount,
7058 const VkBufferImageCopy *pRegions) const {
7059 return ValidateCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions,
Tony Barbour845d29b2021-11-09 11:43:14 -07007060 CMD_COPYBUFFERTOIMAGE);
Jeff Leger178b1e52020-10-05 12:22:23 -04007061}
7062
7063bool CoreChecks::PreCallValidateCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
7064 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo) const {
7065 return ValidateCmdCopyBufferToImage(commandBuffer, pCopyBufferToImageInfo->srcBuffer, pCopyBufferToImageInfo->dstImage,
7066 pCopyBufferToImageInfo->dstImageLayout, pCopyBufferToImageInfo->regionCount,
Tony Barbour845d29b2021-11-09 11:43:14 -07007067 pCopyBufferToImageInfo->pRegions, CMD_COPYBUFFERTOIMAGE2KHR);
7068}
7069
7070bool CoreChecks::PreCallValidateCmdCopyBufferToImage2(VkCommandBuffer commandBuffer,
7071 const VkCopyBufferToImageInfo2 *pCopyBufferToImageInfo) const {
7072 return ValidateCmdCopyBufferToImage(commandBuffer, pCopyBufferToImageInfo->srcBuffer, pCopyBufferToImageInfo->dstImage,
7073 pCopyBufferToImageInfo->dstImageLayout, pCopyBufferToImageInfo->regionCount,
7074 pCopyBufferToImageInfo->pRegions, CMD_COPYBUFFERTOIMAGE2);
Jeff Leger178b1e52020-10-05 12:22:23 -04007075}
7076
John Zulauf1686f232019-07-09 16:27:11 -06007077void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
7078 VkImageLayout dstImageLayout, uint32_t regionCount,
7079 const VkBufferImageCopy *pRegions) {
7080 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
7081
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07007082 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06007083 auto dst_image_state = Get<IMAGE_STATE>(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06007084 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07007085 for (uint32_t i = 0; i < regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06007086 cb_node->SetImageInitialLayout(*dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06007087 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07007088}
Mike Weiblen672b58b2017-02-21 14:32:53 -07007089
Jeff Leger178b1e52020-10-05 12:22:23 -04007090void CoreChecks::PreCallRecordCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
7091 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo2KHR) {
7092 StateTracker::PreCallRecordCmdCopyBufferToImage2KHR(commandBuffer, pCopyBufferToImageInfo2KHR);
7093
Jeremy Gebben332d4dd2022-01-01 12:40:02 -07007094 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06007095 auto dst_image_state = Get<IMAGE_STATE>(pCopyBufferToImageInfo2KHR->dstImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04007096 // Make sure that all image slices are record referenced layout
7097 for (uint32_t i = 0; i < pCopyBufferToImageInfo2KHR->regionCount; ++i) {
Jeremy Gebben1ec89332021-08-05 13:51:49 -06007098 cb_node->SetImageInitialLayout(*dst_image_state, pCopyBufferToImageInfo2KHR->pRegions[i].imageSubresource,
7099 pCopyBufferToImageInfo2KHR->dstImageLayout);
Jeff Leger178b1e52020-10-05 12:22:23 -04007100 }
7101}
Tony Barbour845d29b2021-11-09 11:43:14 -07007102
7103void CoreChecks::PreCallRecordCmdCopyBufferToImage2(VkCommandBuffer commandBuffer,
7104 const VkCopyBufferToImageInfo2 *pCopyBufferToImageInfo) {
7105 StateTracker::PreCallRecordCmdCopyBufferToImage2(commandBuffer, pCopyBufferToImageInfo);
7106
7107 auto cb_node = GetWrite<CMD_BUFFER_STATE>(commandBuffer);
7108 auto dst_image_state = Get<IMAGE_STATE>(pCopyBufferToImageInfo->dstImage);
7109 // Make sure that all image slices are record referenced layout
7110 for (uint32_t i = 0; i < pCopyBufferToImageInfo->regionCount; ++i) {
7111 cb_node->SetImageInitialLayout(*dst_image_state, pCopyBufferToImageInfo->pRegions[i].imageSubresource,
7112 pCopyBufferToImageInfo->dstImageLayout);
7113 }
7114}
7115
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07007116bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05007117 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07007118 bool skip = false;
7119 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
7120
Dave Houlton1d960ff2018-01-19 12:17:05 -07007121 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07007122 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
7123 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
7124 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07007125 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
7126 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07007127 }
7128
Jeremy Gebbenf4449392022-01-28 10:09:10 -07007129 auto image_entry = Get<IMAGE_STATE>(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07007130 if (!image_entry) {
7131 return skip;
7132 }
7133
Mark Lobodzinski6f358172019-10-02 11:09:12 -06007134 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
sfricke-samsung45996a42021-09-16 13:45:27 -07007135 if (IsExtEnabled(device_extensions.vk_ext_image_drm_format_modifier)) {
Mark Lobodzinski6f358172019-10-02 11:09:12 -06007136 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
7137 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07007138 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
7139 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
7140 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06007141 }
7142 } else {
7143 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07007144 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
7145 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06007146 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07007147 }
7148
Dave Houlton1d960ff2018-01-19 12:17:05 -07007149 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07007150 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07007151 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
7152 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
7153 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07007154 }
7155
Dave Houlton1d960ff2018-01-19 12:17:05 -07007156 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07007157 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07007158 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
7159 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
7160 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07007161 }
7162
Dave Houlton1d960ff2018-01-19 12:17:05 -07007163 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07007164 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06007165 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
7166 if (FormatIsMultiplane(img_format)) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08007167 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06007168 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
7169 if (FormatPlaneCount(img_format) > 2u) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08007170 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06007171 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
7172 }
7173 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07007174 skip |= LogError(image, vuid,
7175 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
7176 ") must be a single-plane specifier flag.",
7177 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06007178 }
7179 } else if (FormatIsColor(img_format)) {
7180 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
ziga-lunargcc568bc2021-09-05 13:45:45 +02007181 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04461",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07007182 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
7183 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06007184 }
7185 } else if (FormatIsDepthOrStencil(img_format)) {
Nathaniel Cesario8c80f352021-07-15 15:06:48 -06007186 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06007187 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07007188 }
ziga-lunarg4ecbd5b2021-07-15 20:48:30 +02007189 if (!FormatIsDepthAndStencil(img_format) && !FormatIsDepthOnly(img_format)) {
7190 if (sub_aspect & VK_IMAGE_ASPECT_DEPTH_BIT) {
7191 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04464",
7192 "vkGetImageSubresourceLayout(): Image format (%s) does not contain a depth component, "
7193 "but VkImageSubresource.aspectMask contains VK_IMAGE_ASPECT_DEPTH_BIT.",
7194 string_VkFormat(img_format));
7195 }
7196 } else {
7197 if ((sub_aspect & VK_IMAGE_ASPECT_DEPTH_BIT) == 0) {
7198 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04462",
7199 "vkGetImageSubresourceLayout(): Image format (%s) contains a depth component, "
7200 "but VkImageSubresource.aspectMask does not contain VK_IMAGE_ASPECT_DEPTH_BIT.",
7201 string_VkFormat(img_format));
7202 }
7203 }
7204 if (!FormatIsDepthAndStencil(img_format) && !FormatIsStencilOnly(img_format)) {
7205 if (sub_aspect & VK_IMAGE_ASPECT_STENCIL_BIT) {
7206 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04464",
7207 "vkGetImageSubresourceLayout(): Image format (%s) does not contain a stencil component, "
7208 "but VkImageSubresource.aspectMask contains VK_IMAGE_ASPECT_STENCIL_BIT.",
7209 string_VkFormat(img_format));
7210 }
7211 } else {
7212 if ((sub_aspect & VK_IMAGE_ASPECT_STENCIL_BIT) == 0) {
7213 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-format-04463",
7214 "vkGetImageSubresourceLayout(): Image format (%s) contains a stencil component, "
7215 "but VkImageSubresource.aspectMask does not contain VK_IMAGE_ASPECT_STENCIL_BIT.",
7216 string_VkFormat(img_format));
7217 }
7218 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06007219 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
7220 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
7221 (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 +02007222 skip |= LogError(
7223 image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
7224 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask (%s) must be VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.",
7225 string_VkImageAspectFlags(sub_aspect).c_str());
7226 } else {
7227 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
7228 assert(IsExtEnabled(device_extensions.vk_ext_image_drm_format_modifier));
7229 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = LvlInitStruct<VkImageDrmFormatModifierPropertiesEXT>();
7230 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image, &drm_format_properties);
7231
7232 auto fmt_drm_props = LvlInitStruct<VkDrmFormatModifierPropertiesListEXT>();
7233 auto fmt_props_2 = LvlInitStruct<VkFormatProperties2>(&fmt_drm_props);
7234 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_entry->createInfo.format, &fmt_props_2);
7235 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties{fmt_drm_props.drmFormatModifierCount};
7236 fmt_drm_props.pDrmFormatModifierProperties = drm_properties.data();
7237 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_entry->createInfo.format, &fmt_props_2);
7238
7239 uint32_t max_plane_count = 0u;
7240
7241 for (auto const &drm_property : drm_properties) {
7242 if (drm_format_properties.drmFormatModifier == drm_property.drmFormatModifier) {
7243 max_plane_count = drm_property.drmFormatModifierPlaneCount;
7244 break;
7245 }
7246 }
7247
7248 VkImageAspectFlagBits allowed_plane_indices[] = {
7249 VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT, VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT,
7250 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT, VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT};
7251
7252 bool is_valid = false;
7253
7254 for (uint32_t i = 0u; i < max_plane_count; ++i) {
7255 if (sub_aspect == allowed_plane_indices[i]) {
7256 is_valid = true;
7257 break;
7258 }
7259 }
7260
7261 if (!is_valid) {
7262 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
7263 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask (%s) must be "
7264 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT, with i being less than the "
7265 "VkDrmFormatModifierPropertiesEXT::drmFormatModifierPlaneCount (%" PRIu32
7266 ") associated with the image's format (%s) and "
7267 "VkImageDrmFormatModifierPropertiesEXT::drmFormatModifier (%" PRIu64 ").",
7268 string_VkImageAspectFlags(sub_aspect).c_str(), max_plane_count,
7269 string_VkFormat(image_entry->createInfo.format), drm_format_properties.drmFormatModifier);
7270 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07007271 }
7272 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06007273
sfricke-samsung45996a42021-09-16 13:45:27 -07007274 if (IsExtEnabled(device_extensions.vk_android_external_memory_android_hardware_buffer)) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07007275 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06007276 }
7277
Mike Weiblen672b58b2017-02-21 14:32:53 -07007278 return skip;
7279}
sfricke-samsung022fa252020-07-24 03:26:16 -07007280
7281// Validates the image is allowed to be protected
7282bool CoreChecks::ValidateProtectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06007283 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07007284 bool skip = false;
sfricke-samsung21286f82021-11-16 08:21:46 -08007285
7286 // if driver supports protectedNoFault the operation is valid, just has undefined values
7287 if ((!phys_dev_props_core11.protectedNoFault) && (cb_state->unprotected == true) && (image_state->unprotected == false)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06007288 LogObjectList objlist(cb_state->commandBuffer());
7289 objlist.add(image_state->image());
locke-lunarg351c9d82020-10-23 14:43:21 -06007290 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 -06007291 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
7292 report_data->FormatHandle(image_state->image()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07007293 }
7294 return skip;
7295}
7296
7297// Validates the image is allowed to be unprotected
7298bool CoreChecks::ValidateUnprotectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06007299 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07007300 bool skip = false;
sfricke-samsung21286f82021-11-16 08:21:46 -08007301
7302 // if driver supports protectedNoFault the operation is valid, just has undefined values
7303 if ((!phys_dev_props_core11.protectedNoFault) && (cb_state->unprotected == false) && (image_state->unprotected == true)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06007304 LogObjectList objlist(cb_state->commandBuffer());
7305 objlist.add(image_state->image());
locke-lunarg351c9d82020-10-23 14:43:21 -06007306 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 -06007307 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
7308 report_data->FormatHandle(image_state->image()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07007309 }
7310 return skip;
7311}
7312
7313// Validates the buffer is allowed to be protected
7314bool CoreChecks::ValidateProtectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06007315 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07007316 bool skip = false;
sfricke-samsung21286f82021-11-16 08:21:46 -08007317
7318 // if driver supports protectedNoFault the operation is valid, just has undefined values
7319 if ((!phys_dev_props_core11.protectedNoFault) && (cb_state->unprotected == true) && (buffer_state->unprotected == false)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06007320 LogObjectList objlist(cb_state->commandBuffer());
7321 objlist.add(buffer_state->buffer());
locke-lunarg351c9d82020-10-23 14:43:21 -06007322 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 -06007323 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
7324 report_data->FormatHandle(buffer_state->buffer()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07007325 }
7326 return skip;
7327}
7328
7329// Validates the buffer is allowed to be unprotected
7330bool CoreChecks::ValidateUnprotectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06007331 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07007332 bool skip = false;
sfricke-samsung21286f82021-11-16 08:21:46 -08007333
7334 // if driver supports protectedNoFault the operation is valid, just has undefined values
7335 if ((!phys_dev_props_core11.protectedNoFault) && (cb_state->unprotected == false) && (buffer_state->unprotected == true)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06007336 LogObjectList objlist(cb_state->commandBuffer());
7337 objlist.add(buffer_state->buffer());
locke-lunarg351c9d82020-10-23 14:43:21 -06007338 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 -06007339 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
7340 report_data->FormatHandle(buffer_state->buffer()).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07007341 }
7342 return skip;
7343}