blob: ad359b525fe6f3dc48831bee2c24df55d98706ac [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;
142 if ((create_from_swapchain == VK_NULL_HANDLE) && (binding.mem == other_image_state->binding.mem) &&
143 (binding.mem != VK_NULL_HANDLE) && (binding.offset == other_image_state->binding.offset) &&
144 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
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700215template <class OBJECT, class LAYOUT>
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700216void CoreChecks::SetLayout(OBJECT *pObject, VkImage image, VkImageSubresource range, const LAYOUT &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700217 ImageSubresourcePair imgpair = {image, true, range};
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700218 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
219 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
220 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
221 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600222 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700223 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
224 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
225 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700226 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700227}
228
229template <class OBJECT, class LAYOUT>
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700230void CoreChecks::SetLayout(OBJECT *pObject, ImageSubresourcePair imgpair, const LAYOUT &layout, VkImageAspectFlags aspectMask) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700231 if (imgpair.subresource.aspectMask & aspectMask) {
232 imgpair.subresource.aspectMask = aspectMask;
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700233 SetLayout(pObject, imgpair, layout);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700234 }
235}
236
Tony Barbourdf013b92017-01-25 12:53:48 -0700237// Set the layout in supplied map
John Zulauf3b04ebd2019-07-18 14:08:11 -0600238void CoreChecks::SetLayout(ImageSubresPairLayoutMap &imageLayoutMap, ImageSubresourcePair imgpair, VkImageLayout layout) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700239 auto it = imageLayoutMap.find(imgpair);
240 if (it != imageLayoutMap.end()) {
241 it->second.layout = layout; // Update
242 } else {
243 imageLayoutMap[imgpair].layout = layout; // Insert
244 }
Tony Barbourdf013b92017-01-25 12:53:48 -0700245}
246
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700247bool CoreChecks::FindLayoutVerifyLayout(ImageSubresourcePair imgpair, VkImageLayout &layout, const VkImageAspectFlags aspectMask) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700248 if (!(imgpair.subresource.aspectMask & aspectMask)) {
249 return false;
250 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700251 VkImageAspectFlags oldAspectMask = imgpair.subresource.aspectMask;
252 imgpair.subresource.aspectMask = aspectMask;
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600253 auto imgsubIt = imageLayoutMap.find(imgpair);
254 if (imgsubIt == imageLayoutMap.end()) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700255 return false;
256 }
257 if (layout != VK_IMAGE_LAYOUT_MAX_ENUM && layout != imgsubIt->second.layout) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700258 LogError(imgpair.image, kVUID_Core_DrawState_InvalidLayout,
259 "Cannot query for %s layout when combined aspect mask %d has multiple layout types: %s and %s",
260 report_data->FormatHandle(imgpair.image).c_str(), oldAspectMask, string_VkImageLayout(layout),
261 string_VkImageLayout(imgsubIt->second.layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700262 }
263 layout = imgsubIt->second.layout;
264 return true;
265}
266
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700267// Find layout(s) on the global level
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700268bool CoreChecks::FindGlobalLayout(ImageSubresourcePair imgpair, VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700269 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700270 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
271 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
272 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
273 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600274 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700275 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
276 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
277 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700278 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700279 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
280 imgpair = {imgpair.image, false, VkImageSubresource()};
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600281 auto imgsubIt = imageLayoutMap.find(imgpair);
282 if (imgsubIt == imageLayoutMap.end()) return false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700283 layout = imgsubIt->second.layout;
284 }
285 return true;
286}
287
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500288bool CoreChecks::FindLayouts(VkImage image, std::vector<VkImageLayout> &layouts) const {
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -0600289 auto sub_data = imageSubresourceMap.find(image);
290 if (sub_data == imageSubresourceMap.end()) return false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700291 auto image_state = GetImageState(image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700292 if (!image_state) return false;
293 bool ignoreGlobal = false;
294 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
295 if (sub_data->second.size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
296 ignoreGlobal = true;
297 }
298 for (auto imgsubpair : sub_data->second) {
299 if (ignoreGlobal && !imgsubpair.hasSubresource) continue;
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600300 auto img_data = imageLayoutMap.find(imgsubpair);
301 if (img_data != imageLayoutMap.end()) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700302 layouts.push_back(img_data->second.layout);
303 }
304 }
305 return true;
306}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700307
John Zulauf3b04ebd2019-07-18 14:08:11 -0600308bool CoreChecks::FindLayout(const ImageSubresPairLayoutMap &imageLayoutMap, ImageSubresourcePair imgpair, VkImageLayout &layout,
309 const VkImageAspectFlags aspectMask) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700310 if (!(imgpair.subresource.aspectMask & aspectMask)) {
311 return false;
312 }
313 imgpair.subresource.aspectMask = aspectMask;
314 auto imgsubIt = imageLayoutMap.find(imgpair);
315 if (imgsubIt == imageLayoutMap.end()) {
316 return false;
317 }
318 layout = imgsubIt->second.layout;
319 return true;
Tony Barboure0c5cc92017-02-08 13:53:39 -0700320}
Tony Barbourdf013b92017-01-25 12:53:48 -0700321
322// find layout in supplied map
John Zulauf3b04ebd2019-07-18 14:08:11 -0600323bool CoreChecks::FindLayout(const ImageSubresPairLayoutMap &imageLayoutMap, ImageSubresourcePair imgpair,
324 VkImageLayout &layout) const {
Tony Barbourdf013b92017-01-25 12:53:48 -0700325 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
326 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
327 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
328 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
329 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600330 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700331 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
332 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
333 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
334 }
335 // Image+subresource not found, look for image handle w/o subresource
Tony Barbourdf013b92017-01-25 12:53:48 -0700336 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
337 imgpair = {imgpair.image, false, VkImageSubresource()};
338 auto imgsubIt = imageLayoutMap.find(imgpair);
339 if (imgsubIt == imageLayoutMap.end()) return false;
340 layout = imgsubIt->second.layout;
341 }
342 return true;
343}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700344
345// Set the layout on the global level
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700346void CoreChecks::SetGlobalLayout(ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700347 VkImage &image = imgpair.image;
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600348 auto data = imageLayoutMap.find(imgpair);
349 if (data != imageLayoutMap.end()) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700350 data->second.layout = layout; // Update
351 } else {
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600352 imageLayoutMap[imgpair].layout = layout; // Insert
Dave Houltonb3f4b282018-02-22 16:25:16 -0700353 }
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -0600354 auto &image_subresources = imageSubresourceMap[image];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700355 auto subresource = std::find(image_subresources.begin(), image_subresources.end(), imgpair);
356 if (subresource == image_subresources.end()) {
357 image_subresources.push_back(imgpair);
358 }
359}
360
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600361// Set image layout for given VkImageSubresourceRange struct
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600362void CoreChecks::SetImageLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600363 const VkImageSubresourceRange &image_subresource_range, VkImageLayout layout,
364 VkImageLayout expected_layout) {
365 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
366 assert(subresource_map); // the non-const getter must return a valid pointer
John Zulauf4ec24ec2019-05-02 17:22:59 -0600367 if (subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600368 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700369 }
370}
John Zulauff660ad62019-03-23 07:16:05 -0600371
372// Set the initial image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600373void CoreChecks::SetImageViewInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
Jeff Bolz3e333222019-08-10 23:00:38 -0500374 if (disabled.image_layout_validation) {
375 return;
376 }
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500377 IMAGE_STATE *image_state = view_state.image_state.get();
378 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
John Zulaufb58415b2019-12-09 15:02:32 -0700379 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
John Zulauff660ad62019-03-23 07:16:05 -0600380}
381
382// Set the initial image layout for a passed non-normalized subresource range
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600383void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600384 const VkImageSubresourceRange &range, VkImageLayout layout) {
385 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
386 assert(subresource_map);
John Zulauf4ec24ec2019-05-02 17:22:59 -0600387 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(image_state, range), layout);
John Zulauff660ad62019-03-23 07:16:05 -0600388}
389
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600390void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, VkImage image, const VkImageSubresourceRange &range,
John Zulauff660ad62019-03-23 07:16:05 -0600391 VkImageLayout layout) {
392 const IMAGE_STATE *image_state = GetImageState(image);
393 if (!image_state) return;
394 SetImageInitialLayout(cb_node, *image_state, range, layout);
395};
396
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600397void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600398 const VkImageSubresourceLayers &layers, VkImageLayout layout) {
399 SetImageInitialLayout(cb_node, image_state, RangeFromLayers(layers), layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600400}
Dave Houltonddd65c52018-05-08 14:58:01 -0600401
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600402// Set image layout for all slices of an image view
Piers Daniell4fde9b72019-11-27 16:19:46 -0700403void CoreChecks::SetImageViewLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout,
404 VkImageLayout layoutStencil) {
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500405 IMAGE_STATE *image_state = view_state.image_state.get();
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600406
John Zulauff660ad62019-03-23 07:16:05 -0600407 VkImageSubresourceRange sub_range = view_state.normalized_subresource_range;
Dave Houltonddd65c52018-05-08 14:58:01 -0600408 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
409 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
John Zulauff660ad62019-03-23 07:16:05 -0600410 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 -0600411 sub_range.baseArrayLayer = 0;
412 sub_range.layerCount = image_state->createInfo.extent.depth;
413 }
414
Piers Daniell4fde9b72019-11-27 16:19:46 -0700415 if (sub_range.aspectMask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT) && layoutStencil != kInvalidLayout) {
416 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
417 SetImageLayout(cb_node, *image_state, sub_range, layout);
418 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
419 SetImageLayout(cb_node, *image_state, sub_range, layoutStencil);
420 } else {
421 SetImageLayout(cb_node, *image_state, sub_range, layout);
422 }
John Zulauf4ccf5c02018-09-21 11:46:18 -0600423}
424
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700425bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
426 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700427 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600428 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100429 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700430 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100431 const char *vuid;
432 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
433
434 if (!image_state) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700435 skip |= LogError(image, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
436 "Render Pass begin with %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
437 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
438 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100439 return skip;
440 }
441
442 auto image_usage = image_state->createInfo.usage;
443
444 // Check for layouts that mismatch image usages in the framebuffer
445 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800446 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100447 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700448 LogError(image, vuid,
449 "Layout/usage mismatch for attachment %u in %s"
450 " - the %s is %s but the image attached to %s via %s"
451 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
452 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
453 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100454 }
455
456 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
457 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800458 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100459 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700460 LogError(image, vuid,
461 "Layout/usage mismatch for attachment %u in %s"
462 " - the %s is %s but the image attached to %s via %s"
463 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
464 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
465 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100466 }
467
468 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800469 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100470 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700471 LogError(image, vuid,
472 "Layout/usage mismatch for attachment %u in %s"
473 " - the %s is %s but the image attached to %s via %s"
474 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
475 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
476 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100477 }
478
479 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800480 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100481 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700482 LogError(image, vuid,
483 "Layout/usage mismatch for attachment %u in %s"
484 " - the %s is %s but the image attached to %s via %s"
485 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
486 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
487 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100488 }
489
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600490 if (device_extensions.vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100491 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
492 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
493 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
494 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
495 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800496 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700497 skip |= LogError(image, vuid,
498 "Layout/usage mismatch for attachment %u in %s"
499 " - the %s is %s but the image attached to %s via %s"
500 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
501 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
502 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
503 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100504 }
505 } else {
506 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
507 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
508 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
509 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700510 skip |= LogError(image, "VUID-vkCmdBeginRenderPass-initialLayout-00896",
511 "Layout/usage mismatch for attachment %u in %s"
512 " - the %s is %s but the image attached to %s via %s"
513 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
514 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
515 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
516 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100517 }
518 }
519 return skip;
520}
521
John Zulauf17a01bb2019-08-09 16:41:19 -0600522bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700523 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600524 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600525 bool skip = false;
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700526 auto const pRenderPassInfo = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700527 auto const &framebufferInfo = framebuffer_state->createInfo;
Tobias Hectorc9057422019-07-23 12:15:52 +0100528 const VkImageView *attachments = framebufferInfo.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100529
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700530 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100531 auto framebuffer = framebuffer_state->framebuffer;
532
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700533 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700534 skip |= LogError(pCB->commandBuffer, kVUID_Core_DrawState_InvalidRenderpass,
535 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700536 }
John Zulauf8e308292018-09-21 11:34:37 -0600537
Tobias Hectorc9057422019-07-23 12:15:52 +0100538 const auto *attachmentInfo = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
539 if (((framebufferInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) != 0) && attachmentInfo != nullptr) {
540 attachments = attachmentInfo->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100541 }
542
Tobias Hectorc9057422019-07-23 12:15:52 +0100543 if (attachments != nullptr) {
544 const auto *const_pCB = static_cast<const CMD_BUFFER_STATE *>(pCB);
545 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
546 auto image_view = attachments[i];
547 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100548
Tobias Hectorc9057422019-07-23 12:15:52 +0100549 if (!view_state) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700550 skip |= LogError(pRenderPassBegin->renderPass, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
551 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
552 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
553 report_data->FormatHandle(image_view).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100554 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100555 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100556
557 const VkImage image = view_state->create_info.image;
558 const IMAGE_STATE *image_state = GetImageState(image);
559
560 if (!image_state) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700561 skip |= LogError(pRenderPassBegin->renderPass, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
562 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
563 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
564 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100565 continue;
566 }
567 auto attachment_initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
568 auto final_layout = pRenderPassInfo->pAttachments[i].finalLayout;
569
Piers Daniell7f894f62020-01-09 16:33:48 -0700570 // Default to expecting stencil in the same layout.
571 auto attachment_stencil_initial_layout = attachment_initial_layout;
572
573 // If a separate layout is specified, look for that.
574 const auto *attachment_description_stencil_layout =
575 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
576 if (attachment_description_stencil_layout) {
577 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
578 }
579
Tobias Hectorc9057422019-07-23 12:15:52 +0100580 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
581 // in common with the non-const version.)
582 const ImageSubresourceLayoutMap *subresource_map =
583 (attachment_initial_layout != VK_IMAGE_LAYOUT_UNDEFINED) ? GetImageSubresourceLayoutMap(const_pCB, image) : nullptr;
584
585 if (subresource_map) { // If no layout information for image yet, will be checked at QueueSubmit time
586 LayoutUseCheckAndMessage layout_check(subresource_map);
587 bool subres_skip = false;
John Zulauf5e617452019-11-19 14:44:16 -0700588 auto pos = subresource_map->Find(view_state->normalized_subresource_range);
589 for (; pos != subresource_map->End() && !subres_skip; ++pos) {
590 const VkImageSubresource &subres = pos->subresource;
Piers Daniell7f894f62020-01-09 16:33:48 -0700591
John Zulauf5e617452019-11-19 14:44:16 -0700592 // Allow for differing depth and stencil layouts
593 VkImageLayout check_layout = attachment_initial_layout;
594 if (subres.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) check_layout = attachment_stencil_initial_layout;
595
596 if (!layout_check.Check(subres, check_layout, pos->current_layout, pos->initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700597 subres_skip |= LogError(
598 device, kVUID_Core_DrawState_InvalidRenderpass,
Piers Daniell7f894f62020-01-09 16:33:48 -0700599 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
600 "and the %s layout of the attachment is %s. The layouts must match, or the render "
601 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
John Zulauf5e617452019-11-19 14:44:16 -0700602 i, string_VkImageLayout(check_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobias Hectorc9057422019-07-23 12:15:52 +0100603 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700604 }
John Zulauf5e617452019-11-19 14:44:16 -0700605
Tobias Hectorc9057422019-07-23 12:15:52 +0100606 skip |= subres_skip;
607 }
608
609 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view,
610 framebuffer, render_pass, i, "initial layout");
611
612 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer,
613 render_pass, i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100614 }
615
Tobias Hectorc9057422019-07-23 12:15:52 +0100616 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
617 auto &subpass = pRenderPassInfo->pSubpasses[j];
618 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
619 auto &attachment_ref = subpass.pInputAttachments[k];
620 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
621 auto image_view = attachments[attachment_ref.attachment];
622 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100623
Tobias Hectorc9057422019-07-23 12:15:52 +0100624 if (view_state) {
625 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700626 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
627 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100628 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100629 }
630 }
631 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100632
Tobias Hectorc9057422019-07-23 12:15:52 +0100633 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
634 auto &attachment_ref = subpass.pColorAttachments[k];
635 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
636 auto image_view = attachments[attachment_ref.attachment];
637 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100638
Tobias Hectorc9057422019-07-23 12:15:52 +0100639 if (view_state) {
640 auto image = view_state->create_info.image;
641 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
642 framebuffer, render_pass, attachment_ref.attachment,
643 "color attachment layout");
644 if (subpass.pResolveAttachments) {
645 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
646 rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
647 attachment_ref.attachment, "resolve attachment layout");
648 }
649 }
650 }
651 }
652
653 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
654 auto &attachment_ref = *subpass.pDepthStencilAttachment;
655 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
656 auto image_view = attachments[attachment_ref.attachment];
657 auto view_state = GetImageViewState(image_view);
658
659 if (view_state) {
660 auto image = view_state->create_info.image;
661 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
662 framebuffer, render_pass, attachment_ref.attachment,
663 "input attachment layout");
664 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100665 }
666 }
667 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700668 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600669 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700670}
671
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600672void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700673 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700674 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700675 auto image_view = GetAttachmentImageViewState(pFramebuffer, ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600676 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700677 VkImageLayout stencil_layout = kInvalidLayout;
678 const auto *attachment_reference_stencil_layout = lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(ref.pNext);
679 if (attachment_reference_stencil_layout) {
680 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
681 }
682
683 SetImageViewLayout(pCB, *image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600684 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700685 }
686}
687
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600688void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
689 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700690 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700691
692 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700693 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700694 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700695 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700696 }
697 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700698 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700699 }
700 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700701 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700702 }
703 }
704}
705
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700706// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
707// 1. Transition into initialLayout state
708// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600709void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700710 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700711 // First transition into initialLayout
712 auto const rpci = render_pass_state->createInfo.ptr();
713 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700714 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -0600715 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700716 VkImageLayout stencil_layout = kInvalidLayout;
717 const auto *attachment_description_stencil_layout =
718 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(rpci->pAttachments[i].pNext);
719 if (attachment_description_stencil_layout) {
720 stencil_layout = attachment_description_stencil_layout->stencilInitialLayout;
721 }
722
723 SetImageViewLayout(cb_state, *view_state, rpci->pAttachments[i].initialLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600724 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700725 }
726 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700727 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700728}
729
Dave Houlton10b39482017-03-16 13:18:15 -0600730bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600731 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600732 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600733 }
734 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600735 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600736 }
737 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600738 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600739 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700740 if (0 !=
741 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
742 if (FormatPlaneCount(format) == 1) return false;
743 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600744 return true;
745}
746
Mike Weiblen62d08a32017-03-07 22:18:27 -0700747// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Petr Krausad0096a2019-08-09 18:35:04 +0200748bool CoreChecks::ValidateBarrierLayoutToImageUsage(const VkImageMemoryBarrier &img_barrier, bool new_not_old,
749 VkImageUsageFlags usage_flags, const char *func_name,
John Zulaufa4472282019-08-22 14:44:34 -0600750 const char *barrier_pname) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700751 bool skip = false;
Petr Krausad0096a2019-08-09 18:35:04 +0200752 const VkImageLayout layout = (new_not_old) ? img_barrier.newLayout : img_barrier.oldLayout;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600753 const char *msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700754
755 switch (layout) {
756 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
757 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600758 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700759 }
760 break;
761 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
762 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600763 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700764 }
765 break;
766 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
767 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600768 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700769 }
770 break;
771 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
772 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600773 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700774 }
775 break;
776 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
777 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600778 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700779 }
780 break;
781 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
782 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600783 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700784 }
785 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600786 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500787 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
788 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
789 }
790 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700791 default:
792 // Other VkImageLayout values do not have VUs defined in this context.
793 break;
794 }
795
Dave Houlton8e9f6542018-05-18 12:18:22 -0600796 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700797 skip |= LogError(img_barrier.image, msg_code,
798 "%s: Image barrier %s %s Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".", func_name,
799 barrier_pname, ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
800 report_data->FormatHandle(img_barrier.image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700801 }
802 return skip;
803}
804
805// Verify image barriers are compatible with the images they reference.
John Zulaufa4472282019-08-22 14:44:34 -0600806bool CoreChecks::ValidateBarriersToImages(const CMD_BUFFER_STATE *cb_state, uint32_t imageMemoryBarrierCount,
807 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700808 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700809
Petr Krausad0096a2019-08-09 18:35:04 +0200810 // Scoreboard for checking for duplicate and inconsistent barriers to images
811 struct ImageBarrierScoreboardEntry {
812 uint32_t index;
813 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
814 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
815 const VkImageMemoryBarrier *barrier;
816 };
817 using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
818 using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
819
John Zulauf463c51e2018-05-31 13:29:20 -0600820 // Scoreboard for duplicate layout transition barriers within the list
821 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
822 ImageBarrierScoreboardImageMap layout_transitions;
823
Mike Weiblen62d08a32017-03-07 22:18:27 -0700824 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +0200825 const auto &img_barrier = pImageMemoryBarriers[i];
826 const std::string barrier_pname = "pImageMemoryBarrier[" + std::to_string(i) + "]";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700827
John Zulauf463c51e2018-05-31 13:29:20 -0600828 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
829 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
830 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +0200831 if (img_barrier.oldLayout != img_barrier.newLayout) {
832 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
833 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -0600834 if (image_it != layout_transitions.end()) {
835 auto &subres_map = image_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200836 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -0600837 if (subres_it != subres_map.end()) {
838 auto &entry = subres_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200839 if ((entry.barrier->newLayout != img_barrier.oldLayout) &&
840 (img_barrier.oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
841 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700842 skip = LogError(
843 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
Petr Krausad0096a2019-08-09 18:35:04 +0200844 "%s: %s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600845 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
846 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Petr Krausad0096a2019-08-09 18:35:04 +0200847 func_name, barrier_pname.c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
848 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
849 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600850 }
851 entry = new_entry;
852 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200853 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600854 }
855 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200856 layout_transitions[img_barrier.image][img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600857 }
858 }
859
Petr Krausad0096a2019-08-09 18:35:04 +0200860 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600861 if (image_state) {
862 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Petr Krausad0096a2019-08-09 18:35:04 +0200863 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, false, usage_flags, func_name, barrier_pname.c_str());
864 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, true, usage_flags, func_name, barrier_pname.c_str());
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600865
866 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
867 if (image_state->layout_locked) {
868 // TODO: Add unique id for error when available
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700869 skip |= LogError(
870 img_barrier.image, 0,
locke-lunarg9edc2812019-06-17 23:18:52 -0600871 "Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600872 " 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 +0200873 report_data->FormatHandle(img_barrier.image).c_str(), string_VkImageLayout(img_barrier.oldLayout),
874 string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600875 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600876
John Zulaufa4472282019-08-22 14:44:34 -0600877 const VkImageCreateInfo &image_create_info = image_state->createInfo;
John Zulauff660ad62019-03-23 07:16:05 -0600878 // For a Depth/Stencil image both aspects MUST be set
John Zulaufa4472282019-08-22 14:44:34 -0600879 if (FormatIsDepthAndStencil(image_create_info.format)) {
Petr Krausad0096a2019-08-09 18:35:04 +0200880 auto const aspect_mask = img_barrier.subresourceRange.aspectMask;
Piers Daniell41b8c5d2020-01-10 15:42:00 -0700881 if (enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -0600882 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
883 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700884 LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-03319",
885 "%s: Image barrier %s references %s of format %s that must have either the depth or stencil "
886 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
887 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
888 string_VkFormat(image_create_info.format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600889 }
890 } else {
891 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
892 if ((aspect_mask & ds_mask) != (ds_mask)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700893 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-03320",
894 "%s: Image barrier %s references %s of format %s that must have the depth and stencil "
895 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
896 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
897 string_VkFormat(image_create_info.format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600898 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700899 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700900 }
John Zulauff660ad62019-03-23 07:16:05 -0600901
Petr Krausad0096a2019-08-09 18:35:04 +0200902 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier.image);
903 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -0600904 // TODO: Set memory invalid which is in mem_tracker currently
905 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
906 // subresource.
907 } else if (subresource_map) {
908 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -0600909 LayoutUseCheckAndMessage layout_check(subresource_map);
Petr Krausad0096a2019-08-09 18:35:04 +0200910 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier.subresourceRange);
John Zulauf5e617452019-11-19 14:44:16 -0700911 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
912 const auto &value = *pos;
913 if (!layout_check.Check(value.subresource, img_barrier.oldLayout, value.current_layout, value.initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700914 subres_skip = LogError(
915 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
John Zulauf5e617452019-11-19 14:44:16 -0700916 "For %s you cannot transition the layout of aspect=%d level=%d layer=%d from %s when the "
917 "%s layout is %s.",
918 report_data->FormatHandle(img_barrier.image).c_str(), value.subresource.aspectMask,
919 value.subresource.mipLevel, value.subresource.arrayLayer, string_VkImageLayout(img_barrier.oldLayout),
920 layout_check.message, string_VkImageLayout(layout_check.layout));
John Zulauff660ad62019-03-23 07:16:05 -0600921 }
John Zulauf5e617452019-11-19 14:44:16 -0700922 }
John Zulauff660ad62019-03-23 07:16:05 -0600923 skip |= subres_skip;
924 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700925 }
926 }
927 return skip;
928}
929
John Zulaufe3d1c8a2019-08-12 14:34:58 -0600930bool CoreChecks::IsReleaseOp(CMD_BUFFER_STATE *cb_state, const VkImageMemoryBarrier &barrier) const {
Petr Krausad0096a2019-08-09 18:35:04 +0200931 if (!IsTransferOp(&barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700932
Jeff Bolz6835fda2019-10-06 00:15:34 -0500933 auto pool = cb_state->command_pool.get();
Petr Krausad0096a2019-08-09 18:35:04 +0200934 return pool && TempIsReleaseOp<VkImageMemoryBarrier, true>(pool, &barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700935}
936
John Zulauf6b4aae82018-05-09 13:03:36 -0600937template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -0600938bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
939 uint32_t barrier_count, const Barrier *barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600940 using BarrierRecord = QFOTransferBarrier<Barrier>;
941 bool skip = false;
Jeff Bolz6835fda2019-10-06 00:15:34 -0500942 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -0600943 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
944 const char *barrier_name = BarrierRecord::BarrierName();
945 const char *handle_name = BarrierRecord::HandleName();
946 const char *transfer_type = nullptr;
947 for (uint32_t b = 0; b < barrier_count; b++) {
948 if (!IsTransferOp(&barriers[b])) continue;
949 const BarrierRecord *barrier_record = nullptr;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700950 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufa4472282019-08-22 14:44:34 -0600951 !QueueFamilyIsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600952 const auto found = barrier_sets.release.find(barriers[b]);
953 if (found != barrier_sets.release.cend()) {
954 barrier_record = &(*found);
955 transfer_type = "releasing";
956 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600957 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufa4472282019-08-22 14:44:34 -0600958 !QueueFamilyIsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600959 const auto found = barrier_sets.acquire.find(barriers[b]);
960 if (found != barrier_sets.acquire.cend()) {
961 barrier_record = &(*found);
962 transfer_type = "acquiring";
963 }
964 }
965 if (barrier_record != nullptr) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700966 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOInCB(),
967 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
968 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
969 func_name, barrier_name, b, transfer_type, handle_name,
970 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
971 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -0600972 }
973 }
974 return skip;
975}
976
John Zulaufa4472282019-08-22 14:44:34 -0600977VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
978 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
979}
980
981const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
982 return device_state.GetImageState(barrier.image);
983}
984
985VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
986 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
987}
988
989const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
990 return device_state.GetBufferState(barrier.buffer);
991}
992
993VkBuffer BarrierHandle(const VkBufferMemoryBarrier &barrier) { return barrier.buffer; }
994
John Zulauf6b4aae82018-05-09 13:03:36 -0600995template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -0600996void CoreChecks::RecordBarrierArrayValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
997 const Barrier *barriers) {
Jeff Bolz6835fda2019-10-06 00:15:34 -0500998 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -0600999 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
1000 for (uint32_t b = 0; b < barrier_count; b++) {
John Zulaufa4472282019-08-22 14:44:34 -06001001 auto &barrier = barriers[b];
1002 if (IsTransferOp(&barrier)) {
1003 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barrier) &&
1004 !QueueFamilyIsSpecial(barrier.dstQueueFamilyIndex)) {
1005 barrier_sets.release.emplace(barrier);
1006 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barrier) &&
1007 !QueueFamilyIsSpecial(barrier.srcQueueFamilyIndex)) {
1008 barrier_sets.acquire.emplace(barrier);
1009 }
1010 }
1011
1012 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
1013 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
1014 if (!QueueFamilyIsIgnored(src_queue_family) && !QueueFamilyIsIgnored(dst_queue_family)) {
1015 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
1016 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
1017 auto handle_state = BarrierHandleState(*this, barrier);
1018 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
1019 if (!mode_concurrent) {
1020 const auto typed_handle = BarrierTypedHandle(barrier);
Jeff Bolz310775c2019-10-09 00:46:33 -05001021 cb_state->queue_submit_functions.emplace_back(
1022 [func_name, cb_state, typed_handle, src_queue_family, dst_queue_family](
1023 const ValidationStateTracker *device_data, const QUEUE_STATE *queue_state) {
1024 return ValidateConcurrentBarrierAtSubmit(device_data, queue_state, func_name, cb_state, typed_handle,
1025 src_queue_family, dst_queue_family);
John Zulaufa4472282019-08-22 14:44:34 -06001026 });
1027 }
John Zulauf6b4aae82018-05-09 13:03:36 -06001028 }
1029 }
1030}
1031
John Zulaufa4472282019-08-22 14:44:34 -06001032bool CoreChecks::ValidateBarriersQFOTransferUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001033 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001034 uint32_t imageMemBarrierCount,
John Zulaufa4472282019-08-22 14:44:34 -06001035 const VkImageMemoryBarrier *pImageMemBarriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001036 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001037 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1038 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001039 return skip;
1040}
1041
John Zulaufa4472282019-08-22 14:44:34 -06001042void CoreChecks::RecordBarrierValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
1043 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1044 const VkImageMemoryBarrier *pImageMemBarriers) {
1045 RecordBarrierArrayValidationInfo(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1046 RecordBarrierArrayValidationInfo(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001047}
1048
1049template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001050bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001051 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001052 // Record to the scoreboard or report that we have a duplication
1053 bool skip = false;
1054 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
1055 if (!inserted.second && inserted.first->second != cb_state) {
1056 // 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 -07001057 skip = LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
1058 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1059 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
1060 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
1061 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
1062 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001063 }
1064 return skip;
1065}
1066
1067template <typename Barrier>
John Zulauf3b04ebd2019-07-18 14:08:11 -06001068bool CoreChecks::ValidateQueuedQFOTransferBarriers(const CMD_BUFFER_STATE *cb_state,
1069 QFOTransferCBScoreboards<Barrier> *scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001070 using BarrierRecord = QFOTransferBarrier<Barrier>;
1071 using TypeTag = typename BarrierRecord::Tag;
1072 bool skip = false;
John Zulauf6b4aae82018-05-09 13:03:36 -06001073 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001074 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001075 const char *barrier_name = BarrierRecord::BarrierName();
1076 const char *handle_name = BarrierRecord::HandleName();
1077 // No release should have an extant duplicate (WARNING)
1078 for (const auto &release : cb_barriers.release) {
1079 // Check the global pending release barriers
1080 const auto set_it = global_release_barriers.find(release.handle);
1081 if (set_it != global_release_barriers.cend()) {
1082 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1083 const auto found = set_for_handle.find(release);
1084 if (found != set_for_handle.cend()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001085 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
1086 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1087 " to dstQueueFamilyIndex %" PRIu32
1088 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1089 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1090 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001091 }
1092 }
1093 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1094 }
1095 // Each acquire must have a matching release (ERROR)
1096 for (const auto &acquire : cb_barriers.acquire) {
1097 const auto set_it = global_release_barriers.find(acquire.handle);
1098 bool matching_release_found = false;
1099 if (set_it != global_release_barriers.cend()) {
1100 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1101 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1102 }
1103 if (!matching_release_found) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001104 skip |= LogError(cb_state->commandBuffer, BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
1105 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1106 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1107 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1108 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001109 }
1110 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1111 }
1112 return skip;
1113}
1114
John Zulauf3b04ebd2019-07-18 14:08:11 -06001115bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001116 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001117 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001118 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001119 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state, qfo_image_scoreboards);
1120 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state, qfo_buffer_scoreboards);
John Zulauf6b4aae82018-05-09 13:03:36 -06001121 return skip;
1122}
1123
1124template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001125void CoreChecks::RecordQueuedQFOTransferBarriers(CMD_BUFFER_STATE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001126 using BarrierRecord = QFOTransferBarrier<Barrier>;
1127 using TypeTag = typename BarrierRecord::Tag;
1128 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001129 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001130
1131 // Add release barriers from this submit to the global map
1132 for (const auto &release : cb_barriers.release) {
1133 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1134 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1135 global_release_barriers[release.handle].insert(release);
1136 }
1137
1138 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1139 for (const auto &acquire : cb_barriers.acquire) {
1140 // NOTE: We're not using [] because we don't want to create entries for missing releases
1141 auto set_it = global_release_barriers.find(acquire.handle);
1142 if (set_it != global_release_barriers.end()) {
1143 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1144 set_for_handle.erase(acquire);
1145 if (set_for_handle.size() == 0) { // Clean up empty sets
1146 global_release_barriers.erase(set_it);
1147 }
1148 }
1149 }
1150}
1151
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001152void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001153 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state);
1154 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001155}
1156
John Zulauf6b4aae82018-05-09 13:03:36 -06001157// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001158void CoreChecks::EraseQFOImageRelaseBarriers(const VkImage &image) { EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image); }
John Zulauf6b4aae82018-05-09 13:03:36 -06001159
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001160void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001161 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001162 for (uint32_t i = 0; i < memBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +02001163 const auto &mem_barrier = pImgMemBarriers[i];
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001164
Chris Forbes4de4b132017-08-21 11:27:08 -07001165 // For ownership transfers, the barrier is specified twice; as a release
1166 // operation on the yielding queue family, and as an acquire operation
1167 // on the acquiring queue family. This barrier may also include a layout
1168 // transition, which occurs 'between' the two operations. For validation
1169 // purposes it doesn't seem important which side performs the layout
1170 // transition, but it must not be performed twice. We'll arbitrarily
1171 // choose to perform it as part of the acquire operation.
John Zulauf2be3fe02019-12-30 09:48:02 -07001172 //
1173 // However, we still need to record initial layout for the "initial layout" validation
1174 const bool is_release_op = IsReleaseOp(cb_state, mem_barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -07001175
Petr Krausad0096a2019-08-09 18:35:04 +02001176 auto *image_state = GetImageState(mem_barrier.image);
John Zulauff660ad62019-03-23 07:16:05 -06001177 if (!image_state) continue;
John Zulauf2be3fe02019-12-30 09:48:02 -07001178 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
unknown86bcb3a2019-07-11 13:05:36 -06001179 for (const auto &image : image_state->aliasing_images) {
1180 image_state = GetImageState(image);
John Zulauf2be3fe02019-12-30 09:48:02 -07001181 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
Dave Houltonb3f4b282018-02-22 16:25:16 -07001182 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001183 }
1184}
1185
unknown86bcb3a2019-07-11 13:05:36 -06001186void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
John Zulauf2be3fe02019-12-30 09:48:02 -07001187 const VkImageMemoryBarrier &mem_barrier, bool is_release_op) {
unknown86bcb3a2019-07-11 13:05:36 -06001188 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier.subresourceRange);
1189 const auto &image_create_info = image_state->createInfo;
1190
1191 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1192 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1193 // for all (potential) layer sub_resources.
1194 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
1195 normalized_isr.baseArrayLayer = 0;
1196 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
1197 }
1198
John Zulauf2be3fe02019-12-30 09:48:02 -07001199 if (is_release_op) {
1200 SetImageInitialLayout(cb_state, *image_state, normalized_isr, mem_barrier.oldLayout);
1201 } else {
1202 SetImageLayout(cb_state, *image_state, normalized_isr, mem_barrier.newLayout, mem_barrier.oldLayout);
1203 }
unknown86bcb3a2019-07-11 13:05:36 -06001204}
1205
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001206bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1207 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1208 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1209 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Matthew Ruschd7ef5482019-07-16 22:01:54 -07001210 if (disabled.image_layout_validation) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001211 assert(cb_node);
1212 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001213 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001214 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001215
John Zulauff660ad62019-03-23 07:16:05 -06001216 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1217 if (subresource_map) {
1218 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001219 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
John Zulauf5e617452019-11-19 14:44:16 -07001220 for (auto pos = subresource_map->Find(range); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1221 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001222 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001223 subres_skip |= LogError(cb_node->commandBuffer, layout_mismatch_msg_code,
1224 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1225 "%s layout %s.",
1226 caller, report_data->FormatHandle(image).c_str(), pos->subresource.arrayLayer,
1227 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1228 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001229 }
John Zulauf5e617452019-11-19 14:44:16 -07001230 }
John Zulauff660ad62019-03-23 07:16:05 -06001231 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001232 }
John Zulauff660ad62019-03-23 07:16:05 -06001233
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001234 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1235 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1236 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001237 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1238 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001239 skip |= LogPerformanceWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
1240 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
1241 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001242 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001243 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001244 if (image_state->shared_presentable) {
1245 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001246 skip |= LogError(device, layout_invalid_msg_code,
1247 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1248 string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001249 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001250 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001251 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001252 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001253 skip |= LogError(cb_node->commandBuffer, layout_invalid_msg_code,
1254 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1255 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1256 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001257 }
1258 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001259 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001260}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001261bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001262 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1263 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001264 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001265 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1266 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1267}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001268
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001269void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001270 FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinski2e495882019-03-06 16:11:56 -07001271 auto renderPass = GetRenderPassState(pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001272 if (!renderPass) return;
1273
Tobias Hectorbbb12282018-10-22 15:17:59 +01001274 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001275 if (framebuffer_state) {
1276 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07001277 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -06001278 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001279 VkImageLayout stencil_layout = kInvalidLayout;
1280 const auto *attachment_description_stencil_layout =
1281 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
1282 if (attachment_description_stencil_layout) {
1283 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1284 }
1285
1286 SetImageViewLayout(pCB, *view_state, pRenderPassInfo->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001287 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001288 }
1289 }
1290}
Dave Houltone19e20d2018-02-02 16:32:41 -07001291
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001292#ifdef VK_USE_PLATFORM_ANDROID_KHR
1293// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1294// This could also move into a seperate core_validation_android.cpp file... ?
1295
1296//
1297// AHB-specific validation within non-AHB APIs
1298//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001299bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001300 bool skip = false;
1301
1302 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1303 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001304 if (0 != ext_fmt_android->externalFormat) {
1305 if (VK_FORMAT_UNDEFINED != create_info->format) {
1306 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001307 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1308 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1309 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001310 }
1311
1312 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001313 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1314 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1315 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001316 }
1317
1318 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001319 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1320 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1321 "non-zero externalFormat, but usage includes bits other than VK_IMAGE_USAGE_SAMPLED_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001322 }
1323
1324 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001325 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1326 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1327 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001328 }
1329 }
1330
Mark Lobodzinski1ee06e92019-04-19 14:03:53 -06001331 if ((0 != ext_fmt_android->externalFormat) && (0 == ahb_ext_formats_set.count(ext_fmt_android->externalFormat))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001332 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
1333 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat which has "
1334 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001335 }
1336 }
1337
Dave Houltond9611312018-11-19 17:03:36 -07001338 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001339 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001340 skip |=
1341 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1342 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1343 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001344 }
1345 }
1346
1347 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1348 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1349 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001350 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001351 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1352 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1353 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1354 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001355 }
1356
1357 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001358 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1359 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1360 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1361 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1362 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001363 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001364 }
1365
1366 return skip;
1367}
1368
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001369bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001370 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001371 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001372
1373 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001374 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001375 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1376 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1377 "format member is %s.",
1378 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001379 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001380
Dave Houltond9611312018-11-19 17:03:36 -07001381 // Chain must include a compatible ycbcr conversion
1382 bool conv_found = false;
1383 uint64_t external_format = 0;
1384 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1385 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001386 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001387 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001388 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001389 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001390 }
Dave Houltond9611312018-11-19 17:03:36 -07001391 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001392 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001393 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
1394 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1395 "without a chained VkSamplerYcbcrConversionInfo struct with the same external format.");
Dave Houltond9611312018-11-19 17:03:36 -07001396 }
1397
1398 // Errors in create_info swizzles
1399 if ((create_info->components.r != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1400 (create_info->components.g != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1401 (create_info->components.b != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1402 (create_info->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001403 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1404 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1405 "includes one or more non-identity component swizzles.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001406 }
1407 }
Dave Houltond9611312018-11-19 17:03:36 -07001408
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001409 return skip;
1410}
1411
John Zulaufa26d3c82019-08-14 16:09:08 -06001412bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001413 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001414
John Zulaufa26d3c82019-08-14 16:09:08 -06001415 const IMAGE_STATE *image_state = GetImageState(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001416 if (image_state->imported_ahb && (0 == image_state->GetBoundMemory().size())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001417 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1418 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1419 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1420 "bound to memory.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001421 }
1422 return skip;
1423}
1424
1425#else
1426
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001427bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001428 return false;
1429}
1430
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001431bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001432
John Zulaufa26d3c82019-08-14 16:09:08 -06001433bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001434
1435#endif // VK_USE_PLATFORM_ANDROID_KHR
1436
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001437bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001438 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001439 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001440
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001441 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001442 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001443 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1444 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001445 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1446 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001447 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001448 }
1449
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001450 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1451 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001452 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1453 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1454 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001455 }
1456
1457 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001458 skip |= LogError(device, "VUID-VkImageCreateInfo-imageType-00954",
1459 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1460 "height (%d) and arrayLayers (%d) must be >= 6.",
1461 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001462 }
Dave Houlton130c0212018-01-29 13:39:56 -07001463 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001464
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001465 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001466 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1467 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1468 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001469 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
1470 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1471 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001472 }
1473
1474 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001475 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
1476 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1477 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001478 }
1479
ByumjinConffx991b6062019-08-14 15:17:53 -07001480 if (device_extensions.vk_ext_fragment_density_map) {
1481 uint32_t ceiling_width =
1482 (uint32_t)ceil((float)device_limits->maxFramebufferWidth /
1483 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, 1.0f));
1484 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1485 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001486 LogError(device, "VUID-VkImageCreateInfo-usage-02559",
1487 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1488 "ceiling of device "
1489 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1490 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1491 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001492 }
1493
1494 uint32_t ceiling_height =
1495 (uint32_t)ceil((float)device_limits->maxFramebufferHeight /
1496 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, 1.0f));
1497 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1498 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001499 LogError(device, "VUID-VkImageCreateInfo-usage-02560",
1500 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1501 "ceiling of device "
1502 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1503 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1504 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001505 }
1506 }
1507
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001508 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001509 VkResult result = VK_SUCCESS;
1510 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1511 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1512 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1513 &format_limits);
1514 } else {
1515 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>();
1516 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1517 image_format_info.type = pCreateInfo->imageType;
1518 image_format_info.tiling = pCreateInfo->tiling;
1519 image_format_info.usage = pCreateInfo->usage;
1520 image_format_info.flags = pCreateInfo->flags;
1521 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1522 format_limits = image_format_properties.imageFormatProperties;
1523 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001524
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001525 if (result == VK_ERROR_FORMAT_NOT_SUPPORTED) {
Lockee87f87c2019-04-23 17:53:10 -06001526#ifdef VK_USE_PLATFORM_ANDROID_KHR
1527 if (!lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext))
1528#endif // VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001529 skip |=
1530 LogError(device, kVUIDUndefined, "vkCreateImage(): Format %s is not supported for this combination of parameters.",
1531 string_VkFormat(pCreateInfo->format));
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001532 } else {
1533 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1534 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001535 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1536 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1537 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001538 }
Dave Houlton130c0212018-01-29 13:39:56 -07001539
Dave Houltona585d132019-01-18 13:05:42 -07001540 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1541 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1542 (uint64_t)pCreateInfo->samples;
1543 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * texel_count);
Dave Houlton130c0212018-01-29 13:39:56 -07001544
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001545 // Round up to imageGranularity boundary
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001546 VkDeviceSize imageGranularity = phys_dev_props.limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001547 uint64_t ig_mask = imageGranularity - 1;
1548 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001549
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001550 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001551 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
1552 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1553 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1554 total_size, format_limits.maxResourceSize);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001555 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001556
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001557 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001558 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
1559 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1560 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001561 }
1562
1563 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001564 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
1565 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
1566 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001567 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001568 }
1569
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001570 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsungcead0802020-01-30 22:20:10 -08001571 if (FormatRequiresYcbcrConversion(pCreateInfo->format)) {
1572 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
1573 const char *error_vuid = (device_extensions.vk_ext_ycbcr_image_arrays) ? "VUID-VkImageCreateInfo-format-02653"
1574 : "VUID-VkImageCreateInfo-format-02564";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001575 skip |= LogError(device, error_vuid,
1576 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
1577 "YCbCr Conversion format, arrayLayers must be 1",
1578 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001579 }
1580
1581 if (pCreateInfo->mipLevels != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001582 skip |= LogError(device, "VUID-VkImageCreateInfo-format-02561",
1583 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
1584 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001585 }
1586
1587 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001588 skip |= LogError(
1589 device, "VUID-VkImageCreateInfo-format-02562",
sfricke-samsungcead0802020-01-30 22:20:10 -08001590 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
1591 string_VkSampleCountFlagBits(pCreateInfo->samples));
1592 }
1593
1594 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001595 skip |= LogError(
1596 device, "VUID-VkImageCreateInfo-format-02563",
sfricke-samsungcead0802020-01-30 22:20:10 -08001597 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
1598 string_VkImageType(pCreateInfo->imageType));
1599 }
1600 }
1601
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06001602 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001603 skip |=
1604 LogError(device, "VUID-VkImageCreateInfo-flags-01924",
1605 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
1606 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06001607 }
1608
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001609 if (device_extensions.vk_khr_maintenance2) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06001610 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
1611 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
1612 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
1613 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001614 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001615 LogError(device, kVUIDUndefined,
1616 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1617 "format must be block, ETC or ASTC compressed, but is %s",
1618 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001619 }
1620 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
1621 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001622 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001623 LogError(device, kVUIDUndefined,
1624 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1625 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001626 }
1627 }
1628 }
1629
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001630 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001631 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateImage",
1632 "pCreateInfo->pQueueFamilyIndices", "VUID-VkImageCreateInfo-sharingMode-01420",
1633 "VUID-VkImageCreateInfo-sharingMode-01420", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001634 }
1635
unknown2c877272019-07-11 12:56:50 -06001636 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
1637 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
1638 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001639 LogError(device, "VUID-VkImageCreateInfo-format-01577",
1640 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
1641 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06001642 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001643 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001644}
1645
John Zulauf7eeb6f72019-06-17 11:56:36 -06001646void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1647 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
1648 if (VK_SUCCESS != result) return;
1649
1650 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
1651
1652 IMAGE_LAYOUT_STATE image_state;
1653 image_state.layout = pCreateInfo->initialLayout;
1654 image_state.format = pCreateInfo->format;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001655 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001656 imageSubresourceMap[*pImage].push_back(subpair);
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -06001657 imageLayoutMap[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001658}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001659
Jeff Bolz5c801d12019-10-09 10:38:45 -05001660bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001661 const IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06001662 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001663 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001664 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001665 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001666 }
1667 return skip;
1668}
1669
John Zulauf7eeb6f72019-06-17 11:56:36 -06001670void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
1671 // Clean up validation specific data
1672 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001673
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001674 const auto &sub_entry = imageSubresourceMap.find(image);
1675 if (sub_entry != imageSubresourceMap.end()) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001676 for (const auto &pair : sub_entry->second) {
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -06001677 imageLayoutMap.erase(pair);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001678 }
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001679 imageSubresourceMap.erase(sub_entry);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001680 }
John Zulauf7eeb6f72019-06-17 11:56:36 -06001681
1682 // Clean up generic image state
1683 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001684}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001685
John Zulauf07288512019-07-05 11:09:50 -06001686bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001687 bool skip = false;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001688
1689 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
1690 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 -07001691 skip |= LogError(image_state->image, kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001692 }
1693
Dave Houlton1d2022c2017-03-29 11:43:58 -06001694 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001695 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001696 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -06001697 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001698 char const str[] = "vkCmdClearColorImage called with compressed image.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001699 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001700 }
1701
1702 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
1703 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001704 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-image-00002", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001705 }
1706 return skip;
1707}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001708
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001709uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1710 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1711 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001712 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001713 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001714 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001715 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001716}
1717
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001718uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1719 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1720 uint32_t array_layer_count = range->layerCount;
1721 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1722 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001723 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001724 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001725}
1726
John Zulauf07288512019-07-05 11:09:50 -06001727bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1728 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
1729 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001730 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001731 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1732 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001733 skip |= LogError(image_state->image, "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
1734 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1735 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001736 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001737
1738 } else {
1739 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1740 if (!device_extensions.vk_khr_shared_presentable_image) {
1741 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001742 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-imageLayout-00005",
1743 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1744 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001745 }
1746 } else {
1747 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
1748 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001749 skip |= LogError(
1750 image_state->image, "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001751 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
1752 func_name, string_VkImageLayout(dest_image_layout));
1753 }
1754 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001755 }
1756
John Zulauff660ad62019-03-23 07:16:05 -06001757 // Cast to const to prevent creation at validate time.
John Zulauf07288512019-07-05 11:09:50 -06001758 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06001759 if (subresource_map) {
1760 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001761 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06001762 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
John Zulauf5e617452019-11-19 14:44:16 -07001763 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1764 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06001765 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
1766 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1767 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
1768 } else {
1769 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001770 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001771 subres_skip |= LogError(cb_node->commandBuffer, error_code,
1772 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
1773 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
1774 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001775 }
John Zulauf5e617452019-11-19 14:44:16 -07001776 }
John Zulauff660ad62019-03-23 07:16:05 -06001777 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001778 }
1779
1780 return skip;
1781}
1782
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001783bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1784 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001785 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001786 bool skip = false;
1787 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06001788 const auto *cb_node = GetCBState(commandBuffer);
1789 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001790 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001791 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001792 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001793 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001794 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski544def72019-04-19 14:25:59 -06001795 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001796 skip |=
1797 ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
1798 "VUID-vkCmdClearColorImage-image-01993", "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001799 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001800 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001801 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001802 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001803 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001804 skip |= ValidateImageAttributes(image_state, pRanges[i]);
1805 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001806 }
1807 }
1808 return skip;
1809}
1810
John Zulaufeabb4462019-07-05 14:13:03 -06001811void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1812 const VkClearColorValue *pColor, uint32_t rangeCount,
1813 const VkImageSubresourceRange *pRanges) {
1814 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
1815
1816 auto cb_node = GetCBState(commandBuffer);
1817 auto image_state = GetImageState(image);
1818 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001819 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001820 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001821 }
1822 }
1823}
1824
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001825bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1826 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001827 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001828 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001829
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001830 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06001831 const auto *cb_node = GetCBState(commandBuffer);
1832 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001833 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001834 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06001835 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001836 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001837 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001838 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski544def72019-04-19 14:25:59 -06001839 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001840 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
1841 "VUID-vkCmdClearDepthStencilImage-image-01994",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001842 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001843 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001844 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Andrew Fobel3abeb992020-01-20 16:33:22 -05001845
1846 bool any_include_aspect_depth_bit = false;
1847 bool any_include_aspect_stencil_bit = false;
1848
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001849 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001850 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001851 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001852 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001853 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001854 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1855 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001856 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001857 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1858 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001859 skip |= LogError(commandBuffer, kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001860 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05001861 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
1862 any_include_aspect_depth_bit = true;
1863 }
1864 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
1865 any_include_aspect_stencil_bit = true;
1866 }
1867 }
1868 if (any_include_aspect_stencil_bit) {
1869 const auto image_stencil_struct = lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
1870 if (image_stencil_struct != nullptr) {
1871 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
1872 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001873 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
1874 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
1875 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
1876 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05001877 }
1878 } else {
1879 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001880 skip |= LogError(
1881 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05001882 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
1883 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
1884 "in VkImageCreateInfo::usage used to create image");
1885 }
1886 }
1887 }
1888 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001889 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
1890 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
1891 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001892 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001893 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001894 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001895 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001896 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001897 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1898 char const str[] =
1899 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1900 "set.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001901 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001902 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001903 }
1904 return skip;
1905}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001906
John Zulaufeabb4462019-07-05 14:13:03 -06001907void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1908 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1909 const VkImageSubresourceRange *pRanges) {
1910 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
1911 auto cb_node = GetCBState(commandBuffer);
1912 auto image_state = GetImageState(image);
1913 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001914 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001915 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001916 }
1917 }
1918}
1919
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001920// Returns true if [x, xoffset] and [y, yoffset] overlap
1921static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1922 bool result = false;
1923 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1924 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1925
1926 if (intersection_max > intersection_min) {
1927 result = true;
1928 }
1929 return result;
1930}
1931
Dave Houltonc991cc92018-03-06 11:08:51 -07001932// Returns true if source area of first copy region intersects dest area of second region
1933// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1934static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001935 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001936
Dave Houltonc991cc92018-03-06 11:08:51 -07001937 // Separate planes within a multiplane image cannot intersect
1938 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07001939 return result;
1940 }
1941
Dave Houltonc991cc92018-03-06 11:08:51 -07001942 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
1943 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
1944 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001945 result = true;
1946 switch (type) {
1947 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001948 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001949 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001950 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001951 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001952 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001953 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001954 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001955 break;
1956 default:
1957 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1958 assert(false);
1959 }
1960 }
1961 return result;
1962}
1963
Dave Houltonfc1a4052017-04-27 14:32:45 -06001964// Returns non-zero if offset and extent exceed image extents
1965static const uint32_t x_bit = 1;
1966static const uint32_t y_bit = 2;
1967static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001968static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001969 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001970 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001971 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1972 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001973 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001974 }
1975 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1976 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001977 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001978 }
1979 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1980 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001981 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001982 }
1983 return result;
1984}
1985
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001986// Test if two VkExtent3D structs are equivalent
1987static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1988 bool result = true;
1989 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1990 (extent->depth != other_extent->depth)) {
1991 result = false;
1992 }
1993 return result;
1994}
1995
Dave Houltonee281a52017-12-08 13:51:02 -07001996// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1997// Destination image texel extents must be adjusted by block size for the dest validation checks
1998VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1999 VkExtent3D adjusted_extent = extent;
unknown948b6ba2019-09-19 17:32:54 -06002000 if ((FormatIsCompressed(src_format) || FormatIsSinglePlane_422(src_format)) &&
2001 !(FormatIsCompressed(dst_format) || FormatIsSinglePlane_422(dst_format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002002 VkExtent3D block_size = FormatTexelBlockExtent(src_format);
Dave Houltonee281a52017-12-08 13:51:02 -07002003 adjusted_extent.width /= block_size.width;
2004 adjusted_extent.height /= block_size.height;
2005 adjusted_extent.depth /= block_size.depth;
unknown948b6ba2019-09-19 17:32:54 -06002006 } else if (!(FormatIsCompressed(src_format) || FormatIsSinglePlane_422(src_format)) &&
2007 (FormatIsCompressed(dst_format) || FormatIsSinglePlane_422(dst_format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002008 VkExtent3D block_size = FormatTexelBlockExtent(dst_format);
Dave Houltonee281a52017-12-08 13:51:02 -07002009 adjusted_extent.width *= block_size.width;
2010 adjusted_extent.height *= block_size.height;
2011 adjusted_extent.depth *= block_size.depth;
2012 }
2013 return adjusted_extent;
2014}
2015
Dave Houlton6f9059e2017-05-02 17:15:13 -06002016// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002017static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
2018 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06002019
2020 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06002021 if (mip >= img->createInfo.mipLevels) {
2022 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06002023 }
Dave Houlton1150cf52017-04-27 14:38:11 -06002024
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002025 // 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 -06002026 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05002027
Dave Houltone48cd112019-01-03 17:01:18 -07002028 // If multi-plane, adjust per-plane extent
2029 if (FormatIsMultiplane(img->createInfo.format)) {
2030 VkExtent2D divisors = FindMultiplaneExtentDivisors(img->createInfo.format, subresource->aspectMask);
2031 extent.width /= divisors.width;
2032 extent.height /= divisors.height;
2033 }
2034
Jeff Bolzef40fec2018-09-01 22:04:34 -05002035 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
2036 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
Dave Houlton142c4cb2018-10-17 15:04:41 -06002037 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1) >> mip)));
Jeff Bolzef40fec2018-09-01 22:04:34 -05002038 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
2039 } else {
2040 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
2041 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
2042 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
2043 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06002044
Dave Houlton6f9059e2017-05-02 17:15:13 -06002045 // Image arrays have an effective z extent that isn't diminished by mip level
2046 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002047 extent.depth = img->createInfo.arrayLayers;
2048 }
2049
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002050 return extent;
2051}
2052
2053// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002054static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002055 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2056}
2057
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002058// Test if the extent argument has any dimensions set to 0.
2059static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
2060 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
2061}
2062
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002063// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002064VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002065 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2066 VkExtent3D granularity = {0, 0, 0};
Jeff Bolz6835fda2019-10-06 00:15:34 -05002067 auto pPool = cb_node->command_pool.get();
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002068 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002069 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06002070 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002071 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002072 granularity.width *= block_size.width;
2073 granularity.height *= block_size.height;
2074 }
2075 }
2076 return granularity;
2077}
2078
2079// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2080static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2081 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002082 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2083 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002084 valid = false;
2085 }
2086 return valid;
2087}
2088
2089// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002090bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002091 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002092 bool skip = false;
2093 VkExtent3D offset_extent = {};
2094 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2095 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2096 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002097 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002098 // 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 -07002099 if (IsExtentAllZeroes(&offset_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002100 skip |= LogError(cb_node->commandBuffer, vuid,
2101 "%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 "
2102 "image transfer granularity is (w=0, h=0, d=0).",
2103 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002104 }
2105 } else {
2106 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2107 // integer multiples of the image transfer granularity.
2108 if (IsExtentAligned(&offset_extent, granularity) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002109 skip |= LogError(cb_node->commandBuffer, vuid,
2110 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2111 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2112 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2113 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002114 }
2115 }
2116 return skip;
2117}
2118
2119// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002120bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002121 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002122 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002123 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002124 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002125 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2126 // subresource extent.
2127 if (IsExtentEqual(extent, subresource_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002128 skip |= LogError(cb_node->commandBuffer, vuid,
2129 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2130 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2131 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2132 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002133 }
2134 } else {
2135 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2136 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2137 // subresource extent dimensions.
2138 VkExtent3D offset_extent_sum = {};
2139 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2140 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2141 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002142 bool x_ok = true;
2143 bool y_ok = true;
2144 bool z_ok = true;
2145 switch (image_type) {
2146 case VK_IMAGE_TYPE_3D:
2147 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2148 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002149 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002150 case VK_IMAGE_TYPE_2D:
2151 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2152 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002153 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002154 case VK_IMAGE_TYPE_1D:
2155 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2156 (subresource_extent->width == offset_extent_sum.width));
2157 break;
2158 default:
2159 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2160 assert(false);
2161 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002162 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002163 skip |=
2164 LogError(cb_node->commandBuffer, vuid,
2165 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2166 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2167 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2168 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2169 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2170 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002171 }
2172 }
2173 return skip;
2174}
2175
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002176bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002177 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002178 bool skip = false;
2179 if (mip_level >= img->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002180 skip |= LogError(cb_node->commandBuffer, vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2181 function, i, member, mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002182 }
2183 return skip;
2184}
2185
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002186bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002187 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002188 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002189 bool skip = false;
2190 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2191 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002192 skip |= LogError(cb_node->commandBuffer, vuid,
2193 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2194 "%u, but provided %s has %u array layers.",
2195 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2196 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002197 }
2198 return skip;
2199}
2200
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002201// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002202bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002203 const VkBufferImageCopy *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002204 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002205 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002206 VkExtent3D granularity = GetScaledItg(cb_node, img);
2207 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002208 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002209 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002210 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002211 return skip;
2212}
2213
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002214// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002215bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002216 const IMAGE_STATE *dst_img, const VkImageCopy *region,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002217 const uint32_t i, const char *function) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002218 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002219 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002220 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
2221 skip |=
2222 CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002223 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002224 const VkExtent3D extent = region->extent;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002225 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
2226 i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002227
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002228 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002229 granularity = GetScaledItg(cb_node, dst_img);
2230 skip |=
2231 CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002232 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002233 const VkExtent3D dest_effective_extent =
2234 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002235 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002236 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002237 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002238 return skip;
2239}
2240
Dave Houlton6f9059e2017-05-02 17:15:13 -06002241// Validate contents of a VkImageCopy struct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002242bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const VkImageCopy *ic_regions, const IMAGE_STATE *src_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002243 const IMAGE_STATE *dst_state) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002244 bool skip = false;
2245
2246 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002247 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002248
2249 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002250 const VkExtent3D src_copy_extent = region.extent;
2251 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002252 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2253
Dave Houlton6f9059e2017-05-02 17:15:13 -06002254 bool slice_override = false;
2255 uint32_t depth_slices = 0;
2256
2257 // Special case for copying between a 1D/2D array and a 3D image
2258 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2259 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002260 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002261 slice_override = (depth_slices != 1);
2262 } 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 -07002263 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002264 slice_override = (depth_slices != 1);
2265 }
2266
2267 // Do all checks on source image
2268 //
2269 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002270 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002271 skip |=
2272 LogError(src_state->image, "VUID-VkImageCopy-srcImage-00146",
2273 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2274 "be 0 and 1, respectively.",
2275 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002276 }
2277 }
2278
Dave Houlton533be9f2018-03-26 17:08:30 -06002279 // VUID-VkImageCopy-srcImage-01785
2280 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 -07002281 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-01785",
2282 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
2283 "these must be 0 and 1, respectively.",
2284 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002285 }
2286
Dave Houlton533be9f2018-03-26 17:08:30 -06002287 // VUID-VkImageCopy-srcImage-01787
2288 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002289 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-01787",
2290 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2291 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002292 }
2293
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002294 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002295 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002296 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002297 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002298 LogError(src_state->image, "VUID-VkImageCopy-srcImage-00141",
2299 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2300 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2301 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002302 }
2303 }
2304 } else { // Pre maint 1
2305 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002306 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002307 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-00141",
2308 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2309 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2310 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2311 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002312 }
2313 }
2314 }
2315
Dave Houltonc991cc92018-03-06 11:08:51 -07002316 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002317 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002318 if (FormatIsCompressed(src_state->createInfo.format) ||
2319 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002320 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002321 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002322 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2323 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2324 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002325 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002326 skip |= LogError(src_state->image, vuid,
2327 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
2328 "texel width & height (%d, %d).",
2329 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002330 }
2331
Dave Houlton94a00372017-12-14 15:08:47 -07002332 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002333 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2334 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002335 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002336 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002337 LogError(src_state->image, vuid,
2338 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2339 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2340 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002341 }
2342
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002343 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002344 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2345 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002346 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002347 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002348 LogError(src_state->image, vuid,
2349 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2350 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2351 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002352 }
2353
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002354 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002355 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2356 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002357 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002358 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002359 LogError(src_state->image, vuid,
2360 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2361 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2362 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002363 }
2364 } // Compressed
2365
2366 // Do all checks on dest image
2367 //
2368 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002369 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002370 skip |= LogError(dst_state->image, "VUID-VkImageCopy-dstImage-00152",
2371 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
2372 "these must be 0 and 1, respectively.",
2373 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002374 }
2375 }
2376
Dave Houlton533be9f2018-03-26 17:08:30 -06002377 // VUID-VkImageCopy-dstImage-01786
2378 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 -07002379 skip |=
2380 LogError(dst_state->image, "VUID-VkImageCopy-dstImage-01786",
2381 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2382 "and 1, respectively.",
2383 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002384 }
2385
2386 // VUID-VkImageCopy-dstImage-01788
2387 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002388 skip |= LogError(dst_state->image, "VUID-VkImageCopy-dstImage-01788",
2389 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2390 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002391 }
2392
2393 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002394 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002395 skip |= LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00141",
2396 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2397 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2398 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002399 }
2400 }
2401 // VU01199 changed with mnt1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002402 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002403 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002404 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002405 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002406 LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00141",
2407 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2408 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2409 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002410 }
2411 }
2412 } else { // Pre maint 1
2413 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002414 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002415 skip |= LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00141",
2416 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2417 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2418 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2419 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002420 }
2421 }
2422 }
2423
Dave Houltonc991cc92018-03-06 11:08:51 -07002424 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2425 if (FormatIsCompressed(dst_state->createInfo.format) ||
2426 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002427 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002428
2429 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002430 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2431 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2432 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002433 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002434 skip |= LogError(dst_state->image, vuid,
2435 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
2436 "texel width & height (%d, %d).",
2437 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002438 }
2439
Dave Houlton94a00372017-12-14 15:08:47 -07002440 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002441 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2442 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002443 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002444 skip |= LogError(
2445 dst_state->image, vuid,
2446 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2447 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2448 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002449 }
2450
Dave Houltonee281a52017-12-08 13:51:02 -07002451 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2452 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2453 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002454 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002455 skip |= LogError(dst_state->image, vuid,
2456 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2457 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2458 "height (%d).",
2459 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002460 }
2461
Dave Houltonee281a52017-12-08 13:51:02 -07002462 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2463 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2464 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002465 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002466 skip |= LogError(
2467 dst_state->image, vuid,
2468 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2469 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2470 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002471 }
2472 } // Compressed
2473 }
2474 return skip;
2475}
2476
Dave Houltonc991cc92018-03-06 11:08:51 -07002477// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002478bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002479 const IMAGE_STATE *dst_image_state, const VkImageCopy region) const {
Dave Houltonc991cc92018-03-06 11:08:51 -07002480 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002481
2482 // Neither image is multiplane
2483 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2484 // If neither image is multi-plane the aspectMask member of src and dst must match
2485 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2486 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002487 ss << "vkCmdCopyImage(): Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002488 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002489 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002490 }
2491 } else {
2492 // Source image multiplane checks
2493 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2494 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2495 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2496 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002497 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002498 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002499 }
2500 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2501 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2502 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002503 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002504 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002505 }
2506 // Single-plane to multi-plane
2507 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2508 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2509 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002510 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002511 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002512 }
2513
2514 // Dest image multiplane checks
2515 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2516 aspect = region.dstSubresource.aspectMask;
2517 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2518 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002519 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002520 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002521 }
2522 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2523 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2524 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002525 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002526 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002527 }
2528 // Multi-plane to single-plane
2529 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2530 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2531 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002532 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002533 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002534 }
2535 }
2536
2537 return skip;
2538}
2539
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002540bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2541 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002542 const VkImageCopy *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002543 const auto *cb_node = GetCBState(commandBuffer);
2544 const auto *src_image_state = GetImageState(srcImage);
2545 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002546 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002547
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002548 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002549
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002550 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2551
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002552 for (uint32_t i = 0; i < regionCount; i++) {
2553 const VkImageCopy region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002554
2555 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2556 VkExtent3D src_copy_extent = region.extent;
2557 VkExtent3D dst_copy_extent =
2558 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
2559
Dave Houlton6f9059e2017-05-02 17:15:13 -06002560 bool slice_override = false;
2561 uint32_t depth_slices = 0;
2562
2563 // Special case for copying between a 1D/2D array and a 3D image
2564 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2565 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2566 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002567 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002568 slice_override = (depth_slices != 1);
2569 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2570 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002571 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002572 slice_override = (depth_slices != 1);
2573 }
2574
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002575 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2576 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
2577 skip |= ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002578 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002579 skip |= ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002580 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002581 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002582 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2583 "VUID-vkCmdCopyImage-srcSubresource-01698");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002584 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002585 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2586 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002587
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002588 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002589 // No chance of mismatch if we're overriding depth slice count
2590 if (!slice_override) {
2591 // The number of depth slices in srcSubresource and dstSubresource must match
2592 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2593 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002594 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2595 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002596 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002597 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2598 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002599 if (src_slices != dst_slices) {
2600 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002601 ss << "vkCmdCopyImage(): number of depth slices in source and destination subresources for pRegions[" << i
Dave Houlton6f9059e2017-05-02 17:15:13 -06002602 << "] do not match";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002603 skip |= LogError(command_buffer, "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06002604 }
2605 }
2606 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002607 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002608 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002609 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002610 ss << "vkCmdCopyImage(): number of layers in source and destination subresources for pRegions[" << i
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002611 << "] do not match";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002612 skip |= LogError(command_buffer, "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002613 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002614 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002615
Dave Houltonc991cc92018-03-06 11:08:51 -07002616 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002617 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002618 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region);
Dave Houltonc991cc92018-03-06 11:08:51 -07002619 }
2620
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002621 if (!device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002622 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2623 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002624 char const str[] = "vkCmdCopyImage(): Src and dest aspectMasks for each region must match";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002625 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002626 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002627 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002628
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002629 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07002630 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002631 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002632 ss << "vkCmdCopyImage(): pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002633 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002634 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002635 }
2636
2637 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07002638 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002639 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002640 ss << "vkCmdCopyImage(): pRegion[" << i
2641 << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002642 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002643 }
2644
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002645 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
2646 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
2647 // 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 -07002648 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2649 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002650 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002651 ss << "vkCmdCopyImage(): Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002652 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
2653 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
2654 << " ] exceeds the source image dimensions";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002655 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-pRegions-00122", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002656 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002657
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002658 // 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 -07002659 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2660 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002661 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002662 ss << "vkCmdCopyImage(): Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002663 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
2664 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
2665 << " ] exceeds the destination image dimensions";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002666 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-pRegions-00123", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002667 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002668 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002669
Dave Houltonfc1a4052017-04-27 14:32:45 -06002670 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002671 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2672 if (slice_override) src_copy_extent.depth = depth_slices;
2673 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002674 if (extent_check & x_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002675 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002676 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00144",
2677 "vkCmdCopyImage(): Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2678 "width [%1d].",
2679 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002680 }
2681
2682 if (extent_check & y_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002683 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002684 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00145",
2685 "vkCmdCopyImage(): Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2686 "height [%1d].",
2687 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002688 }
2689 if (extent_check & z_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002690 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002691 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00147",
2692 "vkCmdCopyImage(): Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2693 "depth [%1d].",
2694 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002695 }
2696
Dave Houltonee281a52017-12-08 13:51:02 -07002697 // Adjust dest extent if necessary
2698 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2699 if (slice_override) dst_copy_extent.depth = depth_slices;
2700
2701 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002702 if (extent_check & x_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002703 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00150",
2704 "vkCmdCopyImage(): Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2705 "width [%1d].",
2706 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002707 }
2708 if (extent_check & y_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002709 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00151",
2710 "vkCmdCopyImage(): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2711 "height [%1d].",
2712 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002713 }
2714 if (extent_check & z_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002715 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00153",
2716 "vkCmdCopyImage(): Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2717 "depth [%1d].",
2718 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002719 }
2720
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002721 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2722 // must not overlap in memory
2723 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002724 for (uint32_t j = 0; j < regionCount; j++) {
2725 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
Dave Houltonf5217612018-02-02 16:18:52 -07002726 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002727 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002728 ss << "vkCmdCopyImage(): pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002729 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002730 }
2731 }
2732 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002733 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002734
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002735 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2736 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2737 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002738 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002739 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2740 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002741 skip |= LogError(command_buffer, kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002742 }
2743 } else {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002744 if (!FormatSizesAreEqual(src_image_state->createInfo.format, dst_image_state->createInfo.format, regionCount, pRegions)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002745 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002746 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-srcImage-00135", "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002747 }
2748 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002749
Dave Houlton33c22b72017-02-28 13:16:02 -07002750 // Source and dest image sample counts must match
2751 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2752 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002753 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002754 }
2755
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002756 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2757 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002758 // Validate that SRC & DST images have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002759 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyImage-srcImage-00126",
2760 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2761 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyImage-dstImage-00131",
2762 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06002763 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002764 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
2765 "VUID-vkCmdCopyImage-srcImage-01995", "VUID-vkCmdCopyImage-srcImage-01995");
2766 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
2767 "VUID-vkCmdCopyImage-dstImage-01996", "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002768 }
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002769 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyImage()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002770 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002771 skip |= ValidateCmd(cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
2772 skip |= InsideRenderPass(cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002773 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002774 const char *invalid_src_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2775 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2776 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
2777 const char *invalid_dst_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2778 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2779 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002780 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002781 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002782 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2783 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002784 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002785 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2786 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002787 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
2788 "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002789 }
2790
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002791 return skip;
2792}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002793
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002794void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2795 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2796 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06002797 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
2798 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06002799 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002800 auto src_image_state = GetImageState(srcImage);
2801 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002802
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002803 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002804 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002805 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
2806 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002807 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002808}
2809
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002810// Returns true if sub_rect is entirely contained within rect
2811static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2812 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2813 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2814 return false;
2815 return true;
2816}
2817
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002818bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002819 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
2820 const VkRect2D &render_area, uint32_t rect_count,
2821 const VkClearRect *clear_rects) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07002822 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07002823 const IMAGE_VIEW_STATE *image_view_state = nullptr;
2824 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07002825 image_view_state = GetImageViewState(framebuffer->createInfo.pAttachments[fb_attachment]);
John Zulauff2582972019-02-09 14:53:30 -07002826 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002827
2828 for (uint32_t j = 0; j < rect_count; j++) {
2829 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002830 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00016",
2831 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2832 "the current render pass instance.",
2833 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07002834 }
2835
2836 if (image_view_state) {
2837 // The layers specified by a given element of pRects must be contained within every attachment that
2838 // pAttachments refers to
2839 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
2840 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
2841 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002842 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00017",
2843 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
2844 "of pAttachment[%d].",
2845 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07002846 }
2847 }
2848 }
2849 return skip;
2850}
2851
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002852bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2853 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002854 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002855 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06002856 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02002857 if (!cb_node) return skip;
2858
2859 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
2860 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
2861 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Petr Kraus2dffb382019-08-10 02:52:12 +02002862 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002863
2864 // Validate that attachment is in reference list of active subpass
2865 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002866 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07002867 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01002868 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002869 const auto *framebuffer = GetFramebufferState(cb_node->activeFramebuffer);
John Zulauf3a548ef2019-02-01 16:14:07 -07002870 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002871
John Zulauf3a548ef2019-02-01 16:14:07 -07002872 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2873 auto clear_desc = &pAttachments[attachment_index];
2874 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002875
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002876 if (0 == clear_desc->aspectMask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002877 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002878 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002879 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002880 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07002881 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
2882 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
2883 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2884 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002885 skip |= LogError(
2886 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
2887 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
2888 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
2889 attachment_index, clear_desc->colorAttachment,
2890 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
2891 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07002892
John Zulauff2582972019-02-09 14:53:30 -07002893 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
2894 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002895 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002896 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
2897 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
2898 " subpass %u. colorAttachmentCount=%u",
2899 attachment_index, clear_desc->colorAttachment,
2900 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
2901 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002902 }
John Zulauff2582972019-02-09 14:53:30 -07002903 fb_attachment = color_attachment;
2904
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002905 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2906 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2907 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002908 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002909 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002910 }
2911 } else { // Must be depth and/or stencil
2912 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2913 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002914 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002915 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-parameter", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002916 }
2917 if (!subpass_desc->pDepthStencilAttachment ||
2918 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002919 skip |= LogPerformanceWarning(
2920 commandBuffer, kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002921 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002922 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07002923 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002924 }
2925 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002926 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002927 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
2928 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06002929 }
2930 }
2931 }
2932 return skip;
2933}
2934
2935void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2936 const VkClearAttachment *pAttachments, uint32_t rectCount,
2937 const VkClearRect *pRects) {
2938 auto *cb_node = GetCBState(commandBuffer);
2939 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
2940 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
2941 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
2942 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
2943 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2944 const auto clear_desc = &pAttachments[attachment_index];
2945 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
2946 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
2947 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
2948 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2949 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
2950 subpass_desc->pDepthStencilAttachment) {
2951 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
2952 }
2953 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07002954 if (!clear_rect_copy) {
2955 // We need a copy of the clear rectangles that will persist until the last lambda executes
2956 // but we want to create it as lazily as possible
2957 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002958 }
John Zulauf441558b2019-08-12 11:47:39 -06002959 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
2960 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002961 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
John Zulauff1640d12019-08-13 15:39:58 -06002962 const CMD_BUFFER_STATE *prim_cb, VkFramebuffer fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07002963 assert(rectCount == clear_rect_copy->size());
John Zulauf441558b2019-08-12 11:47:39 -06002964 const FRAMEBUFFER_STATE *framebuffer = GetFramebufferState(fb);
John Zulauf3a548ef2019-02-01 16:14:07 -07002965 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
2966 bool skip = false;
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002967 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
2968 rectCount, clear_rect_copy->data());
John Zulauf3a548ef2019-02-01 16:14:07 -07002969 return skip;
2970 };
2971 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002972 }
2973 }
2974 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002975}
2976
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002977bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2978 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002979 const VkImageResolve *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002980 const auto *cb_node = GetCBState(commandBuffer);
2981 const auto *src_image_state = GetImageState(srcImage);
2982 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002983
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002984 bool skip = false;
2985 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002986 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-srcImage-00256");
2987 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-00258");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002988 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002989 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002990 skip |= ValidateCmd(cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
2991 skip |= InsideRenderPass(cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002992 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, "vkCmdResolveImage()",
2993 "VUID-vkCmdResolveImage-dstImage-02003", "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002994
Cort Stratton7df30962018-05-17 19:45:57 -07002995 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002996 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002997 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002998 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
2999 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
3000 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003001 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003002 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3003 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003004 // For each region, the number of layers in the image subresource should not be zero
3005 // For each region, src and dest image aspect must be color only
3006 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003007 skip |=
3008 ValidateImageSubresourceLayers(cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()", "srcSubresource", i);
3009 skip |=
3010 ValidateImageSubresourceLayers(cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()", "dstSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003011 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003012 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
3013 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003014 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003015 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
3016 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003017 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i, "vkCmdResolveImage()",
3018 "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
3019 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i, "vkCmdResolveImage()",
3020 "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
3021 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003022 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
3023 "VUID-vkCmdResolveImage-srcSubresource-01711");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003024 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003025 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
3026 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07003027
3028 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003029 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003030 skip |= LogError(
3031 cb_node->commandBuffer, "VUID-VkImageResolve-layerCount-00267",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003032 "vkCmdResolveImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003033 }
Cort Stratton7df30962018-05-17 19:45:57 -07003034 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003035 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3036 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
3037 char const str[] =
Graeme Leese79b60cb2018-11-28 11:51:20 +00003038 "vkCmdResolveImage(): src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003039 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003040 }
3041 }
3042
3043 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
3044 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003045 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003046 }
3047 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
3048 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003049 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageType, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003050 }
3051 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
3052 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003053 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-srcImage-00257", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003054 }
3055 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
3056 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003057 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-dstImage-00259", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003058 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003059 } else {
3060 assert(0);
3061 }
3062 return skip;
3063}
3064
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003065bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3066 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003067 const VkImageBlit *pRegions, VkFilter filter) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003068 const auto *cb_node = GetCBState(commandBuffer);
3069 const auto *src_image_state = GetImageState(srcImage);
3070 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003071
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003072 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003073 if (cb_node) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003074 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
John Zulauf5c2750c2018-01-30 15:04:56 -07003075 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003076 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003077 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003078 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003079 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003080 "VUID-vkCmdBlitImage-dstImage-00234");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003081 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
3082 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
Dave Houltond8ed0212018-05-16 17:18:24 -06003083 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003084 ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdBlitImage-srcImage-00219",
3085 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06003086 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003087 ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdBlitImage-dstImage-00224",
3088 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003089 skip |=
3090 ValidateCmdQueueFlags(cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003091 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
3092 skip |= InsideRenderPass(cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003093 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003094 "VUID-vkCmdBlitImage-srcImage-01999", "VUID-vkCmdBlitImage-srcImage-01999");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003095 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003096 "VUID-vkCmdBlitImage-dstImage-02000", "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04003097
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003098 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003099
Dave Houlton33c2d252017-06-09 17:08:32 -06003100 VkFormat src_format = src_image_state->createInfo.format;
3101 VkFormat dst_format = dst_image_state->createInfo.format;
3102 VkImageType src_type = src_image_state->createInfo.imageType;
3103 VkImageType dst_type = dst_image_state->createInfo.imageType;
3104
Cort Stratton186b1a22018-05-01 20:18:06 -04003105 if (VK_FILTER_LINEAR == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003106 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003107 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001",
3108 "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04003109 } else if (VK_FILTER_CUBIC_IMG == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003110 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
3111 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02002",
3112 "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06003113 }
3114
3115 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003116 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-filter-00237",
3117 "vkCmdBlitImage(): source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003118 }
3119
Dave Houlton33c2d252017-06-09 17:08:32 -06003120 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
3121 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003122 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00228",
3123 "vkCmdBlitImage(): source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003124 }
3125
3126 // Validate consistency for unsigned formats
3127 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3128 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003129 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003130 << "the other one must also have unsigned integer format. "
3131 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003132 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003133 }
3134
3135 // Validate consistency for signed formats
3136 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3137 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003138 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003139 << "the other one must also have signed integer format. "
3140 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003141 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003142 }
3143
3144 // Validate filter for Depth/Stencil formats
3145 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3146 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003147 ss << "vkCmdBlitImage(): If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003148 << "then filter must be VK_FILTER_NEAREST.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003149 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003150 }
3151
3152 // Validate aspect bits and formats for depth/stencil images
3153 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3154 if (src_format != dst_format) {
3155 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003156 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003157 << "stencil, the other one must have exactly the same format. "
3158 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3159 << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003160 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003161 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003162 } // Depth or Stencil
3163
3164 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003165 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003166 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003167 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3168 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3169 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003170 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003171 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3172 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003173 for (uint32_t i = 0; i < regionCount; i++) {
3174 const VkImageBlit rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003175 bool hit_error = false;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003176 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003177 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3178 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003179 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003180 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3181 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003182 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3183 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
3184 skip |= ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003185 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003186 skip |= ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003187 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003188 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003189 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3190 "VUID-vkCmdBlitImage-srcSubresource-01707");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003191 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003192 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3193 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003194 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003195 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3196 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003197 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003198 ss << "vkCmdBlitImage(): pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003199 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003200 }
Dave Houlton48989f32017-05-26 15:01:46 -06003201 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3202 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003203 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003204 ss << "vkCmdBlitImage(): pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003205 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003206 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003207
3208 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003209 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003210 skip |= LogError(
3211 cb_node->commandBuffer, "VUID-VkImageBlit-layerCount-00239",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003212 "vkCmdBlitImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003213 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003214
Dave Houlton48989f32017-05-26 15:01:46 -06003215 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003216 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00238",
3217 "vkCmdBlitImage(): aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003218 }
Dave Houlton48989f32017-05-26 15:01:46 -06003219
Dave Houlton33c2d252017-06-09 17:08:32 -06003220 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003221 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00241",
3222 "vkCmdBlitImage(): region [%d] source aspectMask (0x%x) specifies aspects not present in source "
3223 "image format %s.",
3224 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003225 }
3226
3227 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003228 skip |= LogError(
3229 cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00242",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003230 "vkCmdBlitImage(): region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3231 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003232 }
3233
Dave Houlton48989f32017-05-26 15:01:46 -06003234 // Validate source image offsets
3235 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003236 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003237 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003238 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003239 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00245",
3240 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3241 "of (%1d, %1d). These must be (0, 1).",
3242 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003243 }
3244 }
3245
Dave Houlton33c2d252017-06-09 17:08:32 -06003246 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003247 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003248 skip |=
3249 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00247",
3250 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3251 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3252 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003253 }
3254 }
3255
Dave Houlton33c2d252017-06-09 17:08:32 -06003256 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003257 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3258 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003259 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003260 skip |= LogError(
3261 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00243",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003262 "vkCmdBlitImage(): region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).", i,
3263 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003264 }
3265 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3266 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003267 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003268 skip |= LogError(
3269 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00244",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003270 "vkCmdBlitImage(): region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003271 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003272 }
3273 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3274 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003275 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003276 skip |= LogError(
3277 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00246",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003278 "vkCmdBlitImage(): region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).", i,
3279 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003280 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003281 if (oob) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003282 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-pRegions-00215",
3283 "vkCmdBlitImage(): region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003284 }
Dave Houlton48989f32017-05-26 15:01:46 -06003285
3286 // Validate dest image offsets
3287 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003288 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003289 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003290 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003291 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-dstImage-00250",
3292 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3293 "(%1d, %1d). These must be (0, 1).",
3294 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003295 }
3296 }
3297
Dave Houlton33c2d252017-06-09 17:08:32 -06003298 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003299 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003300 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-dstImage-00252",
3301 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3302 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3303 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003304 }
3305 }
3306
Dave Houlton33c2d252017-06-09 17:08:32 -06003307 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003308 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3309 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003310 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003311 skip |= LogError(
3312 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00248",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003313 "vkCmdBlitImage(): region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).", i,
3314 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003315 }
3316 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3317 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003318 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003319 skip |= LogError(
3320 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00249",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003321 "vkCmdBlitImage(): region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003322 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003323 }
3324 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3325 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003326 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003327 skip |= LogError(
3328 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00251",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003329 "vkCmdBlitImage(): region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).", i,
3330 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003331 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003332 if (oob) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003333 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-pRegions-00216",
3334 "vkCmdBlitImage(): region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003335 }
3336
Dave Houlton33c2d252017-06-09 17:08:32 -06003337 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3338 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3339 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003340 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003341 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00240",
3342 "vkCmdBlitImage(): region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3343 "layerCount other than 1.",
3344 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003345 }
3346 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003347 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003348 } else {
3349 assert(0);
3350 }
3351 return skip;
3352}
3353
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003354void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3355 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3356 const VkImageBlit *pRegions, VkFilter filter) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003357 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3358 pRegions, filter);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003359 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003360 auto src_image_state = GetImageState(srcImage);
3361 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003362
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003363 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003364 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003365 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3366 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003367 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003368}
3369
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003370// This validates that the initial layout specified in the command buffer for the IMAGE is the same as the global IMAGE layout
John Zulauf3b04ebd2019-07-18 14:08:11 -06003371bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const ImageSubresPairLayoutMap &globalImageLayoutMap,
3372 ImageSubresPairLayoutMap *overlayLayoutMap_arg) const {
Matthew Ruschd7ef5482019-07-16 22:01:54 -07003373 if (disabled.image_layout_validation) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003374 bool skip = false;
John Zulauf3b04ebd2019-07-18 14:08:11 -06003375 ImageSubresPairLayoutMap &overlayLayoutMap = *overlayLayoutMap_arg;
John Zulauff660ad62019-03-23 07:16:05 -06003376 // Iterate over the layout maps for each referenced image
3377 for (const auto &layout_map_entry : pCB->image_layout_map) {
3378 const auto image = layout_map_entry.first;
3379 const auto *image_state = GetImageState(image);
3380 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06003381 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06003382 ImageSubresourcePair isr_pair;
3383 isr_pair.image = image;
3384 isr_pair.hasSubresource = true;
John Zulauff660ad62019-03-23 07:16:05 -06003385 // Validate the initial_uses for each subresource referenced
John Zulauf6066f732019-11-21 13:15:10 -07003386 for (const auto &pos : subres_map->InitialLayoutView()) {
3387 isr_pair.subresource = pos.subresource;
3388 VkImageLayout initial_layout = pos.it->second; // Point directly into the RangeMap iterated but the view
John Zulauff660ad62019-03-23 07:16:05 -06003389 VkImageLayout image_layout;
3390 if (FindLayout(overlayLayoutMap, isr_pair, image_layout) || FindLayout(globalImageLayoutMap, isr_pair, image_layout)) {
3391 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
3392 // TODO: Set memory invalid which is in mem_tracker currently
3393 } else if (image_layout != initial_layout) {
John Zulaufb61ed972019-04-09 16:12:35 -06003394 // Need to look up the inital layout *state* to get a bit more information
3395 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(isr_pair.subresource);
3396 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
3397 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
3398 if (!matches) {
3399 std::string formatted_label = FormatDebugLabel(" ", pCB->debug_label);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003400 skip |= LogError(
3401 pCB->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06003402 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
locke-lunargadbb54c2019-06-26 00:05:17 -06003403 "to be in layout %s--instead, current layout is %s.%s",
unknown089cdb82019-07-11 12:58:43 -06003404 report_data->FormatHandle(image).c_str(), isr_pair.subresource.aspectMask,
locke-lunargadbb54c2019-06-26 00:05:17 -06003405 isr_pair.subresource.arrayLayer, isr_pair.subresource.mipLevel, string_VkImageLayout(initial_layout),
3406 string_VkImageLayout(image_layout), formatted_label.c_str());
John Zulaufb61ed972019-04-09 16:12:35 -06003407 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003408 }
3409 }
John Zulauff660ad62019-03-23 07:16:05 -06003410 }
3411
3412 // Update all layout set operations (which will be a subset of the initial_layouts
John Zulauf6066f732019-11-21 13:15:10 -07003413 for (const auto &pos : subres_map->CurrentLayoutView()) {
3414 VkImageLayout layout = pos.it->second;
3415 assert(layout != kInvalidLayout);
3416 isr_pair.subresource = pos.subresource;
3417 SetLayout(overlayLayoutMap, isr_pair, layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003418 }
3419 }
John Zulauff660ad62019-03-23 07:16:05 -06003420
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003421 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003422}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003423
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003424void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06003425 for (const auto &layout_map_entry : pCB->image_layout_map) {
3426 const auto image = layout_map_entry.first;
3427 const auto *image_state = GetImageState(image);
3428 if (!image_state) continue; // Can't set layouts of a dead image
3429 const auto &subres_map = layout_map_entry.second;
3430 ImageSubresourcePair isr_pair;
3431 isr_pair.image = image;
3432 isr_pair.hasSubresource = true;
3433
3434 // Update all layout set operations (which will be a subset of the initial_layouts
John Zulauf6066f732019-11-21 13:15:10 -07003435 for (const auto &pos : subres_map->CurrentLayoutView()) {
3436 VkImageLayout layout = pos.it->second;
3437 assert(layout != kInvalidLayout);
3438 isr_pair.subresource = pos.subresource;
3439 SetGlobalLayout(isr_pair, layout);
John Zulauff660ad62019-03-23 07:16:05 -06003440 }
Tony Barbourdf013b92017-01-25 12:53:48 -07003441 }
3442}
3443
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003444// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003445// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3446// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003447bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3448 const VkImageLayout first_layout, const uint32_t attachment,
John Zulauf9d2b6382019-07-25 15:21:36 -06003449 const VkAttachmentDescription2KHR &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003450 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003451 const char *vuid;
3452 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3453
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003454 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
3455 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003456 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3457 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3458 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003459 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
3460 "Cannot clear attachment %d with invalid first layout %s.", attachment,
3461 string_VkImageLayout(first_layout));
Shannon McPherson3ea65132018-12-05 10:37:39 -07003462 } else if (!use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3463 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003464 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
3465 "Cannot clear attachment %d with invalid first layout %s.", attachment,
3466 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003467 }
3468 }
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003469 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3470 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003471 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01566";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003472 skip |= LogError(device, vuid, "Cannot clear attachment %d with invalid first layout %s.", attachment,
3473 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003474 }
3475 }
3476
3477 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3478 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003479 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01567";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003480 skip |= LogError(device, vuid, "Cannot clear attachment %d with invalid first layout %s.", attachment,
3481 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003482 }
3483 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003484 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003485}
3486
Mark Lobodzinskiac02c612020-01-17 14:52:35 -07003487bool CoreChecks::ValidateLayouts(RenderPassCreateVersion rp_version, VkDevice device, const VkRenderPassCreateInfo2KHR *pCreateInfo,
3488 const char *function_name) const {
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003489 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003490 const char *vuid;
3491 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003492
Jason Ekstranda1906302017-12-03 20:16:32 -08003493 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3494 VkFormat format = pCreateInfo->pAttachments[i].format;
3495 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3496 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3497 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003498 skip |= LogWarning(device, kVUID_Core_DrawState_InvalidRenderpass,
3499 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
3500 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3501 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3502 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003503 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003504 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003505 skip |=
3506 LogWarning(device, kVUID_Core_DrawState_InvalidRenderpass,
3507 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3508 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3509 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3510 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003511 }
3512 }
3513 }
3514
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003515 // Track when we're observing the first use of an attachment
3516 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3517 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003518 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003519
3520 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3521 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3522 auto attach_index = subpass.pInputAttachments[j].attachment;
3523 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003524 switch (subpass.pInputAttachments[j].layout) {
3525 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3526 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3527 // These are ideal.
3528 break;
3529
3530 case VK_IMAGE_LAYOUT_GENERAL:
3531 // May not be optimal. TODO: reconsider this warning based on other constraints.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003532 skip |= LogPerformanceWarning(device, kVUID_Core_DrawState_InvalidImageLayout,
3533 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
Cort Stratton7547f772017-05-04 15:18:52 -07003534 break;
3535
Tobias Hectorbbb12282018-10-22 15:17:59 +01003536 case VK_IMAGE_LAYOUT_UNDEFINED:
3537 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003538 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003539 skip |= LogError(device, vuid,
3540 "Layout for input attachment reference %u in subpass %u is %s but must be "
3541 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
3542 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003543 break;
3544
Piers Daniell9af77cd2019-10-16 13:54:12 -06003545 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3546 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3547 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3548 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003549 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003550 skip |= LogError(
3551 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003552 "Layout for input attachment reference %u in subpass %u is %s but must not be "
3553 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3554 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3555 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
3556 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003557 skip |= LogError(
3558 device, "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003559 "Layout for input attachment reference %u in subpass %u is %s but must not be "
3560 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3561 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3562 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
3563 } else if ((subpass.pInputAttachments[j].aspectMask &
3564 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3565 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3566 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3567 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3568 const auto *attachment_reference_stencil_layout =
3569 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pInputAttachments[j].pNext);
3570 if (attachment_reference_stencil_layout) {
3571 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3572 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3573 attachment_reference_stencil_layout->stencilLayout ==
3574 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3575 attachment_reference_stencil_layout->stencilLayout ==
3576 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3577 attachment_reference_stencil_layout->stencilLayout ==
3578 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3579 attachment_reference_stencil_layout->stencilLayout ==
3580 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3581 attachment_reference_stencil_layout->stencilLayout ==
3582 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3583 attachment_reference_stencil_layout->stencilLayout ==
3584 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3585 attachment_reference_stencil_layout->stencilLayout ==
3586 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3587 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003588 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
3589 "In the attachment reference %u in subpass %u with pNext chain instance "
3590 "VkAttachmentReferenceStencilLayoutKHR"
3591 "the stencilLayout member but must not be "
3592 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3593 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3594 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3595 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3596 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3597 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3598 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3599 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3600 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3601 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003602 }
3603 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003604 skip |= LogError(
3605 device, "VUID-VkAttachmentReference2-attachment-03315",
3606 "When the layout for input attachment reference %u in subpass %u is "
3607 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3608 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3609 "VkAttachmentReferenceStencilLayout instance.",
3610 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003611 }
3612 }
3613 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3614 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3615 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003616 skip |= LogError(
3617 device, "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003618 "When the aspectMask for input attachment reference %u in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3619 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3620 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3621 j, i);
3622 }
3623 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3624 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3625 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003626 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
3627 "When the aspectMask for input attachment reference %u in subpass %u is "
3628 "VK_IMAGE_ASPECT_STENCIL_BIT "
3629 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3630 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
3631 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003632 }
3633 }
3634 break;
3635
Graeme Leese668a9862018-10-08 10:40:02 +01003636 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3637 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003638 if (device_extensions.vk_khr_maintenance2) {
Graeme Leese668a9862018-10-08 10:40:02 +01003639 break;
3640 } else {
3641 // Intentionally fall through to generic error message
3642 }
3643 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003644
Cort Stratton7547f772017-05-04 15:18:52 -07003645 default:
3646 // No other layouts are acceptable
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003647 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
3648 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3649 string_VkImageLayout(subpass.pInputAttachments[j].layout));
Cort Stratton7547f772017-05-04 15:18:52 -07003650 }
3651
Cort Stratton7547f772017-05-04 15:18:52 -07003652 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003653 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3654 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003655
3656 bool used_as_depth =
3657 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3658 bool used_as_color = false;
3659 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3660 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3661 }
3662 if (!used_as_depth && !used_as_color &&
3663 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08003664 vuid = use_rp2 ? "VUID-VkSubpassDescription2-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003665 skip |= LogError(device, vuid,
3666 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
3667 function_name, attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07003668 }
3669 }
3670 attach_first_use[attach_index] = false;
3671 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003672
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003673 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3674 auto attach_index = subpass.pColorAttachments[j].attachment;
3675 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3676
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003677 // TODO: Need a way to validate shared presentable images here, currently just allowing
3678 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3679 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003680 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003681 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003682 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003683 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3684 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003685 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003686
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003687 case VK_IMAGE_LAYOUT_GENERAL:
3688 // May not be optimal; TODO: reconsider this warning based on other constraints?
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003689 skip |= LogPerformanceWarning(device, kVUID_Core_DrawState_InvalidImageLayout,
3690 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003691 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003692
Tobias Hectorbbb12282018-10-22 15:17:59 +01003693 case VK_IMAGE_LAYOUT_UNDEFINED:
3694 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003695 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003696 skip |= LogError(device, vuid,
3697 "Layout for color attachment reference %u in subpass %u is %s but should be "
3698 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3699 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003700 break;
3701
Piers Daniell9af77cd2019-10-16 13:54:12 -06003702 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3703 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3704 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3705 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003706 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003707 skip |= LogError(
3708 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003709 "Layout for color attachment reference %u in subpass %u is %s but must not be "
3710 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3711 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3712 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3713 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003714 skip |= LogError(
3715 device, "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003716 "Layout for color attachment reference %u in subpass %u is %s but must not be "
3717 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3718 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3719 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3720 } else if ((subpass.pColorAttachments[j].aspectMask &
3721 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3722 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3723 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3724 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3725 const auto *attachment_reference_stencil_layout =
3726 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pColorAttachments[j].pNext);
3727 if (attachment_reference_stencil_layout) {
3728 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3729 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3730 attachment_reference_stencil_layout->stencilLayout ==
3731 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3732 attachment_reference_stencil_layout->stencilLayout ==
3733 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3734 attachment_reference_stencil_layout->stencilLayout ==
3735 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3736 attachment_reference_stencil_layout->stencilLayout ==
3737 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3738 attachment_reference_stencil_layout->stencilLayout ==
3739 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3740 attachment_reference_stencil_layout->stencilLayout ==
3741 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3742 attachment_reference_stencil_layout->stencilLayout ==
3743 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3744 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003745 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
3746 "In the attachment reference %u in subpass %u with pNext chain instance "
3747 "VkAttachmentReferenceStencilLayoutKHR"
3748 "the stencilLayout member but must not be "
3749 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3750 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3751 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3752 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3753 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3754 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3755 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3756 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3757 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3758 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003759 }
3760 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003761 skip |= LogError(
3762 device, "VUID-VkAttachmentReference2-attachment-03315",
3763 "When the layout for color attachment reference %u in subpass %u is "
3764 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3765 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3766 "VkAttachmentReferenceStencilLayout instance.",
3767 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003768 }
3769 }
3770 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3771 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3772 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003773 skip |= LogError(
3774 device, "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003775 "When the aspectMask for color attachment reference %u in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3776 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3777 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3778 j, i);
3779 }
3780 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3781 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3782 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003783 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
3784 "When the aspectMask for color attachment reference %u in subpass %u is "
3785 "VK_IMAGE_ASPECT_STENCIL_BIT "
3786 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3787 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
3788 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003789 }
3790 }
3791 break;
3792
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003793 default:
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003794 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
3795 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3796 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003797 }
3798
John Zulauf4eee2692019-02-09 16:14:25 -07003799 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].attachment != VK_ATTACHMENT_UNUSED) &&
3800 (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
3801 subpass.pResolveAttachments[j].layout == 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 resolve attachment reference %u in subpass %u is %s but should be "
3805 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3806 j, i, string_VkImageLayout(subpass.pResolveAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003807 }
3808
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003809 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003810 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
3811 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003812 }
3813 attach_first_use[attach_index] = false;
3814 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003815
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003816 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3817 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003818 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3819 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3820 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003821 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003822
Dave Houltona9df0ce2018-02-07 10:51:23 -07003823 case VK_IMAGE_LAYOUT_GENERAL:
3824 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3825 // doing a bunch of transitions.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003826 skip |= LogPerformanceWarning(device, kVUID_Core_DrawState_InvalidImageLayout,
3827 "GENERAL layout for depth attachment may not give optimal performance.");
Dave Houltona9df0ce2018-02-07 10:51:23 -07003828 break;
3829
Tobias Hectorbbb12282018-10-22 15:17:59 +01003830 case VK_IMAGE_LAYOUT_UNDEFINED:
3831 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003832 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003833 skip |= LogError(device, vuid,
3834 "Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
3835 "layout or GENERAL.",
3836 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003837 break;
3838
Piers Daniell9af77cd2019-10-16 13:54:12 -06003839 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3840 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3841 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3842 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003843 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003844 skip |= LogError(
3845 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003846 "Layout for depth attachment reference in subpass %u is %s but must not be "
3847 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3848 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3849 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3850 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003851 skip |= LogError(
3852 device, "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003853 "Layout for depth attachment reference in subpass %u is %s but must not be "
3854 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3855 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3856 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3857 } else if ((subpass.pDepthStencilAttachment->aspectMask &
3858 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3859 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3860 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3861 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3862 const auto *attachment_reference_stencil_layout =
3863 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pDepthStencilAttachment->pNext);
3864 if (attachment_reference_stencil_layout) {
3865 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3866 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3867 attachment_reference_stencil_layout->stencilLayout ==
3868 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3869 attachment_reference_stencil_layout->stencilLayout ==
3870 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3871 attachment_reference_stencil_layout->stencilLayout ==
3872 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3873 attachment_reference_stencil_layout->stencilLayout ==
3874 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3875 attachment_reference_stencil_layout->stencilLayout ==
3876 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3877 attachment_reference_stencil_layout->stencilLayout ==
3878 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3879 attachment_reference_stencil_layout->stencilLayout ==
3880 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3881 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003882 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
3883 "In the attachment reference in subpass %u with pNext chain instance "
3884 "VkAttachmentReferenceStencilLayoutKHR"
3885 "the stencilLayout member but must not be "
3886 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3887 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3888 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3889 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3890 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3891 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3892 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3893 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3894 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3895 i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003896 }
3897 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003898 skip |= LogError(
3899 device, "VUID-VkAttachmentReference2-attachment-03315",
3900 "When the layout for depth attachment reference in subpass %u is "
3901 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3902 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3903 "VkAttachmentReferenceStencilLayout instance.",
3904 i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003905 }
3906 }
3907 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3908 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3909 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003910 skip |= LogError(
3911 device, "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003912 "When the aspectMask for depth attachment reference in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3913 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3914 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3915 i);
3916 }
3917 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3918 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3919 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003920 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
3921 "When the aspectMask for depth attachment reference in subpass %u is "
3922 "VK_IMAGE_ASPECT_STENCIL_BIT "
3923 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3924 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
3925 i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003926 }
3927 }
3928 break;
3929
Dave Houltona9df0ce2018-02-07 10:51:23 -07003930 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3931 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003932 if (device_extensions.vk_khr_maintenance2) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003933 break;
3934 } else {
3935 // Intentionally fall through to generic error message
3936 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06003937 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003938
Dave Houltona9df0ce2018-02-07 10:51:23 -07003939 default:
3940 // No other layouts are acceptable
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003941 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
3942 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3943 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
3944 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003945 }
3946
3947 auto attach_index = subpass.pDepthStencilAttachment->attachment;
3948 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003949 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
3950 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003951 }
3952 attach_first_use[attach_index] = false;
3953 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003954 }
3955 return skip;
3956}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003957
Mark Lobodzinski96210742017-02-09 10:33:46 -07003958// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
3959// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003960template <typename T1>
3961bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
3962 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
3963 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003964 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003965 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06003966 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003967 if (strict) {
3968 correct_usage = ((actual & desired) == desired);
3969 } else {
3970 correct_usage = ((actual & desired) != 0);
3971 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003972
Mark Lobodzinski96210742017-02-09 10:33:46 -07003973 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06003974 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06003975 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003976 skip = LogError(object, kVUID_Core_MemTrack_InvalidUsageFlag,
3977 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
3978 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003979 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003980 skip = LogError(object, msgCode,
3981 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
3982 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003983 }
3984 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003985 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003986}
3987
3988// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3989// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003990bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003991 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003992 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image,
John Zulauf4fea6622019-04-01 11:38:18 -06003993 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003994}
3995
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003996bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
John Zulauf07288512019-07-05 11:09:50 -06003997 char const *func_name, const char *linear_vuid, const char *optimal_vuid) const {
Mark Lobodzinski5c048802019-03-07 10:47:31 -07003998 VkFormatProperties format_properties = GetPDFormatProperties(image_state->createInfo.format);
Cort Stratton186b1a22018-05-01 20:18:06 -04003999 bool skip = false;
4000 if (image_state->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
4001 if ((format_properties.linearTilingFeatures & desired) != desired) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004002 skip |=
4003 LogError(image_state->image, linear_vuid, "In %s, invalid linearTilingFeatures (0x%08X) for format %u used by %s.",
4004 func_name, format_properties.linearTilingFeatures, image_state->createInfo.format,
4005 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04004006 }
4007 } else if (image_state->createInfo.tiling == VK_IMAGE_TILING_OPTIMAL) {
4008 if ((format_properties.optimalTilingFeatures & desired) != desired) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004009 skip |= LogError(image_state->image, optimal_vuid,
4010 "In %s, invalid optimalTilingFeatures (0x%08X) for format %u used by %s.", func_name,
4011 format_properties.optimalTilingFeatures, image_state->createInfo.format,
4012 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04004013 }
4014 }
4015 return skip;
4016}
4017
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004018bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004019 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004020 bool skip = false;
Cort Strattond619a302018-05-17 19:46:32 -07004021 // layerCount must not be zero
4022 if (subresource_layers->layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004023 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-layerCount-01700",
4024 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004025 }
4026 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
4027 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004028 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00168",
4029 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004030 }
4031 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
4032 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
4033 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004034 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00167",
4035 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4036 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4037 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004038 }
4039 return skip;
4040}
4041
Mark Lobodzinski96210742017-02-09 10:33:46 -07004042// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4043// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004044bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004045 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004046 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer,
John Zulauf4fea6622019-04-01 11:38:18 -06004047 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004048}
4049
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004050bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004051 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004052 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004053
4054 const VkDeviceSize &range = pCreateInfo->range;
4055 if (range != VK_WHOLE_SIZE) {
4056 // Range must be greater than 0
4057 if (range <= 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004058 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00928",
4059 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4060 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4061 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004062 }
4063 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004064 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4065 if (SafeModulo(range, format_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004066 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00929",
4067 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4068 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4069 "(%" PRIu32 ").",
4070 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004071 }
4072 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004073 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004074 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00930",
4075 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4076 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4077 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4078 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004079 }
4080 // The sum of range and offset must be less than or equal to the size of buffer
4081 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004082 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00931",
4083 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4084 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4085 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4086 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004087 }
4088 }
4089 return skip;
4090}
4091
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004092bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004093 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004094 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004095 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4096 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004097 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00933",
4098 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
4099 "be supported for uniform texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004100 }
4101 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4102 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004103 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00934",
4104 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
4105 "be supported for storage texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004106 }
4107 return skip;
4108}
4109
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004110bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004111 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004112 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004113
Dave Houltond8ed0212018-05-16 17:18:24 -06004114 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004115
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004116 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!enabled_features.core.sparseBinding)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004117 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-00915",
4118 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
4119 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004120 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06004121
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004122 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!enabled_features.core.sparseResidencyBuffer)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004123 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-00916",
4124 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
4125 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06004126 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06004127
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004128 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004129 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-00917",
4130 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
4131 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06004132 }
Jeff Bolz87697532019-01-11 22:54:00 -06004133
4134 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
4135 if (chained_devaddr_struct) {
4136 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
4137 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004138 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4139 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
4140 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004141 }
4142 }
4143
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004144 auto chained_opaqueaddr_struct = lvl_find_in_chain<VkBufferOpaqueCaptureAddressCreateInfoKHR>(pCreateInfo->pNext);
4145 if (chained_opaqueaddr_struct) {
4146 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
4147 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004148 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
4149 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfoKHR::opaqueCaptureAddress"
4150 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004151 }
4152 }
4153
Shannon McPherson4984e642019-12-05 13:04:34 -07004154 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
Piers Daniell41b8c5d2020-01-10 15:42:00 -07004155 !enabled_features.core12.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004156 skip |= LogError(
4157 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004158 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
4159 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
4160 }
4161
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004162 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004163 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateBuffer",
4164 "pCreateInfo->pQueueFamilyIndices", "VUID-VkBufferCreateInfo-sharingMode-01419",
4165 "VUID-VkBufferCreateInfo-sharingMode-01419", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004166 }
4167
Mark Lobodzinski96210742017-02-09 10:33:46 -07004168 return skip;
4169}
4170
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004171bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004172 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004173 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004174 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004175 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4176 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004177 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004178 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4179 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004180 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004181 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4182 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4183 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004184
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004185 // Buffer view offset must be less than the size of buffer
4186 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004187 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00925",
4188 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4189 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4190 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004191 }
4192
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004193 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004194 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4195 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4196 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004197 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-02749",
4198 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4199 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4200 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004201 }
4202
4203 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
4204 VkDeviceSize elementSize = FormatElementSize(pCreateInfo->format);
4205 if ((elementSize % 3) == 0) {
4206 elementSize /= 3;
4207 }
4208 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
4209 VkDeviceSize alignmentRequirement =
4210 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4211 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
4212 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4213 }
4214 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004215 skip |= LogError(
4216 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02750",
Jeff Bolzd5554e62019-07-19 13:23:52 -05004217 "If buffer was created with usage containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
4218 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4219 ") must be a multiple of the lesser of "
4220 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4221 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4222 "(%" PRId32
4223 ") is VK_TRUE, the size of a texel of the requested format. "
4224 "If the size of a texel is a multiple of three bytes, then the size of a "
4225 "single component of format is used instead",
4226 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4227 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4228 }
4229 }
4230 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
4231 VkDeviceSize alignmentRequirement =
4232 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4233 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
4234 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4235 }
4236 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004237 skip |= LogError(
4238 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02751",
Jeff Bolzd5554e62019-07-19 13:23:52 -05004239 "If buffer was created with usage containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
4240 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4241 ") must be a multiple of the lesser of "
4242 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4243 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4244 "(%" PRId32
4245 ") is VK_TRUE, the size of a texel of the requested format. "
4246 "If the size of a texel is a multiple of three bytes, then the size of a "
4247 "single component of format is used instead",
4248 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4249 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4250 }
4251 }
4252 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004253
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004254 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004255
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004256 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004257 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004258 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004259}
4260
Mark Lobodzinski602de982017-02-09 11:01:33 -07004261// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004262bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004263 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004264 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004265
Dave Houlton1d2022c2017-03-29 11:43:58 -06004266 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004267 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004268 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 -07004269 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004270 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 -07004271 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004272 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004273 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004274 skip |= LogError(image, vuid,
4275 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
4276 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4277 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004278 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004279 skip |= LogError(image, vuid,
4280 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
4281 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4282 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004283 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004284 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004285 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004286 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 -07004287 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004288 skip |=
4289 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 -07004290 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004291 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004292 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004293 skip |=
4294 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 -07004295 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004296 skip |= LogError(image, vuid, "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.",
4297 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004298 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004299 } else if (FormatIsMultiplane(format)) {
4300 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4301 if (3 == FormatPlaneCount(format)) {
4302 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4303 }
4304 if ((aspect_mask & valid_flags) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004305 skip |=
4306 LogError(image, vuid,
4307 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4308 "set, where n = [0, 1, 2].",
4309 func_name);
Dave Houlton501b15b2018-03-30 15:07:41 -06004310 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004311 }
4312 return skip;
4313}
4314
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004315bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4316 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004317 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
4318 SubresourceRangeErrorCodes errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004319 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004320
4321 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004322 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004323 skip |= LogError(image, errorCodes.base_mip_err,
4324 "%s: %s.baseMipLevel (= %" PRIu32
4325 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4326 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004327 }
Petr Kraus4d718682017-05-18 03:38:41 +02004328
Petr Krausffa94af2017-08-08 21:46:02 +02004329 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4330 if (subresourceRange.levelCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004331 skip |= LogError(image, errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004332 } else {
4333 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004334
Petr Krausffa94af2017-08-08 21:46:02 +02004335 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004336 skip |= LogError(image, errorCodes.mip_count_err,
4337 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4338 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
4339 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
4340 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004341 }
Petr Kraus4d718682017-05-18 03:38:41 +02004342 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004343 }
Petr Kraus4d718682017-05-18 03:38:41 +02004344
4345 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004346 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004347 skip |= LogError(image, errorCodes.base_layer_err,
4348 "%s: %s.baseArrayLayer (= %" PRIu32
4349 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4350 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004351 }
Petr Kraus4d718682017-05-18 03:38:41 +02004352
Petr Krausffa94af2017-08-08 21:46:02 +02004353 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4354 if (subresourceRange.layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004355 skip |= LogError(image, errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004356 } else {
4357 const uint64_t necessary_layer_count =
4358 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004359
Petr Krausffa94af2017-08-08 21:46:02 +02004360 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004361 skip |= LogError(image, errorCodes.layer_count_err,
4362 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4363 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
4364 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
4365 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004366 }
Petr Kraus4d718682017-05-18 03:38:41 +02004367 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004368 }
Petr Kraus4d718682017-05-18 03:38:41 +02004369
Mark Lobodzinski602de982017-02-09 11:01:33 -07004370 return skip;
4371}
4372
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004373bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004374 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004375 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004376 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4377 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4378 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4379
4380 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4381 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4382
4383 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004384 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4385 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
Shannon McPherson5a0de262019-06-05 10:43:56 -06004386 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-02724"
Dave Houltond8ed0212018-05-16 17:18:24 -06004387 : "VUID-VkImageViewCreateInfo-image-01482")
4388 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4389 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
Shannon McPherson5a0de262019-06-05 10:43:56 -06004390 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
Dave Houltond8ed0212018-05-16 17:18:24 -06004391 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4392 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004393
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004394 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004395 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004396 image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004397}
4398
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004399bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004400 const VkImageSubresourceRange &subresourceRange,
4401 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004402 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004403 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4404 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4405 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4406 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004407
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004408 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004409 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image,
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004410 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004411}
4412
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004413bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004414 const VkImageSubresourceRange &subresourceRange,
4415 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004416 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004417 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4418 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4419 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4420 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004421
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004422 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004423 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image,
4424 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004425}
4426
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004427bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004428 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
John Zulaufa4472282019-08-22 14:44:34 -06004429 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004430 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004431 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4432 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4433 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4434 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004435
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004436 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004437 cmd_name, param_name, "arrayLayers", image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004438}
4439
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004440bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004441 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004442 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004443 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004444 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004445 skip |=
4446 ValidateImageUsageFlags(image_state,
4447 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
4448 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4449 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV | VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
4450 false, kVUIDUndefined, "vkCreateImageView()",
4451 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
4452 "SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004453 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004454 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004455 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004456 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004457 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004458 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004459
4460 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4461 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004462 VkImageUsageFlags image_usage = image_state->createInfo.usage;
4463 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004464 VkFormat view_format = pCreateInfo->format;
4465 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004466 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004467 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004468
Dave Houltonbd2e2622018-04-10 16:41:14 -06004469 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004470 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004471 if (chained_ivuci_struct) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05004472 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance2) {
4473 if (!device_extensions.vk_ext_separate_stencil_usage) {
4474 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004475 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
4476 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
4477 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05004478 }
4479 } else {
4480 const auto image_stencil_struct =
4481 lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
4482 if (image_stencil_struct == nullptr) {
4483 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004484 skip |= LogError(
4485 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004486 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
4487 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
4488 "any bits that were not set in VkImageCreateInfo::usage used to create image");
4489 }
4490 } else {
4491 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
4492 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
4493 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004494 skip |= LogError(
4495 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004496 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4497 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4498 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
4499 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
4500 }
4501 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
4502 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004503 skip |= LogError(
4504 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004505 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4506 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4507 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
4508 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
4509 }
4510 }
4511 }
4512 }
4513
Dave Houltonbd2e2622018-04-10 16:41:14 -06004514 image_usage = chained_ivuci_struct->usage;
4515 }
4516
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004517 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4518 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004519 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01004520 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06004521 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01004522 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06004523 std::stringstream ss;
4524 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01004525 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06004526 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004527 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004528 }
4529 } else {
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004530 if ((!device_extensions.vk_khr_maintenance2 ||
Dave Houltonc7988072018-04-16 11:46:56 -06004531 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
4532 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4533 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
4534 std::stringstream ss;
4535 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06004536 << " is not in the same format compatibility class as "
4537 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004538 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4539 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004540 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01018", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004541 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004542 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004543 }
4544 } else {
4545 // Format MUST be IDENTICAL to the format the image was created with
4546 if (image_format != view_format) {
4547 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06004548 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07004549 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004550 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004551 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01019", "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004552 }
4553 }
4554
4555 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004556 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004557
4558 switch (image_type) {
4559 case VK_IMAGE_TYPE_1D:
4560 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004561 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4562 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4563 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004564 }
4565 break;
4566 case VK_IMAGE_TYPE_2D:
4567 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4568 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4569 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004570 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
4571 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4572 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004573 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004574 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4575 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4576 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004577 }
4578 }
4579 break;
4580 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004581 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06004582 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4583 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4584 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004585 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004586 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
4587 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4588 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004589 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4590 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004591 skip |= LogError(
4592 pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4593 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4594 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
4595 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4596 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004597 }
4598 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004599 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4600 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4601 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004602 }
4603 }
4604 } else {
4605 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004606 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4607 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4608 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004609 }
4610 }
4611 break;
4612 default:
4613 break;
4614 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004615
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004616 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004617 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07004618 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004619 }
4620
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004621 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004622 VkFormatFeatureFlags tiling_features = (image_tiling & VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4623 : format_properties.optimalTilingFeatures;
4624
4625 if (tiling_features == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004626 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-None-02273",
4627 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4628 "physical device.",
4629 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004630 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004631 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-usage-02274",
4632 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4633 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4634 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004635 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004636 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-usage-02275",
4637 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4638 "VK_IMAGE_USAGE_STORAGE_BIT.",
4639 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004640 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
4641 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004642 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-usage-02276",
4643 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4644 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4645 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004646 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4647 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004648 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-usage-02277",
4649 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4650 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4651 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004652 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004653
Jeff Bolz9af91c52018-09-01 21:53:57 -05004654 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4655 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004656 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
4657 "vkCreateImageView() If image was created with usage containing "
4658 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4659 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05004660 }
4661 if (view_format != VK_FORMAT_R8_UINT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004662 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
4663 "vkCreateImageView() If image was created with usage containing "
4664 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05004665 }
4666 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004667 }
4668 return skip;
4669}
4670
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004671bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
4672 uint32_t regionCount, const VkBufferCopy *pRegions) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004673 bool skip = false;
4674
4675 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
4676 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
4677 VkDeviceSize src_min = UINT64_MAX;
4678 VkDeviceSize src_max = 0;
4679 VkDeviceSize dst_min = UINT64_MAX;
4680 VkDeviceSize dst_max = 0;
4681
4682 for (uint32_t i = 0; i < regionCount; i++) {
4683 src_min = std::min(src_min, pRegions[i].srcOffset);
4684 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
4685 dst_min = std::min(dst_min, pRegions[i].dstOffset);
4686 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
4687
4688 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
4689 if (pRegions[i].srcOffset >= src_buffer_size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004690 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-srcOffset-00113",
4691 "vkCmdCopyBuffer(): pRegions[%d].srcOffset (%" PRIuLEAST64
4692 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
4693 i, pRegions[i].srcOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004694 }
4695
4696 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
4697 if (pRegions[i].dstOffset >= dst_buffer_size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004698 skip |= LogError(dst_buffer_state->buffer, "VUID-vkCmdCopyBuffer-dstOffset-00114",
4699 "vkCmdCopyBuffer(): pRegions[%d].dstOffset (%" PRIuLEAST64
4700 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
4701 i, pRegions[i].dstOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004702 }
4703
4704 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
4705 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004706 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-size-00115",
4707 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
4708 ") is greater than the source buffer size (%" PRIuLEAST64
4709 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
4710 i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004711 }
4712
4713 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
4714 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004715 skip |= LogError(dst_buffer_state->buffer, "VUID-vkCmdCopyBuffer-size-00116",
4716 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
4717 ") is greater than the destination buffer size (%" PRIuLEAST64
4718 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
4719 i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004720 }
4721 }
4722
4723 // The union of the source regions, and the union of the destination regions, must not overlap in memory
4724 if (src_buffer_state->buffer == dst_buffer_state->buffer) {
4725 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004726 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-pRegions-00117",
4727 "vkCmdCopyBuffer(): Detected overlap between source and dest regions in memory.");
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004728 }
4729 }
4730
4731 return skip;
4732}
4733
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004734bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004735 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06004736 const auto cb_node = GetCBState(commandBuffer);
4737 const auto src_buffer_state = GetBufferState(srcBuffer);
4738 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004739
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004740 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004741 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
4742 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004743 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004744 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004745 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
4746 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06004747 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004748 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
4749 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004750 skip |=
4751 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4752 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004753 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
4754 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004755 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, regionCount, pRegions);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004756 return skip;
4757}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004758
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004759bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004760 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004761 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004762 if (!buffer_state) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004763 skip |= LogError(buffer, kVUID_Core_DrawState_DoubleDestroy, "Cannot free %s that has not been allocated.",
4764 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004765 } else {
4766 if (buffer_state->in_use.load()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004767 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
4768 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004769 }
4770 }
4771 return skip;
4772}
4773
Jeff Bolz5c801d12019-10-09 10:38:45 -05004774bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
4775 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004776 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06004777 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004778
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004779 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004780 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004781 skip |=
4782 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004783 }
4784 return skip;
4785}
4786
Jeff Bolz5c801d12019-10-09 10:38:45 -05004787bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004788 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004789
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004790 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004791 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07004792 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004793 }
4794 return skip;
4795}
4796
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004797bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004798 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07004799 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06004800 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004801 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004802 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004803 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06004804 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004805 }
4806 return skip;
4807}
4808
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004809bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004810 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004811 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004812 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004813 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004814 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004815 skip |=
4816 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4817 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004818 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004819 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004820 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
4821 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004822 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07004823
4824 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004825 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
4826 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
4827 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
4828 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07004829 }
4830
4831 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004832 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
4833 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
4834 ") minus dstOffset (0x%" PRIxLEAST64 ").",
4835 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07004836 }
4837
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004838 return skip;
4839}
4840
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004841bool CoreChecks::ValidateBufferImageCopyData(uint32_t regionCount, const VkBufferImageCopy *pRegions,
4842 const IMAGE_STATE *image_state, const char *function) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004843 bool skip = false;
4844
4845 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004846 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
4847 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004848 skip |=
4849 LogError(image_state->image, "VUID-VkBufferImageCopy-srcImage-00199",
4850 "%s(): pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
4851 "and 1, respectively.",
4852 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004853 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004854 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004855
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004856 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
4857 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004858 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-srcImage-00201",
4859 "%s(): pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. For 1D and 2D images these "
4860 "must be 0 and 1, respectively.",
4861 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004862 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004863 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004864
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004865 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
4866 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004867 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-baseArrayLayer-00213",
4868 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
4869 "For 3D images these must be 0 and 1, respectively.",
4870 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004871 }
4872 }
4873
4874 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07004875 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
Locke497739c2019-03-08 11:50:47 -07004876 uint32_t element_size = FormatElementSize(image_state->createInfo.format, pRegions[i].imageSubresource.aspectMask);
4877
Dave Houltona585d132019-01-18 13:05:42 -07004878 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004879 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-bufferOffset-00193",
4880 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
4881 " must be a multiple of this format's texel size (%" PRIu32 ").",
4882 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004883 }
4884
4885 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06004886 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004887 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-bufferOffset-00194",
4888 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
4889 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004890 }
4891
4892 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
4893 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004894 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004895 LogError(image_state->image, "VUID-VkBufferImageCopy-bufferRowLength-00195",
4896 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
4897 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004898 }
4899
4900 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
4901 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004902 skip |= LogError(
4903 image_state->image, "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004904 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
4905 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004906 }
4907
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06004908 // Calculate adjusted image extent, accounting for multiplane image factors
4909 VkExtent3D adusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
4910 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
4911 if ((pRegions[i].imageOffset.x < 0) || (pRegions[i].imageOffset.x > static_cast<int32_t>(adusted_image_extent.width)) ||
4912 ((pRegions[i].imageOffset.x + pRegions[i].imageExtent.width) > static_cast<int32_t>(adusted_image_extent.width))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004913 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00197",
4914 "%s(): Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
4915 "zero or <= image subresource width (%d).",
4916 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
4917 adusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06004918 }
4919
4920 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
4921 if ((pRegions[i].imageOffset.y < 0) || (pRegions[i].imageOffset.y > static_cast<int32_t>(adusted_image_extent.height)) ||
4922 ((pRegions[i].imageOffset.y + pRegions[i].imageExtent.height) > static_cast<int32_t>(adusted_image_extent.height))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004923 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00198",
4924 "%s(): Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
4925 "zero or <= image subresource height (%d).",
4926 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
4927 adusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06004928 }
4929
4930 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
4931 if ((pRegions[i].imageOffset.z < 0) || (pRegions[i].imageOffset.z > static_cast<int32_t>(adusted_image_extent.depth)) ||
4932 ((pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth) > static_cast<int32_t>(adusted_image_extent.depth))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004933 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00200",
4934 "%s(): Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
4935 "zero or <= image subresource depth (%d).",
4936 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
4937 adusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06004938 }
4939
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004940 // subresource aspectMask must have exactly 1 bit set
4941 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
4942 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
4943 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004944 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-00212",
4945 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004946 }
4947
4948 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06004949 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004950 skip |= LogError(
4951 image_state->image, "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004952 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
4953 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004954 }
4955
4956 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04004957 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07004958 auto block_size = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004959
4960 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06004961 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004962 skip |= LogError(
4963 image_state->image, "VUID-VkBufferImageCopy-bufferRowLength-00203",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004964 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
4965 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004966 }
4967
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004968 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004969 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004970 skip |= LogError(
4971 image_state->image, "VUID-VkBufferImageCopy-bufferImageHeight-00204",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004972 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
4973 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004974 }
4975
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004976 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06004977 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
4978 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
4979 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004980 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00205",
4981 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
4982 "width & height (%d, %d)..",
4983 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
4984 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004985 }
4986
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004987 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houltona585d132019-01-18 13:05:42 -07004988 uint32_t block_size_in_bytes = FormatElementSize(image_state->createInfo.format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06004989 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004990 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-bufferOffset-00206",
4991 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
4992 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
4993 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004994 }
Dave Houlton67e9b532017-03-02 17:00:10 -07004995
4996 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07004997 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06004998 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004999 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005000 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageExtent-00207",
5001 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
5002 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
5003 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
5004 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07005005 }
5006
5007 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005008 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005009 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005010 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageExtent-00208",
5011 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
5012 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
5013 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
5014 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07005015 }
5016
5017 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06005018 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005019 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005020 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageExtent-00209",
5021 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
5022 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
5023 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
5024 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07005025 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005026 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005027
5028 // Checks that apply only to multi-planar format images
5029 if (FormatIsMultiplane(image_state->createInfo.format)) {
5030 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
5031 if ((FormatPlaneCount(image_state->createInfo.format) < 3) &&
5032 (pRegions[i].imageSubresource.aspectMask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005033 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-01560",
5034 "%s(): pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
5035 "format has three planes.",
5036 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08005037 }
5038
5039 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
5040 if (0 == (pRegions[i].imageSubresource.aspectMask &
5041 (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 -07005042 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-01560",
5043 "%s(): pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
5044 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
5045 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08005046 }
5047 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005048 }
5049
5050 return skip;
5051}
5052
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005053bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount, const VkBufferImageCopy *pRegions,
5054 const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005055 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005056 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005057
5058 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005059 VkExtent3D extent = pRegions[i].imageExtent;
5060 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005061
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005062 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
5063 {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005064 skip |= LogWarning(image_state->image, kVUID_Core_Image_ZeroAreaSubregion,
5065 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
5066 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005067 }
5068
5069 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
5070
5071 // 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 -06005072 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005073 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005074 if (image_extent.width % block_extent.width) {
5075 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
5076 }
5077 if (image_extent.height % block_extent.height) {
5078 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
5079 }
5080 if (image_extent.depth % block_extent.depth) {
5081 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
5082 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005083 }
5084
Dave Houltonfc1a4052017-04-27 14:32:45 -06005085 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005086 skip |= LogError(image_state->image, msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005087 }
5088 }
5089
5090 return skip;
5091}
5092
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005093bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
5094 const VkBufferImageCopy *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005095 bool skip = false;
5096
5097 VkDeviceSize buffer_size = buff_state->createInfo.size;
5098
5099 for (uint32_t i = 0; i < regionCount; i++) {
5100 VkExtent3D copy_extent = pRegions[i].imageExtent;
5101
5102 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
5103 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Locke497739c2019-03-08 11:50:47 -07005104 VkDeviceSize unit_size = FormatElementSize(image_state->createInfo.format,
5105 pRegions[i].imageSubresource.aspectMask); // size (bytes) of texel or block
Dave Houltonf3229d52017-02-21 15:59:08 -07005106
Tom Cooperb2550c72018-10-15 13:08:41 +01005107 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005108 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houltona585d132019-01-18 13:05:42 -07005109 auto block_dim = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005110 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
5111 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
5112
5113 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
5114 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
5115 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005116 }
5117
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005118 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
5119 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
5120 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07005121 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005122 } else {
5123 // Calculate buffer offset of final copied byte, + 1.
5124 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
5125 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
5126 max_buffer_offset *= unit_size; // convert to bytes
5127 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005128
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005129 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005130 skip |= LogError(device, msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i,
5131 buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005132 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005133 }
5134 }
5135
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005136 return skip;
5137}
5138
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005139bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005140 VkBuffer dstBuffer, uint32_t regionCount,
5141 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005142 const auto cb_node = GetCBState(commandBuffer);
5143 const auto src_image_state = GetImageState(srcImage);
5144 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005145
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005146 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005147
5148 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005149 skip |= ValidateCmd(cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005150
5151 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005152 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005153
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005154 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07005155
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005156 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005157 skip |=
5158 LogError(cb_node->createInfo.commandPool, "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
5159 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
5160 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005161 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005162 skip |= ValidateImageBounds(src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005163 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005164 skip |= ValidateBufferBounds(src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005165 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005166
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005167 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005168 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005169 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
5170 skip |=
5171 ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005172
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005173 // Validate that SRC image & DST buffer have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005174 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005175 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
5176 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005177 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005178 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
5179 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06005180 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005181 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImageToBuffer()",
5182 "VUID-vkCmdCopyImageToBuffer-srcImage-01998",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005183 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04005184 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005185 skip |= InsideRenderPass(cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005186 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005187 const char *src_invalid_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5188 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
5189 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005190 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005191 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
Cort Strattond619a302018-05-17 19:46:32 -07005192 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005193 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005194 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
5195 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005196 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5197 cb_node, src_image_state, &pRegions[i], i, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
5198 skip |=
5199 ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyImageToBuffer()",
5200 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
5201 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005202 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
5203 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005204 }
5205 return skip;
5206}
5207
John Zulauf1686f232019-07-09 16:27:11 -06005208void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5209 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
5210 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
5211
5212 auto cb_node = GetCBState(commandBuffer);
5213 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06005214 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005215 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005216 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005217 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005218}
5219
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005220bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5221 VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005222 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005223 const auto cb_node = GetCBState(commandBuffer);
5224 const auto src_buffer_state = GetBufferState(srcBuffer);
5225 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005226
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005227 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005228
5229 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005230 skip |= ValidateCmd(cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005231
5232 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005233 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005234 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005235 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005236 skip |=
5237 LogError(cb_node->createInfo.commandPool, "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
5238 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
5239 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005240 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005241 skip |= ValidateImageBounds(dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005242 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005243 skip |= ValidateBufferBounds(dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005244 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005245 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005246 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005247 skip |=
5248 ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
5249 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005250 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005251 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
5252 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005253 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005254 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
5255 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06005256 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005257 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyBufferToImage()",
5258 "VUID-vkCmdCopyBufferToImage-dstImage-01997",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005259 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04005260 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005261 skip |= InsideRenderPass(cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005262 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005263 const char *dst_invalid_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5264 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
5265 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005266 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005267 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
Cort Strattond619a302018-05-17 19:46:32 -07005268 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005269 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005270 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
5271 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005272 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5273 cb_node, dst_image_state, &pRegions[i], i, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
5274 skip |=
5275 ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyBufferToImage()",
5276 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
5277 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005278 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
5279 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005280 }
5281 return skip;
5282}
5283
John Zulauf1686f232019-07-09 16:27:11 -06005284void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5285 VkImageLayout dstImageLayout, uint32_t regionCount,
5286 const VkBufferImageCopy *pRegions) {
5287 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
5288
5289 auto cb_node = GetCBState(commandBuffer);
5290 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06005291 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005292 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005293 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005294 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005295}
Mike Weiblen672b58b2017-02-21 14:32:53 -07005296
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005297bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005298 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005299 bool skip = false;
5300 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
5301
Dave Houlton1d960ff2018-01-19 12:17:05 -07005302 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07005303 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
5304 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
5305 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005306 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
5307 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005308 }
5309
John Zulaufa26d3c82019-08-14 16:09:08 -06005310 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005311 if (!image_entry) {
5312 return skip;
5313 }
5314
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005315 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
5316 if (device_extensions.vk_ext_image_drm_format_modifier) {
5317 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
5318 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005319 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
5320 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
5321 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005322 }
5323 } else {
5324 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005325 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
5326 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005327 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07005328 }
5329
Dave Houlton1d960ff2018-01-19 12:17:05 -07005330 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005331 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005332 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
5333 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
5334 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005335 }
5336
Dave Houlton1d960ff2018-01-19 12:17:05 -07005337 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005338 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005339 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
5340 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
5341 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005342 }
5343
Dave Houlton1d960ff2018-01-19 12:17:05 -07005344 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07005345 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005346 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
5347 if (FormatIsMultiplane(img_format)) {
5348 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
5349 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
5350 if (FormatPlaneCount(img_format) > 2u) {
5351 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
5352 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
5353 }
5354 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005355 skip |= LogError(image, vuid,
5356 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
5357 ") must be a single-plane specifier flag.",
5358 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005359 }
5360 } else if (FormatIsColor(img_format)) {
5361 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005362 skip |= LogError(image, kVUID_Core_DrawState_InvalidImageAspect,
5363 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
5364 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005365 }
5366 } else if (FormatIsDepthOrStencil(img_format)) {
5367 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
5368 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07005369 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005370 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5371 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
5372 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
5373 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005374 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
5375 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
5376 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005377 }
5378 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005379
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005380 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005381 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005382 }
5383
Mike Weiblen672b58b2017-02-21 14:32:53 -07005384 return skip;
5385}