blob: dcd533c68f1de33b32e448aae0d5d694be0ab945 [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-lunargcba7d5f2019-12-30 16:59:11 -0700215VkImageLayout GetImageSubresourceInitialLayout(const ImageLayoutMap &imageLayoutMap, const ImageSubresourcePair &imgpair) {
216 auto imgsubIt = imageLayoutMap.find(imgpair.image);
217 if (imgsubIt == imageLayoutMap.end()) return kInvalidLayout;
218 return imgsubIt->second->GetSubresourceInitialLayout(imgpair.subresource);
219}
220
221VkImageLayout GetImageSubresourceLayout(const ImageLayoutMap &imageLayoutMap, const ImageSubresourcePair &imgpair) {
222 auto imgsubIt = imageLayoutMap.find(imgpair.image);
223 if (imgsubIt == imageLayoutMap.end()) return kInvalidLayout;
224 return imgsubIt->second->GetSubresourceLayout(imgpair.subresource);
225}
226
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700227template <class OBJECT, class LAYOUT>
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700228void CoreChecks::SetLayout(OBJECT *pObject, VkImage image, VkImageSubresource range, const LAYOUT &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700229 ImageSubresourcePair imgpair = {image, true, range};
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700230 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
231 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
232 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
233 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600234 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700235 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
236 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
237 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700238 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700239}
240
241template <class OBJECT, class LAYOUT>
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700242void CoreChecks::SetLayout(OBJECT *pObject, ImageSubresourcePair imgpair, const LAYOUT &layout, VkImageAspectFlags aspectMask) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700243 if (imgpair.subresource.aspectMask & aspectMask) {
244 imgpair.subresource.aspectMask = aspectMask;
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700245 SetLayout(pObject, imgpair, layout);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700246 }
247}
248
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500249bool CoreChecks::FindLayouts(VkImage image, std::vector<VkImageLayout> &layouts) const {
locke-lunargcba7d5f2019-12-30 16:59:11 -0700250 auto imgsubIt = imageLayoutMap.find(image);
251 if (imgsubIt == imageLayoutMap.end()) return false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700252 auto image_state = GetImageState(image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700253 if (!image_state) return false;
254 bool ignoreGlobal = false;
255 // 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 -0700256 if (imgsubIt->second->CurrentLayoutSize() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700257 ignoreGlobal = true;
258 }
locke-lunargcba7d5f2019-12-30 16:59:11 -0700259 for (auto imgsubpair : imgsubIt->second->CurrentLayoutView()) {
260 if (ignoreGlobal) continue;
261 layouts.push_back(imgsubpair.it->second);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700262 }
263 return true;
264}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700265
locke-lunargcba7d5f2019-12-30 16:59:11 -0700266bool CoreChecks::FindLayout(const ImageLayoutMap &imageLayoutMap, ImageSubresourcePair imgpair, VkImageLayout &layout,
John Zulauf3b04ebd2019-07-18 14:08:11 -0600267 const VkImageAspectFlags aspectMask) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700268 if (!(imgpair.subresource.aspectMask & aspectMask)) {
269 return false;
270 }
271 imgpair.subresource.aspectMask = aspectMask;
locke-lunargcba7d5f2019-12-30 16:59:11 -0700272 auto layout_ = GetImageSubresourceLayout(imageLayoutMap, imgpair);
273 if (layout_ == kInvalidLayout) return false;
274 layout = layout_;
275
Tony Barbourdf013b92017-01-25 12:53:48 -0700276 return true;
Tony Barboure0c5cc92017-02-08 13:53:39 -0700277}
Tony Barbourdf013b92017-01-25 12:53:48 -0700278
279// find layout in supplied map
locke-lunargcba7d5f2019-12-30 16:59:11 -0700280bool CoreChecks::FindLayout(const ImageLayoutMap &imageLayoutMap, ImageSubresourcePair imgpair,
John Zulauf3b04ebd2019-07-18 14:08:11 -0600281 VkImageLayout &layout) const {
locke-lunargcba7d5f2019-12-30 16:59:11 -0700282 layout = kInvalidLayout;
Tony Barbourdf013b92017-01-25 12:53:48 -0700283 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
284 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
285 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
286 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600287 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700288 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
289 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
290 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
291 }
292 // Image+subresource not found, look for image handle w/o subresource
locke-lunargcba7d5f2019-12-30 16:59:11 -0700293 if (layout == kInvalidLayout) {
294 imgpair = {imgpair.image, false};
295 auto image_state = Get<IMAGE_STATE>(imgpair.image);
296 imgpair.subresource.aspectMask = image_state->full_range.aspectMask;
297 imgpair.subresource.mipLevel = image_state->full_range.baseMipLevel;
298 imgpair.subresource.arrayLayer = image_state->full_range.baseArrayLayer;
299 auto layout_ = GetImageSubresourceInitialLayout(imageLayoutMap, imgpair);
300 if (layout_ == kInvalidLayout) return false;
301 layout = layout_;
Tony Barbourdf013b92017-01-25 12:53:48 -0700302 }
303 return true;
304}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700305
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600306// Set image layout for given VkImageSubresourceRange struct
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600307void CoreChecks::SetImageLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600308 const VkImageSubresourceRange &image_subresource_range, VkImageLayout layout,
309 VkImageLayout expected_layout) {
310 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
311 assert(subresource_map); // the non-const getter must return a valid pointer
John Zulauf4ec24ec2019-05-02 17:22:59 -0600312 if (subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600313 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700314 }
315}
John Zulauff660ad62019-03-23 07:16:05 -0600316
317// Set the initial image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600318void CoreChecks::SetImageViewInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
Jeff Bolz3e333222019-08-10 23:00:38 -0500319 if (disabled.image_layout_validation) {
320 return;
321 }
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500322 IMAGE_STATE *image_state = view_state.image_state.get();
323 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
John Zulaufb58415b2019-12-09 15:02:32 -0700324 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
John Zulauff660ad62019-03-23 07:16:05 -0600325}
326
327// Set the initial image layout for a passed non-normalized subresource range
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600328void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600329 const VkImageSubresourceRange &range, VkImageLayout layout) {
330 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
331 assert(subresource_map);
John Zulauf4ec24ec2019-05-02 17:22:59 -0600332 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(image_state, range), layout);
John Zulauff660ad62019-03-23 07:16:05 -0600333}
334
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600335void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, VkImage image, const VkImageSubresourceRange &range,
John Zulauff660ad62019-03-23 07:16:05 -0600336 VkImageLayout layout) {
337 const IMAGE_STATE *image_state = GetImageState(image);
338 if (!image_state) return;
339 SetImageInitialLayout(cb_node, *image_state, range, layout);
340};
341
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600342void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600343 const VkImageSubresourceLayers &layers, VkImageLayout layout) {
344 SetImageInitialLayout(cb_node, image_state, RangeFromLayers(layers), layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600345}
Dave Houltonddd65c52018-05-08 14:58:01 -0600346
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600347// Set image layout for all slices of an image view
Piers Daniell4fde9b72019-11-27 16:19:46 -0700348void CoreChecks::SetImageViewLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout,
349 VkImageLayout layoutStencil) {
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500350 IMAGE_STATE *image_state = view_state.image_state.get();
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600351
John Zulauff660ad62019-03-23 07:16:05 -0600352 VkImageSubresourceRange sub_range = view_state.normalized_subresource_range;
Dave Houltonddd65c52018-05-08 14:58:01 -0600353 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
354 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
John Zulauff660ad62019-03-23 07:16:05 -0600355 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 -0600356 sub_range.baseArrayLayer = 0;
357 sub_range.layerCount = image_state->createInfo.extent.depth;
358 }
359
Piers Daniell4fde9b72019-11-27 16:19:46 -0700360 if (sub_range.aspectMask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT) && layoutStencil != kInvalidLayout) {
361 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
362 SetImageLayout(cb_node, *image_state, sub_range, layout);
363 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
364 SetImageLayout(cb_node, *image_state, sub_range, layoutStencil);
365 } else {
366 SetImageLayout(cb_node, *image_state, sub_range, layout);
367 }
John Zulauf4ccf5c02018-09-21 11:46:18 -0600368}
369
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700370bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
371 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700372 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600373 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100374 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700375 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100376 const char *vuid;
377 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
378
379 if (!image_state) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700380 skip |= LogError(image, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
381 "Render Pass begin with %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
382 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
383 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100384 return skip;
385 }
386
387 auto image_usage = image_state->createInfo.usage;
388
389 // Check for layouts that mismatch image usages in the framebuffer
390 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800391 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100392 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700393 LogError(image, vuid,
394 "Layout/usage mismatch for attachment %u in %s"
395 " - the %s is %s but the image attached to %s via %s"
396 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
397 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
398 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100399 }
400
401 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
402 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800403 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100404 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700405 LogError(image, vuid,
406 "Layout/usage mismatch for attachment %u in %s"
407 " - the %s is %s but the image attached to %s via %s"
408 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
409 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
410 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100411 }
412
413 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800414 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100415 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700416 LogError(image, vuid,
417 "Layout/usage mismatch for attachment %u in %s"
418 " - the %s is %s but the image attached to %s via %s"
419 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
420 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
421 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100422 }
423
424 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800425 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100426 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700427 LogError(image, vuid,
428 "Layout/usage mismatch for attachment %u in %s"
429 " - the %s is %s but the image attached to %s via %s"
430 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
431 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
432 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100433 }
434
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600435 if (device_extensions.vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100436 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
437 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
438 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
439 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
440 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800441 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700442 skip |= LogError(image, vuid,
443 "Layout/usage mismatch for attachment %u in %s"
444 " - the %s is %s but the image attached to %s via %s"
445 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
446 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
447 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
448 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100449 }
450 } else {
451 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
452 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
453 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
454 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700455 skip |= LogError(image, "VUID-vkCmdBeginRenderPass-initialLayout-00896",
456 "Layout/usage mismatch for attachment %u in %s"
457 " - the %s is %s but the image attached to %s via %s"
458 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
459 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
460 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
461 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100462 }
463 }
464 return skip;
465}
466
John Zulauf17a01bb2019-08-09 16:41:19 -0600467bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700468 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600469 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600470 bool skip = false;
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700471 auto const pRenderPassInfo = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700472 auto const &framebufferInfo = framebuffer_state->createInfo;
Tobias Hectorc9057422019-07-23 12:15:52 +0100473 const VkImageView *attachments = framebufferInfo.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100474
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700475 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100476 auto framebuffer = framebuffer_state->framebuffer;
477
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700478 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700479 skip |= LogError(pCB->commandBuffer, kVUID_Core_DrawState_InvalidRenderpass,
480 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700481 }
John Zulauf8e308292018-09-21 11:34:37 -0600482
Tobias Hectorc9057422019-07-23 12:15:52 +0100483 const auto *attachmentInfo = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
484 if (((framebufferInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) != 0) && attachmentInfo != nullptr) {
485 attachments = attachmentInfo->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100486 }
487
Tobias Hectorc9057422019-07-23 12:15:52 +0100488 if (attachments != nullptr) {
489 const auto *const_pCB = static_cast<const CMD_BUFFER_STATE *>(pCB);
490 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
491 auto image_view = attachments[i];
492 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100493
Tobias Hectorc9057422019-07-23 12:15:52 +0100494 if (!view_state) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700495 skip |= LogError(pRenderPassBegin->renderPass, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
496 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
497 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
498 report_data->FormatHandle(image_view).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100499 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100500 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100501
502 const VkImage image = view_state->create_info.image;
503 const IMAGE_STATE *image_state = GetImageState(image);
504
505 if (!image_state) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700506 skip |= LogError(pRenderPassBegin->renderPass, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
507 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
508 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
509 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100510 continue;
511 }
512 auto attachment_initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
513 auto final_layout = pRenderPassInfo->pAttachments[i].finalLayout;
514
Piers Daniell7f894f62020-01-09 16:33:48 -0700515 // Default to expecting stencil in the same layout.
516 auto attachment_stencil_initial_layout = attachment_initial_layout;
517
518 // If a separate layout is specified, look for that.
519 const auto *attachment_description_stencil_layout =
520 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
521 if (attachment_description_stencil_layout) {
522 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
523 }
524
Tobias Hectorc9057422019-07-23 12:15:52 +0100525 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
526 // in common with the non-const version.)
527 const ImageSubresourceLayoutMap *subresource_map =
528 (attachment_initial_layout != VK_IMAGE_LAYOUT_UNDEFINED) ? GetImageSubresourceLayoutMap(const_pCB, image) : nullptr;
529
530 if (subresource_map) { // If no layout information for image yet, will be checked at QueueSubmit time
531 LayoutUseCheckAndMessage layout_check(subresource_map);
532 bool subres_skip = false;
John Zulauf5e617452019-11-19 14:44:16 -0700533 auto pos = subresource_map->Find(view_state->normalized_subresource_range);
534 for (; pos != subresource_map->End() && !subres_skip; ++pos) {
535 const VkImageSubresource &subres = pos->subresource;
Piers Daniell7f894f62020-01-09 16:33:48 -0700536
John Zulauf5e617452019-11-19 14:44:16 -0700537 // Allow for differing depth and stencil layouts
538 VkImageLayout check_layout = attachment_initial_layout;
539 if (subres.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) check_layout = attachment_stencil_initial_layout;
540
541 if (!layout_check.Check(subres, check_layout, pos->current_layout, pos->initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700542 subres_skip |= LogError(
543 device, kVUID_Core_DrawState_InvalidRenderpass,
Piers Daniell7f894f62020-01-09 16:33:48 -0700544 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
545 "and the %s layout of the attachment is %s. The layouts must match, or the render "
546 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
John Zulauf5e617452019-11-19 14:44:16 -0700547 i, string_VkImageLayout(check_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobias Hectorc9057422019-07-23 12:15:52 +0100548 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700549 }
John Zulauf5e617452019-11-19 14:44:16 -0700550
Tobias Hectorc9057422019-07-23 12:15:52 +0100551 skip |= subres_skip;
552 }
553
554 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view,
555 framebuffer, render_pass, i, "initial layout");
556
557 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer,
558 render_pass, i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100559 }
560
Tobias Hectorc9057422019-07-23 12:15:52 +0100561 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
562 auto &subpass = pRenderPassInfo->pSubpasses[j];
563 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
564 auto &attachment_ref = subpass.pInputAttachments[k];
565 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
566 auto image_view = attachments[attachment_ref.attachment];
567 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100568
Tobias Hectorc9057422019-07-23 12:15:52 +0100569 if (view_state) {
570 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700571 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
572 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100573 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100574 }
575 }
576 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100577
Tobias Hectorc9057422019-07-23 12:15:52 +0100578 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
579 auto &attachment_ref = subpass.pColorAttachments[k];
580 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
581 auto image_view = attachments[attachment_ref.attachment];
582 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100583
Tobias Hectorc9057422019-07-23 12:15:52 +0100584 if (view_state) {
585 auto image = view_state->create_info.image;
586 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
587 framebuffer, render_pass, attachment_ref.attachment,
588 "color attachment layout");
589 if (subpass.pResolveAttachments) {
590 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
591 rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
592 attachment_ref.attachment, "resolve attachment layout");
593 }
594 }
595 }
596 }
597
598 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
599 auto &attachment_ref = *subpass.pDepthStencilAttachment;
600 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
601 auto image_view = attachments[attachment_ref.attachment];
602 auto view_state = GetImageViewState(image_view);
603
604 if (view_state) {
605 auto image = view_state->create_info.image;
606 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
607 framebuffer, render_pass, attachment_ref.attachment,
608 "input attachment layout");
609 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100610 }
611 }
612 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700613 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600614 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700615}
616
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600617void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700618 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700619 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700620 auto image_view = GetAttachmentImageViewState(pFramebuffer, ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600621 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700622 VkImageLayout stencil_layout = kInvalidLayout;
623 const auto *attachment_reference_stencil_layout = lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(ref.pNext);
624 if (attachment_reference_stencil_layout) {
625 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
626 }
627
628 SetImageViewLayout(pCB, *image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600629 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700630 }
631}
632
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600633void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
634 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700635 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700636
637 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700638 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700639 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700640 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700641 }
642 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700643 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700644 }
645 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700646 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700647 }
648 }
649}
650
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700651// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
652// 1. Transition into initialLayout state
653// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600654void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700655 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700656 // First transition into initialLayout
657 auto const rpci = render_pass_state->createInfo.ptr();
658 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700659 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -0600660 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700661 VkImageLayout stencil_layout = kInvalidLayout;
662 const auto *attachment_description_stencil_layout =
663 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(rpci->pAttachments[i].pNext);
664 if (attachment_description_stencil_layout) {
665 stencil_layout = attachment_description_stencil_layout->stencilInitialLayout;
666 }
667
668 SetImageViewLayout(cb_state, *view_state, rpci->pAttachments[i].initialLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600669 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700670 }
671 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700672 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700673}
674
Dave Houlton10b39482017-03-16 13:18:15 -0600675bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600676 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600677 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600678 }
679 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600680 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600681 }
682 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600683 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600684 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700685 if (0 !=
686 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
687 if (FormatPlaneCount(format) == 1) return false;
688 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600689 return true;
690}
691
Mike Weiblen62d08a32017-03-07 22:18:27 -0700692// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Petr Krausad0096a2019-08-09 18:35:04 +0200693bool CoreChecks::ValidateBarrierLayoutToImageUsage(const VkImageMemoryBarrier &img_barrier, bool new_not_old,
694 VkImageUsageFlags usage_flags, const char *func_name,
John Zulaufa4472282019-08-22 14:44:34 -0600695 const char *barrier_pname) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700696 bool skip = false;
Petr Krausad0096a2019-08-09 18:35:04 +0200697 const VkImageLayout layout = (new_not_old) ? img_barrier.newLayout : img_barrier.oldLayout;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600698 const char *msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700699
700 switch (layout) {
701 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
702 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600703 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700704 }
705 break;
706 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
707 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600708 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700709 }
710 break;
711 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
712 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600713 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700714 }
715 break;
716 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
717 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600718 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700719 }
720 break;
721 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
722 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600723 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700724 }
725 break;
726 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
727 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600728 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700729 }
730 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600731 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500732 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
733 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
734 }
735 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700736 default:
737 // Other VkImageLayout values do not have VUs defined in this context.
738 break;
739 }
740
Dave Houlton8e9f6542018-05-18 12:18:22 -0600741 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700742 skip |= LogError(img_barrier.image, msg_code,
743 "%s: Image barrier %s %s Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".", func_name,
744 barrier_pname, ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
745 report_data->FormatHandle(img_barrier.image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700746 }
747 return skip;
748}
749
750// Verify image barriers are compatible with the images they reference.
John Zulaufa4472282019-08-22 14:44:34 -0600751bool CoreChecks::ValidateBarriersToImages(const CMD_BUFFER_STATE *cb_state, uint32_t imageMemoryBarrierCount,
752 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700753 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700754
Petr Krausad0096a2019-08-09 18:35:04 +0200755 // Scoreboard for checking for duplicate and inconsistent barriers to images
756 struct ImageBarrierScoreboardEntry {
757 uint32_t index;
758 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
759 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
760 const VkImageMemoryBarrier *barrier;
761 };
762 using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
763 using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
764
John Zulauf463c51e2018-05-31 13:29:20 -0600765 // Scoreboard for duplicate layout transition barriers within the list
766 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
767 ImageBarrierScoreboardImageMap layout_transitions;
768
Mike Weiblen62d08a32017-03-07 22:18:27 -0700769 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +0200770 const auto &img_barrier = pImageMemoryBarriers[i];
771 const std::string barrier_pname = "pImageMemoryBarrier[" + std::to_string(i) + "]";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700772
John Zulauf463c51e2018-05-31 13:29:20 -0600773 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
774 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
775 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +0200776 if (img_barrier.oldLayout != img_barrier.newLayout) {
777 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
778 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -0600779 if (image_it != layout_transitions.end()) {
780 auto &subres_map = image_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200781 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -0600782 if (subres_it != subres_map.end()) {
783 auto &entry = subres_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200784 if ((entry.barrier->newLayout != img_barrier.oldLayout) &&
785 (img_barrier.oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
786 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700787 skip = LogError(
788 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
Petr Krausad0096a2019-08-09 18:35:04 +0200789 "%s: %s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600790 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
791 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Petr Krausad0096a2019-08-09 18:35:04 +0200792 func_name, barrier_pname.c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
793 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
794 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600795 }
796 entry = new_entry;
797 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200798 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600799 }
800 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200801 layout_transitions[img_barrier.image][img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600802 }
803 }
804
Petr Krausad0096a2019-08-09 18:35:04 +0200805 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600806 if (image_state) {
807 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Petr Krausad0096a2019-08-09 18:35:04 +0200808 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, false, usage_flags, func_name, barrier_pname.c_str());
809 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, true, usage_flags, func_name, barrier_pname.c_str());
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600810
811 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
812 if (image_state->layout_locked) {
813 // TODO: Add unique id for error when available
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700814 skip |= LogError(
815 img_barrier.image, 0,
locke-lunarg9edc2812019-06-17 23:18:52 -0600816 "Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600817 " 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 +0200818 report_data->FormatHandle(img_barrier.image).c_str(), string_VkImageLayout(img_barrier.oldLayout),
819 string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600820 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600821
John Zulaufa4472282019-08-22 14:44:34 -0600822 const VkImageCreateInfo &image_create_info = image_state->createInfo;
John Zulauff660ad62019-03-23 07:16:05 -0600823 // For a Depth/Stencil image both aspects MUST be set
John Zulaufa4472282019-08-22 14:44:34 -0600824 if (FormatIsDepthAndStencil(image_create_info.format)) {
Petr Krausad0096a2019-08-09 18:35:04 +0200825 auto const aspect_mask = img_barrier.subresourceRange.aspectMask;
Piers Daniell41b8c5d2020-01-10 15:42:00 -0700826 if (enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -0600827 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
828 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700829 LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-03319",
830 "%s: Image barrier %s references %s of format %s that must have either the depth or stencil "
831 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
832 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
833 string_VkFormat(image_create_info.format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600834 }
835 } else {
836 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
837 if ((aspect_mask & ds_mask) != (ds_mask)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700838 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-03320",
839 "%s: Image barrier %s references %s of format %s that must have the depth and stencil "
840 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
841 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
842 string_VkFormat(image_create_info.format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600843 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700844 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700845 }
John Zulauff660ad62019-03-23 07:16:05 -0600846
Petr Krausad0096a2019-08-09 18:35:04 +0200847 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier.image);
848 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -0600849 // TODO: Set memory invalid which is in mem_tracker currently
850 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
851 // subresource.
852 } else if (subresource_map) {
853 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -0600854 LayoutUseCheckAndMessage layout_check(subresource_map);
Petr Krausad0096a2019-08-09 18:35:04 +0200855 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier.subresourceRange);
John Zulauf5e617452019-11-19 14:44:16 -0700856 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
857 const auto &value = *pos;
858 if (!layout_check.Check(value.subresource, img_barrier.oldLayout, value.current_layout, value.initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700859 subres_skip = LogError(
860 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
John Zulauf5e617452019-11-19 14:44:16 -0700861 "For %s you cannot transition the layout of aspect=%d level=%d layer=%d from %s when the "
862 "%s layout is %s.",
863 report_data->FormatHandle(img_barrier.image).c_str(), value.subresource.aspectMask,
864 value.subresource.mipLevel, value.subresource.arrayLayer, string_VkImageLayout(img_barrier.oldLayout),
865 layout_check.message, string_VkImageLayout(layout_check.layout));
John Zulauff660ad62019-03-23 07:16:05 -0600866 }
John Zulauf5e617452019-11-19 14:44:16 -0700867 }
John Zulauff660ad62019-03-23 07:16:05 -0600868 skip |= subres_skip;
869 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700870 }
871 }
872 return skip;
873}
874
John Zulaufe3d1c8a2019-08-12 14:34:58 -0600875bool CoreChecks::IsReleaseOp(CMD_BUFFER_STATE *cb_state, const VkImageMemoryBarrier &barrier) const {
Petr Krausad0096a2019-08-09 18:35:04 +0200876 if (!IsTransferOp(&barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700877
Jeff Bolz6835fda2019-10-06 00:15:34 -0500878 auto pool = cb_state->command_pool.get();
Petr Krausad0096a2019-08-09 18:35:04 +0200879 return pool && TempIsReleaseOp<VkImageMemoryBarrier, true>(pool, &barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700880}
881
John Zulauf6b4aae82018-05-09 13:03:36 -0600882template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -0600883bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
884 uint32_t barrier_count, const Barrier *barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600885 using BarrierRecord = QFOTransferBarrier<Barrier>;
886 bool skip = false;
Jeff Bolz6835fda2019-10-06 00:15:34 -0500887 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -0600888 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
889 const char *barrier_name = BarrierRecord::BarrierName();
890 const char *handle_name = BarrierRecord::HandleName();
891 const char *transfer_type = nullptr;
892 for (uint32_t b = 0; b < barrier_count; b++) {
893 if (!IsTransferOp(&barriers[b])) continue;
894 const BarrierRecord *barrier_record = nullptr;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700895 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufa4472282019-08-22 14:44:34 -0600896 !QueueFamilyIsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600897 const auto found = barrier_sets.release.find(barriers[b]);
898 if (found != barrier_sets.release.cend()) {
899 barrier_record = &(*found);
900 transfer_type = "releasing";
901 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600902 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufa4472282019-08-22 14:44:34 -0600903 !QueueFamilyIsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600904 const auto found = barrier_sets.acquire.find(barriers[b]);
905 if (found != barrier_sets.acquire.cend()) {
906 barrier_record = &(*found);
907 transfer_type = "acquiring";
908 }
909 }
910 if (barrier_record != nullptr) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700911 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOInCB(),
912 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
913 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
914 func_name, barrier_name, b, transfer_type, handle_name,
915 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
916 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -0600917 }
918 }
919 return skip;
920}
921
John Zulaufa4472282019-08-22 14:44:34 -0600922VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
923 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
924}
925
926const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
927 return device_state.GetImageState(barrier.image);
928}
929
930VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
931 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
932}
933
934const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
935 return device_state.GetBufferState(barrier.buffer);
936}
937
938VkBuffer BarrierHandle(const VkBufferMemoryBarrier &barrier) { return barrier.buffer; }
939
John Zulauf6b4aae82018-05-09 13:03:36 -0600940template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -0600941void CoreChecks::RecordBarrierArrayValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
942 const Barrier *barriers) {
Jeff Bolz6835fda2019-10-06 00:15:34 -0500943 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -0600944 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
945 for (uint32_t b = 0; b < barrier_count; b++) {
John Zulaufa4472282019-08-22 14:44:34 -0600946 auto &barrier = barriers[b];
947 if (IsTransferOp(&barrier)) {
948 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barrier) &&
949 !QueueFamilyIsSpecial(barrier.dstQueueFamilyIndex)) {
950 barrier_sets.release.emplace(barrier);
951 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barrier) &&
952 !QueueFamilyIsSpecial(barrier.srcQueueFamilyIndex)) {
953 barrier_sets.acquire.emplace(barrier);
954 }
955 }
956
957 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
958 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
959 if (!QueueFamilyIsIgnored(src_queue_family) && !QueueFamilyIsIgnored(dst_queue_family)) {
960 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
961 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
962 auto handle_state = BarrierHandleState(*this, barrier);
963 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
964 if (!mode_concurrent) {
965 const auto typed_handle = BarrierTypedHandle(barrier);
Jeff Bolz310775c2019-10-09 00:46:33 -0500966 cb_state->queue_submit_functions.emplace_back(
967 [func_name, cb_state, typed_handle, src_queue_family, dst_queue_family](
968 const ValidationStateTracker *device_data, const QUEUE_STATE *queue_state) {
969 return ValidateConcurrentBarrierAtSubmit(device_data, queue_state, func_name, cb_state, typed_handle,
970 src_queue_family, dst_queue_family);
John Zulaufa4472282019-08-22 14:44:34 -0600971 });
972 }
John Zulauf6b4aae82018-05-09 13:03:36 -0600973 }
974 }
975}
976
John Zulaufa4472282019-08-22 14:44:34 -0600977bool CoreChecks::ValidateBarriersQFOTransferUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600978 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700979 uint32_t imageMemBarrierCount,
John Zulaufa4472282019-08-22 14:44:34 -0600980 const VkImageMemoryBarrier *pImageMemBarriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600981 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700982 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
983 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -0600984 return skip;
985}
986
John Zulaufa4472282019-08-22 14:44:34 -0600987void CoreChecks::RecordBarrierValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
988 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
989 const VkImageMemoryBarrier *pImageMemBarriers) {
990 RecordBarrierArrayValidationInfo(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
991 RecordBarrierArrayValidationInfo(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -0600992}
993
994template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600995bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
John Zulauf3b04ebd2019-07-18 14:08:11 -0600996 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600997 // Record to the scoreboard or report that we have a duplication
998 bool skip = false;
999 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
1000 if (!inserted.second && inserted.first->second != cb_state) {
1001 // 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 -07001002 skip = LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
1003 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1004 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
1005 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
1006 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
1007 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001008 }
1009 return skip;
1010}
1011
1012template <typename Barrier>
John Zulauf3b04ebd2019-07-18 14:08:11 -06001013bool CoreChecks::ValidateQueuedQFOTransferBarriers(const CMD_BUFFER_STATE *cb_state,
1014 QFOTransferCBScoreboards<Barrier> *scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001015 using BarrierRecord = QFOTransferBarrier<Barrier>;
1016 using TypeTag = typename BarrierRecord::Tag;
1017 bool skip = false;
John Zulauf6b4aae82018-05-09 13:03:36 -06001018 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001019 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001020 const char *barrier_name = BarrierRecord::BarrierName();
1021 const char *handle_name = BarrierRecord::HandleName();
1022 // No release should have an extant duplicate (WARNING)
1023 for (const auto &release : cb_barriers.release) {
1024 // Check the global pending release barriers
1025 const auto set_it = global_release_barriers.find(release.handle);
1026 if (set_it != global_release_barriers.cend()) {
1027 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1028 const auto found = set_for_handle.find(release);
1029 if (found != set_for_handle.cend()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001030 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
1031 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1032 " to dstQueueFamilyIndex %" PRIu32
1033 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1034 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1035 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001036 }
1037 }
1038 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1039 }
1040 // Each acquire must have a matching release (ERROR)
1041 for (const auto &acquire : cb_barriers.acquire) {
1042 const auto set_it = global_release_barriers.find(acquire.handle);
1043 bool matching_release_found = false;
1044 if (set_it != global_release_barriers.cend()) {
1045 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1046 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1047 }
1048 if (!matching_release_found) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001049 skip |= LogError(cb_state->commandBuffer, BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
1050 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1051 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1052 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1053 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001054 }
1055 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1056 }
1057 return skip;
1058}
1059
John Zulauf3b04ebd2019-07-18 14:08:11 -06001060bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001061 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001062 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001063 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001064 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state, qfo_image_scoreboards);
1065 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state, qfo_buffer_scoreboards);
John Zulauf6b4aae82018-05-09 13:03:36 -06001066 return skip;
1067}
1068
1069template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001070void CoreChecks::RecordQueuedQFOTransferBarriers(CMD_BUFFER_STATE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001071 using BarrierRecord = QFOTransferBarrier<Barrier>;
1072 using TypeTag = typename BarrierRecord::Tag;
1073 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001074 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001075
1076 // Add release barriers from this submit to the global map
1077 for (const auto &release : cb_barriers.release) {
1078 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1079 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1080 global_release_barriers[release.handle].insert(release);
1081 }
1082
1083 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1084 for (const auto &acquire : cb_barriers.acquire) {
1085 // NOTE: We're not using [] because we don't want to create entries for missing releases
1086 auto set_it = global_release_barriers.find(acquire.handle);
1087 if (set_it != global_release_barriers.end()) {
1088 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1089 set_for_handle.erase(acquire);
1090 if (set_for_handle.size() == 0) { // Clean up empty sets
1091 global_release_barriers.erase(set_it);
1092 }
1093 }
1094 }
1095}
1096
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001097void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001098 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state);
1099 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001100}
1101
John Zulauf6b4aae82018-05-09 13:03:36 -06001102// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001103void CoreChecks::EraseQFOImageRelaseBarriers(const VkImage &image) { EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image); }
John Zulauf6b4aae82018-05-09 13:03:36 -06001104
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001105void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001106 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001107 for (uint32_t i = 0; i < memBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +02001108 const auto &mem_barrier = pImgMemBarriers[i];
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001109
Chris Forbes4de4b132017-08-21 11:27:08 -07001110 // For ownership transfers, the barrier is specified twice; as a release
1111 // operation on the yielding queue family, and as an acquire operation
1112 // on the acquiring queue family. This barrier may also include a layout
1113 // transition, which occurs 'between' the two operations. For validation
1114 // purposes it doesn't seem important which side performs the layout
1115 // transition, but it must not be performed twice. We'll arbitrarily
1116 // choose to perform it as part of the acquire operation.
John Zulauf2be3fe02019-12-30 09:48:02 -07001117 //
1118 // However, we still need to record initial layout for the "initial layout" validation
1119 const bool is_release_op = IsReleaseOp(cb_state, mem_barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -07001120
Petr Krausad0096a2019-08-09 18:35:04 +02001121 auto *image_state = GetImageState(mem_barrier.image);
John Zulauff660ad62019-03-23 07:16:05 -06001122 if (!image_state) continue;
John Zulauf2be3fe02019-12-30 09:48:02 -07001123 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
unknown86bcb3a2019-07-11 13:05:36 -06001124 for (const auto &image : image_state->aliasing_images) {
1125 image_state = GetImageState(image);
John Zulauf2be3fe02019-12-30 09:48:02 -07001126 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
Dave Houltonb3f4b282018-02-22 16:25:16 -07001127 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001128 }
1129}
1130
unknown86bcb3a2019-07-11 13:05:36 -06001131void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
John Zulauf2be3fe02019-12-30 09:48:02 -07001132 const VkImageMemoryBarrier &mem_barrier, bool is_release_op) {
unknown86bcb3a2019-07-11 13:05:36 -06001133 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier.subresourceRange);
1134 const auto &image_create_info = image_state->createInfo;
1135
1136 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1137 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1138 // for all (potential) layer sub_resources.
1139 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
1140 normalized_isr.baseArrayLayer = 0;
1141 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
1142 }
1143
John Zulauf2be3fe02019-12-30 09:48:02 -07001144 if (is_release_op) {
1145 SetImageInitialLayout(cb_state, *image_state, normalized_isr, mem_barrier.oldLayout);
1146 } else {
1147 SetImageLayout(cb_state, *image_state, normalized_isr, mem_barrier.newLayout, mem_barrier.oldLayout);
1148 }
unknown86bcb3a2019-07-11 13:05:36 -06001149}
1150
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001151bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1152 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1153 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1154 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Matthew Ruschd7ef5482019-07-16 22:01:54 -07001155 if (disabled.image_layout_validation) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001156 assert(cb_node);
1157 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001158 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001159 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001160
John Zulauff660ad62019-03-23 07:16:05 -06001161 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1162 if (subresource_map) {
1163 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001164 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
John Zulauf5e617452019-11-19 14:44:16 -07001165 for (auto pos = subresource_map->Find(range); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1166 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001167 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001168 subres_skip |= LogError(cb_node->commandBuffer, layout_mismatch_msg_code,
1169 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1170 "%s layout %s.",
1171 caller, report_data->FormatHandle(image).c_str(), pos->subresource.arrayLayer,
1172 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1173 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001174 }
John Zulauf5e617452019-11-19 14:44:16 -07001175 }
John Zulauff660ad62019-03-23 07:16:05 -06001176 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001177 }
John Zulauff660ad62019-03-23 07:16:05 -06001178
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001179 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1180 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1181 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001182 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1183 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001184 skip |= LogPerformanceWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
1185 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
1186 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001187 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001188 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001189 if (image_state->shared_presentable) {
1190 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001191 skip |= LogError(device, layout_invalid_msg_code,
1192 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1193 string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001194 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001195 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001196 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001197 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001198 skip |= LogError(cb_node->commandBuffer, layout_invalid_msg_code,
1199 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1200 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1201 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001202 }
1203 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001204 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001205}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001206bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001207 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1208 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001209 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001210 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1211 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1212}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001213
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001214void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001215 FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinski2e495882019-03-06 16:11:56 -07001216 auto renderPass = GetRenderPassState(pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001217 if (!renderPass) return;
1218
Tobias Hectorbbb12282018-10-22 15:17:59 +01001219 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001220 if (framebuffer_state) {
1221 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07001222 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -06001223 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001224 VkImageLayout stencil_layout = kInvalidLayout;
1225 const auto *attachment_description_stencil_layout =
1226 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
1227 if (attachment_description_stencil_layout) {
1228 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1229 }
1230
1231 SetImageViewLayout(pCB, *view_state, pRenderPassInfo->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001232 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001233 }
1234 }
1235}
Dave Houltone19e20d2018-02-02 16:32:41 -07001236
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001237#ifdef VK_USE_PLATFORM_ANDROID_KHR
1238// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1239// This could also move into a seperate core_validation_android.cpp file... ?
1240
1241//
1242// AHB-specific validation within non-AHB APIs
1243//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001244bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001245 bool skip = false;
1246
1247 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1248 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001249 if (0 != ext_fmt_android->externalFormat) {
1250 if (VK_FORMAT_UNDEFINED != create_info->format) {
1251 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001252 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1253 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1254 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001255 }
1256
1257 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001258 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1259 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1260 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001261 }
1262
1263 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001264 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1265 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1266 "non-zero externalFormat, but usage includes bits other than VK_IMAGE_USAGE_SAMPLED_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001267 }
1268
1269 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001270 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1271 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1272 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001273 }
1274 }
1275
Mark Lobodzinski1ee06e92019-04-19 14:03:53 -06001276 if ((0 != ext_fmt_android->externalFormat) && (0 == ahb_ext_formats_set.count(ext_fmt_android->externalFormat))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001277 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
1278 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat which has "
1279 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001280 }
1281 }
1282
Dave Houltond9611312018-11-19 17:03:36 -07001283 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001284 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001285 skip |=
1286 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1287 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1288 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001289 }
1290 }
1291
1292 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1293 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1294 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001295 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001296 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1297 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1298 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1299 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001300 }
1301
1302 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001303 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1304 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1305 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1306 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1307 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001308 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001309 }
1310
1311 return skip;
1312}
1313
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001314bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001315 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001316 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001317
1318 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001319 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001320 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1321 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1322 "format member is %s.",
1323 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001324 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001325
Dave Houltond9611312018-11-19 17:03:36 -07001326 // Chain must include a compatible ycbcr conversion
1327 bool conv_found = false;
1328 uint64_t external_format = 0;
1329 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1330 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001331 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001332 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001333 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001334 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001335 }
Dave Houltond9611312018-11-19 17:03:36 -07001336 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001337 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001338 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
1339 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1340 "without a chained VkSamplerYcbcrConversionInfo struct with the same external format.");
Dave Houltond9611312018-11-19 17:03:36 -07001341 }
1342
1343 // Errors in create_info swizzles
1344 if ((create_info->components.r != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1345 (create_info->components.g != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1346 (create_info->components.b != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1347 (create_info->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001348 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1349 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1350 "includes one or more non-identity component swizzles.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001351 }
1352 }
Dave Houltond9611312018-11-19 17:03:36 -07001353
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001354 return skip;
1355}
1356
John Zulaufa26d3c82019-08-14 16:09:08 -06001357bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001358 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001359
John Zulaufa26d3c82019-08-14 16:09:08 -06001360 const IMAGE_STATE *image_state = GetImageState(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001361 if (image_state->imported_ahb && (0 == image_state->GetBoundMemory().size())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001362 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1363 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1364 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1365 "bound to memory.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001366 }
1367 return skip;
1368}
1369
1370#else
1371
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001372bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001373 return false;
1374}
1375
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001376bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001377
John Zulaufa26d3c82019-08-14 16:09:08 -06001378bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001379
1380#endif // VK_USE_PLATFORM_ANDROID_KHR
1381
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001382bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001383 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001384 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001385
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001386 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001387 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001388 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1389 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001390 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1391 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001392 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001393 }
1394
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001395 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1396 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001397 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1398 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1399 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001400 }
1401
1402 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001403 skip |= LogError(device, "VUID-VkImageCreateInfo-imageType-00954",
1404 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1405 "height (%d) and arrayLayers (%d) must be >= 6.",
1406 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001407 }
Dave Houlton130c0212018-01-29 13:39:56 -07001408 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001409
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001410 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001411 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1412 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1413 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001414 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
1415 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1416 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001417 }
1418
1419 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001420 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
1421 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1422 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001423 }
1424
ByumjinConffx991b6062019-08-14 15:17:53 -07001425 if (device_extensions.vk_ext_fragment_density_map) {
1426 uint32_t ceiling_width =
1427 (uint32_t)ceil((float)device_limits->maxFramebufferWidth /
1428 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, 1.0f));
1429 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1430 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001431 LogError(device, "VUID-VkImageCreateInfo-usage-02559",
1432 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1433 "ceiling of device "
1434 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1435 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1436 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001437 }
1438
1439 uint32_t ceiling_height =
1440 (uint32_t)ceil((float)device_limits->maxFramebufferHeight /
1441 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, 1.0f));
1442 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1443 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001444 LogError(device, "VUID-VkImageCreateInfo-usage-02560",
1445 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1446 "ceiling of device "
1447 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1448 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1449 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001450 }
1451 }
1452
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001453 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001454 VkResult result = VK_SUCCESS;
1455 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1456 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1457 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1458 &format_limits);
1459 } else {
1460 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>();
1461 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1462 image_format_info.type = pCreateInfo->imageType;
1463 image_format_info.tiling = pCreateInfo->tiling;
1464 image_format_info.usage = pCreateInfo->usage;
1465 image_format_info.flags = pCreateInfo->flags;
1466 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1467 format_limits = image_format_properties.imageFormatProperties;
1468 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001469
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001470 if (result == VK_ERROR_FORMAT_NOT_SUPPORTED) {
Lockee87f87c2019-04-23 17:53:10 -06001471#ifdef VK_USE_PLATFORM_ANDROID_KHR
1472 if (!lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext))
1473#endif // VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001474 skip |=
1475 LogError(device, kVUIDUndefined, "vkCreateImage(): Format %s is not supported for this combination of parameters.",
1476 string_VkFormat(pCreateInfo->format));
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001477 } else {
1478 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1479 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001480 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1481 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1482 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001483 }
Dave Houlton130c0212018-01-29 13:39:56 -07001484
Dave Houltona585d132019-01-18 13:05:42 -07001485 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1486 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1487 (uint64_t)pCreateInfo->samples;
1488 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * texel_count);
Dave Houlton130c0212018-01-29 13:39:56 -07001489
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001490 // Round up to imageGranularity boundary
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001491 VkDeviceSize imageGranularity = phys_dev_props.limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001492 uint64_t ig_mask = imageGranularity - 1;
1493 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001494
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001495 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001496 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
1497 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1498 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1499 total_size, format_limits.maxResourceSize);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001500 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001501
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001502 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001503 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
1504 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1505 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001506 }
1507
1508 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001509 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
1510 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
1511 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001512 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001513 }
1514
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001515 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsungcead0802020-01-30 22:20:10 -08001516 if (FormatRequiresYcbcrConversion(pCreateInfo->format)) {
1517 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
1518 const char *error_vuid = (device_extensions.vk_ext_ycbcr_image_arrays) ? "VUID-VkImageCreateInfo-format-02653"
1519 : "VUID-VkImageCreateInfo-format-02564";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001520 skip |= LogError(device, error_vuid,
1521 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
1522 "YCbCr Conversion format, arrayLayers must be 1",
1523 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001524 }
1525
1526 if (pCreateInfo->mipLevels != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001527 skip |= LogError(device, "VUID-VkImageCreateInfo-format-02561",
1528 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
1529 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001530 }
1531
1532 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001533 skip |= LogError(
1534 device, "VUID-VkImageCreateInfo-format-02562",
sfricke-samsungcead0802020-01-30 22:20:10 -08001535 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
1536 string_VkSampleCountFlagBits(pCreateInfo->samples));
1537 }
1538
1539 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001540 skip |= LogError(
1541 device, "VUID-VkImageCreateInfo-format-02563",
sfricke-samsungcead0802020-01-30 22:20:10 -08001542 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
1543 string_VkImageType(pCreateInfo->imageType));
1544 }
1545 }
1546
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06001547 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001548 skip |=
1549 LogError(device, "VUID-VkImageCreateInfo-flags-01924",
1550 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
1551 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06001552 }
1553
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001554 if (device_extensions.vk_khr_maintenance2) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06001555 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
1556 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
1557 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
1558 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001559 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001560 LogError(device, kVUIDUndefined,
1561 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1562 "format must be block, ETC or ASTC compressed, but is %s",
1563 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001564 }
1565 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
1566 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001567 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001568 LogError(device, kVUIDUndefined,
1569 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1570 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001571 }
1572 }
1573 }
1574
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001575 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001576 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateImage",
1577 "pCreateInfo->pQueueFamilyIndices", "VUID-VkImageCreateInfo-sharingMode-01420",
1578 "VUID-VkImageCreateInfo-sharingMode-01420", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001579 }
1580
unknown2c877272019-07-11 12:56:50 -06001581 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
1582 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
1583 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001584 LogError(device, "VUID-VkImageCreateInfo-format-01577",
1585 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
1586 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06001587 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001588 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001589}
1590
John Zulauf7eeb6f72019-06-17 11:56:36 -06001591void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1592 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
1593 if (VK_SUCCESS != result) return;
1594
1595 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
locke-lunarg20699892020-01-02 19:17:29 -07001596 auto image_state = Get<IMAGE_STATE>(*pImage);
1597 AddInitialLayoutintoImageLayoutMap(*image_state, imageLayoutMap);
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001598}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001599
Jeff Bolz5c801d12019-10-09 10:38:45 -05001600bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001601 const IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06001602 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001603 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001604 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001605 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001606 }
1607 return skip;
1608}
1609
John Zulauf7eeb6f72019-06-17 11:56:36 -06001610void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
1611 // Clean up validation specific data
1612 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001613
locke-lunargcba7d5f2019-12-30 16:59:11 -07001614 imageLayoutMap.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06001615
1616 // Clean up generic image state
1617 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001618}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001619
John Zulauf07288512019-07-05 11:09:50 -06001620bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001621 bool skip = false;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001622
1623 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
1624 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 -07001625 skip |= LogError(image_state->image, kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001626 }
1627
Dave Houlton1d2022c2017-03-29 11:43:58 -06001628 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001629 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001630 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -06001631 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001632 char const str[] = "vkCmdClearColorImage called with compressed image.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001633 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001634 }
1635
1636 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
1637 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001638 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-image-00002", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001639 }
1640 return skip;
1641}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001642
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001643uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1644 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1645 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001646 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001647 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001648 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001649 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001650}
1651
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001652uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1653 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1654 uint32_t array_layer_count = range->layerCount;
1655 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1656 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001657 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001658 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001659}
1660
John Zulauf07288512019-07-05 11:09:50 -06001661bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1662 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
1663 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001664 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001665 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1666 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001667 skip |= LogError(image_state->image, "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
1668 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1669 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001670 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001671
1672 } else {
1673 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1674 if (!device_extensions.vk_khr_shared_presentable_image) {
1675 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001676 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-imageLayout-00005",
1677 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1678 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001679 }
1680 } else {
1681 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
1682 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001683 skip |= LogError(
1684 image_state->image, "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001685 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
1686 func_name, string_VkImageLayout(dest_image_layout));
1687 }
1688 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001689 }
1690
John Zulauff660ad62019-03-23 07:16:05 -06001691 // Cast to const to prevent creation at validate time.
John Zulauf07288512019-07-05 11:09:50 -06001692 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06001693 if (subresource_map) {
1694 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001695 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06001696 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
John Zulauf5e617452019-11-19 14:44:16 -07001697 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1698 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06001699 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
1700 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1701 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
1702 } else {
1703 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001704 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001705 subres_skip |= LogError(cb_node->commandBuffer, error_code,
1706 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
1707 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
1708 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001709 }
John Zulauf5e617452019-11-19 14:44:16 -07001710 }
John Zulauff660ad62019-03-23 07:16:05 -06001711 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001712 }
1713
1714 return skip;
1715}
1716
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001717bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1718 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001719 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001720 bool skip = false;
1721 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06001722 const auto *cb_node = GetCBState(commandBuffer);
1723 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001724 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001725 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001726 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001727 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001728 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski544def72019-04-19 14:25:59 -06001729 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001730 skip |=
1731 ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
1732 "VUID-vkCmdClearColorImage-image-01993", "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001733 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001734 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001735 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001736 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001737 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001738 skip |= ValidateImageAttributes(image_state, pRanges[i]);
1739 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001740 }
1741 }
1742 return skip;
1743}
1744
John Zulaufeabb4462019-07-05 14:13:03 -06001745void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1746 const VkClearColorValue *pColor, uint32_t rangeCount,
1747 const VkImageSubresourceRange *pRanges) {
1748 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
1749
1750 auto cb_node = GetCBState(commandBuffer);
1751 auto image_state = GetImageState(image);
1752 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001753 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001754 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001755 }
1756 }
1757}
1758
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001759bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1760 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001761 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001762 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001763
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001764 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06001765 const auto *cb_node = GetCBState(commandBuffer);
1766 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001767 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001768 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06001769 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001770 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001771 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001772 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski544def72019-04-19 14:25:59 -06001773 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001774 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
1775 "VUID-vkCmdClearDepthStencilImage-image-01994",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001776 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001777 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001778 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Andrew Fobel3abeb992020-01-20 16:33:22 -05001779
1780 bool any_include_aspect_depth_bit = false;
1781 bool any_include_aspect_stencil_bit = false;
1782
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001783 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001784 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001785 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001786 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001787 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001788 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1789 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001790 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001791 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1792 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001793 skip |= LogError(commandBuffer, kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001794 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05001795 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
1796 any_include_aspect_depth_bit = true;
1797 }
1798 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
1799 any_include_aspect_stencil_bit = true;
1800 }
1801 }
1802 if (any_include_aspect_stencil_bit) {
1803 const auto image_stencil_struct = lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
1804 if (image_stencil_struct != nullptr) {
1805 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
1806 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001807 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
1808 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
1809 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
1810 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05001811 }
1812 } else {
1813 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001814 skip |= LogError(
1815 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05001816 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
1817 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
1818 "in VkImageCreateInfo::usage used to create image");
1819 }
1820 }
1821 }
1822 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001823 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
1824 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
1825 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001826 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001827 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001828 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001829 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001830 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001831 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1832 char const str[] =
1833 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1834 "set.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001835 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001836 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001837 }
1838 return skip;
1839}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001840
John Zulaufeabb4462019-07-05 14:13:03 -06001841void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1842 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1843 const VkImageSubresourceRange *pRanges) {
1844 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
1845 auto cb_node = GetCBState(commandBuffer);
1846 auto image_state = GetImageState(image);
1847 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001848 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001849 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001850 }
1851 }
1852}
1853
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001854// Returns true if [x, xoffset] and [y, yoffset] overlap
1855static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1856 bool result = false;
1857 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1858 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1859
1860 if (intersection_max > intersection_min) {
1861 result = true;
1862 }
1863 return result;
1864}
1865
Dave Houltonc991cc92018-03-06 11:08:51 -07001866// Returns true if source area of first copy region intersects dest area of second region
1867// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1868static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001869 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001870
Dave Houltonc991cc92018-03-06 11:08:51 -07001871 // Separate planes within a multiplane image cannot intersect
1872 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07001873 return result;
1874 }
1875
Dave Houltonc991cc92018-03-06 11:08:51 -07001876 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
1877 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
1878 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001879 result = true;
1880 switch (type) {
1881 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001882 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001883 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001884 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001885 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001886 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001887 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001888 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001889 break;
1890 default:
1891 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1892 assert(false);
1893 }
1894 }
1895 return result;
1896}
1897
Dave Houltonfc1a4052017-04-27 14:32:45 -06001898// Returns non-zero if offset and extent exceed image extents
1899static const uint32_t x_bit = 1;
1900static const uint32_t y_bit = 2;
1901static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001902static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001903 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001904 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001905 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1906 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001907 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001908 }
1909 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1910 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001911 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001912 }
1913 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1914 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001915 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001916 }
1917 return result;
1918}
1919
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001920// Test if two VkExtent3D structs are equivalent
1921static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1922 bool result = true;
1923 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1924 (extent->depth != other_extent->depth)) {
1925 result = false;
1926 }
1927 return result;
1928}
1929
Dave Houltonee281a52017-12-08 13:51:02 -07001930// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1931// Destination image texel extents must be adjusted by block size for the dest validation checks
1932VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1933 VkExtent3D adjusted_extent = extent;
unknown948b6ba2019-09-19 17:32:54 -06001934 if ((FormatIsCompressed(src_format) || FormatIsSinglePlane_422(src_format)) &&
1935 !(FormatIsCompressed(dst_format) || FormatIsSinglePlane_422(dst_format))) {
Dave Houltona585d132019-01-18 13:05:42 -07001936 VkExtent3D block_size = FormatTexelBlockExtent(src_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001937 adjusted_extent.width /= block_size.width;
1938 adjusted_extent.height /= block_size.height;
1939 adjusted_extent.depth /= block_size.depth;
unknown948b6ba2019-09-19 17:32:54 -06001940 } else if (!(FormatIsCompressed(src_format) || FormatIsSinglePlane_422(src_format)) &&
1941 (FormatIsCompressed(dst_format) || FormatIsSinglePlane_422(dst_format))) {
Dave Houltona585d132019-01-18 13:05:42 -07001942 VkExtent3D block_size = FormatTexelBlockExtent(dst_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001943 adjusted_extent.width *= block_size.width;
1944 adjusted_extent.height *= block_size.height;
1945 adjusted_extent.depth *= block_size.depth;
1946 }
1947 return adjusted_extent;
1948}
1949
Dave Houlton6f9059e2017-05-02 17:15:13 -06001950// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001951static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1952 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001953
1954 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06001955 if (mip >= img->createInfo.mipLevels) {
1956 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06001957 }
Dave Houlton1150cf52017-04-27 14:38:11 -06001958
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001959 // 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 -06001960 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05001961
Dave Houltone48cd112019-01-03 17:01:18 -07001962 // If multi-plane, adjust per-plane extent
1963 if (FormatIsMultiplane(img->createInfo.format)) {
1964 VkExtent2D divisors = FindMultiplaneExtentDivisors(img->createInfo.format, subresource->aspectMask);
1965 extent.width /= divisors.width;
1966 extent.height /= divisors.height;
1967 }
1968
Jeff Bolzef40fec2018-09-01 22:04:34 -05001969 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
1970 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
Dave Houlton142c4cb2018-10-17 15:04:41 -06001971 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1) >> mip)));
Jeff Bolzef40fec2018-09-01 22:04:34 -05001972 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
1973 } else {
1974 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1975 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1976 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
1977 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06001978
Dave Houlton6f9059e2017-05-02 17:15:13 -06001979 // Image arrays have an effective z extent that isn't diminished by mip level
1980 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001981 extent.depth = img->createInfo.arrayLayers;
1982 }
1983
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001984 return extent;
1985}
1986
1987// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001988static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001989 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1990}
1991
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001992// Test if the extent argument has any dimensions set to 0.
1993static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1994 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1995}
1996
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001997// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001998VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001999 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2000 VkExtent3D granularity = {0, 0, 0};
Jeff Bolz6835fda2019-10-06 00:15:34 -05002001 auto pPool = cb_node->command_pool.get();
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002002 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002003 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06002004 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002005 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002006 granularity.width *= block_size.width;
2007 granularity.height *= block_size.height;
2008 }
2009 }
2010 return granularity;
2011}
2012
2013// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2014static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2015 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002016 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2017 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002018 valid = false;
2019 }
2020 return valid;
2021}
2022
2023// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002024bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002025 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002026 bool skip = false;
2027 VkExtent3D offset_extent = {};
2028 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2029 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2030 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002031 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002032 // 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 -07002033 if (IsExtentAllZeroes(&offset_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002034 skip |= LogError(cb_node->commandBuffer, vuid,
2035 "%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 "
2036 "image transfer granularity is (w=0, h=0, d=0).",
2037 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002038 }
2039 } else {
2040 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2041 // integer multiples of the image transfer granularity.
2042 if (IsExtentAligned(&offset_extent, granularity) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002043 skip |= LogError(cb_node->commandBuffer, vuid,
2044 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2045 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2046 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2047 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002048 }
2049 }
2050 return skip;
2051}
2052
2053// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002054bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002055 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002056 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002057 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002058 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002059 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2060 // subresource extent.
2061 if (IsExtentEqual(extent, subresource_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002062 skip |= LogError(cb_node->commandBuffer, vuid,
2063 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2064 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2065 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2066 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002067 }
2068 } else {
2069 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2070 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2071 // subresource extent dimensions.
2072 VkExtent3D offset_extent_sum = {};
2073 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2074 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2075 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002076 bool x_ok = true;
2077 bool y_ok = true;
2078 bool z_ok = true;
2079 switch (image_type) {
2080 case VK_IMAGE_TYPE_3D:
2081 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2082 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002083 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002084 case VK_IMAGE_TYPE_2D:
2085 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2086 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002087 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002088 case VK_IMAGE_TYPE_1D:
2089 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2090 (subresource_extent->width == offset_extent_sum.width));
2091 break;
2092 default:
2093 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2094 assert(false);
2095 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002096 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002097 skip |=
2098 LogError(cb_node->commandBuffer, vuid,
2099 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2100 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2101 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2102 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2103 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2104 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002105 }
2106 }
2107 return skip;
2108}
2109
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002110bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002111 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002112 bool skip = false;
2113 if (mip_level >= img->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002114 skip |= LogError(cb_node->commandBuffer, vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2115 function, i, member, mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002116 }
2117 return skip;
2118}
2119
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002120bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002121 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002122 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002123 bool skip = false;
2124 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2125 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002126 skip |= LogError(cb_node->commandBuffer, vuid,
2127 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2128 "%u, but provided %s has %u array layers.",
2129 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2130 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002131 }
2132 return skip;
2133}
2134
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002135// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002136bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002137 const VkBufferImageCopy *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002138 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002139 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002140 VkExtent3D granularity = GetScaledItg(cb_node, img);
2141 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002142 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002143 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002144 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002145 return skip;
2146}
2147
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002148// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002149bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002150 const IMAGE_STATE *dst_img, const VkImageCopy *region,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002151 const uint32_t i, const char *function) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002152 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002153 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002154 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
2155 skip |=
2156 CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002157 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002158 const VkExtent3D extent = region->extent;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002159 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
2160 i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002161
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002162 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002163 granularity = GetScaledItg(cb_node, dst_img);
2164 skip |=
2165 CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002166 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002167 const VkExtent3D dest_effective_extent =
2168 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002169 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002170 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002171 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002172 return skip;
2173}
2174
Dave Houlton6f9059e2017-05-02 17:15:13 -06002175// Validate contents of a VkImageCopy struct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002176bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const VkImageCopy *ic_regions, const IMAGE_STATE *src_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002177 const IMAGE_STATE *dst_state) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002178 bool skip = false;
2179
2180 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002181 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002182
2183 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002184 const VkExtent3D src_copy_extent = region.extent;
2185 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002186 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2187
Dave Houlton6f9059e2017-05-02 17:15:13 -06002188 bool slice_override = false;
2189 uint32_t depth_slices = 0;
2190
2191 // Special case for copying between a 1D/2D array and a 3D image
2192 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2193 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002194 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002195 slice_override = (depth_slices != 1);
2196 } 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 -07002197 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002198 slice_override = (depth_slices != 1);
2199 }
2200
2201 // Do all checks on source image
2202 //
2203 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002204 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002205 skip |=
2206 LogError(src_state->image, "VUID-VkImageCopy-srcImage-00146",
2207 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2208 "be 0 and 1, respectively.",
2209 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002210 }
2211 }
2212
Dave Houlton533be9f2018-03-26 17:08:30 -06002213 // VUID-VkImageCopy-srcImage-01785
2214 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 -07002215 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-01785",
2216 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
2217 "these must be 0 and 1, respectively.",
2218 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002219 }
2220
Dave Houlton533be9f2018-03-26 17:08:30 -06002221 // VUID-VkImageCopy-srcImage-01787
2222 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002223 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-01787",
2224 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2225 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002226 }
2227
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002228 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002229 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002230 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002231 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002232 LogError(src_state->image, "VUID-VkImageCopy-srcImage-00141",
2233 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2234 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2235 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002236 }
2237 }
2238 } else { // Pre maint 1
2239 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002240 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002241 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-00141",
2242 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2243 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2244 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2245 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002246 }
2247 }
2248 }
2249
Dave Houltonc991cc92018-03-06 11:08:51 -07002250 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002251 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002252 if (FormatIsCompressed(src_state->createInfo.format) ||
2253 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002254 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002255 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002256 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2257 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2258 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002259 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002260 skip |= LogError(src_state->image, vuid,
2261 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
2262 "texel width & height (%d, %d).",
2263 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002264 }
2265
Dave Houlton94a00372017-12-14 15:08:47 -07002266 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002267 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2268 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002269 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002270 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002271 LogError(src_state->image, vuid,
2272 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2273 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2274 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002275 }
2276
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002277 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002278 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2279 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002280 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002281 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002282 LogError(src_state->image, vuid,
2283 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2284 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2285 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002286 }
2287
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002288 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002289 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2290 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002291 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002292 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002293 LogError(src_state->image, vuid,
2294 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2295 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2296 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002297 }
2298 } // Compressed
2299
2300 // Do all checks on dest image
2301 //
2302 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002303 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002304 skip |= LogError(dst_state->image, "VUID-VkImageCopy-dstImage-00152",
2305 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
2306 "these must be 0 and 1, respectively.",
2307 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002308 }
2309 }
2310
Dave Houlton533be9f2018-03-26 17:08:30 -06002311 // VUID-VkImageCopy-dstImage-01786
2312 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 -07002313 skip |=
2314 LogError(dst_state->image, "VUID-VkImageCopy-dstImage-01786",
2315 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2316 "and 1, respectively.",
2317 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002318 }
2319
2320 // VUID-VkImageCopy-dstImage-01788
2321 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002322 skip |= LogError(dst_state->image, "VUID-VkImageCopy-dstImage-01788",
2323 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2324 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002325 }
2326
2327 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002328 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002329 skip |= LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00141",
2330 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2331 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2332 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002333 }
2334 }
2335 // VU01199 changed with mnt1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002336 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002337 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002338 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002339 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002340 LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00141",
2341 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2342 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2343 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002344 }
2345 }
2346 } else { // Pre maint 1
2347 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002348 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002349 skip |= LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00141",
2350 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2351 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2352 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2353 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002354 }
2355 }
2356 }
2357
Dave Houltonc991cc92018-03-06 11:08:51 -07002358 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2359 if (FormatIsCompressed(dst_state->createInfo.format) ||
2360 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002361 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002362
2363 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002364 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2365 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2366 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002367 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002368 skip |= LogError(dst_state->image, vuid,
2369 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
2370 "texel width & height (%d, %d).",
2371 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002372 }
2373
Dave Houlton94a00372017-12-14 15:08:47 -07002374 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002375 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2376 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002377 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002378 skip |= LogError(
2379 dst_state->image, vuid,
2380 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2381 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2382 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002383 }
2384
Dave Houltonee281a52017-12-08 13:51:02 -07002385 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2386 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2387 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002388 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002389 skip |= LogError(dst_state->image, vuid,
2390 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2391 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2392 "height (%d).",
2393 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002394 }
2395
Dave Houltonee281a52017-12-08 13:51:02 -07002396 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2397 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2398 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002399 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002400 skip |= LogError(
2401 dst_state->image, vuid,
2402 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2403 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2404 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002405 }
2406 } // Compressed
2407 }
2408 return skip;
2409}
2410
Dave Houltonc991cc92018-03-06 11:08:51 -07002411// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002412bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002413 const IMAGE_STATE *dst_image_state, const VkImageCopy region) const {
Dave Houltonc991cc92018-03-06 11:08:51 -07002414 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002415
2416 // Neither image is multiplane
2417 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2418 // If neither image is multi-plane the aspectMask member of src and dst must match
2419 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2420 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002421 ss << "vkCmdCopyImage(): Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002422 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002423 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002424 }
2425 } else {
2426 // Source image multiplane checks
2427 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2428 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2429 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2430 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002431 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002432 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002433 }
2434 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2435 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2436 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002437 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002438 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002439 }
2440 // Single-plane to multi-plane
2441 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2442 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2443 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002444 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002445 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002446 }
2447
2448 // Dest image multiplane checks
2449 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2450 aspect = region.dstSubresource.aspectMask;
2451 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2452 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002453 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002454 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002455 }
2456 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2457 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2458 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002459 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002460 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002461 }
2462 // Multi-plane to single-plane
2463 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2464 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2465 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002466 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002467 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002468 }
2469 }
2470
2471 return skip;
2472}
2473
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002474bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2475 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002476 const VkImageCopy *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002477 const auto *cb_node = GetCBState(commandBuffer);
2478 const auto *src_image_state = GetImageState(srcImage);
2479 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002480 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002481
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002482 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002483
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002484 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2485
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002486 for (uint32_t i = 0; i < regionCount; i++) {
2487 const VkImageCopy region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002488
2489 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2490 VkExtent3D src_copy_extent = region.extent;
2491 VkExtent3D dst_copy_extent =
2492 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
2493
Dave Houlton6f9059e2017-05-02 17:15:13 -06002494 bool slice_override = false;
2495 uint32_t depth_slices = 0;
2496
2497 // Special case for copying between a 1D/2D array and a 3D image
2498 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2499 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2500 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002501 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002502 slice_override = (depth_slices != 1);
2503 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2504 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002505 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002506 slice_override = (depth_slices != 1);
2507 }
2508
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002509 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2510 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
2511 skip |= ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002512 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002513 skip |= ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002514 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002515 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002516 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2517 "VUID-vkCmdCopyImage-srcSubresource-01698");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002518 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002519 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2520 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002521
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002522 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002523 // No chance of mismatch if we're overriding depth slice count
2524 if (!slice_override) {
2525 // The number of depth slices in srcSubresource and dstSubresource must match
2526 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2527 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002528 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2529 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002530 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002531 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2532 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002533 if (src_slices != dst_slices) {
2534 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002535 ss << "vkCmdCopyImage(): number of depth slices in source and destination subresources for pRegions[" << i
Dave Houlton6f9059e2017-05-02 17:15:13 -06002536 << "] do not match";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002537 skip |= LogError(command_buffer, "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06002538 }
2539 }
2540 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002541 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002542 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002543 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002544 ss << "vkCmdCopyImage(): number of layers in source and destination subresources for pRegions[" << i
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002545 << "] do not match";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002546 skip |= LogError(command_buffer, "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002547 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002548 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002549
Dave Houltonc991cc92018-03-06 11:08:51 -07002550 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002551 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002552 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region);
Dave Houltonc991cc92018-03-06 11:08:51 -07002553 }
2554
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002555 if (!device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002556 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2557 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002558 char const str[] = "vkCmdCopyImage(): Src and dest aspectMasks for each region must match";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002559 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002560 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002561 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002562
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002563 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07002564 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002565 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002566 ss << "vkCmdCopyImage(): pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002567 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002568 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002569 }
2570
2571 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07002572 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002573 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002574 ss << "vkCmdCopyImage(): pRegion[" << i
2575 << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002576 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002577 }
2578
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002579 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
2580 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
2581 // 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 -07002582 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2583 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002584 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002585 ss << "vkCmdCopyImage(): Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002586 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
2587 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
2588 << " ] exceeds the source image dimensions";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002589 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-pRegions-00122", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002590 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002591
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002592 // 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 -07002593 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2594 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002595 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002596 ss << "vkCmdCopyImage(): Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002597 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
2598 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
2599 << " ] exceeds the destination image dimensions";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002600 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-pRegions-00123", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002601 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002602 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002603
Dave Houltonfc1a4052017-04-27 14:32:45 -06002604 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002605 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2606 if (slice_override) src_copy_extent.depth = depth_slices;
2607 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002608 if (extent_check & x_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002609 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002610 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00144",
2611 "vkCmdCopyImage(): Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2612 "width [%1d].",
2613 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002614 }
2615
2616 if (extent_check & y_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002617 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002618 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00145",
2619 "vkCmdCopyImage(): Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2620 "height [%1d].",
2621 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002622 }
2623 if (extent_check & z_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002624 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002625 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00147",
2626 "vkCmdCopyImage(): Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2627 "depth [%1d].",
2628 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002629 }
2630
Dave Houltonee281a52017-12-08 13:51:02 -07002631 // Adjust dest extent if necessary
2632 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2633 if (slice_override) dst_copy_extent.depth = depth_slices;
2634
2635 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002636 if (extent_check & x_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002637 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00150",
2638 "vkCmdCopyImage(): Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2639 "width [%1d].",
2640 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002641 }
2642 if (extent_check & y_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002643 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00151",
2644 "vkCmdCopyImage(): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2645 "height [%1d].",
2646 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002647 }
2648 if (extent_check & z_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002649 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00153",
2650 "vkCmdCopyImage(): Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2651 "depth [%1d].",
2652 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002653 }
2654
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002655 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2656 // must not overlap in memory
2657 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002658 for (uint32_t j = 0; j < regionCount; j++) {
2659 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
Dave Houltonf5217612018-02-02 16:18:52 -07002660 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002661 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002662 ss << "vkCmdCopyImage(): pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002663 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002664 }
2665 }
2666 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08002667
2668 // Check depth for 2D as post Maintaince 1 requires both while prior only required one to be 2D
2669 if (device_extensions.vk_khr_maintenance1) {
2670 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
2671 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
2672 (src_copy_extent.depth != 1)) {
2673 skip |= LogError(
2674 command_buffer, "VUID-VkImageCopy-srcImage-01790",
2675 "vkCmdCopyImage(): pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1", i,
2676 src_copy_extent.depth);
2677 }
2678 } else {
2679 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
2680 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
2681 (src_copy_extent.depth != 1)) {
2682 skip |= LogError(
2683 command_buffer, "VUID-VkImageCopy-srcImage-01789",
2684 "vkCmdCopyImage(): pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1", i,
2685 src_copy_extent.depth);
2686 }
2687 }
2688
2689 // Check if 2D with 3D and depth not equal to 2D layerCount
2690 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
2691 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2692 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
2693 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01791",
2694 "vkCmdCopyImage(): pRegion[%u] srcImage is 2D, dstImage is 3D and extent.depth is %u and has to be "
2695 "srcSubresource.layerCount (%u)",
2696 i, src_copy_extent.depth, region.srcSubresource.layerCount);
2697 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2698 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
2699 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
2700 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01792",
2701 "vkCmdCopyImage(): pRegion[%u] srcImage is 3D, dstImage is 2D and extent.depth is %u and has to be "
2702 "dstSubresource.layerCount (%u)",
2703 i, src_copy_extent.depth, region.dstSubresource.layerCount);
2704 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002705 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002706
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002707 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2708 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2709 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002710 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002711 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2712 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002713 skip |= LogError(command_buffer, kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002714 }
2715 } else {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002716 if (!FormatSizesAreEqual(src_image_state->createInfo.format, dst_image_state->createInfo.format, regionCount, pRegions)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002717 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002718 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-srcImage-00135", "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002719 }
2720 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002721
Dave Houlton33c22b72017-02-28 13:16:02 -07002722 // Source and dest image sample counts must match
2723 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2724 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002725 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002726 }
2727
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002728 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2729 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002730 // Validate that SRC & DST images have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002731 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyImage-srcImage-00126",
2732 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2733 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyImage-dstImage-00131",
2734 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06002735 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002736 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
2737 "VUID-vkCmdCopyImage-srcImage-01995", "VUID-vkCmdCopyImage-srcImage-01995");
2738 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
2739 "VUID-vkCmdCopyImage-dstImage-01996", "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002740 }
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002741 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyImage()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002742 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002743 skip |= ValidateCmd(cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
2744 skip |= InsideRenderPass(cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002745 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002746 const char *invalid_src_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2747 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2748 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
2749 const char *invalid_dst_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2750 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2751 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002752 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002753 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002754 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2755 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002756 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002757 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2758 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002759 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
2760 "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002761 }
2762
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002763 return skip;
2764}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002765
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002766void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2767 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2768 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06002769 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
2770 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06002771 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002772 auto src_image_state = GetImageState(srcImage);
2773 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002774
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002775 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002776 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002777 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
2778 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002779 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002780}
2781
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002782// Returns true if sub_rect is entirely contained within rect
2783static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2784 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2785 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2786 return false;
2787 return true;
2788}
2789
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002790bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002791 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
2792 const VkRect2D &render_area, uint32_t rect_count,
2793 const VkClearRect *clear_rects) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07002794 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07002795 const IMAGE_VIEW_STATE *image_view_state = nullptr;
2796 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07002797 image_view_state = GetImageViewState(framebuffer->createInfo.pAttachments[fb_attachment]);
John Zulauff2582972019-02-09 14:53:30 -07002798 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002799
2800 for (uint32_t j = 0; j < rect_count; j++) {
2801 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002802 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00016",
2803 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2804 "the current render pass instance.",
2805 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07002806 }
2807
2808 if (image_view_state) {
2809 // The layers specified by a given element of pRects must be contained within every attachment that
2810 // pAttachments refers to
2811 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
2812 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
2813 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002814 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00017",
2815 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
2816 "of pAttachment[%d].",
2817 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07002818 }
2819 }
2820 }
2821 return skip;
2822}
2823
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002824bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2825 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002826 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002827 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06002828 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02002829 if (!cb_node) return skip;
2830
2831 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
2832 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
2833 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Petr Kraus2dffb382019-08-10 02:52:12 +02002834 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002835
2836 // Validate that attachment is in reference list of active subpass
2837 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002838 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07002839 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01002840 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002841 const auto *framebuffer = GetFramebufferState(cb_node->activeFramebuffer);
John Zulauf3a548ef2019-02-01 16:14:07 -07002842 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002843
John Zulauf3a548ef2019-02-01 16:14:07 -07002844 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2845 auto clear_desc = &pAttachments[attachment_index];
2846 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002847
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002848 if (0 == clear_desc->aspectMask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002849 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002850 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002851 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002852 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07002853 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
2854 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
2855 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2856 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002857 skip |= LogError(
2858 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
2859 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
2860 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
2861 attachment_index, clear_desc->colorAttachment,
2862 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
2863 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07002864
John Zulauff2582972019-02-09 14:53:30 -07002865 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
2866 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002867 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002868 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
2869 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
2870 " subpass %u. colorAttachmentCount=%u",
2871 attachment_index, clear_desc->colorAttachment,
2872 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
2873 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002874 }
John Zulauff2582972019-02-09 14:53:30 -07002875 fb_attachment = color_attachment;
2876
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002877 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2878 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2879 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002880 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002881 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002882 }
2883 } else { // Must be depth and/or stencil
2884 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2885 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002886 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002887 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-parameter", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002888 }
2889 if (!subpass_desc->pDepthStencilAttachment ||
2890 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002891 skip |= LogPerformanceWarning(
2892 commandBuffer, kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002893 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002894 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07002895 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002896 }
2897 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002898 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002899 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
2900 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06002901 }
2902 }
2903 }
2904 return skip;
2905}
2906
2907void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2908 const VkClearAttachment *pAttachments, uint32_t rectCount,
2909 const VkClearRect *pRects) {
2910 auto *cb_node = GetCBState(commandBuffer);
2911 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
2912 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
2913 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
2914 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
2915 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2916 const auto clear_desc = &pAttachments[attachment_index];
2917 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
2918 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
2919 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
2920 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2921 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
2922 subpass_desc->pDepthStencilAttachment) {
2923 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
2924 }
2925 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07002926 if (!clear_rect_copy) {
2927 // We need a copy of the clear rectangles that will persist until the last lambda executes
2928 // but we want to create it as lazily as possible
2929 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002930 }
John Zulauf441558b2019-08-12 11:47:39 -06002931 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
2932 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002933 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
John Zulauff1640d12019-08-13 15:39:58 -06002934 const CMD_BUFFER_STATE *prim_cb, VkFramebuffer fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07002935 assert(rectCount == clear_rect_copy->size());
John Zulauf441558b2019-08-12 11:47:39 -06002936 const FRAMEBUFFER_STATE *framebuffer = GetFramebufferState(fb);
John Zulauf3a548ef2019-02-01 16:14:07 -07002937 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
2938 bool skip = false;
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002939 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
2940 rectCount, clear_rect_copy->data());
John Zulauf3a548ef2019-02-01 16:14:07 -07002941 return skip;
2942 };
2943 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002944 }
2945 }
2946 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002947}
2948
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002949bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2950 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002951 const VkImageResolve *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002952 const auto *cb_node = GetCBState(commandBuffer);
2953 const auto *src_image_state = GetImageState(srcImage);
2954 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002955
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002956 bool skip = false;
2957 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002958 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-srcImage-00256");
2959 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-00258");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002960 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002961 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002962 skip |= ValidateCmd(cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
2963 skip |= InsideRenderPass(cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002964 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, "vkCmdResolveImage()",
2965 "VUID-vkCmdResolveImage-dstImage-02003", "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002966
Cort Stratton7df30962018-05-17 19:45:57 -07002967 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002968 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002969 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002970 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
2971 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
2972 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002973 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002974 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
2975 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002976 // For each region, the number of layers in the image subresource should not be zero
2977 // For each region, src and dest image aspect must be color only
2978 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002979 skip |=
2980 ValidateImageSubresourceLayers(cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()", "srcSubresource", i);
2981 skip |=
2982 ValidateImageSubresourceLayers(cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()", "dstSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002983 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002984 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
2985 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002986 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002987 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
2988 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002989 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i, "vkCmdResolveImage()",
2990 "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
2991 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i, "vkCmdResolveImage()",
2992 "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
2993 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002994 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2995 "VUID-vkCmdResolveImage-srcSubresource-01711");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002996 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002997 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2998 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07002999
3000 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003001 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003002 skip |= LogError(
3003 cb_node->commandBuffer, "VUID-VkImageResolve-layerCount-00267",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003004 "vkCmdResolveImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003005 }
Cort Stratton7df30962018-05-17 19:45:57 -07003006 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003007 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3008 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
3009 char const str[] =
Graeme Leese79b60cb2018-11-28 11:51:20 +00003010 "vkCmdResolveImage(): src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003011 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003012 }
3013 }
3014
3015 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
3016 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003017 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003018 }
3019 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
3020 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003021 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageType, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003022 }
3023 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
3024 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003025 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-srcImage-00257", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003026 }
3027 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
3028 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003029 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-dstImage-00259", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003030 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003031 } else {
3032 assert(0);
3033 }
3034 return skip;
3035}
3036
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003037bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3038 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003039 const VkImageBlit *pRegions, VkFilter filter) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003040 const auto *cb_node = GetCBState(commandBuffer);
3041 const auto *src_image_state = GetImageState(srcImage);
3042 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003043
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003044 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003045 if (cb_node) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003046 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
John Zulauf5c2750c2018-01-30 15:04:56 -07003047 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003048 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003049 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003050 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003051 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003052 "VUID-vkCmdBlitImage-dstImage-00234");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003053 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
3054 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
Dave Houltond8ed0212018-05-16 17:18:24 -06003055 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003056 ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdBlitImage-srcImage-00219",
3057 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06003058 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003059 ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdBlitImage-dstImage-00224",
3060 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003061 skip |=
3062 ValidateCmdQueueFlags(cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003063 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
3064 skip |= InsideRenderPass(cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003065 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003066 "VUID-vkCmdBlitImage-srcImage-01999", "VUID-vkCmdBlitImage-srcImage-01999");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003067 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003068 "VUID-vkCmdBlitImage-dstImage-02000", "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04003069
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003070 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003071
Dave Houlton33c2d252017-06-09 17:08:32 -06003072 VkFormat src_format = src_image_state->createInfo.format;
3073 VkFormat dst_format = dst_image_state->createInfo.format;
3074 VkImageType src_type = src_image_state->createInfo.imageType;
3075 VkImageType dst_type = dst_image_state->createInfo.imageType;
3076
Cort Stratton186b1a22018-05-01 20:18:06 -04003077 if (VK_FILTER_LINEAR == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003078 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003079 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001",
3080 "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04003081 } else if (VK_FILTER_CUBIC_IMG == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003082 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
3083 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02002",
3084 "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06003085 }
3086
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003087 if (FormatRequiresYcbcrConversion(src_format)) {
3088 skip |= LogError(device, "VUID-vkCmdBlitImage-srcImage-01561",
3089 "vkCmdBlitImage(): srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
3090 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
3091 string_VkFormat(src_format));
3092 }
3093
3094 if (FormatRequiresYcbcrConversion(dst_format)) {
3095 skip |= LogError(device, "VUID-vkCmdBlitImage-dstImage-01562",
3096 "vkCmdBlitImage(): dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
3097 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
3098 string_VkFormat(dst_format));
3099 }
3100
Dave Houlton33c2d252017-06-09 17:08:32 -06003101 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003102 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-filter-00237",
3103 "vkCmdBlitImage(): source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003104 }
3105
Dave Houlton33c2d252017-06-09 17:08:32 -06003106 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
3107 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003108 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00228",
3109 "vkCmdBlitImage(): source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003110 }
3111
3112 // Validate consistency for unsigned formats
3113 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3114 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003115 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003116 << "the other one must also have unsigned integer format. "
3117 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003118 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003119 }
3120
3121 // Validate consistency for signed formats
3122 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3123 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003124 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003125 << "the other one must also have signed integer format. "
3126 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003127 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003128 }
3129
3130 // Validate filter for Depth/Stencil formats
3131 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3132 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003133 ss << "vkCmdBlitImage(): If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003134 << "then filter must be VK_FILTER_NEAREST.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003135 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003136 }
3137
3138 // Validate aspect bits and formats for depth/stencil images
3139 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3140 if (src_format != dst_format) {
3141 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003142 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003143 << "stencil, the other one must have exactly the same format. "
3144 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3145 << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003146 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003147 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003148 } // Depth or Stencil
3149
3150 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003151 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003152 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003153 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3154 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3155 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003156 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003157 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3158 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003159 for (uint32_t i = 0; i < regionCount; i++) {
3160 const VkImageBlit rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003161 bool hit_error = false;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003162 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003163 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3164 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003165 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003166 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3167 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003168 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3169 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
3170 skip |= ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003171 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003172 skip |= ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003173 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003174 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003175 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3176 "VUID-vkCmdBlitImage-srcSubresource-01707");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003177 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003178 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3179 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003180 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003181 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3182 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003183 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003184 ss << "vkCmdBlitImage(): pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003185 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003186 }
Dave Houlton48989f32017-05-26 15:01:46 -06003187 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3188 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003189 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003190 ss << "vkCmdBlitImage(): pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003191 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003192 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003193
3194 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003195 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003196 skip |= LogError(
3197 cb_node->commandBuffer, "VUID-VkImageBlit-layerCount-00239",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003198 "vkCmdBlitImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003199 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003200
Dave Houlton48989f32017-05-26 15:01:46 -06003201 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003202 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00238",
3203 "vkCmdBlitImage(): aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003204 }
Dave Houlton48989f32017-05-26 15:01:46 -06003205
Dave Houlton33c2d252017-06-09 17:08:32 -06003206 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003207 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00241",
3208 "vkCmdBlitImage(): region [%d] source aspectMask (0x%x) specifies aspects not present in source "
3209 "image format %s.",
3210 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003211 }
3212
3213 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003214 skip |= LogError(
3215 cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00242",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003216 "vkCmdBlitImage(): region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3217 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003218 }
3219
Dave Houlton48989f32017-05-26 15:01:46 -06003220 // Validate source image offsets
3221 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003222 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003223 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003224 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003225 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00245",
3226 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3227 "of (%1d, %1d). These must be (0, 1).",
3228 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003229 }
3230 }
3231
Dave Houlton33c2d252017-06-09 17:08:32 -06003232 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003233 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003234 skip |=
3235 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00247",
3236 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3237 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3238 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003239 }
3240 }
3241
Dave Houlton33c2d252017-06-09 17:08:32 -06003242 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003243 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3244 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003245 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003246 skip |= LogError(
3247 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00243",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003248 "vkCmdBlitImage(): region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).", i,
3249 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003250 }
3251 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3252 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003253 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003254 skip |= LogError(
3255 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00244",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003256 "vkCmdBlitImage(): region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003257 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003258 }
3259 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3260 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003261 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003262 skip |= LogError(
3263 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00246",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003264 "vkCmdBlitImage(): region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).", i,
3265 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003266 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003267 if (oob) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003268 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-pRegions-00215",
3269 "vkCmdBlitImage(): region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003270 }
Dave Houlton48989f32017-05-26 15:01:46 -06003271
3272 // Validate dest image offsets
3273 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003274 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003275 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003276 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003277 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-dstImage-00250",
3278 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3279 "(%1d, %1d). These must be (0, 1).",
3280 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003281 }
3282 }
3283
Dave Houlton33c2d252017-06-09 17:08:32 -06003284 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003285 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003286 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-dstImage-00252",
3287 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3288 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3289 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003290 }
3291 }
3292
Dave Houlton33c2d252017-06-09 17:08:32 -06003293 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003294 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3295 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003296 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003297 skip |= LogError(
3298 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00248",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003299 "vkCmdBlitImage(): region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).", i,
3300 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003301 }
3302 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3303 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003304 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003305 skip |= LogError(
3306 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00249",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003307 "vkCmdBlitImage(): region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003308 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003309 }
3310 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3311 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003312 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003313 skip |= LogError(
3314 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00251",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003315 "vkCmdBlitImage(): region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).", i,
3316 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003317 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003318 if (oob) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003319 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-pRegions-00216",
3320 "vkCmdBlitImage(): region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003321 }
3322
Dave Houlton33c2d252017-06-09 17:08:32 -06003323 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3324 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3325 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003326 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003327 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00240",
3328 "vkCmdBlitImage(): region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3329 "layerCount other than 1.",
3330 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003331 }
3332 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003333 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003334 } else {
3335 assert(0);
3336 }
3337 return skip;
3338}
3339
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003340void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3341 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3342 const VkImageBlit *pRegions, VkFilter filter) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003343 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3344 pRegions, filter);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003345 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003346 auto src_image_state = GetImageState(srcImage);
3347 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003348
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003349 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003350 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003351 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3352 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003353 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003354}
3355
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003356// 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 -07003357bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const ImageLayoutMap &globalImageLayoutMap,
3358 ImageLayoutMap *overlayLayoutMap_arg) const {
Matthew Ruschd7ef5482019-07-16 22:01:54 -07003359 if (disabled.image_layout_validation) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003360 bool skip = false;
locke-lunargcba7d5f2019-12-30 16:59:11 -07003361 ImageLayoutMap &overlayLayoutMap = *overlayLayoutMap_arg;
John Zulauff660ad62019-03-23 07:16:05 -06003362 // Iterate over the layout maps for each referenced image
3363 for (const auto &layout_map_entry : pCB->image_layout_map) {
3364 const auto image = layout_map_entry.first;
3365 const auto *image_state = GetImageState(image);
3366 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06003367 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06003368 ImageSubresourcePair isr_pair;
3369 isr_pair.image = image;
3370 isr_pair.hasSubresource = true;
John Zulauff660ad62019-03-23 07:16:05 -06003371 // Validate the initial_uses for each subresource referenced
John Zulauf6066f732019-11-21 13:15:10 -07003372 for (const auto &pos : subres_map->InitialLayoutView()) {
3373 isr_pair.subresource = pos.subresource;
3374 VkImageLayout initial_layout = pos.it->second; // Point directly into the RangeMap iterated but the view
John Zulauff660ad62019-03-23 07:16:05 -06003375 VkImageLayout image_layout;
3376 if (FindLayout(overlayLayoutMap, isr_pair, image_layout) || FindLayout(globalImageLayoutMap, isr_pair, image_layout)) {
3377 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
3378 // TODO: Set memory invalid which is in mem_tracker currently
3379 } else if (image_layout != initial_layout) {
John Zulaufb61ed972019-04-09 16:12:35 -06003380 // Need to look up the inital layout *state* to get a bit more information
3381 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(isr_pair.subresource);
3382 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
3383 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
3384 if (!matches) {
3385 std::string formatted_label = FormatDebugLabel(" ", pCB->debug_label);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003386 skip |= LogError(
3387 pCB->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06003388 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
locke-lunargadbb54c2019-06-26 00:05:17 -06003389 "to be in layout %s--instead, current layout is %s.%s",
unknown089cdb82019-07-11 12:58:43 -06003390 report_data->FormatHandle(image).c_str(), isr_pair.subresource.aspectMask,
locke-lunargadbb54c2019-06-26 00:05:17 -06003391 isr_pair.subresource.arrayLayer, isr_pair.subresource.mipLevel, string_VkImageLayout(initial_layout),
3392 string_VkImageLayout(image_layout), formatted_label.c_str());
John Zulaufb61ed972019-04-09 16:12:35 -06003393 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003394 }
3395 }
John Zulauff660ad62019-03-23 07:16:05 -06003396 }
3397
3398 // Update all layout set operations (which will be a subset of the initial_layouts
locke-lunargcba7d5f2019-12-30 16:59:11 -07003399 UpdateImageLayoutMap(*subres_map.get(), overlayLayoutMap);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003400 }
John Zulauff660ad62019-03-23 07:16:05 -06003401
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003402 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003403}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003404
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003405void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06003406 for (const auto &layout_map_entry : pCB->image_layout_map) {
3407 const auto image = layout_map_entry.first;
3408 const auto *image_state = GetImageState(image);
3409 if (!image_state) continue; // Can't set layouts of a dead image
locke-lunargcba7d5f2019-12-30 16:59:11 -07003410 UpdateImageLayoutMap(*layout_map_entry.second.get(), imageLayoutMap);
Tony Barbourdf013b92017-01-25 12:53:48 -07003411 }
3412}
3413
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003414// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003415// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3416// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003417bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3418 const VkImageLayout first_layout, const uint32_t attachment,
John Zulauf9d2b6382019-07-25 15:21:36 -06003419 const VkAttachmentDescription2KHR &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003420 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003421 const char *vuid;
3422 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3423
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003424 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
3425 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003426 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3427 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3428 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003429 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
3430 "Cannot clear attachment %d with invalid first layout %s.", attachment,
3431 string_VkImageLayout(first_layout));
Shannon McPherson3ea65132018-12-05 10:37:39 -07003432 } else if (!use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3433 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003434 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
3435 "Cannot clear attachment %d with invalid first layout %s.", attachment,
3436 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003437 }
3438 }
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003439 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3440 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003441 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01566";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003442 skip |= LogError(device, vuid, "Cannot clear attachment %d with invalid first layout %s.", attachment,
3443 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003444 }
3445 }
3446
3447 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3448 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003449 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01567";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003450 skip |= LogError(device, vuid, "Cannot clear attachment %d with invalid first layout %s.", attachment,
3451 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003452 }
3453 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003454 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003455}
3456
Mark Lobodzinskiac02c612020-01-17 14:52:35 -07003457bool CoreChecks::ValidateLayouts(RenderPassCreateVersion rp_version, VkDevice device, const VkRenderPassCreateInfo2KHR *pCreateInfo,
3458 const char *function_name) const {
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003459 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003460 const char *vuid;
3461 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003462
Jason Ekstranda1906302017-12-03 20:16:32 -08003463 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3464 VkFormat format = pCreateInfo->pAttachments[i].format;
3465 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3466 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3467 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003468 skip |= LogWarning(device, kVUID_Core_DrawState_InvalidRenderpass,
3469 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
3470 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3471 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3472 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003473 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003474 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003475 skip |=
3476 LogWarning(device, kVUID_Core_DrawState_InvalidRenderpass,
3477 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3478 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3479 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3480 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003481 }
3482 }
3483 }
3484
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003485 // Track when we're observing the first use of an attachment
3486 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3487 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003488 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003489
3490 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3491 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3492 auto attach_index = subpass.pInputAttachments[j].attachment;
3493 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003494 switch (subpass.pInputAttachments[j].layout) {
3495 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3496 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3497 // These are ideal.
3498 break;
3499
3500 case VK_IMAGE_LAYOUT_GENERAL:
3501 // May not be optimal. TODO: reconsider this warning based on other constraints.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003502 skip |= LogPerformanceWarning(device, kVUID_Core_DrawState_InvalidImageLayout,
3503 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
Cort Stratton7547f772017-05-04 15:18:52 -07003504 break;
3505
Tobias Hectorbbb12282018-10-22 15:17:59 +01003506 case VK_IMAGE_LAYOUT_UNDEFINED:
3507 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003508 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003509 skip |= LogError(device, vuid,
3510 "Layout for input attachment reference %u in subpass %u is %s but must be "
3511 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
3512 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003513 break;
3514
Piers Daniell9af77cd2019-10-16 13:54:12 -06003515 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3516 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3517 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3518 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003519 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003520 skip |= LogError(
3521 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003522 "Layout for input attachment reference %u in subpass %u is %s but must not be "
3523 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3524 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3525 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
3526 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003527 skip |= LogError(
3528 device, "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003529 "Layout for input attachment reference %u in subpass %u is %s but must not be "
3530 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3531 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3532 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
3533 } else if ((subpass.pInputAttachments[j].aspectMask &
3534 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3535 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3536 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3537 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3538 const auto *attachment_reference_stencil_layout =
3539 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pInputAttachments[j].pNext);
3540 if (attachment_reference_stencil_layout) {
3541 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3542 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3543 attachment_reference_stencil_layout->stencilLayout ==
3544 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3545 attachment_reference_stencil_layout->stencilLayout ==
3546 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3547 attachment_reference_stencil_layout->stencilLayout ==
3548 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3549 attachment_reference_stencil_layout->stencilLayout ==
3550 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3551 attachment_reference_stencil_layout->stencilLayout ==
3552 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3553 attachment_reference_stencil_layout->stencilLayout ==
3554 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3555 attachment_reference_stencil_layout->stencilLayout ==
3556 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3557 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003558 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
3559 "In the attachment reference %u in subpass %u with pNext chain instance "
3560 "VkAttachmentReferenceStencilLayoutKHR"
3561 "the stencilLayout member but must not be "
3562 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3563 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3564 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3565 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3566 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3567 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3568 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3569 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3570 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3571 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003572 }
3573 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003574 skip |= LogError(
3575 device, "VUID-VkAttachmentReference2-attachment-03315",
3576 "When the layout for input attachment reference %u in subpass %u is "
3577 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3578 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3579 "VkAttachmentReferenceStencilLayout instance.",
3580 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003581 }
3582 }
3583 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3584 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3585 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003586 skip |= LogError(
3587 device, "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003588 "When the aspectMask for input attachment reference %u in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3589 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3590 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3591 j, i);
3592 }
3593 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3594 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3595 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003596 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
3597 "When the aspectMask for input attachment reference %u in subpass %u is "
3598 "VK_IMAGE_ASPECT_STENCIL_BIT "
3599 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3600 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
3601 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003602 }
3603 }
3604 break;
3605
Graeme Leese668a9862018-10-08 10:40:02 +01003606 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3607 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003608 if (device_extensions.vk_khr_maintenance2) {
Graeme Leese668a9862018-10-08 10:40:02 +01003609 break;
3610 } else {
3611 // Intentionally fall through to generic error message
3612 }
3613 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003614
Cort Stratton7547f772017-05-04 15:18:52 -07003615 default:
3616 // No other layouts are acceptable
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003617 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
3618 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3619 string_VkImageLayout(subpass.pInputAttachments[j].layout));
Cort Stratton7547f772017-05-04 15:18:52 -07003620 }
3621
Cort Stratton7547f772017-05-04 15:18:52 -07003622 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003623 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3624 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003625
3626 bool used_as_depth =
3627 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3628 bool used_as_color = false;
3629 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3630 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3631 }
3632 if (!used_as_depth && !used_as_color &&
3633 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08003634 vuid = use_rp2 ? "VUID-VkSubpassDescription2-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003635 skip |= LogError(device, vuid,
3636 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
3637 function_name, attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07003638 }
3639 }
3640 attach_first_use[attach_index] = false;
3641 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003642
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003643 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3644 auto attach_index = subpass.pColorAttachments[j].attachment;
3645 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3646
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003647 // TODO: Need a way to validate shared presentable images here, currently just allowing
3648 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3649 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003650 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003651 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003652 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003653 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3654 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003655 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003656
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003657 case VK_IMAGE_LAYOUT_GENERAL:
3658 // May not be optimal; TODO: reconsider this warning based on other constraints?
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003659 skip |= LogPerformanceWarning(device, kVUID_Core_DrawState_InvalidImageLayout,
3660 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003661 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003662
Tobias Hectorbbb12282018-10-22 15:17:59 +01003663 case VK_IMAGE_LAYOUT_UNDEFINED:
3664 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003665 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003666 skip |= LogError(device, vuid,
3667 "Layout for color attachment reference %u in subpass %u is %s but should be "
3668 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3669 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003670 break;
3671
Piers Daniell9af77cd2019-10-16 13:54:12 -06003672 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3673 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3674 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3675 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003676 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003677 skip |= LogError(
3678 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003679 "Layout for color attachment reference %u in subpass %u is %s but must not be "
3680 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3681 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3682 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3683 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003684 skip |= LogError(
3685 device, "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003686 "Layout for color attachment reference %u in subpass %u is %s but must not be "
3687 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3688 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3689 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3690 } else if ((subpass.pColorAttachments[j].aspectMask &
3691 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3692 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3693 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3694 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3695 const auto *attachment_reference_stencil_layout =
3696 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pColorAttachments[j].pNext);
3697 if (attachment_reference_stencil_layout) {
3698 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3699 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3700 attachment_reference_stencil_layout->stencilLayout ==
3701 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3702 attachment_reference_stencil_layout->stencilLayout ==
3703 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3704 attachment_reference_stencil_layout->stencilLayout ==
3705 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3706 attachment_reference_stencil_layout->stencilLayout ==
3707 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3708 attachment_reference_stencil_layout->stencilLayout ==
3709 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3710 attachment_reference_stencil_layout->stencilLayout ==
3711 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3712 attachment_reference_stencil_layout->stencilLayout ==
3713 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3714 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003715 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
3716 "In the attachment reference %u in subpass %u with pNext chain instance "
3717 "VkAttachmentReferenceStencilLayoutKHR"
3718 "the stencilLayout member but must not be "
3719 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3720 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3721 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3722 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3723 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3724 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3725 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3726 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3727 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3728 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003729 }
3730 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003731 skip |= LogError(
3732 device, "VUID-VkAttachmentReference2-attachment-03315",
3733 "When the layout for color attachment reference %u in subpass %u is "
3734 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3735 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3736 "VkAttachmentReferenceStencilLayout instance.",
3737 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003738 }
3739 }
3740 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3741 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3742 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003743 skip |= LogError(
3744 device, "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003745 "When the aspectMask for color attachment reference %u in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3746 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3747 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3748 j, i);
3749 }
3750 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3751 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3752 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003753 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
3754 "When the aspectMask for color attachment reference %u in subpass %u is "
3755 "VK_IMAGE_ASPECT_STENCIL_BIT "
3756 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3757 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
3758 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003759 }
3760 }
3761 break;
3762
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003763 default:
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003764 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
3765 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3766 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003767 }
3768
John Zulauf4eee2692019-02-09 16:14:25 -07003769 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].attachment != VK_ATTACHMENT_UNUSED) &&
3770 (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
3771 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08003772 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003773 skip |= LogError(device, vuid,
3774 "Layout for resolve attachment reference %u in subpass %u is %s but should be "
3775 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3776 j, i, string_VkImageLayout(subpass.pResolveAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003777 }
3778
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003779 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003780 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
3781 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003782 }
3783 attach_first_use[attach_index] = false;
3784 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003785
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003786 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3787 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003788 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3789 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3790 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003791 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003792
Dave Houltona9df0ce2018-02-07 10:51:23 -07003793 case VK_IMAGE_LAYOUT_GENERAL:
3794 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3795 // doing a bunch of transitions.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003796 skip |= LogPerformanceWarning(device, kVUID_Core_DrawState_InvalidImageLayout,
3797 "GENERAL layout for depth attachment may not give optimal performance.");
Dave Houltona9df0ce2018-02-07 10:51:23 -07003798 break;
3799
Tobias Hectorbbb12282018-10-22 15:17:59 +01003800 case VK_IMAGE_LAYOUT_UNDEFINED:
3801 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003802 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003803 skip |= LogError(device, vuid,
3804 "Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
3805 "layout or GENERAL.",
3806 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003807 break;
3808
Piers Daniell9af77cd2019-10-16 13:54:12 -06003809 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3810 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3811 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3812 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003813 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003814 skip |= LogError(
3815 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003816 "Layout for depth attachment reference in subpass %u is %s but must not be "
3817 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3818 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3819 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3820 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003821 skip |= LogError(
3822 device, "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003823 "Layout for depth attachment reference in subpass %u is %s but must not be "
3824 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3825 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3826 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3827 } else if ((subpass.pDepthStencilAttachment->aspectMask &
3828 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3829 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3830 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3831 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3832 const auto *attachment_reference_stencil_layout =
3833 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pDepthStencilAttachment->pNext);
3834 if (attachment_reference_stencil_layout) {
3835 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3836 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3837 attachment_reference_stencil_layout->stencilLayout ==
3838 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3839 attachment_reference_stencil_layout->stencilLayout ==
3840 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3841 attachment_reference_stencil_layout->stencilLayout ==
3842 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3843 attachment_reference_stencil_layout->stencilLayout ==
3844 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3845 attachment_reference_stencil_layout->stencilLayout ==
3846 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3847 attachment_reference_stencil_layout->stencilLayout ==
3848 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3849 attachment_reference_stencil_layout->stencilLayout ==
3850 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3851 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003852 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
3853 "In the attachment reference in subpass %u with pNext chain instance "
3854 "VkAttachmentReferenceStencilLayoutKHR"
3855 "the stencilLayout member but must not be "
3856 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3857 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3858 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3859 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3860 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3861 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3862 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3863 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3864 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3865 i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003866 }
3867 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003868 skip |= LogError(
3869 device, "VUID-VkAttachmentReference2-attachment-03315",
3870 "When the layout for depth attachment reference in subpass %u is "
3871 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3872 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3873 "VkAttachmentReferenceStencilLayout instance.",
3874 i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003875 }
3876 }
3877 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3878 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3879 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003880 skip |= LogError(
3881 device, "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003882 "When the aspectMask for depth attachment reference in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3883 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3884 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3885 i);
3886 }
3887 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3888 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3889 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003890 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
3891 "When the aspectMask for depth attachment reference in subpass %u is "
3892 "VK_IMAGE_ASPECT_STENCIL_BIT "
3893 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3894 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
3895 i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003896 }
3897 }
3898 break;
3899
Dave Houltona9df0ce2018-02-07 10:51:23 -07003900 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3901 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003902 if (device_extensions.vk_khr_maintenance2) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003903 break;
3904 } else {
3905 // Intentionally fall through to generic error message
3906 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06003907 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003908
Dave Houltona9df0ce2018-02-07 10:51:23 -07003909 default:
3910 // No other layouts are acceptable
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003911 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
3912 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3913 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
3914 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003915 }
3916
3917 auto attach_index = subpass.pDepthStencilAttachment->attachment;
3918 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003919 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
3920 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003921 }
3922 attach_first_use[attach_index] = false;
3923 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003924 }
3925 return skip;
3926}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003927
Mark Lobodzinski96210742017-02-09 10:33:46 -07003928// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
3929// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003930template <typename T1>
3931bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
3932 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
3933 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003934 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003935 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06003936 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003937 if (strict) {
3938 correct_usage = ((actual & desired) == desired);
3939 } else {
3940 correct_usage = ((actual & desired) != 0);
3941 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003942
Mark Lobodzinski96210742017-02-09 10:33:46 -07003943 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06003944 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06003945 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003946 skip = LogError(object, kVUID_Core_MemTrack_InvalidUsageFlag,
3947 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
3948 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003949 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003950 skip = LogError(object, msgCode,
3951 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
3952 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003953 }
3954 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003955 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003956}
3957
3958// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3959// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003960bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003961 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003962 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image,
John Zulauf4fea6622019-04-01 11:38:18 -06003963 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003964}
3965
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003966bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
John Zulauf07288512019-07-05 11:09:50 -06003967 char const *func_name, const char *linear_vuid, const char *optimal_vuid) const {
Mark Lobodzinski5c048802019-03-07 10:47:31 -07003968 VkFormatProperties format_properties = GetPDFormatProperties(image_state->createInfo.format);
Cort Stratton186b1a22018-05-01 20:18:06 -04003969 bool skip = false;
3970 if (image_state->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
3971 if ((format_properties.linearTilingFeatures & desired) != desired) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003972 skip |=
3973 LogError(image_state->image, linear_vuid, "In %s, invalid linearTilingFeatures (0x%08X) for format %u used by %s.",
3974 func_name, format_properties.linearTilingFeatures, image_state->createInfo.format,
3975 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04003976 }
3977 } else if (image_state->createInfo.tiling == VK_IMAGE_TILING_OPTIMAL) {
3978 if ((format_properties.optimalTilingFeatures & desired) != desired) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003979 skip |= LogError(image_state->image, optimal_vuid,
3980 "In %s, invalid optimalTilingFeatures (0x%08X) for format %u used by %s.", func_name,
3981 format_properties.optimalTilingFeatures, image_state->createInfo.format,
3982 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04003983 }
3984 }
3985 return skip;
3986}
3987
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003988bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003989 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07003990 bool skip = false;
Cort Strattond619a302018-05-17 19:46:32 -07003991 // layerCount must not be zero
3992 if (subresource_layers->layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003993 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-layerCount-01700",
3994 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07003995 }
3996 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
3997 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003998 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00168",
3999 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004000 }
4001 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
4002 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
4003 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004004 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00167",
4005 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4006 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4007 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004008 }
4009 return skip;
4010}
4011
Mark Lobodzinski96210742017-02-09 10:33:46 -07004012// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4013// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004014bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004015 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004016 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer,
John Zulauf4fea6622019-04-01 11:38:18 -06004017 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004018}
4019
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004020bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004021 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004022 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004023
4024 const VkDeviceSize &range = pCreateInfo->range;
4025 if (range != VK_WHOLE_SIZE) {
4026 // Range must be greater than 0
4027 if (range <= 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004028 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00928",
4029 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4030 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4031 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004032 }
4033 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004034 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4035 if (SafeModulo(range, format_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004036 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00929",
4037 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4038 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4039 "(%" PRIu32 ").",
4040 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004041 }
4042 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004043 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004044 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00930",
4045 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4046 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4047 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4048 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004049 }
4050 // The sum of range and offset must be less than or equal to the size of buffer
4051 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004052 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00931",
4053 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4054 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4055 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4056 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004057 }
4058 }
4059 return skip;
4060}
4061
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004062bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004063 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004064 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004065 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4066 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004067 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00933",
4068 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
4069 "be supported for uniform texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004070 }
4071 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4072 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004073 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00934",
4074 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
4075 "be supported for storage texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004076 }
4077 return skip;
4078}
4079
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004080bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004081 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004082 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004083
Dave Houltond8ed0212018-05-16 17:18:24 -06004084 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004085
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004086 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!enabled_features.core.sparseBinding)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004087 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-00915",
4088 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
4089 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004090 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06004091
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004092 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!enabled_features.core.sparseResidencyBuffer)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004093 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-00916",
4094 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
4095 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06004096 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06004097
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004098 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004099 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-00917",
4100 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
4101 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06004102 }
Jeff Bolz87697532019-01-11 22:54:00 -06004103
4104 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
4105 if (chained_devaddr_struct) {
4106 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
4107 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004108 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4109 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
4110 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004111 }
4112 }
4113
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004114 auto chained_opaqueaddr_struct = lvl_find_in_chain<VkBufferOpaqueCaptureAddressCreateInfoKHR>(pCreateInfo->pNext);
4115 if (chained_opaqueaddr_struct) {
4116 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
4117 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004118 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
4119 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfoKHR::opaqueCaptureAddress"
4120 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004121 }
4122 }
4123
Shannon McPherson4984e642019-12-05 13:04:34 -07004124 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
Piers Daniell41b8c5d2020-01-10 15:42:00 -07004125 !enabled_features.core12.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004126 skip |= LogError(
4127 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004128 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
4129 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
4130 }
4131
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004132 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004133 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateBuffer",
4134 "pCreateInfo->pQueueFamilyIndices", "VUID-VkBufferCreateInfo-sharingMode-01419",
4135 "VUID-VkBufferCreateInfo-sharingMode-01419", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004136 }
4137
Mark Lobodzinski96210742017-02-09 10:33:46 -07004138 return skip;
4139}
4140
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004141bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004142 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004143 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004144 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004145 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4146 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004147 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004148 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4149 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004150 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004151 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4152 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4153 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004154
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004155 // Buffer view offset must be less than the size of buffer
4156 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004157 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00925",
4158 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4159 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4160 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004161 }
4162
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004163 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004164 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4165 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4166 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004167 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-02749",
4168 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4169 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4170 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004171 }
4172
4173 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
4174 VkDeviceSize elementSize = FormatElementSize(pCreateInfo->format);
4175 if ((elementSize % 3) == 0) {
4176 elementSize /= 3;
4177 }
4178 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
4179 VkDeviceSize alignmentRequirement =
4180 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4181 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
4182 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4183 }
4184 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004185 skip |= LogError(
4186 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02750",
Jeff Bolzd5554e62019-07-19 13:23:52 -05004187 "If buffer was created with usage containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
4188 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4189 ") must be a multiple of the lesser of "
4190 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4191 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4192 "(%" PRId32
4193 ") is VK_TRUE, the size of a texel of the requested format. "
4194 "If the size of a texel is a multiple of three bytes, then the size of a "
4195 "single component of format is used instead",
4196 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4197 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4198 }
4199 }
4200 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
4201 VkDeviceSize alignmentRequirement =
4202 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4203 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
4204 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4205 }
4206 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004207 skip |= LogError(
4208 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02751",
Jeff Bolzd5554e62019-07-19 13:23:52 -05004209 "If buffer was created with usage containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
4210 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4211 ") must be a multiple of the lesser of "
4212 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4213 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4214 "(%" PRId32
4215 ") is VK_TRUE, the size of a texel of the requested format. "
4216 "If the size of a texel is a multiple of three bytes, then the size of a "
4217 "single component of format is used instead",
4218 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4219 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4220 }
4221 }
4222 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004223
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004224 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004225
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004226 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004227 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004228 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004229}
4230
Mark Lobodzinski602de982017-02-09 11:01:33 -07004231// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004232bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004233 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004234 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004235
Dave Houlton1d2022c2017-03-29 11:43:58 -06004236 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004237 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004238 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 -07004239 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004240 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 -07004241 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004242 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004243 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004244 skip |= LogError(image, vuid,
4245 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
4246 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4247 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004248 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004249 skip |= LogError(image, vuid,
4250 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
4251 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4252 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004253 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004254 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004255 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004256 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 -07004257 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004258 skip |=
4259 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 -07004260 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004261 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004262 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004263 skip |=
4264 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 -07004265 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004266 skip |= LogError(image, vuid, "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.",
4267 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004268 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004269 } else if (FormatIsMultiplane(format)) {
4270 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4271 if (3 == FormatPlaneCount(format)) {
4272 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4273 }
4274 if ((aspect_mask & valid_flags) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004275 skip |=
4276 LogError(image, vuid,
4277 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4278 "set, where n = [0, 1, 2].",
4279 func_name);
Dave Houlton501b15b2018-03-30 15:07:41 -06004280 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004281 }
4282 return skip;
4283}
4284
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004285bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4286 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004287 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
4288 SubresourceRangeErrorCodes errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004289 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004290
4291 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004292 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004293 skip |= LogError(image, errorCodes.base_mip_err,
4294 "%s: %s.baseMipLevel (= %" PRIu32
4295 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4296 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004297 }
Petr Kraus4d718682017-05-18 03:38:41 +02004298
Petr Krausffa94af2017-08-08 21:46:02 +02004299 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4300 if (subresourceRange.levelCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004301 skip |= LogError(image, errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004302 } else {
4303 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004304
Petr Krausffa94af2017-08-08 21:46:02 +02004305 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004306 skip |= LogError(image, errorCodes.mip_count_err,
4307 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4308 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
4309 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
4310 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004311 }
Petr Kraus4d718682017-05-18 03:38:41 +02004312 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004313 }
Petr Kraus4d718682017-05-18 03:38:41 +02004314
4315 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004316 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004317 skip |= LogError(image, errorCodes.base_layer_err,
4318 "%s: %s.baseArrayLayer (= %" PRIu32
4319 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4320 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004321 }
Petr Kraus4d718682017-05-18 03:38:41 +02004322
Petr Krausffa94af2017-08-08 21:46:02 +02004323 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4324 if (subresourceRange.layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004325 skip |= LogError(image, errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004326 } else {
4327 const uint64_t necessary_layer_count =
4328 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004329
Petr Krausffa94af2017-08-08 21:46:02 +02004330 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004331 skip |= LogError(image, errorCodes.layer_count_err,
4332 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4333 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
4334 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
4335 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004336 }
Petr Kraus4d718682017-05-18 03:38:41 +02004337 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004338 }
Petr Kraus4d718682017-05-18 03:38:41 +02004339
Mark Lobodzinski602de982017-02-09 11:01:33 -07004340 return skip;
4341}
4342
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004343bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004344 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004345 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004346 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4347 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4348 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4349
4350 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4351 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4352
4353 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004354 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4355 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
Shannon McPherson5a0de262019-06-05 10:43:56 -06004356 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-02724"
Dave Houltond8ed0212018-05-16 17:18:24 -06004357 : "VUID-VkImageViewCreateInfo-image-01482")
4358 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4359 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
Shannon McPherson5a0de262019-06-05 10:43:56 -06004360 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
Dave Houltond8ed0212018-05-16 17:18:24 -06004361 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4362 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004363
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004364 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004365 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004366 image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004367}
4368
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004369bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004370 const VkImageSubresourceRange &subresourceRange,
4371 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004372 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004373 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4374 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4375 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4376 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004377
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004378 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004379 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image,
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004380 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004381}
4382
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004383bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004384 const VkImageSubresourceRange &subresourceRange,
4385 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004386 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004387 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4388 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4389 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4390 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004391
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004392 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004393 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image,
4394 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004395}
4396
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004397bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004398 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
John Zulaufa4472282019-08-22 14:44:34 -06004399 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004400 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004401 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4402 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4403 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4404 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004405
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004406 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004407 cmd_name, param_name, "arrayLayers", image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004408}
4409
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004410bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004411 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004412 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004413 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004414 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004415 skip |=
4416 ValidateImageUsageFlags(image_state,
4417 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
4418 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4419 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV | VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
4420 false, kVUIDUndefined, "vkCreateImageView()",
4421 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
4422 "SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004423 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004424 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004425 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004426 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004427 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004428 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004429
4430 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4431 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004432 VkImageUsageFlags image_usage = image_state->createInfo.usage;
4433 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004434 VkFormat view_format = pCreateInfo->format;
4435 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004436 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004437 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004438
Dave Houltonbd2e2622018-04-10 16:41:14 -06004439 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004440 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004441 if (chained_ivuci_struct) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05004442 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance2) {
4443 if (!device_extensions.vk_ext_separate_stencil_usage) {
4444 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004445 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
4446 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
4447 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05004448 }
4449 } else {
4450 const auto image_stencil_struct =
4451 lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
4452 if (image_stencil_struct == nullptr) {
4453 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004454 skip |= LogError(
4455 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004456 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
4457 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
4458 "any bits that were not set in VkImageCreateInfo::usage used to create image");
4459 }
4460 } else {
4461 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
4462 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
4463 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004464 skip |= LogError(
4465 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004466 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4467 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4468 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
4469 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
4470 }
4471 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
4472 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004473 skip |= LogError(
4474 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004475 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4476 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4477 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
4478 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
4479 }
4480 }
4481 }
4482 }
4483
Dave Houltonbd2e2622018-04-10 16:41:14 -06004484 image_usage = chained_ivuci_struct->usage;
4485 }
4486
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004487 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4488 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004489 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01004490 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06004491 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01004492 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06004493 std::stringstream ss;
4494 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01004495 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06004496 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004497 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004498 }
4499 } else {
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004500 if ((!device_extensions.vk_khr_maintenance2 ||
Dave Houltonc7988072018-04-16 11:46:56 -06004501 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
4502 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4503 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
4504 std::stringstream ss;
4505 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06004506 << " is not in the same format compatibility class as "
4507 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004508 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4509 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004510 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01018", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004511 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004512 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004513 }
4514 } else {
4515 // Format MUST be IDENTICAL to the format the image was created with
4516 if (image_format != view_format) {
4517 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06004518 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07004519 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004520 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004521 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01019", "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004522 }
4523 }
4524
sfricke-samsungd40eda42020-02-09 17:54:31 -08004525 // Validate feature set if using CUBE_ARRAY
4526 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) && (enabled_features.core.imageCubeArray == false)) {
4527 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-viewType-01004",
4528 "vkCreateImageView(): pCreateInfo->viewType can't be VK_IMAGE_VIEW_TYPE_CUBE_ARRAY without "
4529 "enabling the imageCubeArray feature.");
4530 }
4531
Mark Lobodzinski602de982017-02-09 11:01:33 -07004532 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004533 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004534
4535 switch (image_type) {
4536 case VK_IMAGE_TYPE_1D:
4537 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004538 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4539 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4540 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004541 }
4542 break;
4543 case VK_IMAGE_TYPE_2D:
4544 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4545 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4546 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004547 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
4548 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4549 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004550 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004551 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4552 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4553 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004554 }
4555 }
4556 break;
4557 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004558 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06004559 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4560 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4561 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004562 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004563 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
4564 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4565 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004566 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4567 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004568 skip |= LogError(
4569 pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4570 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4571 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
4572 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4573 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004574 }
4575 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004576 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4577 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4578 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004579 }
4580 }
4581 } else {
4582 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004583 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4584 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4585 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004586 }
4587 }
4588 break;
4589 default:
4590 break;
4591 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004592
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004593 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004594 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07004595 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004596 }
4597
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004598 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004599 VkFormatFeatureFlags tiling_features = (image_tiling & VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4600 : format_properties.optimalTilingFeatures;
4601
4602 if (tiling_features == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004603 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-None-02273",
4604 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4605 "physical device.",
4606 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004607 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004608 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-usage-02274",
4609 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4610 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4611 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004612 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004613 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-usage-02275",
4614 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4615 "VK_IMAGE_USAGE_STORAGE_BIT.",
4616 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004617 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
4618 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004619 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-usage-02276",
4620 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4621 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4622 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004623 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4624 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004625 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-usage-02277",
4626 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4627 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4628 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
sfricke-samsungd40eda42020-02-09 17:54:31 -08004629 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
4630 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
4631 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-usage-02652",
4632 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4633 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4634 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004635 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004636
Jeff Bolz9af91c52018-09-01 21:53:57 -05004637 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4638 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004639 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
4640 "vkCreateImageView() If image was created with usage containing "
4641 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4642 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05004643 }
4644 if (view_format != VK_FORMAT_R8_UINT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004645 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
4646 "vkCreateImageView() If image was created with usage containing "
4647 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05004648 }
4649 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004650 }
4651 return skip;
4652}
4653
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004654bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
4655 uint32_t regionCount, const VkBufferCopy *pRegions) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004656 bool skip = false;
4657
4658 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
4659 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
4660 VkDeviceSize src_min = UINT64_MAX;
4661 VkDeviceSize src_max = 0;
4662 VkDeviceSize dst_min = UINT64_MAX;
4663 VkDeviceSize dst_max = 0;
4664
4665 for (uint32_t i = 0; i < regionCount; i++) {
4666 src_min = std::min(src_min, pRegions[i].srcOffset);
4667 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
4668 dst_min = std::min(dst_min, pRegions[i].dstOffset);
4669 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
4670
4671 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
4672 if (pRegions[i].srcOffset >= src_buffer_size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004673 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-srcOffset-00113",
4674 "vkCmdCopyBuffer(): pRegions[%d].srcOffset (%" PRIuLEAST64
4675 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
4676 i, pRegions[i].srcOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004677 }
4678
4679 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
4680 if (pRegions[i].dstOffset >= dst_buffer_size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004681 skip |= LogError(dst_buffer_state->buffer, "VUID-vkCmdCopyBuffer-dstOffset-00114",
4682 "vkCmdCopyBuffer(): pRegions[%d].dstOffset (%" PRIuLEAST64
4683 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
4684 i, pRegions[i].dstOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004685 }
4686
4687 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
4688 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004689 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-size-00115",
4690 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
4691 ") is greater than the source buffer size (%" PRIuLEAST64
4692 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
4693 i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004694 }
4695
4696 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
4697 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004698 skip |= LogError(dst_buffer_state->buffer, "VUID-vkCmdCopyBuffer-size-00116",
4699 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
4700 ") is greater than the destination buffer size (%" PRIuLEAST64
4701 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
4702 i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004703 }
4704 }
4705
4706 // The union of the source regions, and the union of the destination regions, must not overlap in memory
4707 if (src_buffer_state->buffer == dst_buffer_state->buffer) {
4708 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004709 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-pRegions-00117",
4710 "vkCmdCopyBuffer(): Detected overlap between source and dest regions in memory.");
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004711 }
4712 }
4713
4714 return skip;
4715}
4716
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004717bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004718 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06004719 const auto cb_node = GetCBState(commandBuffer);
4720 const auto src_buffer_state = GetBufferState(srcBuffer);
4721 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004722
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004723 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004724 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
4725 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004726 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004727 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004728 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
4729 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06004730 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004731 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
4732 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004733 skip |=
4734 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4735 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004736 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
4737 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004738 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, regionCount, pRegions);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004739 return skip;
4740}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004741
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004742bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004743 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004744 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004745 if (!buffer_state) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004746 skip |= LogError(buffer, kVUID_Core_DrawState_DoubleDestroy, "Cannot free %s that has not been allocated.",
4747 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004748 } else {
4749 if (buffer_state->in_use.load()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004750 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
4751 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004752 }
4753 }
4754 return skip;
4755}
4756
Jeff Bolz5c801d12019-10-09 10:38:45 -05004757bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
4758 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004759 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06004760 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004761
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004762 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004763 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004764 skip |=
4765 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004766 }
4767 return skip;
4768}
4769
Jeff Bolz5c801d12019-10-09 10:38:45 -05004770bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004771 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004772
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004773 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004774 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07004775 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004776 }
4777 return skip;
4778}
4779
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004780bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004781 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07004782 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06004783 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004784 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004785 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004786 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06004787 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004788 }
4789 return skip;
4790}
4791
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004792bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004793 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004794 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004795 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004796 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004797 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004798 skip |=
4799 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4800 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004801 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004802 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004803 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
4804 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004805 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07004806
4807 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004808 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
4809 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
4810 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
4811 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07004812 }
4813
4814 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004815 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
4816 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
4817 ") minus dstOffset (0x%" PRIxLEAST64 ").",
4818 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07004819 }
4820
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004821 return skip;
4822}
4823
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004824bool CoreChecks::ValidateBufferImageCopyData(uint32_t regionCount, const VkBufferImageCopy *pRegions,
4825 const IMAGE_STATE *image_state, const char *function) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004826 bool skip = false;
4827
4828 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004829 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
4830 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004831 skip |=
4832 LogError(image_state->image, "VUID-VkBufferImageCopy-srcImage-00199",
4833 "%s(): pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
4834 "and 1, respectively.",
4835 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004836 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004837 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004838
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004839 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
4840 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004841 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-srcImage-00201",
4842 "%s(): pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. For 1D and 2D images these "
4843 "must be 0 and 1, respectively.",
4844 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004845 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004846 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004847
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004848 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
4849 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004850 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-baseArrayLayer-00213",
4851 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
4852 "For 3D images these must be 0 and 1, respectively.",
4853 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004854 }
4855 }
4856
4857 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07004858 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
Locke497739c2019-03-08 11:50:47 -07004859 uint32_t element_size = FormatElementSize(image_state->createInfo.format, pRegions[i].imageSubresource.aspectMask);
4860
Dave Houltona585d132019-01-18 13:05:42 -07004861 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004862 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-bufferOffset-00193",
4863 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
4864 " must be a multiple of this format's texel size (%" PRIu32 ").",
4865 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004866 }
4867
4868 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06004869 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004870 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-bufferOffset-00194",
4871 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
4872 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004873 }
4874
4875 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
4876 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004877 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004878 LogError(image_state->image, "VUID-VkBufferImageCopy-bufferRowLength-00195",
4879 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
4880 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004881 }
4882
4883 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
4884 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004885 skip |= LogError(
4886 image_state->image, "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004887 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
4888 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004889 }
4890
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06004891 // Calculate adjusted image extent, accounting for multiplane image factors
4892 VkExtent3D adusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
4893 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
4894 if ((pRegions[i].imageOffset.x < 0) || (pRegions[i].imageOffset.x > static_cast<int32_t>(adusted_image_extent.width)) ||
4895 ((pRegions[i].imageOffset.x + pRegions[i].imageExtent.width) > static_cast<int32_t>(adusted_image_extent.width))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004896 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00197",
4897 "%s(): Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
4898 "zero or <= image subresource width (%d).",
4899 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
4900 adusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06004901 }
4902
4903 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
4904 if ((pRegions[i].imageOffset.y < 0) || (pRegions[i].imageOffset.y > static_cast<int32_t>(adusted_image_extent.height)) ||
4905 ((pRegions[i].imageOffset.y + pRegions[i].imageExtent.height) > static_cast<int32_t>(adusted_image_extent.height))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004906 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00198",
4907 "%s(): Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
4908 "zero or <= image subresource height (%d).",
4909 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
4910 adusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06004911 }
4912
4913 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
4914 if ((pRegions[i].imageOffset.z < 0) || (pRegions[i].imageOffset.z > static_cast<int32_t>(adusted_image_extent.depth)) ||
4915 ((pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth) > static_cast<int32_t>(adusted_image_extent.depth))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004916 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00200",
4917 "%s(): Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
4918 "zero or <= image subresource depth (%d).",
4919 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
4920 adusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06004921 }
4922
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004923 // subresource aspectMask must have exactly 1 bit set
4924 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
4925 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
4926 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004927 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-00212",
4928 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004929 }
4930
4931 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06004932 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004933 skip |= LogError(
4934 image_state->image, "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004935 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
4936 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004937 }
4938
4939 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04004940 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07004941 auto block_size = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004942
4943 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06004944 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004945 skip |= LogError(
4946 image_state->image, "VUID-VkBufferImageCopy-bufferRowLength-00203",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004947 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
4948 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004949 }
4950
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004951 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004952 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004953 skip |= LogError(
4954 image_state->image, "VUID-VkBufferImageCopy-bufferImageHeight-00204",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004955 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
4956 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004957 }
4958
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004959 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06004960 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
4961 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
4962 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004963 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00205",
4964 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
4965 "width & height (%d, %d)..",
4966 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
4967 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004968 }
4969
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004970 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houltona585d132019-01-18 13:05:42 -07004971 uint32_t block_size_in_bytes = FormatElementSize(image_state->createInfo.format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06004972 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004973 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-bufferOffset-00206",
4974 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
4975 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
4976 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004977 }
Dave Houlton67e9b532017-03-02 17:00:10 -07004978
4979 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07004980 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06004981 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004982 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004983 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageExtent-00207",
4984 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
4985 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
4986 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
4987 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07004988 }
4989
4990 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004991 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004992 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004993 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageExtent-00208",
4994 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
4995 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
4996 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
4997 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07004998 }
4999
5000 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06005001 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005002 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005003 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageExtent-00209",
5004 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
5005 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
5006 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
5007 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07005008 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005009 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005010
5011 // Checks that apply only to multi-planar format images
5012 if (FormatIsMultiplane(image_state->createInfo.format)) {
5013 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
5014 if ((FormatPlaneCount(image_state->createInfo.format) < 3) &&
5015 (pRegions[i].imageSubresource.aspectMask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005016 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-01560",
5017 "%s(): pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
5018 "format has three planes.",
5019 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08005020 }
5021
5022 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
5023 if (0 == (pRegions[i].imageSubresource.aspectMask &
5024 (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 -07005025 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-01560",
5026 "%s(): pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
5027 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
5028 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08005029 }
5030 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005031 }
5032
5033 return skip;
5034}
5035
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005036bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount, const VkBufferImageCopy *pRegions,
5037 const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005038 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005039 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005040
5041 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005042 VkExtent3D extent = pRegions[i].imageExtent;
5043 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005044
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005045 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
5046 {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005047 skip |= LogWarning(image_state->image, kVUID_Core_Image_ZeroAreaSubregion,
5048 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
5049 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005050 }
5051
5052 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
5053
5054 // 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 -06005055 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005056 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005057 if (image_extent.width % block_extent.width) {
5058 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
5059 }
5060 if (image_extent.height % block_extent.height) {
5061 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
5062 }
5063 if (image_extent.depth % block_extent.depth) {
5064 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
5065 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005066 }
5067
Dave Houltonfc1a4052017-04-27 14:32:45 -06005068 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005069 skip |= LogError(image_state->image, msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005070 }
5071 }
5072
5073 return skip;
5074}
5075
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005076bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
5077 const VkBufferImageCopy *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005078 bool skip = false;
5079
5080 VkDeviceSize buffer_size = buff_state->createInfo.size;
5081
5082 for (uint32_t i = 0; i < regionCount; i++) {
5083 VkExtent3D copy_extent = pRegions[i].imageExtent;
5084
5085 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
5086 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Locke497739c2019-03-08 11:50:47 -07005087 VkDeviceSize unit_size = FormatElementSize(image_state->createInfo.format,
5088 pRegions[i].imageSubresource.aspectMask); // size (bytes) of texel or block
Dave Houltonf3229d52017-02-21 15:59:08 -07005089
Tom Cooperb2550c72018-10-15 13:08:41 +01005090 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005091 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houltona585d132019-01-18 13:05:42 -07005092 auto block_dim = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005093 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
5094 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
5095
5096 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
5097 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
5098 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005099 }
5100
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005101 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
5102 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
5103 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07005104 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005105 } else {
5106 // Calculate buffer offset of final copied byte, + 1.
5107 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
5108 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
5109 max_buffer_offset *= unit_size; // convert to bytes
5110 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005111
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005112 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005113 skip |= LogError(device, msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i,
5114 buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005115 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005116 }
5117 }
5118
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005119 return skip;
5120}
5121
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005122bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005123 VkBuffer dstBuffer, uint32_t regionCount,
5124 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005125 const auto cb_node = GetCBState(commandBuffer);
5126 const auto src_image_state = GetImageState(srcImage);
5127 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005128
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005129 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005130
5131 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005132 skip |= ValidateCmd(cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005133
5134 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005135 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005136
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005137 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07005138
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005139 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005140 skip |=
5141 LogError(cb_node->createInfo.commandPool, "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
5142 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
5143 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005144 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005145 skip |= ValidateImageBounds(src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005146 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005147 skip |= ValidateBufferBounds(src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005148 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005149
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005150 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005151 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005152 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
5153 skip |=
5154 ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005155
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005156 // Validate that SRC image & DST buffer have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005157 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005158 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
5159 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005160 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005161 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
5162 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06005163 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005164 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImageToBuffer()",
5165 "VUID-vkCmdCopyImageToBuffer-srcImage-01998",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005166 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04005167 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005168 skip |= InsideRenderPass(cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005169 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005170 const char *src_invalid_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5171 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
5172 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005173 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005174 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
Cort Strattond619a302018-05-17 19:46:32 -07005175 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005176 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005177 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
5178 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005179 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5180 cb_node, src_image_state, &pRegions[i], i, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
5181 skip |=
5182 ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyImageToBuffer()",
5183 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
5184 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005185 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
5186 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005187 }
5188 return skip;
5189}
5190
John Zulauf1686f232019-07-09 16:27:11 -06005191void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5192 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
5193 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
5194
5195 auto cb_node = GetCBState(commandBuffer);
5196 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06005197 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005198 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005199 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005200 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005201}
5202
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005203bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5204 VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005205 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005206 const auto cb_node = GetCBState(commandBuffer);
5207 const auto src_buffer_state = GetBufferState(srcBuffer);
5208 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005209
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005210 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005211
5212 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005213 skip |= ValidateCmd(cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005214
5215 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005216 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005217 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005218 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005219 skip |=
5220 LogError(cb_node->createInfo.commandPool, "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
5221 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
5222 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005223 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005224 skip |= ValidateImageBounds(dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005225 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005226 skip |= ValidateBufferBounds(dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005227 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005228 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005229 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005230 skip |=
5231 ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
5232 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005233 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005234 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
5235 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005236 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005237 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
5238 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06005239 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005240 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyBufferToImage()",
5241 "VUID-vkCmdCopyBufferToImage-dstImage-01997",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005242 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04005243 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005244 skip |= InsideRenderPass(cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005245 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005246 const char *dst_invalid_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5247 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
5248 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005249 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005250 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
Cort Strattond619a302018-05-17 19:46:32 -07005251 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005252 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005253 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
5254 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005255 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5256 cb_node, dst_image_state, &pRegions[i], i, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
5257 skip |=
5258 ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyBufferToImage()",
5259 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
5260 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005261 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
5262 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005263 }
5264 return skip;
5265}
5266
John Zulauf1686f232019-07-09 16:27:11 -06005267void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5268 VkImageLayout dstImageLayout, uint32_t regionCount,
5269 const VkBufferImageCopy *pRegions) {
5270 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
5271
5272 auto cb_node = GetCBState(commandBuffer);
5273 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06005274 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005275 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005276 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005277 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005278}
Mike Weiblen672b58b2017-02-21 14:32:53 -07005279
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005280bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005281 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005282 bool skip = false;
5283 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
5284
Dave Houlton1d960ff2018-01-19 12:17:05 -07005285 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07005286 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
5287 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
5288 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005289 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
5290 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005291 }
5292
John Zulaufa26d3c82019-08-14 16:09:08 -06005293 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005294 if (!image_entry) {
5295 return skip;
5296 }
5297
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005298 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
5299 if (device_extensions.vk_ext_image_drm_format_modifier) {
5300 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
5301 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005302 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
5303 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
5304 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005305 }
5306 } else {
5307 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005308 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
5309 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005310 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07005311 }
5312
Dave Houlton1d960ff2018-01-19 12:17:05 -07005313 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005314 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005315 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
5316 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
5317 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005318 }
5319
Dave Houlton1d960ff2018-01-19 12:17:05 -07005320 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005321 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005322 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
5323 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
5324 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005325 }
5326
Dave Houlton1d960ff2018-01-19 12:17:05 -07005327 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07005328 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005329 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
5330 if (FormatIsMultiplane(img_format)) {
5331 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
5332 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
5333 if (FormatPlaneCount(img_format) > 2u) {
5334 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
5335 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
5336 }
5337 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005338 skip |= LogError(image, vuid,
5339 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
5340 ") must be a single-plane specifier flag.",
5341 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005342 }
5343 } else if (FormatIsColor(img_format)) {
5344 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005345 skip |= LogError(image, kVUID_Core_DrawState_InvalidImageAspect,
5346 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
5347 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005348 }
5349 } else if (FormatIsDepthOrStencil(img_format)) {
5350 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
5351 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07005352 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005353 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5354 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
5355 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
5356 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005357 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
5358 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
5359 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005360 }
5361 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005362
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005363 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005364 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005365 }
5366
Mike Weiblen672b58b2017-02-21 14:32:53 -07005367 return skip;
5368}