blob: 91b98fae91672d06e587fc0ae1e38a7fcc5e41a9 [file] [log] [blame]
sfricke-samsung552d5e12020-01-07 22:00:20 -08001/* Copyright (c) 2015-2020 The Khronos Group Inc.
2 * Copyright (c) 2015-2020 Valve Corporation
3 * Copyright (c) 2015-2020 LunarG, Inc.
4 * Copyright (C) 2015-2020 Google Inc.
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -07005 *
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 *
18 * Author: Mark Lobodzinski <mark@lunarg.com>
Dave Houlton4eaaf3a2017-03-14 11:31:20 -060019 * Author: Dave Houlton <daveh@lunarg.com>
Shannon McPherson3ea65132018-12-05 10:37:39 -070020 * Shannon McPherson <shannon@lunarg.com>
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070021 */
22
Dave Houlton0d4ad6f2018-09-05 14:53:34 -060023#include <cmath>
24#include <set>
Mark Lobodzinski90224de2017-01-26 15:23:11 -070025#include <sstream>
Petr Kraus4d718682017-05-18 03:38:41 +020026#include <string>
Mark Lobodzinski90224de2017-01-26 15:23:11 -070027
28#include "vk_enum_string_helper.h"
Petr Kraus5a01b472019-08-10 01:40:28 +020029#include "vk_format_utils.h"
Mark Lobodzinski90224de2017-01-26 15:23:11 -070030#include "vk_layer_data.h"
31#include "vk_layer_utils.h"
32#include "vk_layer_logging.h"
Dave Houltonbd2e2622018-04-10 16:41:14 -060033#include "vk_typemap_helper.h"
Mark Lobodzinski90224de2017-01-26 15:23:11 -070034
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -070035#include "chassis.h"
Mark Lobodzinski76d76662019-02-14 14:38:21 -070036#include "core_validation.h"
37#include "shader_validation.h"
38#include "descriptor_sets.h"
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070039#include "buffer_validation.h"
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -070040
John Zulauff660ad62019-03-23 07:16:05 -060041// Transfer VkImageSubresourceLayers into VkImageSubresourceRange struct
42static VkImageSubresourceRange RangeFromLayers(const VkImageSubresourceLayers &subresource_layers) {
43 VkImageSubresourceRange subresource_range;
44 subresource_range.aspectMask = subresource_layers.aspectMask;
45 subresource_range.baseArrayLayer = subresource_layers.baseArrayLayer;
46 subresource_range.layerCount = subresource_layers.layerCount;
47 subresource_range.baseMipLevel = subresource_layers.mipLevel;
48 subresource_range.levelCount = 1;
49 return subresource_range;
50}
51
John Zulaufb58415b2019-12-09 15:02:32 -070052static VkImageSubresourceRange NormalizeSubresourceRange(const VkImageCreateInfo &image_create_info,
53 const VkImageSubresourceRange &range);
54static VkImageSubresourceRange MakeImageFullRange(const VkImageCreateInfo &create_info) {
55 const auto format = create_info.format;
56 VkImageSubresourceRange init_range{0, 0, VK_REMAINING_MIP_LEVELS, 0, VK_REMAINING_ARRAY_LAYERS};
57 if (FormatIsColor(format) || FormatIsMultiplane(format)) {
58 init_range.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT; // Normalization will expand this for multiplane
59 } else {
60 init_range.aspectMask =
61 (FormatHasDepth(format) ? VK_IMAGE_ASPECT_DEPTH_BIT : 0) | (FormatHasStencil(format) ? VK_IMAGE_ASPECT_STENCIL_BIT : 0);
62 }
63 return NormalizeSubresourceRange(create_info, init_range);
64}
65
John Zulauff660ad62019-03-23 07:16:05 -060066IMAGE_STATE::IMAGE_STATE(VkImage img, const VkImageCreateInfo *pCreateInfo)
67 : image(img),
Tony-LunarGf3278f52020-01-31 09:58:26 -070068 safe_create_info(pCreateInfo),
69 createInfo(*safe_create_info.ptr()),
John Zulauff660ad62019-03-23 07:16:05 -060070 valid(false),
71 acquired(false),
72 shared_presentable(false),
73 layout_locked(false),
74 get_sparse_reqs_called(false),
75 sparse_metadata_required(false),
76 sparse_metadata_bound(false),
77 imported_ahb(false),
78 has_ahb_format(false),
79 ahb_format(0),
John Zulaufb58415b2019-12-09 15:02:32 -070080 full_range{MakeImageFullRange(createInfo)},
unknown09edc722019-06-21 15:49:38 -060081 create_from_swapchain(VK_NULL_HANDLE),
82 bind_swapchain(VK_NULL_HANDLE),
unknown08c57af2019-06-21 16:33:35 -060083 bind_swapchain_imageIndex(0),
John Zulaufb58415b2019-12-09 15:02:32 -070084 range_encoder(full_range),
unknown08c57af2019-06-21 16:33:35 -060085 sparse_requirements{} {
John Zulauff660ad62019-03-23 07:16:05 -060086 if ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) && (createInfo.queueFamilyIndexCount > 0)) {
87 uint32_t *pQueueFamilyIndices = new uint32_t[createInfo.queueFamilyIndexCount];
88 for (uint32_t i = 0; i < createInfo.queueFamilyIndexCount; i++) {
89 pQueueFamilyIndices[i] = pCreateInfo->pQueueFamilyIndices[i];
90 }
91 createInfo.pQueueFamilyIndices = pQueueFamilyIndices;
92 }
93
94 if (createInfo.flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) {
95 sparse = true;
96 }
Locked8af3732019-05-10 09:47:56 -060097
sfricke-samsunge2441192019-11-06 14:07:57 -080098 auto *externalMemoryInfo = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(pCreateInfo->pNext);
99 if (externalMemoryInfo) {
100 external_memory_handle = externalMemoryInfo->handleTypes;
101 }
102
Locked8af3732019-05-10 09:47:56 -0600103#ifdef VK_USE_PLATFORM_ANDROID_KHR
104 auto external_format = lvl_find_in_chain<VkExternalFormatANDROID>(createInfo.pNext);
105 if (external_format) {
106 external_format_android = external_format->externalFormat;
107 } else {
108 // If externalFormat is zero, the effect is as if the VkExternalFormatANDROID structure was not present.
109 external_format_android = 0;
110 }
111#endif // VK_USE_PLATFORM_ANDROID_KHR
John Zulauff660ad62019-03-23 07:16:05 -0600112}
113
unknown2c877272019-07-11 12:56:50 -0600114bool IMAGE_STATE::IsCreateInfoEqual(const VkImageCreateInfo &other_createInfo) const {
115 bool is_equal = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
116 is_equal = is_equal && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
117 is_equal = is_equal && IsMipLevelsEqual(other_createInfo) && IsArrayLayersEqual(other_createInfo);
118 is_equal = is_equal && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
119 is_equal = is_equal && IsExtentEqual(other_createInfo) && IsTilingEqual(other_createInfo);
120 is_equal = is_equal && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
121 return is_equal && IsQueueFamilyIndicesEqual(other_createInfo);
122}
123
Jeff Bolz82f854d2019-09-17 14:56:47 -0500124// Check image compatibility rules for VK_NV_dedicated_allocation_image_aliasing
125bool IMAGE_STATE::IsCreateInfoDedicatedAllocationImageAliasingCompatible(const VkImageCreateInfo &other_createInfo) const {
126 bool is_compatible = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
127 is_compatible = is_compatible && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
128 is_compatible = is_compatible && IsMipLevelsEqual(other_createInfo);
129 is_compatible = is_compatible && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
130 is_compatible = is_compatible && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
131 is_compatible = is_compatible && IsQueueFamilyIndicesEqual(other_createInfo) && IsTilingEqual(other_createInfo);
132
133 is_compatible = is_compatible && createInfo.extent.width <= other_createInfo.extent.width &&
134 createInfo.extent.height <= other_createInfo.extent.height &&
135 createInfo.extent.depth <= other_createInfo.extent.depth &&
136 createInfo.arrayLayers <= other_createInfo.arrayLayers;
137 return is_compatible;
138}
139
unknown2c877272019-07-11 12:56:50 -0600140bool IMAGE_STATE::IsCompatibleAliasing(IMAGE_STATE *other_image_state) {
141 if (!(createInfo.flags & other_image_state->createInfo.flags & VK_IMAGE_CREATE_ALIAS_BIT)) return false;
locke-lunarg5f59e782019-12-19 10:32:23 -0700142 if ((create_from_swapchain == VK_NULL_HANDLE) && binding.mem_state &&
143 (binding.mem_state == other_image_state->binding.mem_state) && (binding.offset == other_image_state->binding.offset) &&
unknown2c877272019-07-11 12:56:50 -0600144 IsCreateInfoEqual(other_image_state->createInfo)) {
145 return true;
146 }
unknowne1661522019-07-11 13:04:18 -0600147 if ((bind_swapchain == other_image_state->bind_swapchain) && (bind_swapchain != VK_NULL_HANDLE)) {
148 return true;
149 }
unknown2c877272019-07-11 12:56:50 -0600150 return false;
151}
152
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500153IMAGE_VIEW_STATE::IMAGE_VIEW_STATE(const std::shared_ptr<IMAGE_STATE> &im, VkImageView iv, const VkImageViewCreateInfo *ci)
154 : image_view(iv),
155 create_info(*ci),
John Zulaufb58415b2019-12-09 15:02:32 -0700156 normalized_subresource_range(NormalizeSubresourceRange(*im, ci->subresourceRange)),
157 range_generator(im->range_encoder, normalized_subresource_range),
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500158 samplerConversion(VK_NULL_HANDLE),
159 image_state(im) {
John Zulauff660ad62019-03-23 07:16:05 -0600160 auto *conversionInfo = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info.pNext);
161 if (conversionInfo) samplerConversion = conversionInfo->conversion;
162 if (image_state) {
163 // A light normalization of the createInfo range
164 auto &sub_res_range = create_info.subresourceRange;
165 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
166 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
167
168 // Cache a full normalization (for "full image/whole image" comparisons)
John Zulaufb58415b2019-12-09 15:02:32 -0700169 // normalized_subresource_range = NormalizeSubresourceRange(*image_state, ci->subresourceRange);
Jeff Bolz6cede832019-08-09 23:30:39 -0500170 samples = image_state->createInfo.samples;
171 descriptor_format_bits = DescriptorRequirementsBitsFromFormat(create_info.format);
John Zulauff660ad62019-03-23 07:16:05 -0600172 }
173}
174
Dave Houltond9611312018-11-19 17:03:36 -0700175uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
176 // uint cast applies floor()
177 return 1u + (uint32_t)log2(std::max({height, width, depth}));
178}
179
180uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
181
182uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
183
John Zulaufb58415b2019-12-09 15:02:32 -0700184static VkImageSubresourceRange NormalizeSubresourceRange(const VkImageCreateInfo &image_create_info,
185 const VkImageSubresourceRange &range) {
John Zulauff660ad62019-03-23 07:16:05 -0600186 VkImageSubresourceRange norm = range;
187 norm.levelCount = ResolveRemainingLevels(&range, image_create_info.mipLevels);
188
189 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
190 // <arrayLayers> can potentially alias.
191 uint32_t layer_limit = (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR))
192 ? image_create_info.extent.depth
193 : image_create_info.arrayLayers;
194 norm.layerCount = ResolveRemainingLayers(&range, layer_limit);
195
196 // For multiplanar formats, IMAGE_ASPECT_COLOR is equivalent to adding the aspect of the individual planes
197 VkImageAspectFlags &aspect_mask = norm.aspectMask;
198 if (FormatIsMultiplane(image_create_info.format)) {
199 if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
200 aspect_mask &= ~VK_IMAGE_ASPECT_COLOR_BIT;
201 aspect_mask |= (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
202 if (FormatPlaneCount(image_create_info.format) > 2) {
203 aspect_mask |= VK_IMAGE_ASPECT_PLANE_2_BIT;
204 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700205 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700206 }
John Zulauff660ad62019-03-23 07:16:05 -0600207 return norm;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700208}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700209
John Zulaufb58415b2019-12-09 15:02:32 -0700210VkImageSubresourceRange NormalizeSubresourceRange(const IMAGE_STATE &image_state, const VkImageSubresourceRange &range) {
211 const VkImageCreateInfo &image_create_info = image_state.createInfo;
212 return NormalizeSubresourceRange(image_create_info, range);
213}
214
locke-lunarga344e7c2020-01-02 19:48:53 -0700215VkImageLayout GetImageSubresourceInitialLayout(const ImageLayoutMap &imageLayoutMap, const VkImage image,
216 const VkImageSubresource &subresource) {
217 auto imgsubIt = imageLayoutMap.find(image);
locke-lunargcba7d5f2019-12-30 16:59:11 -0700218 if (imgsubIt == imageLayoutMap.end()) return kInvalidLayout;
locke-lunarga344e7c2020-01-02 19:48:53 -0700219 return imgsubIt->second->GetSubresourceInitialLayout(subresource);
locke-lunargcba7d5f2019-12-30 16:59:11 -0700220}
221
locke-lunarga344e7c2020-01-02 19:48:53 -0700222VkImageLayout GetImageSubresourceLayout(const ImageLayoutMap &imageLayoutMap, const VkImage image,
223 const VkImageSubresource &subresource) {
224 auto imgsubIt = imageLayoutMap.find(image);
locke-lunargcba7d5f2019-12-30 16:59:11 -0700225 if (imgsubIt == imageLayoutMap.end()) return kInvalidLayout;
locke-lunarga344e7c2020-01-02 19:48:53 -0700226 return imgsubIt->second->GetSubresourceLayout(subresource);
locke-lunargcba7d5f2019-12-30 16:59:11 -0700227}
228
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700229template <class OBJECT, class LAYOUT>
locke-lunarga344e7c2020-01-02 19:48:53 -0700230void CoreChecks::SetLayout(OBJECT *pObject, VkImage image, const VkImageSubresource &subresource, const LAYOUT &layout) {
231 SetLayout(pObject, image, subresource, layout, VK_IMAGE_ASPECT_COLOR_BIT);
232 SetLayout(pObject, image, subresource, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
233 SetLayout(pObject, image, subresource, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
234 SetLayout(pObject, image, subresource, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600235 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
locke-lunarga344e7c2020-01-02 19:48:53 -0700236 SetLayout(pObject, image, subresource, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
237 SetLayout(pObject, image, subresource, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
238 SetLayout(pObject, image, subresource, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700239 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700240}
241
242template <class OBJECT, class LAYOUT>
locke-lunarga344e7c2020-01-02 19:48:53 -0700243void CoreChecks::SetLayout(OBJECT *pObject, const VkImage image, VkImageSubresource subresource, const LAYOUT &layout,
244 VkImageAspectFlags aspectMask) {
245 if (subresource.aspectMask & aspectMask) {
246 subresource.aspectMask = aspectMask;
247 SetLayout(pObject, image, subresource, layout);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700248 }
249}
250
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500251bool CoreChecks::FindLayouts(VkImage image, std::vector<VkImageLayout> &layouts) const {
locke-lunargcba7d5f2019-12-30 16:59:11 -0700252 auto imgsubIt = imageLayoutMap.find(image);
253 if (imgsubIt == imageLayoutMap.end()) return false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700254 auto image_state = GetImageState(image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700255 if (!image_state) return false;
256 bool ignoreGlobal = false;
257 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
locke-lunargcba7d5f2019-12-30 16:59:11 -0700258 if (imgsubIt->second->CurrentLayoutSize() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700259 ignoreGlobal = true;
260 }
locke-lunargcba7d5f2019-12-30 16:59:11 -0700261 for (auto imgsubpair : imgsubIt->second->CurrentLayoutView()) {
262 if (ignoreGlobal) continue;
263 layouts.push_back(imgsubpair.it->second);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700264 }
265 return true;
266}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700267
locke-lunarga344e7c2020-01-02 19:48:53 -0700268bool CoreChecks::FindLayout(const ImageLayoutMap &imageLayoutMap, const VkImage image, VkImageSubresource subresource,
269 VkImageLayout &layout, const VkImageAspectFlags aspectMask) {
270 if (!(subresource.aspectMask & aspectMask)) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700271 return false;
272 }
locke-lunarga344e7c2020-01-02 19:48:53 -0700273 subresource.aspectMask = aspectMask;
274 auto layout_ = GetImageSubresourceLayout(imageLayoutMap, image, subresource);
locke-lunargcba7d5f2019-12-30 16:59:11 -0700275 if (layout_ == kInvalidLayout) return false;
276 layout = layout_;
277
Tony Barbourdf013b92017-01-25 12:53:48 -0700278 return true;
Tony Barboure0c5cc92017-02-08 13:53:39 -0700279}
Tony Barbourdf013b92017-01-25 12:53:48 -0700280
281// find layout in supplied map
locke-lunarga344e7c2020-01-02 19:48:53 -0700282bool CoreChecks::FindLayout(const ImageLayoutMap &imageLayoutMap, const VkImage image, VkImageSubresource subresource,
John Zulauf3b04ebd2019-07-18 14:08:11 -0600283 VkImageLayout &layout) const {
locke-lunargcba7d5f2019-12-30 16:59:11 -0700284 layout = kInvalidLayout;
locke-lunarga344e7c2020-01-02 19:48:53 -0700285 FindLayout(imageLayoutMap, image, subresource, layout, VK_IMAGE_ASPECT_COLOR_BIT);
286 FindLayout(imageLayoutMap, image, subresource, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
287 FindLayout(imageLayoutMap, image, subresource, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
288 FindLayout(imageLayoutMap, image, subresource, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600289 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
locke-lunarga344e7c2020-01-02 19:48:53 -0700290 FindLayout(imageLayoutMap, image, subresource, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
291 FindLayout(imageLayoutMap, image, subresource, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
292 FindLayout(imageLayoutMap, image, subresource, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700293 }
294 // Image+subresource not found, look for image handle w/o subresource
locke-lunargcba7d5f2019-12-30 16:59:11 -0700295 if (layout == kInvalidLayout) {
locke-lunarga344e7c2020-01-02 19:48:53 -0700296 auto image_state = Get<IMAGE_STATE>(image);
297 subresource.aspectMask = image_state->full_range.aspectMask;
298 subresource.mipLevel = image_state->full_range.baseMipLevel;
299 subresource.arrayLayer = image_state->full_range.baseArrayLayer;
300 auto layout_ = GetImageSubresourceInitialLayout(imageLayoutMap, image, subresource);
locke-lunargcba7d5f2019-12-30 16:59:11 -0700301 if (layout_ == kInvalidLayout) return false;
302 layout = layout_;
Tony Barbourdf013b92017-01-25 12:53:48 -0700303 }
304 return true;
305}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700306
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600307// Set image layout for given VkImageSubresourceRange struct
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600308void CoreChecks::SetImageLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600309 const VkImageSubresourceRange &image_subresource_range, VkImageLayout layout,
310 VkImageLayout expected_layout) {
311 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
312 assert(subresource_map); // the non-const getter must return a valid pointer
John Zulauf4ec24ec2019-05-02 17:22:59 -0600313 if (subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600314 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700315 }
316}
John Zulauff660ad62019-03-23 07:16:05 -0600317
318// Set the initial image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600319void CoreChecks::SetImageViewInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
Jeff Bolz3e333222019-08-10 23:00:38 -0500320 if (disabled.image_layout_validation) {
321 return;
322 }
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500323 IMAGE_STATE *image_state = view_state.image_state.get();
324 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
John Zulaufb58415b2019-12-09 15:02:32 -0700325 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
John Zulauff660ad62019-03-23 07:16:05 -0600326}
327
328// Set the initial image layout for a passed non-normalized subresource range
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600329void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600330 const VkImageSubresourceRange &range, VkImageLayout layout) {
331 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
332 assert(subresource_map);
John Zulauf4ec24ec2019-05-02 17:22:59 -0600333 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(image_state, range), layout);
John Zulauff660ad62019-03-23 07:16:05 -0600334}
335
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600336void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, VkImage image, const VkImageSubresourceRange &range,
John Zulauff660ad62019-03-23 07:16:05 -0600337 VkImageLayout layout) {
338 const IMAGE_STATE *image_state = GetImageState(image);
339 if (!image_state) return;
340 SetImageInitialLayout(cb_node, *image_state, range, layout);
341};
342
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600343void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600344 const VkImageSubresourceLayers &layers, VkImageLayout layout) {
345 SetImageInitialLayout(cb_node, image_state, RangeFromLayers(layers), layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600346}
Dave Houltonddd65c52018-05-08 14:58:01 -0600347
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600348// Set image layout for all slices of an image view
Piers Daniell4fde9b72019-11-27 16:19:46 -0700349void CoreChecks::SetImageViewLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout,
350 VkImageLayout layoutStencil) {
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500351 IMAGE_STATE *image_state = view_state.image_state.get();
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600352
John Zulauff660ad62019-03-23 07:16:05 -0600353 VkImageSubresourceRange sub_range = view_state.normalized_subresource_range;
Dave Houltonddd65c52018-05-08 14:58:01 -0600354 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
355 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
John Zulauff660ad62019-03-23 07:16:05 -0600356 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) && (view_state.create_info.viewType != VK_IMAGE_VIEW_TYPE_3D)) {
Dave Houltonddd65c52018-05-08 14:58:01 -0600357 sub_range.baseArrayLayer = 0;
358 sub_range.layerCount = image_state->createInfo.extent.depth;
359 }
360
Piers Daniell4fde9b72019-11-27 16:19:46 -0700361 if (sub_range.aspectMask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT) && layoutStencil != kInvalidLayout) {
362 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
363 SetImageLayout(cb_node, *image_state, sub_range, layout);
364 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
365 SetImageLayout(cb_node, *image_state, sub_range, layoutStencil);
366 } else {
367 SetImageLayout(cb_node, *image_state, sub_range, layout);
368 }
John Zulauf4ccf5c02018-09-21 11:46:18 -0600369}
370
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700371bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
372 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700373 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600374 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100375 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700376 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100377 const char *vuid;
378 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
379
380 if (!image_state) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700381 skip |= LogError(image, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
382 "Render Pass begin with %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
383 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
384 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100385 return skip;
386 }
387
388 auto image_usage = image_state->createInfo.usage;
389
390 // Check for layouts that mismatch image usages in the framebuffer
391 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800392 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100393 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700394 LogError(image, vuid,
395 "Layout/usage mismatch for attachment %u in %s"
396 " - the %s is %s but the image attached to %s via %s"
397 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
398 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
399 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100400 }
401
402 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
403 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800404 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100405 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700406 LogError(image, vuid,
407 "Layout/usage mismatch for attachment %u in %s"
408 " - the %s is %s but the image attached to %s via %s"
409 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
410 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
411 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100412 }
413
414 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800415 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100416 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700417 LogError(image, vuid,
418 "Layout/usage mismatch for attachment %u in %s"
419 " - the %s is %s but the image attached to %s via %s"
420 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
421 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
422 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100423 }
424
425 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800426 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100427 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700428 LogError(image, vuid,
429 "Layout/usage mismatch for attachment %u in %s"
430 " - the %s is %s but the image attached to %s via %s"
431 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
432 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
433 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100434 }
435
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600436 if (device_extensions.vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100437 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
438 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
439 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
440 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
441 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800442 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700443 skip |= LogError(image, vuid,
444 "Layout/usage mismatch for attachment %u in %s"
445 " - the %s is %s but the image attached to %s via %s"
446 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
447 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
448 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
449 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100450 }
451 } else {
452 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
453 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
454 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
455 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700456 skip |= LogError(image, "VUID-vkCmdBeginRenderPass-initialLayout-00896",
457 "Layout/usage mismatch for attachment %u in %s"
458 " - the %s is %s but the image attached to %s via %s"
459 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
460 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
461 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
462 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100463 }
464 }
465 return skip;
466}
467
John Zulauf17a01bb2019-08-09 16:41:19 -0600468bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700469 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600470 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600471 bool skip = false;
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700472 auto const pRenderPassInfo = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700473 auto const &framebufferInfo = framebuffer_state->createInfo;
Tobias Hectorc9057422019-07-23 12:15:52 +0100474 const VkImageView *attachments = framebufferInfo.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100475
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700476 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100477 auto framebuffer = framebuffer_state->framebuffer;
478
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700479 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700480 skip |= LogError(pCB->commandBuffer, kVUID_Core_DrawState_InvalidRenderpass,
481 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700482 }
John Zulauf8e308292018-09-21 11:34:37 -0600483
Tobias Hectorc9057422019-07-23 12:15:52 +0100484 const auto *attachmentInfo = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
485 if (((framebufferInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) != 0) && attachmentInfo != nullptr) {
486 attachments = attachmentInfo->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100487 }
488
Tobias Hectorc9057422019-07-23 12:15:52 +0100489 if (attachments != nullptr) {
490 const auto *const_pCB = static_cast<const CMD_BUFFER_STATE *>(pCB);
491 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
492 auto image_view = attachments[i];
493 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100494
Tobias Hectorc9057422019-07-23 12:15:52 +0100495 if (!view_state) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700496 skip |= LogError(pRenderPassBegin->renderPass, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
497 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
498 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
499 report_data->FormatHandle(image_view).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100500 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100501 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100502
503 const VkImage image = view_state->create_info.image;
504 const IMAGE_STATE *image_state = GetImageState(image);
505
506 if (!image_state) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700507 skip |= LogError(pRenderPassBegin->renderPass, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
508 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
509 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
510 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100511 continue;
512 }
513 auto attachment_initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
514 auto final_layout = pRenderPassInfo->pAttachments[i].finalLayout;
515
Piers Daniell7f894f62020-01-09 16:33:48 -0700516 // Default to expecting stencil in the same layout.
517 auto attachment_stencil_initial_layout = attachment_initial_layout;
518
519 // If a separate layout is specified, look for that.
520 const auto *attachment_description_stencil_layout =
521 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
522 if (attachment_description_stencil_layout) {
523 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
524 }
525
Tobias Hectorc9057422019-07-23 12:15:52 +0100526 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
527 // in common with the non-const version.)
528 const ImageSubresourceLayoutMap *subresource_map =
529 (attachment_initial_layout != VK_IMAGE_LAYOUT_UNDEFINED) ? GetImageSubresourceLayoutMap(const_pCB, image) : nullptr;
530
531 if (subresource_map) { // If no layout information for image yet, will be checked at QueueSubmit time
532 LayoutUseCheckAndMessage layout_check(subresource_map);
533 bool subres_skip = false;
John Zulauf5e617452019-11-19 14:44:16 -0700534 auto pos = subresource_map->Find(view_state->normalized_subresource_range);
535 for (; pos != subresource_map->End() && !subres_skip; ++pos) {
536 const VkImageSubresource &subres = pos->subresource;
Piers Daniell7f894f62020-01-09 16:33:48 -0700537
John Zulauf5e617452019-11-19 14:44:16 -0700538 // Allow for differing depth and stencil layouts
539 VkImageLayout check_layout = attachment_initial_layout;
540 if (subres.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) check_layout = attachment_stencil_initial_layout;
541
542 if (!layout_check.Check(subres, check_layout, pos->current_layout, pos->initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700543 subres_skip |= LogError(
544 device, kVUID_Core_DrawState_InvalidRenderpass,
Piers Daniell7f894f62020-01-09 16:33:48 -0700545 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
546 "and the %s layout of the attachment is %s. The layouts must match, or the render "
547 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
John Zulauf5e617452019-11-19 14:44:16 -0700548 i, string_VkImageLayout(check_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobias Hectorc9057422019-07-23 12:15:52 +0100549 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700550 }
John Zulauf5e617452019-11-19 14:44:16 -0700551
Tobias Hectorc9057422019-07-23 12:15:52 +0100552 skip |= subres_skip;
553 }
554
555 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view,
556 framebuffer, render_pass, i, "initial layout");
557
558 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer,
559 render_pass, i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100560 }
561
Tobias Hectorc9057422019-07-23 12:15:52 +0100562 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
563 auto &subpass = pRenderPassInfo->pSubpasses[j];
564 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
565 auto &attachment_ref = subpass.pInputAttachments[k];
566 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
567 auto image_view = attachments[attachment_ref.attachment];
568 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100569
Tobias Hectorc9057422019-07-23 12:15:52 +0100570 if (view_state) {
571 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700572 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
573 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100574 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100575 }
576 }
577 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100578
Tobias Hectorc9057422019-07-23 12:15:52 +0100579 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
580 auto &attachment_ref = subpass.pColorAttachments[k];
581 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
582 auto image_view = attachments[attachment_ref.attachment];
583 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100584
Tobias Hectorc9057422019-07-23 12:15:52 +0100585 if (view_state) {
586 auto image = view_state->create_info.image;
587 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
588 framebuffer, render_pass, attachment_ref.attachment,
589 "color attachment layout");
590 if (subpass.pResolveAttachments) {
591 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
592 rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
593 attachment_ref.attachment, "resolve attachment layout");
594 }
595 }
596 }
597 }
598
599 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
600 auto &attachment_ref = *subpass.pDepthStencilAttachment;
601 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
602 auto image_view = attachments[attachment_ref.attachment];
603 auto view_state = GetImageViewState(image_view);
604
605 if (view_state) {
606 auto image = view_state->create_info.image;
607 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
608 framebuffer, render_pass, attachment_ref.attachment,
609 "input attachment layout");
610 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100611 }
612 }
613 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700614 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600615 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700616}
617
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600618void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700619 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700620 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700621 auto image_view = GetAttachmentImageViewState(pFramebuffer, ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600622 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700623 VkImageLayout stencil_layout = kInvalidLayout;
624 const auto *attachment_reference_stencil_layout = lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(ref.pNext);
625 if (attachment_reference_stencil_layout) {
626 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
627 }
628
629 SetImageViewLayout(pCB, *image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600630 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700631 }
632}
633
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600634void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
635 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700636 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700637
638 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700639 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700640 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700641 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700642 }
643 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700644 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700645 }
646 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700647 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700648 }
649 }
650}
651
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700652// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
653// 1. Transition into initialLayout state
654// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600655void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700656 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700657 // First transition into initialLayout
658 auto const rpci = render_pass_state->createInfo.ptr();
659 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700660 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -0600661 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700662 VkImageLayout stencil_layout = kInvalidLayout;
663 const auto *attachment_description_stencil_layout =
664 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(rpci->pAttachments[i].pNext);
665 if (attachment_description_stencil_layout) {
666 stencil_layout = attachment_description_stencil_layout->stencilInitialLayout;
667 }
668
669 SetImageViewLayout(cb_state, *view_state, rpci->pAttachments[i].initialLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600670 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700671 }
672 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700673 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700674}
675
Dave Houlton10b39482017-03-16 13:18:15 -0600676bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600677 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600678 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600679 }
680 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600681 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600682 }
683 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600684 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600685 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700686 if (0 !=
687 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
688 if (FormatPlaneCount(format) == 1) return false;
689 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600690 return true;
691}
692
Mike Weiblen62d08a32017-03-07 22:18:27 -0700693// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Petr Krausad0096a2019-08-09 18:35:04 +0200694bool CoreChecks::ValidateBarrierLayoutToImageUsage(const VkImageMemoryBarrier &img_barrier, bool new_not_old,
695 VkImageUsageFlags usage_flags, const char *func_name,
John Zulaufa4472282019-08-22 14:44:34 -0600696 const char *barrier_pname) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700697 bool skip = false;
Petr Krausad0096a2019-08-09 18:35:04 +0200698 const VkImageLayout layout = (new_not_old) ? img_barrier.newLayout : img_barrier.oldLayout;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600699 const char *msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700700
701 switch (layout) {
702 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
703 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600704 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700705 }
706 break;
707 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
708 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600709 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700710 }
711 break;
712 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
713 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600714 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700715 }
716 break;
717 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
718 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600719 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700720 }
721 break;
722 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
723 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600724 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700725 }
726 break;
727 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
728 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600729 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700730 }
731 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600732 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500733 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
734 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
735 }
736 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700737 default:
738 // Other VkImageLayout values do not have VUs defined in this context.
739 break;
740 }
741
Dave Houlton8e9f6542018-05-18 12:18:22 -0600742 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700743 skip |= LogError(img_barrier.image, msg_code,
744 "%s: Image barrier %s %s Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".", func_name,
745 barrier_pname, ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
746 report_data->FormatHandle(img_barrier.image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700747 }
748 return skip;
749}
750
751// Verify image barriers are compatible with the images they reference.
John Zulaufa4472282019-08-22 14:44:34 -0600752bool CoreChecks::ValidateBarriersToImages(const CMD_BUFFER_STATE *cb_state, uint32_t imageMemoryBarrierCount,
753 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700754 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700755
Petr Krausad0096a2019-08-09 18:35:04 +0200756 // Scoreboard for checking for duplicate and inconsistent barriers to images
757 struct ImageBarrierScoreboardEntry {
758 uint32_t index;
759 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
760 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
761 const VkImageMemoryBarrier *barrier;
762 };
763 using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
764 using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
765
John Zulauf463c51e2018-05-31 13:29:20 -0600766 // Scoreboard for duplicate layout transition barriers within the list
767 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
768 ImageBarrierScoreboardImageMap layout_transitions;
769
Mike Weiblen62d08a32017-03-07 22:18:27 -0700770 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +0200771 const auto &img_barrier = pImageMemoryBarriers[i];
772 const std::string barrier_pname = "pImageMemoryBarrier[" + std::to_string(i) + "]";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700773
John Zulauf463c51e2018-05-31 13:29:20 -0600774 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
775 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
776 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +0200777 if (img_barrier.oldLayout != img_barrier.newLayout) {
778 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
779 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -0600780 if (image_it != layout_transitions.end()) {
781 auto &subres_map = image_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200782 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -0600783 if (subres_it != subres_map.end()) {
784 auto &entry = subres_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200785 if ((entry.barrier->newLayout != img_barrier.oldLayout) &&
786 (img_barrier.oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
787 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700788 skip = LogError(
789 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
Petr Krausad0096a2019-08-09 18:35:04 +0200790 "%s: %s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600791 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
792 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Petr Krausad0096a2019-08-09 18:35:04 +0200793 func_name, barrier_pname.c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
794 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
795 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600796 }
797 entry = new_entry;
798 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200799 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600800 }
801 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200802 layout_transitions[img_barrier.image][img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600803 }
804 }
805
Petr Krausad0096a2019-08-09 18:35:04 +0200806 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600807 if (image_state) {
808 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Petr Krausad0096a2019-08-09 18:35:04 +0200809 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, false, usage_flags, func_name, barrier_pname.c_str());
810 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, true, usage_flags, func_name, barrier_pname.c_str());
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600811
812 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
813 if (image_state->layout_locked) {
814 // TODO: Add unique id for error when available
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700815 skip |= LogError(
816 img_barrier.image, 0,
locke-lunarg9edc2812019-06-17 23:18:52 -0600817 "Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600818 " from layout %s to layout %s, but image has already been presented and cannot have its layout transitioned.",
Petr Krausad0096a2019-08-09 18:35:04 +0200819 report_data->FormatHandle(img_barrier.image).c_str(), string_VkImageLayout(img_barrier.oldLayout),
820 string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600821 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600822
John Zulaufa4472282019-08-22 14:44:34 -0600823 const VkImageCreateInfo &image_create_info = image_state->createInfo;
John Zulauff660ad62019-03-23 07:16:05 -0600824 // For a Depth/Stencil image both aspects MUST be set
John Zulaufa4472282019-08-22 14:44:34 -0600825 if (FormatIsDepthAndStencil(image_create_info.format)) {
Petr Krausad0096a2019-08-09 18:35:04 +0200826 auto const aspect_mask = img_barrier.subresourceRange.aspectMask;
Piers Daniell41b8c5d2020-01-10 15:42:00 -0700827 if (enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -0600828 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
829 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700830 LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-03319",
831 "%s: Image barrier %s references %s of format %s that must have either the depth or stencil "
832 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
833 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
834 string_VkFormat(image_create_info.format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600835 }
836 } else {
837 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
838 if ((aspect_mask & ds_mask) != (ds_mask)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700839 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-03320",
840 "%s: Image barrier %s references %s of format %s that must have the depth and stencil "
841 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
842 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
843 string_VkFormat(image_create_info.format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600844 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700845 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700846 }
John Zulauff660ad62019-03-23 07:16:05 -0600847
Petr Krausad0096a2019-08-09 18:35:04 +0200848 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier.image);
849 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -0600850 // TODO: Set memory invalid which is in mem_tracker currently
851 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
852 // subresource.
853 } else if (subresource_map) {
854 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -0600855 LayoutUseCheckAndMessage layout_check(subresource_map);
Petr Krausad0096a2019-08-09 18:35:04 +0200856 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier.subresourceRange);
John Zulauf5e617452019-11-19 14:44:16 -0700857 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
858 const auto &value = *pos;
859 if (!layout_check.Check(value.subresource, img_barrier.oldLayout, value.current_layout, value.initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700860 subres_skip = LogError(
861 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
John Zulauf5e617452019-11-19 14:44:16 -0700862 "For %s you cannot transition the layout of aspect=%d level=%d layer=%d from %s when the "
863 "%s layout is %s.",
864 report_data->FormatHandle(img_barrier.image).c_str(), value.subresource.aspectMask,
865 value.subresource.mipLevel, value.subresource.arrayLayer, string_VkImageLayout(img_barrier.oldLayout),
866 layout_check.message, string_VkImageLayout(layout_check.layout));
John Zulauff660ad62019-03-23 07:16:05 -0600867 }
John Zulauf5e617452019-11-19 14:44:16 -0700868 }
John Zulauff660ad62019-03-23 07:16:05 -0600869 skip |= subres_skip;
870 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700871 }
872 }
873 return skip;
874}
875
John Zulaufe3d1c8a2019-08-12 14:34:58 -0600876bool CoreChecks::IsReleaseOp(CMD_BUFFER_STATE *cb_state, const VkImageMemoryBarrier &barrier) const {
Petr Krausad0096a2019-08-09 18:35:04 +0200877 if (!IsTransferOp(&barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700878
Jeff Bolz6835fda2019-10-06 00:15:34 -0500879 auto pool = cb_state->command_pool.get();
Petr Krausad0096a2019-08-09 18:35:04 +0200880 return pool && TempIsReleaseOp<VkImageMemoryBarrier, true>(pool, &barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700881}
882
John Zulauf6b4aae82018-05-09 13:03:36 -0600883template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -0600884bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
885 uint32_t barrier_count, const Barrier *barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600886 using BarrierRecord = QFOTransferBarrier<Barrier>;
887 bool skip = false;
Jeff Bolz6835fda2019-10-06 00:15:34 -0500888 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -0600889 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
890 const char *barrier_name = BarrierRecord::BarrierName();
891 const char *handle_name = BarrierRecord::HandleName();
892 const char *transfer_type = nullptr;
893 for (uint32_t b = 0; b < barrier_count; b++) {
894 if (!IsTransferOp(&barriers[b])) continue;
895 const BarrierRecord *barrier_record = nullptr;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700896 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufa4472282019-08-22 14:44:34 -0600897 !QueueFamilyIsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600898 const auto found = barrier_sets.release.find(barriers[b]);
899 if (found != barrier_sets.release.cend()) {
900 barrier_record = &(*found);
901 transfer_type = "releasing";
902 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600903 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufa4472282019-08-22 14:44:34 -0600904 !QueueFamilyIsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600905 const auto found = barrier_sets.acquire.find(barriers[b]);
906 if (found != barrier_sets.acquire.cend()) {
907 barrier_record = &(*found);
908 transfer_type = "acquiring";
909 }
910 }
911 if (barrier_record != nullptr) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700912 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOInCB(),
913 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
914 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
915 func_name, barrier_name, b, transfer_type, handle_name,
916 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
917 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -0600918 }
919 }
920 return skip;
921}
922
John Zulaufa4472282019-08-22 14:44:34 -0600923VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
924 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
925}
926
927const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
928 return device_state.GetImageState(barrier.image);
929}
930
931VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
932 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
933}
934
935const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
936 return device_state.GetBufferState(barrier.buffer);
937}
938
939VkBuffer BarrierHandle(const VkBufferMemoryBarrier &barrier) { return barrier.buffer; }
940
John Zulauf6b4aae82018-05-09 13:03:36 -0600941template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -0600942void CoreChecks::RecordBarrierArrayValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
943 const Barrier *barriers) {
Jeff Bolz6835fda2019-10-06 00:15:34 -0500944 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -0600945 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
946 for (uint32_t b = 0; b < barrier_count; b++) {
John Zulaufa4472282019-08-22 14:44:34 -0600947 auto &barrier = barriers[b];
948 if (IsTransferOp(&barrier)) {
949 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barrier) &&
950 !QueueFamilyIsSpecial(barrier.dstQueueFamilyIndex)) {
951 barrier_sets.release.emplace(barrier);
952 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barrier) &&
953 !QueueFamilyIsSpecial(barrier.srcQueueFamilyIndex)) {
954 barrier_sets.acquire.emplace(barrier);
955 }
956 }
957
958 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
959 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
960 if (!QueueFamilyIsIgnored(src_queue_family) && !QueueFamilyIsIgnored(dst_queue_family)) {
961 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
962 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
963 auto handle_state = BarrierHandleState(*this, barrier);
964 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
965 if (!mode_concurrent) {
966 const auto typed_handle = BarrierTypedHandle(barrier);
Jeff Bolz310775c2019-10-09 00:46:33 -0500967 cb_state->queue_submit_functions.emplace_back(
968 [func_name, cb_state, typed_handle, src_queue_family, dst_queue_family](
969 const ValidationStateTracker *device_data, const QUEUE_STATE *queue_state) {
970 return ValidateConcurrentBarrierAtSubmit(device_data, queue_state, func_name, cb_state, typed_handle,
971 src_queue_family, dst_queue_family);
John Zulaufa4472282019-08-22 14:44:34 -0600972 });
973 }
John Zulauf6b4aae82018-05-09 13:03:36 -0600974 }
975 }
976}
977
John Zulaufa4472282019-08-22 14:44:34 -0600978bool CoreChecks::ValidateBarriersQFOTransferUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600979 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700980 uint32_t imageMemBarrierCount,
John Zulaufa4472282019-08-22 14:44:34 -0600981 const VkImageMemoryBarrier *pImageMemBarriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600982 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700983 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
984 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -0600985 return skip;
986}
987
John Zulaufa4472282019-08-22 14:44:34 -0600988void CoreChecks::RecordBarrierValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
989 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
990 const VkImageMemoryBarrier *pImageMemBarriers) {
991 RecordBarrierArrayValidationInfo(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
992 RecordBarrierArrayValidationInfo(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -0600993}
994
995template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600996bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
John Zulauf3b04ebd2019-07-18 14:08:11 -0600997 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600998 // Record to the scoreboard or report that we have a duplication
999 bool skip = false;
1000 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
1001 if (!inserted.second && inserted.first->second != cb_state) {
1002 // This is a duplication (but don't report duplicates from the same CB, as we do that at record time
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001003 skip = LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
1004 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1005 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
1006 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
1007 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
1008 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001009 }
1010 return skip;
1011}
1012
1013template <typename Barrier>
John Zulauf3b04ebd2019-07-18 14:08:11 -06001014bool CoreChecks::ValidateQueuedQFOTransferBarriers(const CMD_BUFFER_STATE *cb_state,
1015 QFOTransferCBScoreboards<Barrier> *scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001016 using BarrierRecord = QFOTransferBarrier<Barrier>;
1017 using TypeTag = typename BarrierRecord::Tag;
1018 bool skip = false;
John Zulauf6b4aae82018-05-09 13:03:36 -06001019 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001020 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001021 const char *barrier_name = BarrierRecord::BarrierName();
1022 const char *handle_name = BarrierRecord::HandleName();
1023 // No release should have an extant duplicate (WARNING)
1024 for (const auto &release : cb_barriers.release) {
1025 // Check the global pending release barriers
1026 const auto set_it = global_release_barriers.find(release.handle);
1027 if (set_it != global_release_barriers.cend()) {
1028 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1029 const auto found = set_for_handle.find(release);
1030 if (found != set_for_handle.cend()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001031 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
1032 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1033 " to dstQueueFamilyIndex %" PRIu32
1034 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1035 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1036 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001037 }
1038 }
1039 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1040 }
1041 // Each acquire must have a matching release (ERROR)
1042 for (const auto &acquire : cb_barriers.acquire) {
1043 const auto set_it = global_release_barriers.find(acquire.handle);
1044 bool matching_release_found = false;
1045 if (set_it != global_release_barriers.cend()) {
1046 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1047 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1048 }
1049 if (!matching_release_found) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001050 skip |= LogError(cb_state->commandBuffer, BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
1051 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1052 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1053 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1054 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001055 }
1056 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1057 }
1058 return skip;
1059}
1060
John Zulauf3b04ebd2019-07-18 14:08:11 -06001061bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001062 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001063 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001064 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001065 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state, qfo_image_scoreboards);
1066 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state, qfo_buffer_scoreboards);
John Zulauf6b4aae82018-05-09 13:03:36 -06001067 return skip;
1068}
1069
1070template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001071void CoreChecks::RecordQueuedQFOTransferBarriers(CMD_BUFFER_STATE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001072 using BarrierRecord = QFOTransferBarrier<Barrier>;
1073 using TypeTag = typename BarrierRecord::Tag;
1074 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001075 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001076
1077 // Add release barriers from this submit to the global map
1078 for (const auto &release : cb_barriers.release) {
1079 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1080 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1081 global_release_barriers[release.handle].insert(release);
1082 }
1083
1084 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1085 for (const auto &acquire : cb_barriers.acquire) {
1086 // NOTE: We're not using [] because we don't want to create entries for missing releases
1087 auto set_it = global_release_barriers.find(acquire.handle);
1088 if (set_it != global_release_barriers.end()) {
1089 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1090 set_for_handle.erase(acquire);
1091 if (set_for_handle.size() == 0) { // Clean up empty sets
1092 global_release_barriers.erase(set_it);
1093 }
1094 }
1095 }
1096}
1097
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001098void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001099 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state);
1100 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001101}
1102
John Zulauf6b4aae82018-05-09 13:03:36 -06001103// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001104void CoreChecks::EraseQFOImageRelaseBarriers(const VkImage &image) { EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image); }
John Zulauf6b4aae82018-05-09 13:03:36 -06001105
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001106void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001107 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001108 for (uint32_t i = 0; i < memBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +02001109 const auto &mem_barrier = pImgMemBarriers[i];
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001110
Chris Forbes4de4b132017-08-21 11:27:08 -07001111 // For ownership transfers, the barrier is specified twice; as a release
1112 // operation on the yielding queue family, and as an acquire operation
1113 // on the acquiring queue family. This barrier may also include a layout
1114 // transition, which occurs 'between' the two operations. For validation
1115 // purposes it doesn't seem important which side performs the layout
1116 // transition, but it must not be performed twice. We'll arbitrarily
1117 // choose to perform it as part of the acquire operation.
John Zulauf2be3fe02019-12-30 09:48:02 -07001118 //
1119 // However, we still need to record initial layout for the "initial layout" validation
1120 const bool is_release_op = IsReleaseOp(cb_state, mem_barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -07001121
Petr Krausad0096a2019-08-09 18:35:04 +02001122 auto *image_state = GetImageState(mem_barrier.image);
John Zulauff660ad62019-03-23 07:16:05 -06001123 if (!image_state) continue;
John Zulauf2be3fe02019-12-30 09:48:02 -07001124 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
unknown86bcb3a2019-07-11 13:05:36 -06001125 for (const auto &image : image_state->aliasing_images) {
1126 image_state = GetImageState(image);
John Zulauf2be3fe02019-12-30 09:48:02 -07001127 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
Dave Houltonb3f4b282018-02-22 16:25:16 -07001128 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001129 }
1130}
1131
unknown86bcb3a2019-07-11 13:05:36 -06001132void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
John Zulauf2be3fe02019-12-30 09:48:02 -07001133 const VkImageMemoryBarrier &mem_barrier, bool is_release_op) {
unknown86bcb3a2019-07-11 13:05:36 -06001134 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier.subresourceRange);
1135 const auto &image_create_info = image_state->createInfo;
1136
1137 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1138 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1139 // for all (potential) layer sub_resources.
1140 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
1141 normalized_isr.baseArrayLayer = 0;
1142 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
1143 }
1144
John Zulauf2be3fe02019-12-30 09:48:02 -07001145 if (is_release_op) {
1146 SetImageInitialLayout(cb_state, *image_state, normalized_isr, mem_barrier.oldLayout);
1147 } else {
1148 SetImageLayout(cb_state, *image_state, normalized_isr, mem_barrier.newLayout, mem_barrier.oldLayout);
1149 }
unknown86bcb3a2019-07-11 13:05:36 -06001150}
1151
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001152bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1153 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1154 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1155 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Matthew Ruschd7ef5482019-07-16 22:01:54 -07001156 if (disabled.image_layout_validation) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001157 assert(cb_node);
1158 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001159 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001160 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001161
John Zulauff660ad62019-03-23 07:16:05 -06001162 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1163 if (subresource_map) {
1164 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001165 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
John Zulauf5e617452019-11-19 14:44:16 -07001166 for (auto pos = subresource_map->Find(range); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1167 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001168 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001169 subres_skip |= LogError(cb_node->commandBuffer, layout_mismatch_msg_code,
1170 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1171 "%s layout %s.",
1172 caller, report_data->FormatHandle(image).c_str(), pos->subresource.arrayLayer,
1173 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1174 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001175 }
John Zulauf5e617452019-11-19 14:44:16 -07001176 }
John Zulauff660ad62019-03-23 07:16:05 -06001177 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001178 }
John Zulauff660ad62019-03-23 07:16:05 -06001179
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001180 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1181 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1182 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001183 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1184 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001185 skip |= LogPerformanceWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
1186 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
1187 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001188 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001189 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001190 if (image_state->shared_presentable) {
1191 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001192 skip |= LogError(device, layout_invalid_msg_code,
1193 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1194 string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001195 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001196 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001197 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001198 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001199 skip |= LogError(cb_node->commandBuffer, layout_invalid_msg_code,
1200 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1201 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1202 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001203 }
1204 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001205 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001206}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001207bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001208 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1209 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001210 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001211 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1212 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1213}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001214
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001215void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001216 FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinski2e495882019-03-06 16:11:56 -07001217 auto renderPass = GetRenderPassState(pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001218 if (!renderPass) return;
1219
Tobias Hectorbbb12282018-10-22 15:17:59 +01001220 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001221 if (framebuffer_state) {
1222 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07001223 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -06001224 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001225 VkImageLayout stencil_layout = kInvalidLayout;
1226 const auto *attachment_description_stencil_layout =
1227 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
1228 if (attachment_description_stencil_layout) {
1229 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1230 }
1231
1232 SetImageViewLayout(pCB, *view_state, pRenderPassInfo->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001233 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001234 }
1235 }
1236}
Dave Houltone19e20d2018-02-02 16:32:41 -07001237
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001238#ifdef VK_USE_PLATFORM_ANDROID_KHR
1239// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1240// This could also move into a seperate core_validation_android.cpp file... ?
1241
1242//
1243// AHB-specific validation within non-AHB APIs
1244//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001245bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001246 bool skip = false;
1247
1248 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1249 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001250 if (0 != ext_fmt_android->externalFormat) {
1251 if (VK_FORMAT_UNDEFINED != create_info->format) {
1252 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001253 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1254 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1255 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001256 }
1257
1258 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001259 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1260 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1261 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001262 }
1263
1264 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001265 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1266 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1267 "non-zero externalFormat, but usage includes bits other than VK_IMAGE_USAGE_SAMPLED_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001268 }
1269
1270 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001271 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1272 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1273 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001274 }
1275 }
1276
Mark Lobodzinski1ee06e92019-04-19 14:03:53 -06001277 if ((0 != ext_fmt_android->externalFormat) && (0 == ahb_ext_formats_set.count(ext_fmt_android->externalFormat))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001278 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
1279 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat which has "
1280 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001281 }
1282 }
1283
Dave Houltond9611312018-11-19 17:03:36 -07001284 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001285 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001286 skip |=
1287 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1288 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1289 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001290 }
1291 }
1292
1293 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1294 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1295 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001296 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001297 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1298 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1299 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1300 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001301 }
1302
1303 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001304 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1305 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1306 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1307 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1308 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001309 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001310 }
1311
1312 return skip;
1313}
1314
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001315bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001316 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001317 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001318
1319 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001320 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001321 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1322 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1323 "format member is %s.",
1324 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001325 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001326
Dave Houltond9611312018-11-19 17:03:36 -07001327 // Chain must include a compatible ycbcr conversion
1328 bool conv_found = false;
1329 uint64_t external_format = 0;
1330 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1331 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001332 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001333 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001334 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001335 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001336 }
Dave Houltond9611312018-11-19 17:03:36 -07001337 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001338 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001339 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
1340 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1341 "without a chained VkSamplerYcbcrConversionInfo struct with the same external format.");
Dave Houltond9611312018-11-19 17:03:36 -07001342 }
1343
1344 // Errors in create_info swizzles
1345 if ((create_info->components.r != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1346 (create_info->components.g != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1347 (create_info->components.b != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1348 (create_info->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001349 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1350 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1351 "includes one or more non-identity component swizzles.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001352 }
1353 }
Dave Houltond9611312018-11-19 17:03:36 -07001354
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001355 return skip;
1356}
1357
John Zulaufa26d3c82019-08-14 16:09:08 -06001358bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001359 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001360
John Zulaufa26d3c82019-08-14 16:09:08 -06001361 const IMAGE_STATE *image_state = GetImageState(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001362 if (image_state->imported_ahb && (0 == image_state->GetBoundMemory().size())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001363 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1364 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1365 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1366 "bound to memory.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001367 }
1368 return skip;
1369}
1370
1371#else
1372
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001373bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001374 return false;
1375}
1376
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001377bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001378
John Zulaufa26d3c82019-08-14 16:09:08 -06001379bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001380
1381#endif // VK_USE_PLATFORM_ANDROID_KHR
1382
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001383bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001384 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001385 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001386
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001387 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001388 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001389 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1390 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001391 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1392 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001393 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001394 }
1395
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001396 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1397 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001398 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1399 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1400 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001401 }
1402
1403 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001404 skip |= LogError(device, "VUID-VkImageCreateInfo-imageType-00954",
1405 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1406 "height (%d) and arrayLayers (%d) must be >= 6.",
1407 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001408 }
Dave Houlton130c0212018-01-29 13:39:56 -07001409 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001410
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001411 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001412 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1413 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1414 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001415 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
1416 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1417 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001418 }
1419
1420 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001421 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
1422 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1423 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001424 }
1425
ByumjinConffx991b6062019-08-14 15:17:53 -07001426 if (device_extensions.vk_ext_fragment_density_map) {
1427 uint32_t ceiling_width =
1428 (uint32_t)ceil((float)device_limits->maxFramebufferWidth /
1429 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, 1.0f));
1430 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1431 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001432 LogError(device, "VUID-VkImageCreateInfo-usage-02559",
1433 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1434 "ceiling of device "
1435 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1436 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1437 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001438 }
1439
1440 uint32_t ceiling_height =
1441 (uint32_t)ceil((float)device_limits->maxFramebufferHeight /
1442 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, 1.0f));
1443 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1444 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001445 LogError(device, "VUID-VkImageCreateInfo-usage-02560",
1446 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1447 "ceiling of device "
1448 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1449 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1450 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001451 }
1452 }
1453
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001454 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001455 VkResult result = VK_SUCCESS;
1456 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1457 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1458 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1459 &format_limits);
1460 } else {
1461 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>();
1462 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1463 image_format_info.type = pCreateInfo->imageType;
1464 image_format_info.tiling = pCreateInfo->tiling;
1465 image_format_info.usage = pCreateInfo->usage;
1466 image_format_info.flags = pCreateInfo->flags;
1467 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1468 format_limits = image_format_properties.imageFormatProperties;
1469 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001470
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001471 if (result == VK_ERROR_FORMAT_NOT_SUPPORTED) {
Lockee87f87c2019-04-23 17:53:10 -06001472#ifdef VK_USE_PLATFORM_ANDROID_KHR
1473 if (!lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext))
1474#endif // VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001475 skip |=
1476 LogError(device, kVUIDUndefined, "vkCreateImage(): Format %s is not supported for this combination of parameters.",
1477 string_VkFormat(pCreateInfo->format));
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001478 } else {
1479 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1480 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001481 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1482 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1483 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001484 }
Dave Houlton130c0212018-01-29 13:39:56 -07001485
Dave Houltona585d132019-01-18 13:05:42 -07001486 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1487 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1488 (uint64_t)pCreateInfo->samples;
1489 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * texel_count);
Dave Houlton130c0212018-01-29 13:39:56 -07001490
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001491 // Round up to imageGranularity boundary
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001492 VkDeviceSize imageGranularity = phys_dev_props.limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001493 uint64_t ig_mask = imageGranularity - 1;
1494 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001495
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001496 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001497 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
1498 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1499 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1500 total_size, format_limits.maxResourceSize);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001501 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001502
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001503 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001504 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
1505 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1506 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001507 }
1508
1509 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001510 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
1511 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
1512 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001513 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001514 }
1515
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001516 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsungcead0802020-01-30 22:20:10 -08001517 if (FormatRequiresYcbcrConversion(pCreateInfo->format)) {
1518 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
1519 const char *error_vuid = (device_extensions.vk_ext_ycbcr_image_arrays) ? "VUID-VkImageCreateInfo-format-02653"
1520 : "VUID-VkImageCreateInfo-format-02564";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001521 skip |= LogError(device, error_vuid,
1522 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
1523 "YCbCr Conversion format, arrayLayers must be 1",
1524 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001525 }
1526
1527 if (pCreateInfo->mipLevels != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001528 skip |= LogError(device, "VUID-VkImageCreateInfo-format-02561",
1529 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
1530 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001531 }
1532
1533 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001534 skip |= LogError(
1535 device, "VUID-VkImageCreateInfo-format-02562",
sfricke-samsungcead0802020-01-30 22:20:10 -08001536 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
1537 string_VkSampleCountFlagBits(pCreateInfo->samples));
1538 }
1539
1540 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001541 skip |= LogError(
1542 device, "VUID-VkImageCreateInfo-format-02563",
sfricke-samsungcead0802020-01-30 22:20:10 -08001543 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
1544 string_VkImageType(pCreateInfo->imageType));
1545 }
1546 }
1547
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06001548 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001549 skip |=
1550 LogError(device, "VUID-VkImageCreateInfo-flags-01924",
1551 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
1552 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06001553 }
1554
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001555 if (device_extensions.vk_khr_maintenance2) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06001556 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
1557 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
1558 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
1559 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001560 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001561 LogError(device, kVUIDUndefined,
1562 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1563 "format must be block, ETC or ASTC compressed, but is %s",
1564 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001565 }
1566 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
1567 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001568 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001569 LogError(device, kVUIDUndefined,
1570 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1571 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001572 }
1573 }
1574 }
1575
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001576 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001577 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateImage",
1578 "pCreateInfo->pQueueFamilyIndices", "VUID-VkImageCreateInfo-sharingMode-01420",
1579 "VUID-VkImageCreateInfo-sharingMode-01420", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001580 }
1581
unknown2c877272019-07-11 12:56:50 -06001582 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
1583 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
1584 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001585 LogError(device, "VUID-VkImageCreateInfo-format-01577",
1586 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
1587 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06001588 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001589 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001590}
1591
John Zulauf7eeb6f72019-06-17 11:56:36 -06001592void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1593 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
1594 if (VK_SUCCESS != result) return;
1595
1596 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
locke-lunarg20699892020-01-02 19:17:29 -07001597 auto image_state = Get<IMAGE_STATE>(*pImage);
1598 AddInitialLayoutintoImageLayoutMap(*image_state, imageLayoutMap);
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001599}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001600
Jeff Bolz5c801d12019-10-09 10:38:45 -05001601bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001602 const IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06001603 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001604 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001605 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001606 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001607 }
1608 return skip;
1609}
1610
John Zulauf7eeb6f72019-06-17 11:56:36 -06001611void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
1612 // Clean up validation specific data
1613 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001614
locke-lunargcba7d5f2019-12-30 16:59:11 -07001615 imageLayoutMap.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06001616
1617 // Clean up generic image state
1618 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001619}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001620
John Zulauf07288512019-07-05 11:09:50 -06001621bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001622 bool skip = false;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001623
1624 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
1625 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001626 skip |= LogError(image_state->image, kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001627 }
1628
Dave Houlton1d2022c2017-03-29 11:43:58 -06001629 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001630 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001631 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -06001632 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001633 char const str[] = "vkCmdClearColorImage called with compressed image.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001634 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001635 }
1636
1637 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
1638 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001639 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-image-00002", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001640 }
1641 return skip;
1642}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001643
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001644uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1645 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1646 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001647 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001648 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001649 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001650 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001651}
1652
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001653uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1654 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1655 uint32_t array_layer_count = range->layerCount;
1656 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1657 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001658 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001659 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001660}
1661
John Zulauf07288512019-07-05 11:09:50 -06001662bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1663 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
1664 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001665 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001666 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1667 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001668 skip |= LogError(image_state->image, "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
1669 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1670 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001671 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001672
1673 } else {
1674 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1675 if (!device_extensions.vk_khr_shared_presentable_image) {
1676 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001677 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-imageLayout-00005",
1678 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1679 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001680 }
1681 } else {
1682 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
1683 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001684 skip |= LogError(
1685 image_state->image, "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001686 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
1687 func_name, string_VkImageLayout(dest_image_layout));
1688 }
1689 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001690 }
1691
John Zulauff660ad62019-03-23 07:16:05 -06001692 // Cast to const to prevent creation at validate time.
John Zulauf07288512019-07-05 11:09:50 -06001693 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06001694 if (subresource_map) {
1695 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001696 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06001697 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
John Zulauf5e617452019-11-19 14:44:16 -07001698 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1699 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06001700 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
1701 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1702 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
1703 } else {
1704 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001705 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001706 subres_skip |= LogError(cb_node->commandBuffer, error_code,
1707 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
1708 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
1709 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001710 }
John Zulauf5e617452019-11-19 14:44:16 -07001711 }
John Zulauff660ad62019-03-23 07:16:05 -06001712 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001713 }
1714
1715 return skip;
1716}
1717
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001718bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1719 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001720 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001721 bool skip = false;
1722 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06001723 const auto *cb_node = GetCBState(commandBuffer);
1724 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001725 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001726 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001727 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001728 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001729 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski544def72019-04-19 14:25:59 -06001730 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001731 skip |=
1732 ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
1733 "VUID-vkCmdClearColorImage-image-01993", "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001734 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001735 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001736 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001737 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001738 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001739 skip |= ValidateImageAttributes(image_state, pRanges[i]);
1740 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001741 }
1742 }
1743 return skip;
1744}
1745
John Zulaufeabb4462019-07-05 14:13:03 -06001746void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1747 const VkClearColorValue *pColor, uint32_t rangeCount,
1748 const VkImageSubresourceRange *pRanges) {
1749 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
1750
1751 auto cb_node = GetCBState(commandBuffer);
1752 auto image_state = GetImageState(image);
1753 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001754 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001755 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001756 }
1757 }
1758}
1759
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001760bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1761 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001762 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001763 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001764
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001765 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06001766 const auto *cb_node = GetCBState(commandBuffer);
1767 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001768 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001769 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06001770 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001771 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001772 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001773 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski544def72019-04-19 14:25:59 -06001774 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001775 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
1776 "VUID-vkCmdClearDepthStencilImage-image-01994",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001777 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001778 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001779 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Andrew Fobel3abeb992020-01-20 16:33:22 -05001780
1781 bool any_include_aspect_depth_bit = false;
1782 bool any_include_aspect_stencil_bit = false;
1783
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001784 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001785 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001786 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001787 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001788 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001789 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1790 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001791 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001792 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1793 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001794 skip |= LogError(commandBuffer, kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001795 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05001796 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
1797 any_include_aspect_depth_bit = true;
1798 }
1799 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
1800 any_include_aspect_stencil_bit = true;
1801 }
1802 }
1803 if (any_include_aspect_stencil_bit) {
1804 const auto image_stencil_struct = lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
1805 if (image_stencil_struct != nullptr) {
1806 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
1807 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001808 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
1809 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
1810 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
1811 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05001812 }
1813 } else {
1814 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001815 skip |= LogError(
1816 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05001817 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
1818 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
1819 "in VkImageCreateInfo::usage used to create image");
1820 }
1821 }
1822 }
1823 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001824 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
1825 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
1826 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001827 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001828 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001829 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001830 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001831 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001832 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1833 char const str[] =
1834 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1835 "set.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001836 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001837 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001838 }
1839 return skip;
1840}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001841
John Zulaufeabb4462019-07-05 14:13:03 -06001842void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1843 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1844 const VkImageSubresourceRange *pRanges) {
1845 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
1846 auto cb_node = GetCBState(commandBuffer);
1847 auto image_state = GetImageState(image);
1848 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001849 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001850 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001851 }
1852 }
1853}
1854
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001855// Returns true if [x, xoffset] and [y, yoffset] overlap
1856static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1857 bool result = false;
1858 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1859 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1860
1861 if (intersection_max > intersection_min) {
1862 result = true;
1863 }
1864 return result;
1865}
1866
Dave Houltonc991cc92018-03-06 11:08:51 -07001867// Returns true if source area of first copy region intersects dest area of second region
1868// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1869static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001870 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001871
Dave Houltonc991cc92018-03-06 11:08:51 -07001872 // Separate planes within a multiplane image cannot intersect
1873 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07001874 return result;
1875 }
1876
Dave Houltonc991cc92018-03-06 11:08:51 -07001877 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
1878 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
1879 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001880 result = true;
1881 switch (type) {
1882 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001883 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001884 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001885 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001886 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001887 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001888 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001889 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001890 break;
1891 default:
1892 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1893 assert(false);
1894 }
1895 }
1896 return result;
1897}
1898
Dave Houltonfc1a4052017-04-27 14:32:45 -06001899// Returns non-zero if offset and extent exceed image extents
1900static const uint32_t x_bit = 1;
1901static const uint32_t y_bit = 2;
1902static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001903static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001904 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001905 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001906 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1907 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001908 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001909 }
1910 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1911 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001912 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001913 }
1914 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1915 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001916 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001917 }
1918 return result;
1919}
1920
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001921// Test if two VkExtent3D structs are equivalent
1922static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1923 bool result = true;
1924 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1925 (extent->depth != other_extent->depth)) {
1926 result = false;
1927 }
1928 return result;
1929}
1930
Dave Houltonee281a52017-12-08 13:51:02 -07001931// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1932// Destination image texel extents must be adjusted by block size for the dest validation checks
1933VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1934 VkExtent3D adjusted_extent = extent;
unknown948b6ba2019-09-19 17:32:54 -06001935 if ((FormatIsCompressed(src_format) || FormatIsSinglePlane_422(src_format)) &&
1936 !(FormatIsCompressed(dst_format) || FormatIsSinglePlane_422(dst_format))) {
Dave Houltona585d132019-01-18 13:05:42 -07001937 VkExtent3D block_size = FormatTexelBlockExtent(src_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001938 adjusted_extent.width /= block_size.width;
1939 adjusted_extent.height /= block_size.height;
1940 adjusted_extent.depth /= block_size.depth;
unknown948b6ba2019-09-19 17:32:54 -06001941 } else if (!(FormatIsCompressed(src_format) || FormatIsSinglePlane_422(src_format)) &&
1942 (FormatIsCompressed(dst_format) || FormatIsSinglePlane_422(dst_format))) {
Dave Houltona585d132019-01-18 13:05:42 -07001943 VkExtent3D block_size = FormatTexelBlockExtent(dst_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001944 adjusted_extent.width *= block_size.width;
1945 adjusted_extent.height *= block_size.height;
1946 adjusted_extent.depth *= block_size.depth;
1947 }
1948 return adjusted_extent;
1949}
1950
Dave Houlton6f9059e2017-05-02 17:15:13 -06001951// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001952static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1953 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001954
1955 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06001956 if (mip >= img->createInfo.mipLevels) {
1957 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06001958 }
Dave Houlton1150cf52017-04-27 14:38:11 -06001959
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001960 // Don't allow mip adjustment to create 0 dim, but pass along a 0 if that's what subresource specified
Dave Houltonfc1a4052017-04-27 14:32:45 -06001961 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05001962
Dave Houltone48cd112019-01-03 17:01:18 -07001963 // If multi-plane, adjust per-plane extent
1964 if (FormatIsMultiplane(img->createInfo.format)) {
1965 VkExtent2D divisors = FindMultiplaneExtentDivisors(img->createInfo.format, subresource->aspectMask);
1966 extent.width /= divisors.width;
1967 extent.height /= divisors.height;
1968 }
1969
Jeff Bolzef40fec2018-09-01 22:04:34 -05001970 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
1971 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
Dave Houlton142c4cb2018-10-17 15:04:41 -06001972 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1) >> mip)));
Jeff Bolzef40fec2018-09-01 22:04:34 -05001973 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
1974 } else {
1975 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1976 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1977 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
1978 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06001979
Dave Houlton6f9059e2017-05-02 17:15:13 -06001980 // Image arrays have an effective z extent that isn't diminished by mip level
1981 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001982 extent.depth = img->createInfo.arrayLayers;
1983 }
1984
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001985 return extent;
1986}
1987
1988// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001989static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001990 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1991}
1992
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001993// Test if the extent argument has any dimensions set to 0.
1994static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1995 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1996}
1997
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001998// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001999VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002000 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2001 VkExtent3D granularity = {0, 0, 0};
Jeff Bolz6835fda2019-10-06 00:15:34 -05002002 auto pPool = cb_node->command_pool.get();
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002003 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002004 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06002005 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002006 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002007 granularity.width *= block_size.width;
2008 granularity.height *= block_size.height;
2009 }
2010 }
2011 return granularity;
2012}
2013
2014// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2015static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2016 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002017 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2018 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002019 valid = false;
2020 }
2021 return valid;
2022}
2023
2024// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002025bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002026 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002027 bool skip = false;
2028 VkExtent3D offset_extent = {};
2029 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2030 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2031 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002032 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002033 // 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 -07002034 if (IsExtentAllZeroes(&offset_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002035 skip |= LogError(cb_node->commandBuffer, vuid,
2036 "%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 "
2037 "image transfer granularity is (w=0, h=0, d=0).",
2038 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002039 }
2040 } else {
2041 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2042 // integer multiples of the image transfer granularity.
2043 if (IsExtentAligned(&offset_extent, granularity) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002044 skip |= LogError(cb_node->commandBuffer, vuid,
2045 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2046 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2047 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2048 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002049 }
2050 }
2051 return skip;
2052}
2053
2054// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002055bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002056 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002057 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002058 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002059 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002060 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2061 // subresource extent.
2062 if (IsExtentEqual(extent, subresource_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002063 skip |= LogError(cb_node->commandBuffer, vuid,
2064 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2065 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2066 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2067 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002068 }
2069 } else {
2070 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2071 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2072 // subresource extent dimensions.
2073 VkExtent3D offset_extent_sum = {};
2074 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2075 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2076 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002077 bool x_ok = true;
2078 bool y_ok = true;
2079 bool z_ok = true;
2080 switch (image_type) {
2081 case VK_IMAGE_TYPE_3D:
2082 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2083 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002084 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002085 case VK_IMAGE_TYPE_2D:
2086 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2087 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002088 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002089 case VK_IMAGE_TYPE_1D:
2090 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2091 (subresource_extent->width == offset_extent_sum.width));
2092 break;
2093 default:
2094 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2095 assert(false);
2096 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002097 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002098 skip |=
2099 LogError(cb_node->commandBuffer, vuid,
2100 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2101 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2102 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2103 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2104 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2105 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002106 }
2107 }
2108 return skip;
2109}
2110
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002111bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002112 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002113 bool skip = false;
2114 if (mip_level >= img->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002115 skip |= LogError(cb_node->commandBuffer, vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2116 function, i, member, mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002117 }
2118 return skip;
2119}
2120
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002121bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002122 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002123 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002124 bool skip = false;
2125 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2126 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002127 skip |= LogError(cb_node->commandBuffer, vuid,
2128 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2129 "%u, but provided %s has %u array layers.",
2130 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2131 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002132 }
2133 return skip;
2134}
2135
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002136// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002137bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002138 const VkBufferImageCopy *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002139 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002140 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002141 VkExtent3D granularity = GetScaledItg(cb_node, img);
2142 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002143 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002144 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002145 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002146 return skip;
2147}
2148
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002149// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002150bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002151 const IMAGE_STATE *dst_img, const VkImageCopy *region,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002152 const uint32_t i, const char *function) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002153 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002154 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002155 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
2156 skip |=
2157 CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002158 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002159 const VkExtent3D extent = region->extent;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002160 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
2161 i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002162
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002163 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002164 granularity = GetScaledItg(cb_node, dst_img);
2165 skip |=
2166 CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002167 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002168 const VkExtent3D dest_effective_extent =
2169 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002170 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002171 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002172 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002173 return skip;
2174}
2175
Dave Houlton6f9059e2017-05-02 17:15:13 -06002176// Validate contents of a VkImageCopy struct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002177bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const VkImageCopy *ic_regions, const IMAGE_STATE *src_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002178 const IMAGE_STATE *dst_state) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002179 bool skip = false;
2180
2181 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002182 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002183
2184 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002185 const VkExtent3D src_copy_extent = region.extent;
2186 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002187 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2188
Dave Houlton6f9059e2017-05-02 17:15:13 -06002189 bool slice_override = false;
2190 uint32_t depth_slices = 0;
2191
2192 // Special case for copying between a 1D/2D array and a 3D image
2193 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2194 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002195 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002196 slice_override = (depth_slices != 1);
2197 } 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 -07002198 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002199 slice_override = (depth_slices != 1);
2200 }
2201
2202 // Do all checks on source image
2203 //
2204 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002205 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002206 skip |=
2207 LogError(src_state->image, "VUID-VkImageCopy-srcImage-00146",
2208 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2209 "be 0 and 1, respectively.",
2210 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002211 }
2212 }
2213
Dave Houlton533be9f2018-03-26 17:08:30 -06002214 // VUID-VkImageCopy-srcImage-01785
2215 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002216 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-01785",
2217 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
2218 "these must be 0 and 1, respectively.",
2219 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002220 }
2221
Dave Houlton533be9f2018-03-26 17:08:30 -06002222 // VUID-VkImageCopy-srcImage-01787
2223 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002224 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-01787",
2225 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2226 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002227 }
2228
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002229 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002230 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002231 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002232 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002233 LogError(src_state->image, "VUID-VkImageCopy-srcImage-00141",
2234 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2235 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2236 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002237 }
2238 }
2239 } else { // Pre maint 1
2240 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002241 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002242 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-00141",
2243 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2244 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2245 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2246 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002247 }
2248 }
2249 }
2250
Dave Houltonc991cc92018-03-06 11:08:51 -07002251 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002252 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002253 if (FormatIsCompressed(src_state->createInfo.format) ||
2254 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002255 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002256 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002257 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2258 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2259 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002260 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002261 skip |= LogError(src_state->image, vuid,
2262 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
2263 "texel width & height (%d, %d).",
2264 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002265 }
2266
Dave Houlton94a00372017-12-14 15:08:47 -07002267 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002268 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2269 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002270 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002271 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002272 LogError(src_state->image, vuid,
2273 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2274 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2275 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002276 }
2277
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002278 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002279 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2280 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002281 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002282 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002283 LogError(src_state->image, vuid,
2284 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2285 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2286 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002287 }
2288
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002289 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002290 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2291 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002292 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002293 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002294 LogError(src_state->image, vuid,
2295 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2296 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2297 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002298 }
2299 } // Compressed
2300
2301 // Do all checks on dest image
2302 //
2303 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002304 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002305 skip |= LogError(dst_state->image, "VUID-VkImageCopy-dstImage-00152",
2306 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
2307 "these must be 0 and 1, respectively.",
2308 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002309 }
2310 }
2311
Dave Houlton533be9f2018-03-26 17:08:30 -06002312 // VUID-VkImageCopy-dstImage-01786
2313 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002314 skip |=
2315 LogError(dst_state->image, "VUID-VkImageCopy-dstImage-01786",
2316 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2317 "and 1, respectively.",
2318 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002319 }
2320
2321 // VUID-VkImageCopy-dstImage-01788
2322 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002323 skip |= LogError(dst_state->image, "VUID-VkImageCopy-dstImage-01788",
2324 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2325 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002326 }
2327
2328 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002329 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002330 skip |= LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00141",
2331 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2332 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2333 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002334 }
2335 }
2336 // VU01199 changed with mnt1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002337 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002338 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002339 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002340 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002341 LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00141",
2342 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2343 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2344 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002345 }
2346 }
2347 } else { // Pre maint 1
2348 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002349 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002350 skip |= LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00141",
2351 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2352 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2353 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2354 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002355 }
2356 }
2357 }
2358
Dave Houltonc991cc92018-03-06 11:08:51 -07002359 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2360 if (FormatIsCompressed(dst_state->createInfo.format) ||
2361 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002362 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002363
2364 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002365 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2366 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2367 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002368 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002369 skip |= LogError(dst_state->image, vuid,
2370 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
2371 "texel width & height (%d, %d).",
2372 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002373 }
2374
Dave Houlton94a00372017-12-14 15:08:47 -07002375 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002376 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2377 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002378 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002379 skip |= LogError(
2380 dst_state->image, vuid,
2381 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2382 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2383 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002384 }
2385
Dave Houltonee281a52017-12-08 13:51:02 -07002386 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2387 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2388 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002389 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002390 skip |= LogError(dst_state->image, vuid,
2391 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2392 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2393 "height (%d).",
2394 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002395 }
2396
Dave Houltonee281a52017-12-08 13:51:02 -07002397 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2398 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2399 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002400 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002401 skip |= LogError(
2402 dst_state->image, vuid,
2403 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2404 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2405 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002406 }
2407 } // Compressed
2408 }
2409 return skip;
2410}
2411
Dave Houltonc991cc92018-03-06 11:08:51 -07002412// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002413bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002414 const IMAGE_STATE *dst_image_state, const VkImageCopy region) const {
Dave Houltonc991cc92018-03-06 11:08:51 -07002415 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002416
2417 // Neither image is multiplane
2418 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2419 // If neither image is multi-plane the aspectMask member of src and dst must match
2420 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2421 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002422 ss << "vkCmdCopyImage(): Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002423 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002424 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002425 }
2426 } else {
2427 // Source image multiplane checks
2428 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2429 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2430 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2431 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002432 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002433 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002434 }
2435 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2436 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2437 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002438 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002439 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002440 }
2441 // Single-plane to multi-plane
2442 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2443 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2444 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002445 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002446 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002447 }
2448
2449 // Dest image multiplane checks
2450 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2451 aspect = region.dstSubresource.aspectMask;
2452 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2453 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002454 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002455 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002456 }
2457 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2458 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2459 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002460 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002461 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002462 }
2463 // Multi-plane to single-plane
2464 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2465 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2466 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002467 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002468 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002469 }
2470 }
2471
2472 return skip;
2473}
2474
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002475bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2476 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002477 const VkImageCopy *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002478 const auto *cb_node = GetCBState(commandBuffer);
2479 const auto *src_image_state = GetImageState(srcImage);
2480 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002481 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002482
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002483 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002484
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002485 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2486
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002487 for (uint32_t i = 0; i < regionCount; i++) {
2488 const VkImageCopy region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002489
2490 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2491 VkExtent3D src_copy_extent = region.extent;
2492 VkExtent3D dst_copy_extent =
2493 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
2494
Dave Houlton6f9059e2017-05-02 17:15:13 -06002495 bool slice_override = false;
2496 uint32_t depth_slices = 0;
2497
2498 // Special case for copying between a 1D/2D array and a 3D image
2499 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2500 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2501 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002502 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002503 slice_override = (depth_slices != 1);
2504 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2505 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002506 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002507 slice_override = (depth_slices != 1);
2508 }
2509
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002510 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2511 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
2512 skip |= ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002513 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002514 skip |= ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002515 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002516 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002517 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2518 "VUID-vkCmdCopyImage-srcSubresource-01698");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002519 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002520 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2521 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002522
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002523 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002524 // No chance of mismatch if we're overriding depth slice count
2525 if (!slice_override) {
2526 // The number of depth slices in srcSubresource and dstSubresource must match
2527 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2528 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002529 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2530 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002531 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002532 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2533 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002534 if (src_slices != dst_slices) {
2535 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002536 ss << "vkCmdCopyImage(): number of depth slices in source and destination subresources for pRegions[" << i
Dave Houlton6f9059e2017-05-02 17:15:13 -06002537 << "] do not match";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002538 skip |= LogError(command_buffer, "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06002539 }
2540 }
2541 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002542 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002543 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002544 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002545 ss << "vkCmdCopyImage(): number of layers in source and destination subresources for pRegions[" << i
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002546 << "] do not match";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002547 skip |= LogError(command_buffer, "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002548 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002549 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002550
Dave Houltonc991cc92018-03-06 11:08:51 -07002551 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002552 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002553 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region);
Dave Houltonc991cc92018-03-06 11:08:51 -07002554 }
2555
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002556 if (!device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002557 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2558 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002559 char const str[] = "vkCmdCopyImage(): Src and dest aspectMasks for each region must match";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002560 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002561 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002562 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002563
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002564 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07002565 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002566 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002567 ss << "vkCmdCopyImage(): pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002568 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002569 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002570 }
2571
2572 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07002573 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002574 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002575 ss << "vkCmdCopyImage(): pRegion[" << i
2576 << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002577 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002578 }
2579
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002580 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
2581 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
2582 // The source region specified by a given element of regions must be a region that is contained within srcImage
Dave Houltonee281a52017-12-08 13:51:02 -07002583 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2584 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002585 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002586 ss << "vkCmdCopyImage(): Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002587 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
2588 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
2589 << " ] exceeds the source image dimensions";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002590 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-pRegions-00122", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002591 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002592
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002593 // The destination region specified by a given element of regions must be a region that is contained within dst_image
Dave Houltonee281a52017-12-08 13:51:02 -07002594 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2595 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002596 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002597 ss << "vkCmdCopyImage(): Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002598 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
2599 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
2600 << " ] exceeds the destination image dimensions";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002601 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-pRegions-00123", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002602 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002603 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002604
Dave Houltonfc1a4052017-04-27 14:32:45 -06002605 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002606 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2607 if (slice_override) src_copy_extent.depth = depth_slices;
2608 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002609 if (extent_check & x_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002610 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002611 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00144",
2612 "vkCmdCopyImage(): Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2613 "width [%1d].",
2614 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002615 }
2616
2617 if (extent_check & y_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002618 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002619 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00145",
2620 "vkCmdCopyImage(): Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2621 "height [%1d].",
2622 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002623 }
2624 if (extent_check & z_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002625 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002626 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00147",
2627 "vkCmdCopyImage(): Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2628 "depth [%1d].",
2629 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002630 }
2631
Dave Houltonee281a52017-12-08 13:51:02 -07002632 // Adjust dest extent if necessary
2633 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2634 if (slice_override) dst_copy_extent.depth = depth_slices;
2635
2636 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002637 if (extent_check & x_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002638 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00150",
2639 "vkCmdCopyImage(): Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2640 "width [%1d].",
2641 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002642 }
2643 if (extent_check & y_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002644 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00151",
2645 "vkCmdCopyImage(): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2646 "height [%1d].",
2647 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002648 }
2649 if (extent_check & z_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002650 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00153",
2651 "vkCmdCopyImage(): Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2652 "depth [%1d].",
2653 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002654 }
2655
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002656 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2657 // must not overlap in memory
2658 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002659 for (uint32_t j = 0; j < regionCount; j++) {
2660 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
Dave Houltonf5217612018-02-02 16:18:52 -07002661 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002662 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002663 ss << "vkCmdCopyImage(): pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002664 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002665 }
2666 }
2667 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08002668
2669 // Check depth for 2D as post Maintaince 1 requires both while prior only required one to be 2D
2670 if (device_extensions.vk_khr_maintenance1) {
2671 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
2672 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
2673 (src_copy_extent.depth != 1)) {
2674 skip |= LogError(
2675 command_buffer, "VUID-VkImageCopy-srcImage-01790",
2676 "vkCmdCopyImage(): pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1", i,
2677 src_copy_extent.depth);
2678 }
2679 } else {
2680 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
2681 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
2682 (src_copy_extent.depth != 1)) {
2683 skip |= LogError(
2684 command_buffer, "VUID-VkImageCopy-srcImage-01789",
2685 "vkCmdCopyImage(): pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1", i,
2686 src_copy_extent.depth);
2687 }
2688 }
2689
2690 // Check if 2D with 3D and depth not equal to 2D layerCount
2691 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
2692 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2693 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
2694 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01791",
2695 "vkCmdCopyImage(): pRegion[%u] srcImage is 2D, dstImage is 3D and extent.depth is %u and has to be "
2696 "srcSubresource.layerCount (%u)",
2697 i, src_copy_extent.depth, region.srcSubresource.layerCount);
2698 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2699 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
2700 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
2701 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01792",
2702 "vkCmdCopyImage(): pRegion[%u] srcImage is 3D, dstImage is 2D and extent.depth is %u and has to be "
2703 "dstSubresource.layerCount (%u)",
2704 i, src_copy_extent.depth, region.dstSubresource.layerCount);
2705 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002706 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002707
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002708 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2709 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2710 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002711 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002712 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2713 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002714 skip |= LogError(command_buffer, kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002715 }
2716 } else {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002717 if (!FormatSizesAreEqual(src_image_state->createInfo.format, dst_image_state->createInfo.format, regionCount, pRegions)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002718 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002719 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-srcImage-00135", "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002720 }
2721 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002722
Dave Houlton33c22b72017-02-28 13:16:02 -07002723 // Source and dest image sample counts must match
2724 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2725 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002726 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002727 }
2728
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002729 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2730 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002731 // Validate that SRC & DST images have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002732 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyImage-srcImage-00126",
2733 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2734 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyImage-dstImage-00131",
2735 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06002736 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002737 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
2738 "VUID-vkCmdCopyImage-srcImage-01995", "VUID-vkCmdCopyImage-srcImage-01995");
2739 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
2740 "VUID-vkCmdCopyImage-dstImage-01996", "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002741 }
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002742 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyImage()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002743 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002744 skip |= ValidateCmd(cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
2745 skip |= InsideRenderPass(cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002746 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002747 const char *invalid_src_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2748 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2749 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
2750 const char *invalid_dst_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2751 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2752 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002753 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002754 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002755 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2756 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002757 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002758 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2759 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002760 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
2761 "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002762 }
2763
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002764 return skip;
2765}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002766
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002767void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2768 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2769 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06002770 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
2771 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06002772 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002773 auto src_image_state = GetImageState(srcImage);
2774 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002775
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002776 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002777 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002778 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
2779 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002780 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002781}
2782
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002783// Returns true if sub_rect is entirely contained within rect
2784static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2785 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2786 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2787 return false;
2788 return true;
2789}
2790
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002791bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002792 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
2793 const VkRect2D &render_area, uint32_t rect_count,
2794 const VkClearRect *clear_rects) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07002795 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07002796 const IMAGE_VIEW_STATE *image_view_state = nullptr;
2797 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07002798 image_view_state = GetImageViewState(framebuffer->createInfo.pAttachments[fb_attachment]);
John Zulauff2582972019-02-09 14:53:30 -07002799 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002800
2801 for (uint32_t j = 0; j < rect_count; j++) {
2802 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002803 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00016",
2804 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2805 "the current render pass instance.",
2806 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07002807 }
2808
2809 if (image_view_state) {
2810 // The layers specified by a given element of pRects must be contained within every attachment that
2811 // pAttachments refers to
2812 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
2813 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
2814 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002815 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00017",
2816 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
2817 "of pAttachment[%d].",
2818 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07002819 }
2820 }
2821 }
2822 return skip;
2823}
2824
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002825bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2826 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002827 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002828 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06002829 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02002830 if (!cb_node) return skip;
2831
2832 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
2833 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
2834 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Petr Kraus2dffb382019-08-10 02:52:12 +02002835 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002836
2837 // Validate that attachment is in reference list of active subpass
2838 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002839 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07002840 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01002841 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002842 const auto *framebuffer = GetFramebufferState(cb_node->activeFramebuffer);
John Zulauf3a548ef2019-02-01 16:14:07 -07002843 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002844
John Zulauf3a548ef2019-02-01 16:14:07 -07002845 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2846 auto clear_desc = &pAttachments[attachment_index];
2847 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002848
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002849 if (0 == clear_desc->aspectMask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002850 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002851 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002852 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002853 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07002854 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
2855 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
2856 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2857 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002858 skip |= LogError(
2859 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
2860 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
2861 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
2862 attachment_index, clear_desc->colorAttachment,
2863 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
2864 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07002865
John Zulauff2582972019-02-09 14:53:30 -07002866 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
2867 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002868 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002869 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
2870 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
2871 " subpass %u. colorAttachmentCount=%u",
2872 attachment_index, clear_desc->colorAttachment,
2873 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
2874 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002875 }
John Zulauff2582972019-02-09 14:53:30 -07002876 fb_attachment = color_attachment;
2877
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002878 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2879 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2880 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002881 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002882 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002883 }
2884 } else { // Must be depth and/or stencil
2885 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2886 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002887 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002888 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-parameter", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002889 }
2890 if (!subpass_desc->pDepthStencilAttachment ||
2891 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002892 skip |= LogPerformanceWarning(
2893 commandBuffer, kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002894 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002895 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07002896 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002897 }
2898 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002899 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002900 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
2901 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06002902 }
2903 }
2904 }
2905 return skip;
2906}
2907
2908void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2909 const VkClearAttachment *pAttachments, uint32_t rectCount,
2910 const VkClearRect *pRects) {
2911 auto *cb_node = GetCBState(commandBuffer);
2912 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
2913 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
2914 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
2915 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
2916 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2917 const auto clear_desc = &pAttachments[attachment_index];
2918 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
2919 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
2920 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
2921 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2922 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
2923 subpass_desc->pDepthStencilAttachment) {
2924 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
2925 }
2926 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07002927 if (!clear_rect_copy) {
2928 // We need a copy of the clear rectangles that will persist until the last lambda executes
2929 // but we want to create it as lazily as possible
2930 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002931 }
John Zulauf441558b2019-08-12 11:47:39 -06002932 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
2933 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002934 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
John Zulauff1640d12019-08-13 15:39:58 -06002935 const CMD_BUFFER_STATE *prim_cb, VkFramebuffer fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07002936 assert(rectCount == clear_rect_copy->size());
John Zulauf441558b2019-08-12 11:47:39 -06002937 const FRAMEBUFFER_STATE *framebuffer = GetFramebufferState(fb);
John Zulauf3a548ef2019-02-01 16:14:07 -07002938 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
2939 bool skip = false;
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002940 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
2941 rectCount, clear_rect_copy->data());
John Zulauf3a548ef2019-02-01 16:14:07 -07002942 return skip;
2943 };
2944 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002945 }
2946 }
2947 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002948}
2949
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002950bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2951 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002952 const VkImageResolve *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002953 const auto *cb_node = GetCBState(commandBuffer);
2954 const auto *src_image_state = GetImageState(srcImage);
2955 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002956
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002957 bool skip = false;
2958 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002959 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-srcImage-00256");
2960 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-00258");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002961 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002962 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002963 skip |= ValidateCmd(cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
2964 skip |= InsideRenderPass(cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002965 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, "vkCmdResolveImage()",
2966 "VUID-vkCmdResolveImage-dstImage-02003", "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002967
Cort Stratton7df30962018-05-17 19:45:57 -07002968 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002969 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002970 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002971 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
2972 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
2973 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002974 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002975 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
2976 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002977 // For each region, the number of layers in the image subresource should not be zero
2978 // For each region, src and dest image aspect must be color only
2979 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002980 skip |=
2981 ValidateImageSubresourceLayers(cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()", "srcSubresource", i);
2982 skip |=
2983 ValidateImageSubresourceLayers(cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()", "dstSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002984 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002985 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
2986 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002987 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002988 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
2989 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002990 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i, "vkCmdResolveImage()",
2991 "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
2992 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i, "vkCmdResolveImage()",
2993 "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
2994 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002995 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2996 "VUID-vkCmdResolveImage-srcSubresource-01711");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002997 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002998 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2999 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07003000
3001 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003002 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003003 skip |= LogError(
3004 cb_node->commandBuffer, "VUID-VkImageResolve-layerCount-00267",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003005 "vkCmdResolveImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003006 }
Cort Stratton7df30962018-05-17 19:45:57 -07003007 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003008 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3009 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
3010 char const str[] =
Graeme Leese79b60cb2018-11-28 11:51:20 +00003011 "vkCmdResolveImage(): src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003012 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003013 }
3014 }
3015
3016 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
3017 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003018 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003019 }
3020 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
3021 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003022 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageType, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003023 }
3024 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
3025 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003026 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-srcImage-00257", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003027 }
3028 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
3029 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003030 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-dstImage-00259", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003031 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003032 } else {
3033 assert(0);
3034 }
3035 return skip;
3036}
3037
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003038bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3039 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003040 const VkImageBlit *pRegions, VkFilter filter) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003041 const auto *cb_node = GetCBState(commandBuffer);
3042 const auto *src_image_state = GetImageState(srcImage);
3043 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003044
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003045 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003046 if (cb_node) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003047 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
John Zulauf5c2750c2018-01-30 15:04:56 -07003048 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003049 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003050 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003051 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003052 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003053 "VUID-vkCmdBlitImage-dstImage-00234");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003054 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
3055 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
Dave Houltond8ed0212018-05-16 17:18:24 -06003056 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003057 ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdBlitImage-srcImage-00219",
3058 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06003059 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003060 ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdBlitImage-dstImage-00224",
3061 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003062 skip |=
3063 ValidateCmdQueueFlags(cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003064 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
3065 skip |= InsideRenderPass(cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003066 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003067 "VUID-vkCmdBlitImage-srcImage-01999", "VUID-vkCmdBlitImage-srcImage-01999");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003068 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003069 "VUID-vkCmdBlitImage-dstImage-02000", "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04003070
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003071 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003072
Dave Houlton33c2d252017-06-09 17:08:32 -06003073 VkFormat src_format = src_image_state->createInfo.format;
3074 VkFormat dst_format = dst_image_state->createInfo.format;
3075 VkImageType src_type = src_image_state->createInfo.imageType;
3076 VkImageType dst_type = dst_image_state->createInfo.imageType;
3077
Cort Stratton186b1a22018-05-01 20:18:06 -04003078 if (VK_FILTER_LINEAR == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003079 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003080 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001",
3081 "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04003082 } else if (VK_FILTER_CUBIC_IMG == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003083 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
3084 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02002",
3085 "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06003086 }
3087
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003088 if (FormatRequiresYcbcrConversion(src_format)) {
3089 skip |= LogError(device, "VUID-vkCmdBlitImage-srcImage-01561",
3090 "vkCmdBlitImage(): srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
3091 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
3092 string_VkFormat(src_format));
3093 }
3094
3095 if (FormatRequiresYcbcrConversion(dst_format)) {
3096 skip |= LogError(device, "VUID-vkCmdBlitImage-dstImage-01562",
3097 "vkCmdBlitImage(): dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
3098 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
3099 string_VkFormat(dst_format));
3100 }
3101
Dave Houlton33c2d252017-06-09 17:08:32 -06003102 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003103 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-filter-00237",
3104 "vkCmdBlitImage(): source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003105 }
3106
Dave Houlton33c2d252017-06-09 17:08:32 -06003107 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
3108 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003109 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00228",
3110 "vkCmdBlitImage(): source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003111 }
3112
3113 // Validate consistency for unsigned formats
3114 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3115 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003116 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003117 << "the other one must also have unsigned integer format. "
3118 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003119 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003120 }
3121
3122 // Validate consistency for signed formats
3123 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3124 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003125 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003126 << "the other one must also have signed integer format. "
3127 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003128 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003129 }
3130
3131 // Validate filter for Depth/Stencil formats
3132 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3133 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003134 ss << "vkCmdBlitImage(): If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003135 << "then filter must be VK_FILTER_NEAREST.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003136 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003137 }
3138
3139 // Validate aspect bits and formats for depth/stencil images
3140 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3141 if (src_format != dst_format) {
3142 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003143 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003144 << "stencil, the other one must have exactly the same format. "
3145 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3146 << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003147 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003148 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003149 } // Depth or Stencil
3150
3151 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003152 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003153 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003154 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3155 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3156 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003157 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003158 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3159 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003160 for (uint32_t i = 0; i < regionCount; i++) {
3161 const VkImageBlit rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003162 bool hit_error = false;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003163 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003164 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3165 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003166 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003167 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3168 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003169 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3170 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
3171 skip |= ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003172 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003173 skip |= ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003174 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003175 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003176 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3177 "VUID-vkCmdBlitImage-srcSubresource-01707");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003178 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003179 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3180 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003181 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003182 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3183 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003184 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003185 ss << "vkCmdBlitImage(): pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003186 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003187 }
Dave Houlton48989f32017-05-26 15:01:46 -06003188 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3189 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003190 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003191 ss << "vkCmdBlitImage(): pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003192 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003193 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003194
3195 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003196 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003197 skip |= LogError(
3198 cb_node->commandBuffer, "VUID-VkImageBlit-layerCount-00239",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003199 "vkCmdBlitImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003200 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003201
Dave Houlton48989f32017-05-26 15:01:46 -06003202 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003203 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00238",
3204 "vkCmdBlitImage(): aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003205 }
Dave Houlton48989f32017-05-26 15:01:46 -06003206
Dave Houlton33c2d252017-06-09 17:08:32 -06003207 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003208 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00241",
3209 "vkCmdBlitImage(): region [%d] source aspectMask (0x%x) specifies aspects not present in source "
3210 "image format %s.",
3211 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003212 }
3213
3214 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003215 skip |= LogError(
3216 cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00242",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003217 "vkCmdBlitImage(): region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3218 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003219 }
3220
Dave Houlton48989f32017-05-26 15:01:46 -06003221 // Validate source image offsets
3222 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003223 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003224 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003225 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003226 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00245",
3227 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3228 "of (%1d, %1d). These must be (0, 1).",
3229 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003230 }
3231 }
3232
Dave Houlton33c2d252017-06-09 17:08:32 -06003233 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003234 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003235 skip |=
3236 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00247",
3237 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3238 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3239 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003240 }
3241 }
3242
Dave Houlton33c2d252017-06-09 17:08:32 -06003243 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003244 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3245 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003246 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003247 skip |= LogError(
3248 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00243",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003249 "vkCmdBlitImage(): region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).", i,
3250 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003251 }
3252 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3253 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003254 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003255 skip |= LogError(
3256 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00244",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003257 "vkCmdBlitImage(): region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003258 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003259 }
3260 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3261 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003262 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003263 skip |= LogError(
3264 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00246",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003265 "vkCmdBlitImage(): region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).", i,
3266 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003267 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003268 if (oob) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003269 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-pRegions-00215",
3270 "vkCmdBlitImage(): region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003271 }
Dave Houlton48989f32017-05-26 15:01:46 -06003272
3273 // Validate dest image offsets
3274 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003275 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003276 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003277 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003278 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-dstImage-00250",
3279 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3280 "(%1d, %1d). These must be (0, 1).",
3281 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003282 }
3283 }
3284
Dave Houlton33c2d252017-06-09 17:08:32 -06003285 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003286 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003287 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-dstImage-00252",
3288 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3289 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3290 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003291 }
3292 }
3293
Dave Houlton33c2d252017-06-09 17:08:32 -06003294 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003295 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3296 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003297 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003298 skip |= LogError(
3299 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00248",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003300 "vkCmdBlitImage(): region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).", i,
3301 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003302 }
3303 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3304 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003305 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003306 skip |= LogError(
3307 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00249",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003308 "vkCmdBlitImage(): region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003309 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003310 }
3311 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3312 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003313 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003314 skip |= LogError(
3315 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00251",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003316 "vkCmdBlitImage(): region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).", i,
3317 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003318 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003319 if (oob) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003320 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-pRegions-00216",
3321 "vkCmdBlitImage(): region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003322 }
3323
Dave Houlton33c2d252017-06-09 17:08:32 -06003324 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3325 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3326 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003327 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003328 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00240",
3329 "vkCmdBlitImage(): region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3330 "layerCount other than 1.",
3331 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003332 }
3333 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003334 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003335 } else {
3336 assert(0);
3337 }
3338 return skip;
3339}
3340
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003341void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3342 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3343 const VkImageBlit *pRegions, VkFilter filter) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003344 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3345 pRegions, filter);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003346 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003347 auto src_image_state = GetImageState(srcImage);
3348 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003349
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003350 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003351 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003352 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3353 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003354 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003355}
3356
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003357// This validates that the initial layout specified in the command buffer for the IMAGE is the same as the global IMAGE layout
locke-lunargcba7d5f2019-12-30 16:59:11 -07003358bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const ImageLayoutMap &globalImageLayoutMap,
3359 ImageLayoutMap *overlayLayoutMap_arg) const {
Matthew Ruschd7ef5482019-07-16 22:01:54 -07003360 if (disabled.image_layout_validation) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003361 bool skip = false;
locke-lunargcba7d5f2019-12-30 16:59:11 -07003362 ImageLayoutMap &overlayLayoutMap = *overlayLayoutMap_arg;
John Zulauff660ad62019-03-23 07:16:05 -06003363 // Iterate over the layout maps for each referenced image
3364 for (const auto &layout_map_entry : pCB->image_layout_map) {
3365 const auto image = layout_map_entry.first;
3366 const auto *image_state = GetImageState(image);
3367 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06003368 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06003369 // Validate the initial_uses for each subresource referenced
John Zulauf6066f732019-11-21 13:15:10 -07003370 for (const auto &pos : subres_map->InitialLayoutView()) {
John Zulauf6066f732019-11-21 13:15:10 -07003371 VkImageLayout initial_layout = pos.it->second; // Point directly into the RangeMap iterated but the view
John Zulauff660ad62019-03-23 07:16:05 -06003372 VkImageLayout image_layout;
locke-lunarga344e7c2020-01-02 19:48:53 -07003373 if (FindLayout(overlayLayoutMap, image, pos.subresource, image_layout) ||
3374 FindLayout(globalImageLayoutMap, image, pos.subresource, image_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06003375 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
3376 // TODO: Set memory invalid which is in mem_tracker currently
3377 } else if (image_layout != initial_layout) {
John Zulaufb61ed972019-04-09 16:12:35 -06003378 // Need to look up the inital layout *state* to get a bit more information
locke-lunarga344e7c2020-01-02 19:48:53 -07003379 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(pos.subresource);
John Zulaufb61ed972019-04-09 16:12:35 -06003380 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
3381 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
3382 if (!matches) {
3383 std::string formatted_label = FormatDebugLabel(" ", pCB->debug_label);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003384 skip |= LogError(
3385 pCB->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06003386 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
locke-lunargadbb54c2019-06-26 00:05:17 -06003387 "to be in layout %s--instead, current layout is %s.%s",
locke-lunarga344e7c2020-01-02 19:48:53 -07003388 report_data->FormatHandle(image).c_str(), pos.subresource.aspectMask, pos.subresource.arrayLayer,
3389 pos.subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout),
3390 formatted_label.c_str());
John Zulaufb61ed972019-04-09 16:12:35 -06003391 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003392 }
3393 }
John Zulauff660ad62019-03-23 07:16:05 -06003394 }
3395
3396 // Update all layout set operations (which will be a subset of the initial_layouts
locke-lunargcba7d5f2019-12-30 16:59:11 -07003397 UpdateImageLayoutMap(*subres_map.get(), overlayLayoutMap);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003398 }
John Zulauff660ad62019-03-23 07:16:05 -06003399
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003400 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003401}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003402
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003403void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06003404 for (const auto &layout_map_entry : pCB->image_layout_map) {
3405 const auto image = layout_map_entry.first;
3406 const auto *image_state = GetImageState(image);
3407 if (!image_state) continue; // Can't set layouts of a dead image
locke-lunargcba7d5f2019-12-30 16:59:11 -07003408 UpdateImageLayoutMap(*layout_map_entry.second.get(), imageLayoutMap);
Tony Barbourdf013b92017-01-25 12:53:48 -07003409 }
3410}
3411
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003412// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003413// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3414// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003415bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3416 const VkImageLayout first_layout, const uint32_t attachment,
John Zulauf9d2b6382019-07-25 15:21:36 -06003417 const VkAttachmentDescription2KHR &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003418 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003419 const char *vuid;
3420 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3421
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003422 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
3423 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003424 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3425 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3426 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003427 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
3428 "Cannot clear attachment %d with invalid first layout %s.", attachment,
3429 string_VkImageLayout(first_layout));
Shannon McPherson3ea65132018-12-05 10:37:39 -07003430 } else if (!use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3431 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003432 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
3433 "Cannot clear attachment %d with invalid first layout %s.", attachment,
3434 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003435 }
3436 }
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003437 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3438 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003439 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01566";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003440 skip |= LogError(device, vuid, "Cannot clear attachment %d with invalid first layout %s.", attachment,
3441 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003442 }
3443 }
3444
3445 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3446 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003447 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01567";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003448 skip |= LogError(device, vuid, "Cannot clear attachment %d with invalid first layout %s.", attachment,
3449 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003450 }
3451 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003452 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003453}
3454
Mark Lobodzinskiac02c612020-01-17 14:52:35 -07003455bool CoreChecks::ValidateLayouts(RenderPassCreateVersion rp_version, VkDevice device, const VkRenderPassCreateInfo2KHR *pCreateInfo,
3456 const char *function_name) const {
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003457 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003458 const char *vuid;
3459 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003460
Jason Ekstranda1906302017-12-03 20:16:32 -08003461 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3462 VkFormat format = pCreateInfo->pAttachments[i].format;
3463 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3464 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3465 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003466 skip |= LogWarning(device, kVUID_Core_DrawState_InvalidRenderpass,
3467 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
3468 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3469 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3470 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003471 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003472 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003473 skip |=
3474 LogWarning(device, kVUID_Core_DrawState_InvalidRenderpass,
3475 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3476 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3477 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3478 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003479 }
3480 }
3481 }
3482
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003483 // Track when we're observing the first use of an attachment
3484 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3485 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003486 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003487
3488 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3489 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3490 auto attach_index = subpass.pInputAttachments[j].attachment;
3491 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003492 switch (subpass.pInputAttachments[j].layout) {
3493 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3494 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3495 // These are ideal.
3496 break;
3497
3498 case VK_IMAGE_LAYOUT_GENERAL:
3499 // May not be optimal. TODO: reconsider this warning based on other constraints.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003500 skip |= LogPerformanceWarning(device, kVUID_Core_DrawState_InvalidImageLayout,
3501 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
Cort Stratton7547f772017-05-04 15:18:52 -07003502 break;
3503
Tobias Hectorbbb12282018-10-22 15:17:59 +01003504 case VK_IMAGE_LAYOUT_UNDEFINED:
3505 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003506 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003507 skip |= LogError(device, vuid,
3508 "Layout for input attachment reference %u in subpass %u is %s but must be "
3509 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
3510 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003511 break;
3512
Piers Daniell9af77cd2019-10-16 13:54:12 -06003513 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3514 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3515 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3516 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003517 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003518 skip |= LogError(
3519 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003520 "Layout for input attachment reference %u in subpass %u is %s but must not be "
3521 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3522 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3523 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
3524 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003525 skip |= LogError(
3526 device, "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003527 "Layout for input attachment reference %u in subpass %u is %s but must not be "
3528 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3529 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3530 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
3531 } else if ((subpass.pInputAttachments[j].aspectMask &
3532 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3533 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3534 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3535 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3536 const auto *attachment_reference_stencil_layout =
3537 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pInputAttachments[j].pNext);
3538 if (attachment_reference_stencil_layout) {
3539 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3540 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3541 attachment_reference_stencil_layout->stencilLayout ==
3542 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3543 attachment_reference_stencil_layout->stencilLayout ==
3544 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3545 attachment_reference_stencil_layout->stencilLayout ==
3546 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3547 attachment_reference_stencil_layout->stencilLayout ==
3548 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3549 attachment_reference_stencil_layout->stencilLayout ==
3550 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3551 attachment_reference_stencil_layout->stencilLayout ==
3552 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3553 attachment_reference_stencil_layout->stencilLayout ==
3554 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3555 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003556 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
3557 "In the attachment reference %u in subpass %u with pNext chain instance "
3558 "VkAttachmentReferenceStencilLayoutKHR"
3559 "the stencilLayout member but must not be "
3560 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3561 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3562 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3563 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3564 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3565 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3566 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3567 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3568 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3569 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003570 }
3571 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003572 skip |= LogError(
3573 device, "VUID-VkAttachmentReference2-attachment-03315",
3574 "When the layout for input attachment reference %u in subpass %u is "
3575 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3576 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3577 "VkAttachmentReferenceStencilLayout instance.",
3578 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003579 }
3580 }
3581 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3582 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3583 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003584 skip |= LogError(
3585 device, "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003586 "When the aspectMask for input attachment reference %u in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3587 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3588 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3589 j, i);
3590 }
3591 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3592 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3593 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003594 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
3595 "When the aspectMask for input attachment reference %u in subpass %u is "
3596 "VK_IMAGE_ASPECT_STENCIL_BIT "
3597 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3598 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
3599 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003600 }
3601 }
3602 break;
3603
Graeme Leese668a9862018-10-08 10:40:02 +01003604 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3605 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003606 if (device_extensions.vk_khr_maintenance2) {
Graeme Leese668a9862018-10-08 10:40:02 +01003607 break;
3608 } else {
3609 // Intentionally fall through to generic error message
3610 }
3611 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003612
Cort Stratton7547f772017-05-04 15:18:52 -07003613 default:
3614 // No other layouts are acceptable
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003615 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
3616 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3617 string_VkImageLayout(subpass.pInputAttachments[j].layout));
Cort Stratton7547f772017-05-04 15:18:52 -07003618 }
3619
Cort Stratton7547f772017-05-04 15:18:52 -07003620 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003621 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3622 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003623
3624 bool used_as_depth =
3625 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3626 bool used_as_color = false;
3627 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3628 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3629 }
3630 if (!used_as_depth && !used_as_color &&
3631 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08003632 vuid = use_rp2 ? "VUID-VkSubpassDescription2-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003633 skip |= LogError(device, vuid,
3634 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
3635 function_name, attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07003636 }
3637 }
3638 attach_first_use[attach_index] = false;
3639 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003640
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003641 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3642 auto attach_index = subpass.pColorAttachments[j].attachment;
3643 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3644
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003645 // TODO: Need a way to validate shared presentable images here, currently just allowing
3646 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3647 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003648 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003649 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003650 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003651 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3652 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003653 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003654
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003655 case VK_IMAGE_LAYOUT_GENERAL:
3656 // May not be optimal; TODO: reconsider this warning based on other constraints?
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003657 skip |= LogPerformanceWarning(device, kVUID_Core_DrawState_InvalidImageLayout,
3658 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003659 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003660
Tobias Hectorbbb12282018-10-22 15:17:59 +01003661 case VK_IMAGE_LAYOUT_UNDEFINED:
3662 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003663 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003664 skip |= LogError(device, vuid,
3665 "Layout for color attachment reference %u in subpass %u is %s but should be "
3666 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3667 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003668 break;
3669
Piers Daniell9af77cd2019-10-16 13:54:12 -06003670 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3671 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3672 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3673 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003674 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003675 skip |= LogError(
3676 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003677 "Layout for color attachment reference %u in subpass %u is %s but must not be "
3678 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3679 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3680 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3681 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003682 skip |= LogError(
3683 device, "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003684 "Layout for color attachment reference %u in subpass %u is %s but must not be "
3685 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3686 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3687 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3688 } else if ((subpass.pColorAttachments[j].aspectMask &
3689 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3690 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3691 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3692 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3693 const auto *attachment_reference_stencil_layout =
3694 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pColorAttachments[j].pNext);
3695 if (attachment_reference_stencil_layout) {
3696 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3697 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3698 attachment_reference_stencil_layout->stencilLayout ==
3699 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3700 attachment_reference_stencil_layout->stencilLayout ==
3701 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3702 attachment_reference_stencil_layout->stencilLayout ==
3703 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3704 attachment_reference_stencil_layout->stencilLayout ==
3705 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3706 attachment_reference_stencil_layout->stencilLayout ==
3707 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3708 attachment_reference_stencil_layout->stencilLayout ==
3709 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3710 attachment_reference_stencil_layout->stencilLayout ==
3711 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3712 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003713 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
3714 "In the attachment reference %u in subpass %u with pNext chain instance "
3715 "VkAttachmentReferenceStencilLayoutKHR"
3716 "the stencilLayout member but must not be "
3717 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3718 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3719 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3720 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3721 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3722 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3723 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3724 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3725 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3726 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003727 }
3728 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003729 skip |= LogError(
3730 device, "VUID-VkAttachmentReference2-attachment-03315",
3731 "When the layout for color attachment reference %u in subpass %u is "
3732 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3733 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3734 "VkAttachmentReferenceStencilLayout instance.",
3735 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003736 }
3737 }
3738 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3739 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3740 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003741 skip |= LogError(
3742 device, "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003743 "When the aspectMask for color attachment reference %u in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3744 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3745 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3746 j, i);
3747 }
3748 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3749 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3750 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003751 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
3752 "When the aspectMask for color attachment reference %u in subpass %u is "
3753 "VK_IMAGE_ASPECT_STENCIL_BIT "
3754 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3755 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
3756 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003757 }
3758 }
3759 break;
3760
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003761 default:
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003762 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
3763 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3764 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003765 }
3766
John Zulauf4eee2692019-02-09 16:14:25 -07003767 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].attachment != VK_ATTACHMENT_UNUSED) &&
3768 (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
3769 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08003770 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003771 skip |= LogError(device, vuid,
3772 "Layout for resolve attachment reference %u in subpass %u is %s but should be "
3773 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3774 j, i, string_VkImageLayout(subpass.pResolveAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003775 }
3776
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003777 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003778 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
3779 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003780 }
3781 attach_first_use[attach_index] = false;
3782 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003783
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003784 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3785 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003786 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3787 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3788 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003789 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003790
Dave Houltona9df0ce2018-02-07 10:51:23 -07003791 case VK_IMAGE_LAYOUT_GENERAL:
3792 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3793 // doing a bunch of transitions.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003794 skip |= LogPerformanceWarning(device, kVUID_Core_DrawState_InvalidImageLayout,
3795 "GENERAL layout for depth attachment may not give optimal performance.");
Dave Houltona9df0ce2018-02-07 10:51:23 -07003796 break;
3797
Tobias Hectorbbb12282018-10-22 15:17:59 +01003798 case VK_IMAGE_LAYOUT_UNDEFINED:
3799 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003800 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003801 skip |= LogError(device, vuid,
3802 "Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
3803 "layout or GENERAL.",
3804 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003805 break;
3806
Piers Daniell9af77cd2019-10-16 13:54:12 -06003807 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3808 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3809 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3810 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003811 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003812 skip |= LogError(
3813 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003814 "Layout for depth attachment reference in subpass %u is %s but must not be "
3815 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3816 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3817 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3818 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003819 skip |= LogError(
3820 device, "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003821 "Layout for depth attachment reference in subpass %u is %s but must not be "
3822 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3823 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3824 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3825 } else if ((subpass.pDepthStencilAttachment->aspectMask &
3826 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3827 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3828 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3829 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3830 const auto *attachment_reference_stencil_layout =
3831 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pDepthStencilAttachment->pNext);
3832 if (attachment_reference_stencil_layout) {
3833 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3834 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3835 attachment_reference_stencil_layout->stencilLayout ==
3836 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3837 attachment_reference_stencil_layout->stencilLayout ==
3838 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3839 attachment_reference_stencil_layout->stencilLayout ==
3840 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3841 attachment_reference_stencil_layout->stencilLayout ==
3842 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3843 attachment_reference_stencil_layout->stencilLayout ==
3844 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3845 attachment_reference_stencil_layout->stencilLayout ==
3846 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3847 attachment_reference_stencil_layout->stencilLayout ==
3848 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3849 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003850 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
3851 "In the attachment reference in subpass %u with pNext chain instance "
3852 "VkAttachmentReferenceStencilLayoutKHR"
3853 "the stencilLayout member but must not be "
3854 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3855 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3856 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3857 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3858 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3859 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3860 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3861 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3862 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3863 i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003864 }
3865 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003866 skip |= LogError(
3867 device, "VUID-VkAttachmentReference2-attachment-03315",
3868 "When the layout for depth attachment reference in subpass %u is "
3869 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3870 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3871 "VkAttachmentReferenceStencilLayout instance.",
3872 i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003873 }
3874 }
3875 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3876 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3877 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003878 skip |= LogError(
3879 device, "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003880 "When the aspectMask for depth attachment reference in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3881 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3882 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3883 i);
3884 }
3885 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3886 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3887 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003888 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
3889 "When the aspectMask for depth attachment reference in subpass %u is "
3890 "VK_IMAGE_ASPECT_STENCIL_BIT "
3891 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3892 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
3893 i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003894 }
3895 }
3896 break;
3897
Dave Houltona9df0ce2018-02-07 10:51:23 -07003898 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3899 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003900 if (device_extensions.vk_khr_maintenance2) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003901 break;
3902 } else {
3903 // Intentionally fall through to generic error message
3904 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06003905 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003906
Dave Houltona9df0ce2018-02-07 10:51:23 -07003907 default:
3908 // No other layouts are acceptable
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003909 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
3910 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3911 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
3912 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003913 }
3914
3915 auto attach_index = subpass.pDepthStencilAttachment->attachment;
3916 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003917 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
3918 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003919 }
3920 attach_first_use[attach_index] = false;
3921 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003922 }
3923 return skip;
3924}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003925
Mark Lobodzinski96210742017-02-09 10:33:46 -07003926// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
3927// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003928template <typename T1>
3929bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
3930 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
3931 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003932 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003933 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06003934 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003935 if (strict) {
3936 correct_usage = ((actual & desired) == desired);
3937 } else {
3938 correct_usage = ((actual & desired) != 0);
3939 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003940
Mark Lobodzinski96210742017-02-09 10:33:46 -07003941 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06003942 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06003943 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003944 skip = LogError(object, kVUID_Core_MemTrack_InvalidUsageFlag,
3945 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
3946 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003947 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003948 skip = LogError(object, msgCode,
3949 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
3950 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003951 }
3952 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003953 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003954}
3955
3956// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3957// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003958bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003959 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003960 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image,
John Zulauf4fea6622019-04-01 11:38:18 -06003961 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003962}
3963
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003964bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
John Zulauf07288512019-07-05 11:09:50 -06003965 char const *func_name, const char *linear_vuid, const char *optimal_vuid) const {
Mark Lobodzinski5c048802019-03-07 10:47:31 -07003966 VkFormatProperties format_properties = GetPDFormatProperties(image_state->createInfo.format);
Cort Stratton186b1a22018-05-01 20:18:06 -04003967 bool skip = false;
3968 if (image_state->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
3969 if ((format_properties.linearTilingFeatures & desired) != desired) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003970 skip |=
3971 LogError(image_state->image, linear_vuid, "In %s, invalid linearTilingFeatures (0x%08X) for format %u used by %s.",
3972 func_name, format_properties.linearTilingFeatures, image_state->createInfo.format,
3973 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04003974 }
3975 } else if (image_state->createInfo.tiling == VK_IMAGE_TILING_OPTIMAL) {
3976 if ((format_properties.optimalTilingFeatures & desired) != desired) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003977 skip |= LogError(image_state->image, optimal_vuid,
3978 "In %s, invalid optimalTilingFeatures (0x%08X) for format %u used by %s.", func_name,
3979 format_properties.optimalTilingFeatures, image_state->createInfo.format,
3980 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04003981 }
3982 }
3983 return skip;
3984}
3985
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003986bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003987 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07003988 bool skip = false;
Cort Strattond619a302018-05-17 19:46:32 -07003989 // layerCount must not be zero
3990 if (subresource_layers->layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003991 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-layerCount-01700",
3992 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07003993 }
3994 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
3995 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003996 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00168",
3997 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07003998 }
3999 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
4000 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
4001 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004002 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00167",
4003 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4004 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4005 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004006 }
4007 return skip;
4008}
4009
Mark Lobodzinski96210742017-02-09 10:33:46 -07004010// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4011// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004012bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004013 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004014 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer,
John Zulauf4fea6622019-04-01 11:38:18 -06004015 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004016}
4017
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004018bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004019 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004020 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004021
4022 const VkDeviceSize &range = pCreateInfo->range;
4023 if (range != VK_WHOLE_SIZE) {
4024 // Range must be greater than 0
4025 if (range <= 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004026 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00928",
4027 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4028 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4029 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004030 }
4031 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004032 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4033 if (SafeModulo(range, format_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004034 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00929",
4035 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4036 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4037 "(%" PRIu32 ").",
4038 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004039 }
4040 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004041 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004042 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00930",
4043 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4044 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4045 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4046 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004047 }
4048 // The sum of range and offset must be less than or equal to the size of buffer
4049 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004050 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00931",
4051 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4052 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4053 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4054 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004055 }
4056 }
4057 return skip;
4058}
4059
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004060bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004061 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004062 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004063 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4064 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004065 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00933",
4066 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
4067 "be supported for uniform texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004068 }
4069 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4070 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004071 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00934",
4072 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
4073 "be supported for storage texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004074 }
4075 return skip;
4076}
4077
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004078bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004079 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004080 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004081
Dave Houltond8ed0212018-05-16 17:18:24 -06004082 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004083
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004084 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!enabled_features.core.sparseBinding)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004085 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-00915",
4086 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
4087 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004088 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06004089
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004090 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!enabled_features.core.sparseResidencyBuffer)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004091 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-00916",
4092 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
4093 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06004094 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06004095
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004096 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004097 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-00917",
4098 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
4099 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06004100 }
Jeff Bolz87697532019-01-11 22:54:00 -06004101
4102 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
4103 if (chained_devaddr_struct) {
4104 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
4105 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004106 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4107 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
4108 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004109 }
4110 }
4111
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004112 auto chained_opaqueaddr_struct = lvl_find_in_chain<VkBufferOpaqueCaptureAddressCreateInfoKHR>(pCreateInfo->pNext);
4113 if (chained_opaqueaddr_struct) {
4114 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
4115 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004116 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
4117 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfoKHR::opaqueCaptureAddress"
4118 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004119 }
4120 }
4121
Shannon McPherson4984e642019-12-05 13:04:34 -07004122 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
Piers Daniell41b8c5d2020-01-10 15:42:00 -07004123 !enabled_features.core12.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004124 skip |= LogError(
4125 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004126 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
4127 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
4128 }
4129
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004130 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004131 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateBuffer",
4132 "pCreateInfo->pQueueFamilyIndices", "VUID-VkBufferCreateInfo-sharingMode-01419",
4133 "VUID-VkBufferCreateInfo-sharingMode-01419", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004134 }
4135
Mark Lobodzinski96210742017-02-09 10:33:46 -07004136 return skip;
4137}
4138
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004139bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004140 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004141 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004142 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004143 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4144 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004145 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004146 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4147 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004148 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004149 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4150 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4151 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004152
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004153 // Buffer view offset must be less than the size of buffer
4154 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004155 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00925",
4156 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4157 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4158 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004159 }
4160
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004161 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004162 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4163 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4164 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004165 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-02749",
4166 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4167 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4168 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004169 }
4170
4171 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
4172 VkDeviceSize elementSize = FormatElementSize(pCreateInfo->format);
4173 if ((elementSize % 3) == 0) {
4174 elementSize /= 3;
4175 }
4176 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
4177 VkDeviceSize alignmentRequirement =
4178 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4179 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
4180 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4181 }
4182 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004183 skip |= LogError(
4184 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02750",
Jeff Bolzd5554e62019-07-19 13:23:52 -05004185 "If buffer was created with usage containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
4186 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4187 ") must be a multiple of the lesser of "
4188 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4189 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4190 "(%" PRId32
4191 ") is VK_TRUE, the size of a texel of the requested format. "
4192 "If the size of a texel is a multiple of three bytes, then the size of a "
4193 "single component of format is used instead",
4194 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4195 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4196 }
4197 }
4198 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
4199 VkDeviceSize alignmentRequirement =
4200 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4201 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
4202 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4203 }
4204 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004205 skip |= LogError(
4206 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02751",
Jeff Bolzd5554e62019-07-19 13:23:52 -05004207 "If buffer was created with usage containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
4208 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4209 ") must be a multiple of the lesser of "
4210 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4211 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4212 "(%" PRId32
4213 ") is VK_TRUE, the size of a texel of the requested format. "
4214 "If the size of a texel is a multiple of three bytes, then the size of a "
4215 "single component of format is used instead",
4216 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4217 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4218 }
4219 }
4220 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004221
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004222 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004223
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004224 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004225 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004226 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004227}
4228
Mark Lobodzinski602de982017-02-09 11:01:33 -07004229// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004230bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004231 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004232 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004233
Dave Houlton1d2022c2017-03-29 11:43:58 -06004234 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004235 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004236 skip |= LogError(image, vuid, "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004237 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004238 skip |= LogError(image, vuid, "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004239 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004240 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004241 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004242 skip |= LogError(image, vuid,
4243 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
4244 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4245 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004246 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004247 skip |= LogError(image, vuid,
4248 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
4249 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4250 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004251 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004252 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004253 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004254 skip |= LogError(image, vuid, "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004255 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004256 skip |=
4257 LogError(image, vuid, "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004258 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004259 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004260 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004261 skip |=
4262 LogError(image, vuid, "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004263 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004264 skip |= LogError(image, vuid, "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.",
4265 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004266 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004267 } else if (FormatIsMultiplane(format)) {
4268 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4269 if (3 == FormatPlaneCount(format)) {
4270 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4271 }
4272 if ((aspect_mask & valid_flags) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004273 skip |=
4274 LogError(image, vuid,
4275 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4276 "set, where n = [0, 1, 2].",
4277 func_name);
Dave Houlton501b15b2018-03-30 15:07:41 -06004278 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004279 }
4280 return skip;
4281}
4282
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004283bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4284 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004285 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
4286 SubresourceRangeErrorCodes errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004287 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004288
4289 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004290 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004291 skip |= LogError(image, errorCodes.base_mip_err,
4292 "%s: %s.baseMipLevel (= %" PRIu32
4293 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4294 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004295 }
Petr Kraus4d718682017-05-18 03:38:41 +02004296
Petr Krausffa94af2017-08-08 21:46:02 +02004297 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4298 if (subresourceRange.levelCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004299 skip |= LogError(image, errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004300 } else {
4301 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004302
Petr Krausffa94af2017-08-08 21:46:02 +02004303 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004304 skip |= LogError(image, errorCodes.mip_count_err,
4305 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4306 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
4307 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
4308 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004309 }
Petr Kraus4d718682017-05-18 03:38:41 +02004310 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004311 }
Petr Kraus4d718682017-05-18 03:38:41 +02004312
4313 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004314 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004315 skip |= LogError(image, errorCodes.base_layer_err,
4316 "%s: %s.baseArrayLayer (= %" PRIu32
4317 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4318 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004319 }
Petr Kraus4d718682017-05-18 03:38:41 +02004320
Petr Krausffa94af2017-08-08 21:46:02 +02004321 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4322 if (subresourceRange.layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004323 skip |= LogError(image, errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004324 } else {
4325 const uint64_t necessary_layer_count =
4326 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004327
Petr Krausffa94af2017-08-08 21:46:02 +02004328 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004329 skip |= LogError(image, errorCodes.layer_count_err,
4330 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4331 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
4332 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
4333 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004334 }
Petr Kraus4d718682017-05-18 03:38:41 +02004335 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004336 }
Petr Kraus4d718682017-05-18 03:38:41 +02004337
Mark Lobodzinski602de982017-02-09 11:01:33 -07004338 return skip;
4339}
4340
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004341bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004342 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004343 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004344 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4345 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4346 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4347
4348 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4349 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4350
4351 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004352 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4353 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
Shannon McPherson5a0de262019-06-05 10:43:56 -06004354 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-02724"
Dave Houltond8ed0212018-05-16 17:18:24 -06004355 : "VUID-VkImageViewCreateInfo-image-01482")
4356 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4357 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
Shannon McPherson5a0de262019-06-05 10:43:56 -06004358 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
Dave Houltond8ed0212018-05-16 17:18:24 -06004359 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4360 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004361
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004362 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004363 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004364 image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004365}
4366
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004367bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004368 const VkImageSubresourceRange &subresourceRange,
4369 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004370 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004371 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4372 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4373 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4374 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004375
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004376 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004377 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image,
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004378 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004379}
4380
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004381bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004382 const VkImageSubresourceRange &subresourceRange,
4383 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004384 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004385 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4386 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4387 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4388 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004389
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004390 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004391 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image,
4392 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004393}
4394
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004395bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004396 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
John Zulaufa4472282019-08-22 14:44:34 -06004397 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004398 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004399 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4400 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4401 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4402 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004403
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004404 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004405 cmd_name, param_name, "arrayLayers", image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004406}
4407
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004408bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004409 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004410 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004411 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004412 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004413 skip |=
4414 ValidateImageUsageFlags(image_state,
4415 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
4416 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4417 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV | VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
4418 false, kVUIDUndefined, "vkCreateImageView()",
4419 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
4420 "SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004421 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004422 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004423 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004424 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004425 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004426 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004427
4428 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4429 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004430 VkImageUsageFlags image_usage = image_state->createInfo.usage;
4431 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004432 VkFormat view_format = pCreateInfo->format;
4433 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004434 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004435 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004436
Dave Houltonbd2e2622018-04-10 16:41:14 -06004437 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004438 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004439 if (chained_ivuci_struct) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05004440 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance2) {
4441 if (!device_extensions.vk_ext_separate_stencil_usage) {
4442 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004443 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
4444 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
4445 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05004446 }
4447 } else {
4448 const auto image_stencil_struct =
4449 lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
4450 if (image_stencil_struct == nullptr) {
4451 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004452 skip |= LogError(
4453 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004454 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
4455 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
4456 "any bits that were not set in VkImageCreateInfo::usage used to create image");
4457 }
4458 } else {
4459 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
4460 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
4461 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004462 skip |= LogError(
4463 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004464 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4465 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4466 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
4467 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
4468 }
4469 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
4470 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004471 skip |= LogError(
4472 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004473 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4474 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4475 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
4476 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
4477 }
4478 }
4479 }
4480 }
4481
Dave Houltonbd2e2622018-04-10 16:41:14 -06004482 image_usage = chained_ivuci_struct->usage;
4483 }
4484
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004485 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4486 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004487 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01004488 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06004489 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01004490 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06004491 std::stringstream ss;
4492 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01004493 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06004494 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004495 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004496 }
4497 } else {
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004498 if ((!device_extensions.vk_khr_maintenance2 ||
Dave Houltonc7988072018-04-16 11:46:56 -06004499 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
4500 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4501 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
4502 std::stringstream ss;
4503 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06004504 << " is not in the same format compatibility class as "
4505 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004506 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4507 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004508 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01018", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004509 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004510 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004511 }
4512 } else {
4513 // Format MUST be IDENTICAL to the format the image was created with
4514 if (image_format != view_format) {
4515 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06004516 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07004517 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004518 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004519 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01019", "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004520 }
4521 }
4522
sfricke-samsungd40eda42020-02-09 17:54:31 -08004523 // Validate feature set if using CUBE_ARRAY
4524 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) && (enabled_features.core.imageCubeArray == false)) {
4525 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-viewType-01004",
4526 "vkCreateImageView(): pCreateInfo->viewType can't be VK_IMAGE_VIEW_TYPE_CUBE_ARRAY without "
4527 "enabling the imageCubeArray feature.");
4528 }
4529
Mark Lobodzinski602de982017-02-09 11:01:33 -07004530 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004531 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004532
4533 switch (image_type) {
4534 case VK_IMAGE_TYPE_1D:
4535 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004536 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4537 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4538 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004539 }
4540 break;
4541 case VK_IMAGE_TYPE_2D:
4542 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4543 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4544 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004545 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
4546 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4547 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004548 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004549 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4550 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4551 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004552 }
4553 }
4554 break;
4555 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004556 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06004557 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4558 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4559 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004560 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004561 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
4562 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4563 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004564 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4565 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004566 skip |= LogError(
4567 pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4568 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4569 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
4570 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4571 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004572 }
4573 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004574 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4575 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4576 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004577 }
4578 }
4579 } else {
4580 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004581 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4582 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4583 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004584 }
4585 }
4586 break;
4587 default:
4588 break;
4589 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004590
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004591 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004592 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07004593 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004594 }
4595
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004596 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004597 VkFormatFeatureFlags tiling_features = (image_tiling & VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4598 : format_properties.optimalTilingFeatures;
4599
4600 if (tiling_features == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004601 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-None-02273",
4602 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4603 "physical device.",
4604 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004605 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004606 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-usage-02274",
4607 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4608 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4609 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004610 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004611 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-usage-02275",
4612 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4613 "VK_IMAGE_USAGE_STORAGE_BIT.",
4614 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004615 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
4616 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004617 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-usage-02276",
4618 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4619 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4620 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004621 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4622 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004623 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-usage-02277",
4624 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4625 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4626 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
sfricke-samsungd40eda42020-02-09 17:54:31 -08004627 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
4628 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
4629 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-usage-02652",
4630 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4631 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4632 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004633 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004634
Jeff Bolz9af91c52018-09-01 21:53:57 -05004635 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4636 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004637 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
4638 "vkCreateImageView() If image was created with usage containing "
4639 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4640 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05004641 }
4642 if (view_format != VK_FORMAT_R8_UINT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004643 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
4644 "vkCreateImageView() If image was created with usage containing "
4645 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05004646 }
4647 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004648 }
4649 return skip;
4650}
4651
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004652bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
4653 uint32_t regionCount, const VkBufferCopy *pRegions) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004654 bool skip = false;
4655
4656 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
4657 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
4658 VkDeviceSize src_min = UINT64_MAX;
4659 VkDeviceSize src_max = 0;
4660 VkDeviceSize dst_min = UINT64_MAX;
4661 VkDeviceSize dst_max = 0;
4662
4663 for (uint32_t i = 0; i < regionCount; i++) {
4664 src_min = std::min(src_min, pRegions[i].srcOffset);
4665 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
4666 dst_min = std::min(dst_min, pRegions[i].dstOffset);
4667 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
4668
4669 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
4670 if (pRegions[i].srcOffset >= src_buffer_size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004671 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-srcOffset-00113",
4672 "vkCmdCopyBuffer(): pRegions[%d].srcOffset (%" PRIuLEAST64
4673 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
4674 i, pRegions[i].srcOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004675 }
4676
4677 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
4678 if (pRegions[i].dstOffset >= dst_buffer_size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004679 skip |= LogError(dst_buffer_state->buffer, "VUID-vkCmdCopyBuffer-dstOffset-00114",
4680 "vkCmdCopyBuffer(): pRegions[%d].dstOffset (%" PRIuLEAST64
4681 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
4682 i, pRegions[i].dstOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004683 }
4684
4685 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
4686 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004687 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-size-00115",
4688 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
4689 ") is greater than the source buffer size (%" PRIuLEAST64
4690 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
4691 i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004692 }
4693
4694 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
4695 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004696 skip |= LogError(dst_buffer_state->buffer, "VUID-vkCmdCopyBuffer-size-00116",
4697 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
4698 ") is greater than the destination buffer size (%" PRIuLEAST64
4699 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
4700 i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004701 }
4702 }
4703
4704 // The union of the source regions, and the union of the destination regions, must not overlap in memory
4705 if (src_buffer_state->buffer == dst_buffer_state->buffer) {
4706 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004707 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-pRegions-00117",
4708 "vkCmdCopyBuffer(): Detected overlap between source and dest regions in memory.");
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004709 }
4710 }
4711
4712 return skip;
4713}
4714
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004715bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004716 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06004717 const auto cb_node = GetCBState(commandBuffer);
4718 const auto src_buffer_state = GetBufferState(srcBuffer);
4719 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004720
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004721 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004722 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
4723 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004724 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004725 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004726 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
4727 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06004728 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004729 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
4730 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004731 skip |=
4732 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4733 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004734 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
4735 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004736 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, regionCount, pRegions);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004737 return skip;
4738}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004739
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004740bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004741 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004742 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004743 if (!buffer_state) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004744 skip |= LogError(buffer, kVUID_Core_DrawState_DoubleDestroy, "Cannot free %s that has not been allocated.",
4745 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004746 } else {
4747 if (buffer_state->in_use.load()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004748 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
4749 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004750 }
4751 }
4752 return skip;
4753}
4754
Jeff Bolz5c801d12019-10-09 10:38:45 -05004755bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
4756 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004757 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06004758 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004759
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004760 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004761 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004762 skip |=
4763 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004764 }
4765 return skip;
4766}
4767
Jeff Bolz5c801d12019-10-09 10:38:45 -05004768bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004769 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004770
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004771 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004772 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07004773 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004774 }
4775 return skip;
4776}
4777
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004778bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004779 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07004780 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06004781 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004782 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004783 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004784 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06004785 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004786 }
4787 return skip;
4788}
4789
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004790bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004791 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004792 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004793 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004794 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004795 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004796 skip |=
4797 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4798 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004799 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004800 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004801 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
4802 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004803 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07004804
4805 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004806 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
4807 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
4808 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
4809 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07004810 }
4811
4812 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004813 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
4814 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
4815 ") minus dstOffset (0x%" PRIxLEAST64 ").",
4816 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07004817 }
4818
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004819 return skip;
4820}
4821
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004822bool CoreChecks::ValidateBufferImageCopyData(uint32_t regionCount, const VkBufferImageCopy *pRegions,
4823 const IMAGE_STATE *image_state, const char *function) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004824 bool skip = false;
4825
4826 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004827 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
4828 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004829 skip |=
4830 LogError(image_state->image, "VUID-VkBufferImageCopy-srcImage-00199",
4831 "%s(): pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
4832 "and 1, respectively.",
4833 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004834 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004835 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004836
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004837 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
4838 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004839 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-srcImage-00201",
4840 "%s(): pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. For 1D and 2D images these "
4841 "must be 0 and 1, respectively.",
4842 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004843 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004844 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004845
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004846 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
4847 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004848 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-baseArrayLayer-00213",
4849 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
4850 "For 3D images these must be 0 and 1, respectively.",
4851 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004852 }
4853 }
4854
4855 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07004856 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
Locke497739c2019-03-08 11:50:47 -07004857 uint32_t element_size = FormatElementSize(image_state->createInfo.format, pRegions[i].imageSubresource.aspectMask);
4858
Dave Houltona585d132019-01-18 13:05:42 -07004859 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004860 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-bufferOffset-00193",
4861 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
4862 " must be a multiple of this format's texel size (%" PRIu32 ").",
4863 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004864 }
4865
4866 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06004867 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004868 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-bufferOffset-00194",
4869 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
4870 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004871 }
4872
4873 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
4874 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004875 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004876 LogError(image_state->image, "VUID-VkBufferImageCopy-bufferRowLength-00195",
4877 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
4878 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004879 }
4880
4881 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
4882 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004883 skip |= LogError(
4884 image_state->image, "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004885 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
4886 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004887 }
4888
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06004889 // Calculate adjusted image extent, accounting for multiplane image factors
4890 VkExtent3D adusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
4891 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
4892 if ((pRegions[i].imageOffset.x < 0) || (pRegions[i].imageOffset.x > static_cast<int32_t>(adusted_image_extent.width)) ||
4893 ((pRegions[i].imageOffset.x + pRegions[i].imageExtent.width) > static_cast<int32_t>(adusted_image_extent.width))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004894 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00197",
4895 "%s(): Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
4896 "zero or <= image subresource width (%d).",
4897 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
4898 adusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06004899 }
4900
4901 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
4902 if ((pRegions[i].imageOffset.y < 0) || (pRegions[i].imageOffset.y > static_cast<int32_t>(adusted_image_extent.height)) ||
4903 ((pRegions[i].imageOffset.y + pRegions[i].imageExtent.height) > static_cast<int32_t>(adusted_image_extent.height))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004904 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00198",
4905 "%s(): Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
4906 "zero or <= image subresource height (%d).",
4907 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
4908 adusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06004909 }
4910
4911 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
4912 if ((pRegions[i].imageOffset.z < 0) || (pRegions[i].imageOffset.z > static_cast<int32_t>(adusted_image_extent.depth)) ||
4913 ((pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth) > static_cast<int32_t>(adusted_image_extent.depth))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004914 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00200",
4915 "%s(): Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
4916 "zero or <= image subresource depth (%d).",
4917 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
4918 adusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06004919 }
4920
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004921 // subresource aspectMask must have exactly 1 bit set
4922 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
4923 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
4924 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004925 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-00212",
4926 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004927 }
4928
4929 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06004930 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004931 skip |= LogError(
4932 image_state->image, "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004933 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
4934 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004935 }
4936
4937 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04004938 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07004939 auto block_size = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004940
4941 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06004942 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004943 skip |= LogError(
4944 image_state->image, "VUID-VkBufferImageCopy-bufferRowLength-00203",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004945 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
4946 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004947 }
4948
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004949 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004950 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004951 skip |= LogError(
4952 image_state->image, "VUID-VkBufferImageCopy-bufferImageHeight-00204",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004953 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
4954 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004955 }
4956
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004957 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06004958 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
4959 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
4960 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004961 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00205",
4962 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
4963 "width & height (%d, %d)..",
4964 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
4965 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004966 }
4967
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004968 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houltona585d132019-01-18 13:05:42 -07004969 uint32_t block_size_in_bytes = FormatElementSize(image_state->createInfo.format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06004970 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004971 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-bufferOffset-00206",
4972 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
4973 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
4974 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004975 }
Dave Houlton67e9b532017-03-02 17:00:10 -07004976
4977 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07004978 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06004979 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004980 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004981 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageExtent-00207",
4982 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
4983 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
4984 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
4985 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07004986 }
4987
4988 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004989 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004990 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004991 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageExtent-00208",
4992 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
4993 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
4994 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
4995 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07004996 }
4997
4998 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06004999 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005000 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005001 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageExtent-00209",
5002 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
5003 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
5004 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
5005 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07005006 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005007 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005008
5009 // Checks that apply only to multi-planar format images
5010 if (FormatIsMultiplane(image_state->createInfo.format)) {
5011 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
5012 if ((FormatPlaneCount(image_state->createInfo.format) < 3) &&
5013 (pRegions[i].imageSubresource.aspectMask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005014 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-01560",
5015 "%s(): pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
5016 "format has three planes.",
5017 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08005018 }
5019
5020 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
5021 if (0 == (pRegions[i].imageSubresource.aspectMask &
5022 (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005023 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-01560",
5024 "%s(): pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
5025 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
5026 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08005027 }
5028 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005029 }
5030
5031 return skip;
5032}
5033
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005034bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount, const VkBufferImageCopy *pRegions,
5035 const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005036 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005037 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005038
5039 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005040 VkExtent3D extent = pRegions[i].imageExtent;
5041 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005042
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005043 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
5044 {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005045 skip |= LogWarning(image_state->image, kVUID_Core_Image_ZeroAreaSubregion,
5046 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
5047 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005048 }
5049
5050 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
5051
5052 // If we're using a compressed format, valid extent is rounded up to multiple of block size (per 18.1)
unknown948b6ba2019-09-19 17:32:54 -06005053 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005054 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005055 if (image_extent.width % block_extent.width) {
5056 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
5057 }
5058 if (image_extent.height % block_extent.height) {
5059 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
5060 }
5061 if (image_extent.depth % block_extent.depth) {
5062 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
5063 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005064 }
5065
Dave Houltonfc1a4052017-04-27 14:32:45 -06005066 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005067 skip |= LogError(image_state->image, msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005068 }
5069 }
5070
5071 return skip;
5072}
5073
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005074bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
5075 const VkBufferImageCopy *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005076 bool skip = false;
5077
5078 VkDeviceSize buffer_size = buff_state->createInfo.size;
5079
5080 for (uint32_t i = 0; i < regionCount; i++) {
5081 VkExtent3D copy_extent = pRegions[i].imageExtent;
5082
5083 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
5084 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Locke497739c2019-03-08 11:50:47 -07005085 VkDeviceSize unit_size = FormatElementSize(image_state->createInfo.format,
5086 pRegions[i].imageSubresource.aspectMask); // size (bytes) of texel or block
Dave Houltonf3229d52017-02-21 15:59:08 -07005087
Tom Cooperb2550c72018-10-15 13:08:41 +01005088 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005089 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houltona585d132019-01-18 13:05:42 -07005090 auto block_dim = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005091 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
5092 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
5093
5094 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
5095 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
5096 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005097 }
5098
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005099 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
5100 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
5101 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07005102 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005103 } else {
5104 // Calculate buffer offset of final copied byte, + 1.
5105 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
5106 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
5107 max_buffer_offset *= unit_size; // convert to bytes
5108 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005109
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005110 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005111 skip |= LogError(device, msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i,
5112 buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005113 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005114 }
5115 }
5116
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005117 return skip;
5118}
5119
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005120bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005121 VkBuffer dstBuffer, uint32_t regionCount,
5122 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005123 const auto cb_node = GetCBState(commandBuffer);
5124 const auto src_image_state = GetImageState(srcImage);
5125 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005126
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005127 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005128
5129 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005130 skip |= ValidateCmd(cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005131
5132 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005133 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005134
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005135 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07005136
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005137 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005138 skip |=
5139 LogError(cb_node->createInfo.commandPool, "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
5140 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
5141 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005142 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005143 skip |= ValidateImageBounds(src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005144 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005145 skip |= ValidateBufferBounds(src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005146 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005147
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005148 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005149 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005150 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
5151 skip |=
5152 ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005153
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005154 // Validate that SRC image & DST buffer have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005155 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005156 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
5157 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005158 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005159 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
5160 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06005161 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005162 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImageToBuffer()",
5163 "VUID-vkCmdCopyImageToBuffer-srcImage-01998",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005164 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04005165 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005166 skip |= InsideRenderPass(cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005167 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005168 const char *src_invalid_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5169 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
5170 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005171 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005172 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
Cort Strattond619a302018-05-17 19:46:32 -07005173 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005174 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005175 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
5176 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005177 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5178 cb_node, src_image_state, &pRegions[i], i, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
5179 skip |=
5180 ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyImageToBuffer()",
5181 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
5182 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005183 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
5184 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005185 }
5186 return skip;
5187}
5188
John Zulauf1686f232019-07-09 16:27:11 -06005189void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5190 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
5191 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
5192
5193 auto cb_node = GetCBState(commandBuffer);
5194 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06005195 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005196 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005197 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005198 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005199}
5200
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005201bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5202 VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005203 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005204 const auto cb_node = GetCBState(commandBuffer);
5205 const auto src_buffer_state = GetBufferState(srcBuffer);
5206 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005207
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005208 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005209
5210 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005211 skip |= ValidateCmd(cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005212
5213 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005214 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005215 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005216 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005217 skip |=
5218 LogError(cb_node->createInfo.commandPool, "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
5219 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
5220 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005221 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005222 skip |= ValidateImageBounds(dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005223 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005224 skip |= ValidateBufferBounds(dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005225 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005226 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005227 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005228 skip |=
5229 ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
5230 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005231 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005232 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
5233 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005234 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005235 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
5236 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06005237 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005238 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyBufferToImage()",
5239 "VUID-vkCmdCopyBufferToImage-dstImage-01997",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005240 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04005241 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005242 skip |= InsideRenderPass(cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005243 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005244 const char *dst_invalid_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5245 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
5246 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005247 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005248 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
Cort Strattond619a302018-05-17 19:46:32 -07005249 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005250 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005251 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
5252 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005253 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5254 cb_node, dst_image_state, &pRegions[i], i, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
5255 skip |=
5256 ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyBufferToImage()",
5257 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
5258 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005259 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
5260 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005261 }
5262 return skip;
5263}
5264
John Zulauf1686f232019-07-09 16:27:11 -06005265void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5266 VkImageLayout dstImageLayout, uint32_t regionCount,
5267 const VkBufferImageCopy *pRegions) {
5268 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
5269
5270 auto cb_node = GetCBState(commandBuffer);
5271 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06005272 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005273 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005274 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005275 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005276}
Mike Weiblen672b58b2017-02-21 14:32:53 -07005277
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005278bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005279 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005280 bool skip = false;
5281 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
5282
Dave Houlton1d960ff2018-01-19 12:17:05 -07005283 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07005284 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
5285 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
5286 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005287 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
5288 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005289 }
5290
John Zulaufa26d3c82019-08-14 16:09:08 -06005291 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005292 if (!image_entry) {
5293 return skip;
5294 }
5295
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005296 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
5297 if (device_extensions.vk_ext_image_drm_format_modifier) {
5298 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
5299 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005300 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
5301 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
5302 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005303 }
5304 } else {
5305 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005306 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
5307 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005308 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07005309 }
5310
Dave Houlton1d960ff2018-01-19 12:17:05 -07005311 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005312 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005313 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
5314 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
5315 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005316 }
5317
Dave Houlton1d960ff2018-01-19 12:17:05 -07005318 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005319 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005320 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
5321 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
5322 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005323 }
5324
Dave Houlton1d960ff2018-01-19 12:17:05 -07005325 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07005326 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005327 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
5328 if (FormatIsMultiplane(img_format)) {
5329 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
5330 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
5331 if (FormatPlaneCount(img_format) > 2u) {
5332 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
5333 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
5334 }
5335 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005336 skip |= LogError(image, vuid,
5337 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
5338 ") must be a single-plane specifier flag.",
5339 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005340 }
5341 } else if (FormatIsColor(img_format)) {
5342 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005343 skip |= LogError(image, kVUID_Core_DrawState_InvalidImageAspect,
5344 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
5345 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005346 }
5347 } else if (FormatIsDepthOrStencil(img_format)) {
5348 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
5349 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07005350 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005351 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5352 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
5353 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
5354 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005355 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
5356 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
5357 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005358 }
5359 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005360
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005361 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005362 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005363 }
5364
Mike Weiblen672b58b2017-02-21 14:32:53 -07005365 return skip;
5366}