blob: c3044cc0432aae3d4d1a02d0a789a47f131e6f37 [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) {
Petr Krausbc7f5442017-05-14 23:43:38 +0200258 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(imgpair.image),
Dave Houlton51653902018-06-22 17:32:13 -0600259 kVUID_Core_DrawState_InvalidLayout,
locke-lunarg9edc2812019-06-17 23:18:52 -0600260 "Cannot query for %s layout when combined aspect mask %d has multiple layout types: %s and %s",
Lockee9aeebf2019-03-03 23:50:08 -0700261 report_data->FormatHandle(imgpair.image).c_str(), oldAspectMask, string_VkImageLayout(layout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700262 string_VkImageLayout(imgsubIt->second.layout));
263 }
264 layout = imgsubIt->second.layout;
265 return true;
266}
267
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700268// Find layout(s) on the global level
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700269bool CoreChecks::FindGlobalLayout(ImageSubresourcePair imgpair, VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700270 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700271 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
272 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
273 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
274 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600275 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700276 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
277 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
278 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700279 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700280 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
281 imgpair = {imgpair.image, false, VkImageSubresource()};
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600282 auto imgsubIt = imageLayoutMap.find(imgpair);
283 if (imgsubIt == imageLayoutMap.end()) return false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700284 layout = imgsubIt->second.layout;
285 }
286 return true;
287}
288
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500289bool CoreChecks::FindLayouts(VkImage image, std::vector<VkImageLayout> &layouts) const {
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -0600290 auto sub_data = imageSubresourceMap.find(image);
291 if (sub_data == imageSubresourceMap.end()) return false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700292 auto image_state = GetImageState(image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700293 if (!image_state) return false;
294 bool ignoreGlobal = false;
295 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
296 if (sub_data->second.size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
297 ignoreGlobal = true;
298 }
299 for (auto imgsubpair : sub_data->second) {
300 if (ignoreGlobal && !imgsubpair.hasSubresource) continue;
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600301 auto img_data = imageLayoutMap.find(imgsubpair);
302 if (img_data != imageLayoutMap.end()) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700303 layouts.push_back(img_data->second.layout);
304 }
305 }
306 return true;
307}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700308
John Zulauf3b04ebd2019-07-18 14:08:11 -0600309bool CoreChecks::FindLayout(const ImageSubresPairLayoutMap &imageLayoutMap, ImageSubresourcePair imgpair, VkImageLayout &layout,
310 const VkImageAspectFlags aspectMask) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700311 if (!(imgpair.subresource.aspectMask & aspectMask)) {
312 return false;
313 }
314 imgpair.subresource.aspectMask = aspectMask;
315 auto imgsubIt = imageLayoutMap.find(imgpair);
316 if (imgsubIt == imageLayoutMap.end()) {
317 return false;
318 }
319 layout = imgsubIt->second.layout;
320 return true;
Tony Barboure0c5cc92017-02-08 13:53:39 -0700321}
Tony Barbourdf013b92017-01-25 12:53:48 -0700322
323// find layout in supplied map
John Zulauf3b04ebd2019-07-18 14:08:11 -0600324bool CoreChecks::FindLayout(const ImageSubresPairLayoutMap &imageLayoutMap, ImageSubresourcePair imgpair,
325 VkImageLayout &layout) const {
Tony Barbourdf013b92017-01-25 12:53:48 -0700326 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
327 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
328 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
329 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
330 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600331 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700332 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
333 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
334 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
335 }
336 // Image+subresource not found, look for image handle w/o subresource
Tony Barbourdf013b92017-01-25 12:53:48 -0700337 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
338 imgpair = {imgpair.image, false, VkImageSubresource()};
339 auto imgsubIt = imageLayoutMap.find(imgpair);
340 if (imgsubIt == imageLayoutMap.end()) return false;
341 layout = imgsubIt->second.layout;
342 }
343 return true;
344}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700345
346// Set the layout on the global level
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700347void CoreChecks::SetGlobalLayout(ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700348 VkImage &image = imgpair.image;
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600349 auto data = imageLayoutMap.find(imgpair);
350 if (data != imageLayoutMap.end()) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700351 data->second.layout = layout; // Update
352 } else {
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600353 imageLayoutMap[imgpair].layout = layout; // Insert
Dave Houltonb3f4b282018-02-22 16:25:16 -0700354 }
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -0600355 auto &image_subresources = imageSubresourceMap[image];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700356 auto subresource = std::find(image_subresources.begin(), image_subresources.end(), imgpair);
357 if (subresource == image_subresources.end()) {
358 image_subresources.push_back(imgpair);
359 }
360}
361
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600362// Set image layout for given VkImageSubresourceRange struct
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600363void CoreChecks::SetImageLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600364 const VkImageSubresourceRange &image_subresource_range, VkImageLayout layout,
365 VkImageLayout expected_layout) {
366 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
367 assert(subresource_map); // the non-const getter must return a valid pointer
John Zulauf4ec24ec2019-05-02 17:22:59 -0600368 if (subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600369 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700370 }
371}
John Zulauff660ad62019-03-23 07:16:05 -0600372
373// Set the initial image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600374void CoreChecks::SetImageViewInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
Jeff Bolz3e333222019-08-10 23:00:38 -0500375 if (disabled.image_layout_validation) {
376 return;
377 }
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500378 IMAGE_STATE *image_state = view_state.image_state.get();
379 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
John Zulaufb58415b2019-12-09 15:02:32 -0700380 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
John Zulauff660ad62019-03-23 07:16:05 -0600381}
382
383// Set the initial image layout for a passed non-normalized subresource range
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600384void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600385 const VkImageSubresourceRange &range, VkImageLayout layout) {
386 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
387 assert(subresource_map);
John Zulauf4ec24ec2019-05-02 17:22:59 -0600388 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(image_state, range), layout);
John Zulauff660ad62019-03-23 07:16:05 -0600389}
390
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600391void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, VkImage image, const VkImageSubresourceRange &range,
John Zulauff660ad62019-03-23 07:16:05 -0600392 VkImageLayout layout) {
393 const IMAGE_STATE *image_state = GetImageState(image);
394 if (!image_state) return;
395 SetImageInitialLayout(cb_node, *image_state, range, layout);
396};
397
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600398void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600399 const VkImageSubresourceLayers &layers, VkImageLayout layout) {
400 SetImageInitialLayout(cb_node, image_state, RangeFromLayers(layers), layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600401}
Dave Houltonddd65c52018-05-08 14:58:01 -0600402
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600403// Set image layout for all slices of an image view
Piers Daniell4fde9b72019-11-27 16:19:46 -0700404void CoreChecks::SetImageViewLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout,
405 VkImageLayout layoutStencil) {
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500406 IMAGE_STATE *image_state = view_state.image_state.get();
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600407
John Zulauff660ad62019-03-23 07:16:05 -0600408 VkImageSubresourceRange sub_range = view_state.normalized_subresource_range;
Dave Houltonddd65c52018-05-08 14:58:01 -0600409 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
410 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
John Zulauff660ad62019-03-23 07:16:05 -0600411 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 -0600412 sub_range.baseArrayLayer = 0;
413 sub_range.layerCount = image_state->createInfo.extent.depth;
414 }
415
Piers Daniell4fde9b72019-11-27 16:19:46 -0700416 if (sub_range.aspectMask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT) && layoutStencil != kInvalidLayout) {
417 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
418 SetImageLayout(cb_node, *image_state, sub_range, layout);
419 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
420 SetImageLayout(cb_node, *image_state, sub_range, layoutStencil);
421 } else {
422 SetImageLayout(cb_node, *image_state, sub_range, layout);
423 }
John Zulauf4ccf5c02018-09-21 11:46:18 -0600424}
425
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700426bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
427 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700428 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600429 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100430 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700431 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100432 const char *vuid;
433 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
434
435 if (!image_state) {
436 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
437 "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
locke-lunarg9edc2812019-06-17 23:18:52 -0600438 "Render Pass begin with %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
Lockee9aeebf2019-03-03 23:50:08 -0700439 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
440 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100441 return skip;
442 }
443
444 auto image_usage = image_state->createInfo.usage;
445
446 // Check for layouts that mismatch image usages in the framebuffer
447 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800448 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100449 skip |=
450 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
locke-lunarg9edc2812019-06-17 23:18:52 -0600451 "Layout/usage mismatch for attachment %u in %s"
452 " - the %s is %s but the image attached to %s via %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100453 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600454 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
455 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100456 }
457
458 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
459 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800460 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100461 skip |=
462 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
locke-lunarg9edc2812019-06-17 23:18:52 -0600463 "Layout/usage mismatch for attachment %u in %s"
464 " - the %s is %s but the image attached to %s via %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100465 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600466 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
467 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100468 }
469
470 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800471 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100472 skip |=
473 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
locke-lunarg9edc2812019-06-17 23:18:52 -0600474 "Layout/usage mismatch for attachment %u in %s"
475 " - the %s is %s but the image attached to %s via %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100476 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600477 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
478 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100479 }
480
481 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800482 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100483 skip |=
484 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
locke-lunarg9edc2812019-06-17 23:18:52 -0600485 "Layout/usage mismatch for attachment %u in %s"
486 " - the %s is %s but the image attached to %s via %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100487 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600488 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
489 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100490 }
491
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600492 if (device_extensions.vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100493 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
494 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
495 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
496 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
497 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800498 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Lockee9aeebf2019-03-03 23:50:08 -0700499 skip |= log_msg(
500 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
locke-lunarg9edc2812019-06-17 23:18:52 -0600501 "Layout/usage mismatch for attachment %u in %s"
502 " - the %s is %s but the image attached to %s via %s"
Lockee9aeebf2019-03-03 23:50:08 -0700503 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600504 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
505 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100506 }
507 } else {
508 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
509 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
510 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
511 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
512 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
513 HandleToUint64(image), "VUID-vkCmdBeginRenderPass-initialLayout-00896",
locke-lunarg9edc2812019-06-17 23:18:52 -0600514 "Layout/usage mismatch for attachment %u in %s"
515 " - the %s is %s but the image attached to %s via %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100516 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600517 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
518 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
Lockee9aeebf2019-03-03 23:50:08 -0700519 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100520 }
521 }
522 return skip;
523}
524
John Zulauf17a01bb2019-08-09 16:41:19 -0600525bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700526 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600527 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600528 bool skip = false;
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700529 auto const pRenderPassInfo = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700530 auto const &framebufferInfo = framebuffer_state->createInfo;
Tobias Hectorc9057422019-07-23 12:15:52 +0100531 const VkImageView *attachments = framebufferInfo.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100532
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700533 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100534 auto framebuffer = framebuffer_state->framebuffer;
535
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700536 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600537 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -0600538 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700539 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700540 }
John Zulauf8e308292018-09-21 11:34:37 -0600541
Tobias Hectorc9057422019-07-23 12:15:52 +0100542 const auto *attachmentInfo = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
543 if (((framebufferInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) != 0) && attachmentInfo != nullptr) {
544 attachments = attachmentInfo->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100545 }
546
Tobias Hectorc9057422019-07-23 12:15:52 +0100547 if (attachments != nullptr) {
548 const auto *const_pCB = static_cast<const CMD_BUFFER_STATE *>(pCB);
549 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
550 auto image_view = attachments[i];
551 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100552
Tobias Hectorc9057422019-07-23 12:15:52 +0100553 if (!view_state) {
554 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_RENDER_PASS_EXT,
555 HandleToUint64(pRenderPassBegin->renderPass), "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
556 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
557 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
558 report_data->FormatHandle(image_view).c_str());
559 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100560 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100561
562 const VkImage image = view_state->create_info.image;
563 const IMAGE_STATE *image_state = GetImageState(image);
564
565 if (!image_state) {
566 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_RENDER_PASS_EXT,
567 HandleToUint64(pRenderPassBegin->renderPass), "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
568 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
569 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
570 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
571 continue;
572 }
573 auto attachment_initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
574 auto final_layout = pRenderPassInfo->pAttachments[i].finalLayout;
575
Piers Daniell7f894f62020-01-09 16:33:48 -0700576 // Default to expecting stencil in the same layout.
577 auto attachment_stencil_initial_layout = attachment_initial_layout;
578
579 // If a separate layout is specified, look for that.
580 const auto *attachment_description_stencil_layout =
581 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
582 if (attachment_description_stencil_layout) {
583 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
584 }
585
Tobias Hectorc9057422019-07-23 12:15:52 +0100586 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
587 // in common with the non-const version.)
588 const ImageSubresourceLayoutMap *subresource_map =
589 (attachment_initial_layout != VK_IMAGE_LAYOUT_UNDEFINED) ? GetImageSubresourceLayoutMap(const_pCB, image) : nullptr;
590
591 if (subresource_map) { // If no layout information for image yet, will be checked at QueueSubmit time
592 LayoutUseCheckAndMessage layout_check(subresource_map);
593 bool subres_skip = false;
John Zulauf5e617452019-11-19 14:44:16 -0700594 auto pos = subresource_map->Find(view_state->normalized_subresource_range);
595 for (; pos != subresource_map->End() && !subres_skip; ++pos) {
596 const VkImageSubresource &subres = pos->subresource;
Piers Daniell7f894f62020-01-09 16:33:48 -0700597
John Zulauf5e617452019-11-19 14:44:16 -0700598 // Allow for differing depth and stencil layouts
599 VkImageLayout check_layout = attachment_initial_layout;
600 if (subres.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) check_layout = attachment_stencil_initial_layout;
601
602 if (!layout_check.Check(subres, check_layout, pos->current_layout, pos->initial_layout)) {
Piers Daniell7f894f62020-01-09 16:33:48 -0700603 subres_skip |= log_msg(
604 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
605 kVUID_Core_DrawState_InvalidRenderpass,
606 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
607 "and the %s layout of the attachment is %s. The layouts must match, or the render "
608 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
John Zulauf5e617452019-11-19 14:44:16 -0700609 i, string_VkImageLayout(check_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobias Hectorc9057422019-07-23 12:15:52 +0100610 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700611 }
John Zulauf5e617452019-11-19 14:44:16 -0700612
Tobias Hectorc9057422019-07-23 12:15:52 +0100613 skip |= subres_skip;
614 }
615
616 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view,
617 framebuffer, render_pass, i, "initial layout");
618
619 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer,
620 render_pass, i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100621 }
622
Tobias Hectorc9057422019-07-23 12:15:52 +0100623 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
624 auto &subpass = pRenderPassInfo->pSubpasses[j];
625 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
626 auto &attachment_ref = subpass.pInputAttachments[k];
627 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
628 auto image_view = attachments[attachment_ref.attachment];
629 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100630
Tobias Hectorc9057422019-07-23 12:15:52 +0100631 if (view_state) {
632 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700633 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
634 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100635 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100636 }
637 }
638 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100639
Tobias Hectorc9057422019-07-23 12:15:52 +0100640 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
641 auto &attachment_ref = subpass.pColorAttachments[k];
642 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
643 auto image_view = attachments[attachment_ref.attachment];
644 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100645
Tobias Hectorc9057422019-07-23 12:15:52 +0100646 if (view_state) {
647 auto image = view_state->create_info.image;
648 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
649 framebuffer, render_pass, attachment_ref.attachment,
650 "color attachment layout");
651 if (subpass.pResolveAttachments) {
652 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
653 rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
654 attachment_ref.attachment, "resolve attachment layout");
655 }
656 }
657 }
658 }
659
660 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
661 auto &attachment_ref = *subpass.pDepthStencilAttachment;
662 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
663 auto image_view = attachments[attachment_ref.attachment];
664 auto view_state = GetImageViewState(image_view);
665
666 if (view_state) {
667 auto image = view_state->create_info.image;
668 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
669 framebuffer, render_pass, attachment_ref.attachment,
670 "input attachment layout");
671 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100672 }
673 }
674 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700675 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600676 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700677}
678
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600679void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700680 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700681 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700682 auto image_view = GetAttachmentImageViewState(pFramebuffer, ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600683 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700684 VkImageLayout stencil_layout = kInvalidLayout;
685 const auto *attachment_reference_stencil_layout = lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(ref.pNext);
686 if (attachment_reference_stencil_layout) {
687 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
688 }
689
690 SetImageViewLayout(pCB, *image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600691 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700692 }
693}
694
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600695void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
696 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700697 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700698
699 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700700 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700701 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700702 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700703 }
704 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700705 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700706 }
707 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700708 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700709 }
710 }
711}
712
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700713// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
714// 1. Transition into initialLayout state
715// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600716void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700717 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700718 // First transition into initialLayout
719 auto const rpci = render_pass_state->createInfo.ptr();
720 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700721 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -0600722 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700723 VkImageLayout stencil_layout = kInvalidLayout;
724 const auto *attachment_description_stencil_layout =
725 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(rpci->pAttachments[i].pNext);
726 if (attachment_description_stencil_layout) {
727 stencil_layout = attachment_description_stencil_layout->stencilInitialLayout;
728 }
729
730 SetImageViewLayout(cb_state, *view_state, rpci->pAttachments[i].initialLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600731 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700732 }
733 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700734 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700735}
736
Dave Houlton10b39482017-03-16 13:18:15 -0600737bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600738 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600739 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600740 }
741 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600742 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600743 }
744 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600745 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600746 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700747 if (0 !=
748 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
749 if (FormatPlaneCount(format) == 1) return false;
750 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600751 return true;
752}
753
Mike Weiblen62d08a32017-03-07 22:18:27 -0700754// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Petr Krausad0096a2019-08-09 18:35:04 +0200755bool CoreChecks::ValidateBarrierLayoutToImageUsage(const VkImageMemoryBarrier &img_barrier, bool new_not_old,
756 VkImageUsageFlags usage_flags, const char *func_name,
John Zulaufa4472282019-08-22 14:44:34 -0600757 const char *barrier_pname) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700758 bool skip = false;
Petr Krausad0096a2019-08-09 18:35:04 +0200759 const VkImageLayout layout = (new_not_old) ? img_barrier.newLayout : img_barrier.oldLayout;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600760 const char *msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700761
762 switch (layout) {
763 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
764 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600765 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700766 }
767 break;
768 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
769 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600770 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700771 }
772 break;
773 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
774 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600775 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700776 }
777 break;
778 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
779 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600780 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700781 }
782 break;
783 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
784 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600785 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700786 }
787 break;
788 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
789 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600790 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700791 }
792 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600793 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500794 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
795 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
796 }
797 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700798 default:
799 // Other VkImageLayout values do not have VUs defined in this context.
800 break;
801 }
802
Dave Houlton8e9f6542018-05-18 12:18:22 -0600803 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600804 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Krausad0096a2019-08-09 18:35:04 +0200805 HandleToUint64(img_barrier.image), msg_code,
806 "%s: Image barrier %s %s Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".", func_name,
807 barrier_pname, ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
808 report_data->FormatHandle(img_barrier.image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700809 }
810 return skip;
811}
812
813// Verify image barriers are compatible with the images they reference.
John Zulaufa4472282019-08-22 14:44:34 -0600814bool CoreChecks::ValidateBarriersToImages(const CMD_BUFFER_STATE *cb_state, uint32_t imageMemoryBarrierCount,
815 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700816 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700817
Petr Krausad0096a2019-08-09 18:35:04 +0200818 // Scoreboard for checking for duplicate and inconsistent barriers to images
819 struct ImageBarrierScoreboardEntry {
820 uint32_t index;
821 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
822 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
823 const VkImageMemoryBarrier *barrier;
824 };
825 using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
826 using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
827
John Zulauf463c51e2018-05-31 13:29:20 -0600828 // Scoreboard for duplicate layout transition barriers within the list
829 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
830 ImageBarrierScoreboardImageMap layout_transitions;
831
Mike Weiblen62d08a32017-03-07 22:18:27 -0700832 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +0200833 const auto &img_barrier = pImageMemoryBarriers[i];
834 const std::string barrier_pname = "pImageMemoryBarrier[" + std::to_string(i) + "]";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700835
John Zulauf463c51e2018-05-31 13:29:20 -0600836 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
837 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
838 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +0200839 if (img_barrier.oldLayout != img_barrier.newLayout) {
840 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
841 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -0600842 if (image_it != layout_transitions.end()) {
843 auto &subres_map = image_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200844 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -0600845 if (subres_it != subres_map.end()) {
846 auto &entry = subres_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200847 if ((entry.barrier->newLayout != img_barrier.oldLayout) &&
848 (img_barrier.oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
849 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
John Zulauf463c51e2018-05-31 13:29:20 -0600850 skip = log_msg(
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700851 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
852 HandleToUint64(cb_state->commandBuffer), "VUID-VkImageMemoryBarrier-oldLayout-01197",
Petr Krausad0096a2019-08-09 18:35:04 +0200853 "%s: %s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600854 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
855 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Petr Krausad0096a2019-08-09 18:35:04 +0200856 func_name, barrier_pname.c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
857 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
858 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600859 }
860 entry = new_entry;
861 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200862 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600863 }
864 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200865 layout_transitions[img_barrier.image][img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600866 }
867 }
868
Petr Krausad0096a2019-08-09 18:35:04 +0200869 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600870 if (image_state) {
871 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Petr Krausad0096a2019-08-09 18:35:04 +0200872 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, false, usage_flags, func_name, barrier_pname.c_str());
873 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, true, usage_flags, func_name, barrier_pname.c_str());
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600874
875 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
876 if (image_state->layout_locked) {
877 // TODO: Add unique id for error when available
Dave Houlton33c2d252017-06-09 17:08:32 -0600878 skip |= log_msg(
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700879 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Krausad0096a2019-08-09 18:35:04 +0200880 HandleToUint64(img_barrier.image), 0,
locke-lunarg9edc2812019-06-17 23:18:52 -0600881 "Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600882 " 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 +0200883 report_data->FormatHandle(img_barrier.image).c_str(), string_VkImageLayout(img_barrier.oldLayout),
884 string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600885 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600886
John Zulaufa4472282019-08-22 14:44:34 -0600887 const VkImageCreateInfo &image_create_info = image_state->createInfo;
John Zulauff660ad62019-03-23 07:16:05 -0600888 // For a Depth/Stencil image both aspects MUST be set
John Zulaufa4472282019-08-22 14:44:34 -0600889 if (FormatIsDepthAndStencil(image_create_info.format)) {
Petr Krausad0096a2019-08-09 18:35:04 +0200890 auto const aspect_mask = img_barrier.subresourceRange.aspectMask;
Piers Daniell41b8c5d2020-01-10 15:42:00 -0700891 if (enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -0600892 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
893 skip |=
894 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
895 HandleToUint64(img_barrier.image), "VUID-VkImageMemoryBarrier-image-03319",
896 "%s: Image barrier %s references %s of format %s that must have either the depth or stencil "
John Zulauff660ad62019-03-23 07:16:05 -0600897 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
Petr Krausad0096a2019-08-09 18:35:04 +0200898 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
John Zulaufa4472282019-08-22 14:44:34 -0600899 string_VkFormat(image_create_info.format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600900 }
901 } else {
902 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
903 if ((aspect_mask & ds_mask) != (ds_mask)) {
904 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
905 HandleToUint64(img_barrier.image), "VUID-VkImageMemoryBarrier-image-03320",
906 "%s: Image barrier %s references %s of format %s that must have the depth and stencil "
907 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
908 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
909 string_VkFormat(image_create_info.format), aspect_mask);
910 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700911 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700912 }
John Zulauff660ad62019-03-23 07:16:05 -0600913
Petr Krausad0096a2019-08-09 18:35:04 +0200914 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier.image);
915 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -0600916 // TODO: Set memory invalid which is in mem_tracker currently
917 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
918 // subresource.
919 } else if (subresource_map) {
920 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -0600921 LayoutUseCheckAndMessage layout_check(subresource_map);
Petr Krausad0096a2019-08-09 18:35:04 +0200922 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier.subresourceRange);
John Zulauf5e617452019-11-19 14:44:16 -0700923 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
924 const auto &value = *pos;
925 if (!layout_check.Check(value.subresource, img_barrier.oldLayout, value.current_layout, value.initial_layout)) {
926 subres_skip = log_msg(
927 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
928 HandleToUint64(cb_state->commandBuffer), "VUID-VkImageMemoryBarrier-oldLayout-01197",
929 "For %s you cannot transition the layout of aspect=%d level=%d layer=%d from %s when the "
930 "%s layout is %s.",
931 report_data->FormatHandle(img_barrier.image).c_str(), value.subresource.aspectMask,
932 value.subresource.mipLevel, value.subresource.arrayLayer, string_VkImageLayout(img_barrier.oldLayout),
933 layout_check.message, string_VkImageLayout(layout_check.layout));
John Zulauff660ad62019-03-23 07:16:05 -0600934 }
John Zulauf5e617452019-11-19 14:44:16 -0700935 }
John Zulauff660ad62019-03-23 07:16:05 -0600936 skip |= subres_skip;
937 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700938 }
939 }
940 return skip;
941}
942
John Zulaufe3d1c8a2019-08-12 14:34:58 -0600943bool CoreChecks::IsReleaseOp(CMD_BUFFER_STATE *cb_state, const VkImageMemoryBarrier &barrier) const {
Petr Krausad0096a2019-08-09 18:35:04 +0200944 if (!IsTransferOp(&barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700945
Jeff Bolz6835fda2019-10-06 00:15:34 -0500946 auto pool = cb_state->command_pool.get();
Petr Krausad0096a2019-08-09 18:35:04 +0200947 return pool && TempIsReleaseOp<VkImageMemoryBarrier, true>(pool, &barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700948}
949
John Zulauf6b4aae82018-05-09 13:03:36 -0600950template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -0600951bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
952 uint32_t barrier_count, const Barrier *barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600953 using BarrierRecord = QFOTransferBarrier<Barrier>;
954 bool skip = false;
Jeff Bolz6835fda2019-10-06 00:15:34 -0500955 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -0600956 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
957 const char *barrier_name = BarrierRecord::BarrierName();
958 const char *handle_name = BarrierRecord::HandleName();
959 const char *transfer_type = nullptr;
960 for (uint32_t b = 0; b < barrier_count; b++) {
961 if (!IsTransferOp(&barriers[b])) continue;
962 const BarrierRecord *barrier_record = nullptr;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700963 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufa4472282019-08-22 14:44:34 -0600964 !QueueFamilyIsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600965 const auto found = barrier_sets.release.find(barriers[b]);
966 if (found != barrier_sets.release.cend()) {
967 barrier_record = &(*found);
968 transfer_type = "releasing";
969 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600970 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufa4472282019-08-22 14:44:34 -0600971 !QueueFamilyIsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600972 const auto found = barrier_sets.acquire.find(barriers[b]);
973 if (found != barrier_sets.acquire.cend()) {
974 barrier_record = &(*found);
975 transfer_type = "acquiring";
976 }
977 }
978 if (barrier_record != nullptr) {
Lockee9aeebf2019-03-03 23:50:08 -0700979 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
980 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInCB(),
981 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
982 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
983 func_name, barrier_name, b, transfer_type, handle_name,
984 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
985 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -0600986 }
987 }
988 return skip;
989}
990
John Zulaufa4472282019-08-22 14:44:34 -0600991VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
992 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
993}
994
995const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
996 return device_state.GetImageState(barrier.image);
997}
998
999VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
1000 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1001}
1002
1003const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
1004 return device_state.GetBufferState(barrier.buffer);
1005}
1006
1007VkBuffer BarrierHandle(const VkBufferMemoryBarrier &barrier) { return barrier.buffer; }
1008
John Zulauf6b4aae82018-05-09 13:03:36 -06001009template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -06001010void CoreChecks::RecordBarrierArrayValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1011 const Barrier *barriers) {
Jeff Bolz6835fda2019-10-06 00:15:34 -05001012 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -06001013 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
1014 for (uint32_t b = 0; b < barrier_count; b++) {
John Zulaufa4472282019-08-22 14:44:34 -06001015 auto &barrier = barriers[b];
1016 if (IsTransferOp(&barrier)) {
1017 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barrier) &&
1018 !QueueFamilyIsSpecial(barrier.dstQueueFamilyIndex)) {
1019 barrier_sets.release.emplace(barrier);
1020 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barrier) &&
1021 !QueueFamilyIsSpecial(barrier.srcQueueFamilyIndex)) {
1022 barrier_sets.acquire.emplace(barrier);
1023 }
1024 }
1025
1026 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
1027 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
1028 if (!QueueFamilyIsIgnored(src_queue_family) && !QueueFamilyIsIgnored(dst_queue_family)) {
1029 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
1030 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
1031 auto handle_state = BarrierHandleState(*this, barrier);
1032 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
1033 if (!mode_concurrent) {
1034 const auto typed_handle = BarrierTypedHandle(barrier);
Jeff Bolz310775c2019-10-09 00:46:33 -05001035 cb_state->queue_submit_functions.emplace_back(
1036 [func_name, cb_state, typed_handle, src_queue_family, dst_queue_family](
1037 const ValidationStateTracker *device_data, const QUEUE_STATE *queue_state) {
1038 return ValidateConcurrentBarrierAtSubmit(device_data, queue_state, func_name, cb_state, typed_handle,
1039 src_queue_family, dst_queue_family);
John Zulaufa4472282019-08-22 14:44:34 -06001040 });
1041 }
John Zulauf6b4aae82018-05-09 13:03:36 -06001042 }
1043 }
1044}
1045
John Zulaufa4472282019-08-22 14:44:34 -06001046bool CoreChecks::ValidateBarriersQFOTransferUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001047 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001048 uint32_t imageMemBarrierCount,
John Zulaufa4472282019-08-22 14:44:34 -06001049 const VkImageMemoryBarrier *pImageMemBarriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001050 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001051 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1052 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001053 return skip;
1054}
1055
John Zulaufa4472282019-08-22 14:44:34 -06001056void CoreChecks::RecordBarrierValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
1057 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1058 const VkImageMemoryBarrier *pImageMemBarriers) {
1059 RecordBarrierArrayValidationInfo(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1060 RecordBarrierArrayValidationInfo(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001061}
1062
1063template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001064bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001065 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001066 // Record to the scoreboard or report that we have a duplication
1067 bool skip = false;
1068 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
1069 if (!inserted.second && inserted.first->second != cb_state) {
1070 // This is a duplication (but don't report duplicates from the same CB, as we do that at record time
Lockee9aeebf2019-03-03 23:50:08 -07001071 skip = log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1072 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
1073 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
locke-lunarg9edc2812019-06-17 23:18:52 -06001074 " duplicates existing barrier submitted in this batch from %s.",
Lockee9aeebf2019-03-03 23:50:08 -07001075 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
1076 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex, barrier.dstQueueFamilyIndex,
John Zulauf7eb94822019-04-05 09:38:46 -06001077 report_data->FormatHandle(inserted.first->second->commandBuffer).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001078 }
1079 return skip;
1080}
1081
1082template <typename Barrier>
John Zulauf3b04ebd2019-07-18 14:08:11 -06001083bool CoreChecks::ValidateQueuedQFOTransferBarriers(const CMD_BUFFER_STATE *cb_state,
1084 QFOTransferCBScoreboards<Barrier> *scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001085 using BarrierRecord = QFOTransferBarrier<Barrier>;
1086 using TypeTag = typename BarrierRecord::Tag;
1087 bool skip = false;
John Zulauf6b4aae82018-05-09 13:03:36 -06001088 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001089 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001090 const char *barrier_name = BarrierRecord::BarrierName();
1091 const char *handle_name = BarrierRecord::HandleName();
1092 // No release should have an extant duplicate (WARNING)
1093 for (const auto &release : cb_barriers.release) {
1094 // Check the global pending release barriers
1095 const auto set_it = global_release_barriers.find(release.handle);
1096 if (set_it != global_release_barriers.cend()) {
1097 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1098 const auto found = set_for_handle.find(release);
1099 if (found != set_for_handle.cend()) {
1100 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1101 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
Lockee9aeebf2019-03-03 23:50:08 -07001102 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
John Zulauf6b4aae82018-05-09 13:03:36 -06001103 " to dstQueueFamilyIndex %" PRIu32
1104 " duplicates existing barrier queued for execution, without intervening acquire operation.",
Lockee9aeebf2019-03-03 23:50:08 -07001105 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
John Zulauf6b4aae82018-05-09 13:03:36 -06001106 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
1107 }
1108 }
1109 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1110 }
1111 // Each acquire must have a matching release (ERROR)
1112 for (const auto &acquire : cb_barriers.acquire) {
1113 const auto set_it = global_release_barriers.find(acquire.handle);
1114 bool matching_release_found = false;
1115 if (set_it != global_release_barriers.cend()) {
1116 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1117 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1118 }
1119 if (!matching_release_found) {
1120 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1121 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
Lockee9aeebf2019-03-03 23:50:08 -07001122 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1123 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1124 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
John Zulauf6b4aae82018-05-09 13:03:36 -06001125 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
1126 }
1127 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1128 }
1129 return skip;
1130}
1131
John Zulauf3b04ebd2019-07-18 14:08:11 -06001132bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001133 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001134 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001135 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001136 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state, qfo_image_scoreboards);
1137 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state, qfo_buffer_scoreboards);
John Zulauf6b4aae82018-05-09 13:03:36 -06001138 return skip;
1139}
1140
1141template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001142void CoreChecks::RecordQueuedQFOTransferBarriers(CMD_BUFFER_STATE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001143 using BarrierRecord = QFOTransferBarrier<Barrier>;
1144 using TypeTag = typename BarrierRecord::Tag;
1145 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001146 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001147
1148 // Add release barriers from this submit to the global map
1149 for (const auto &release : cb_barriers.release) {
1150 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1151 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1152 global_release_barriers[release.handle].insert(release);
1153 }
1154
1155 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1156 for (const auto &acquire : cb_barriers.acquire) {
1157 // NOTE: We're not using [] because we don't want to create entries for missing releases
1158 auto set_it = global_release_barriers.find(acquire.handle);
1159 if (set_it != global_release_barriers.end()) {
1160 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1161 set_for_handle.erase(acquire);
1162 if (set_for_handle.size() == 0) { // Clean up empty sets
1163 global_release_barriers.erase(set_it);
1164 }
1165 }
1166 }
1167}
1168
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001169void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001170 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state);
1171 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001172}
1173
John Zulauf6b4aae82018-05-09 13:03:36 -06001174// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001175void CoreChecks::EraseQFOImageRelaseBarriers(const VkImage &image) { EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image); }
John Zulauf6b4aae82018-05-09 13:03:36 -06001176
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001177void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001178 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001179 for (uint32_t i = 0; i < memBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +02001180 const auto &mem_barrier = pImgMemBarriers[i];
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001181
Chris Forbes4de4b132017-08-21 11:27:08 -07001182 // For ownership transfers, the barrier is specified twice; as a release
1183 // operation on the yielding queue family, and as an acquire operation
1184 // on the acquiring queue family. This barrier may also include a layout
1185 // transition, which occurs 'between' the two operations. For validation
1186 // purposes it doesn't seem important which side performs the layout
1187 // transition, but it must not be performed twice. We'll arbitrarily
1188 // choose to perform it as part of the acquire operation.
John Zulauf2be3fe02019-12-30 09:48:02 -07001189 //
1190 // However, we still need to record initial layout for the "initial layout" validation
1191 const bool is_release_op = IsReleaseOp(cb_state, mem_barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -07001192
Petr Krausad0096a2019-08-09 18:35:04 +02001193 auto *image_state = GetImageState(mem_barrier.image);
John Zulauff660ad62019-03-23 07:16:05 -06001194 if (!image_state) continue;
John Zulauf2be3fe02019-12-30 09:48:02 -07001195 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
unknown86bcb3a2019-07-11 13:05:36 -06001196 for (const auto &image : image_state->aliasing_images) {
1197 image_state = GetImageState(image);
John Zulauf2be3fe02019-12-30 09:48:02 -07001198 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
Dave Houltonb3f4b282018-02-22 16:25:16 -07001199 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001200 }
1201}
1202
unknown86bcb3a2019-07-11 13:05:36 -06001203void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
John Zulauf2be3fe02019-12-30 09:48:02 -07001204 const VkImageMemoryBarrier &mem_barrier, bool is_release_op) {
unknown86bcb3a2019-07-11 13:05:36 -06001205 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier.subresourceRange);
1206 const auto &image_create_info = image_state->createInfo;
1207
1208 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1209 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1210 // for all (potential) layer sub_resources.
1211 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
1212 normalized_isr.baseArrayLayer = 0;
1213 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
1214 }
1215
John Zulauf2be3fe02019-12-30 09:48:02 -07001216 if (is_release_op) {
1217 SetImageInitialLayout(cb_state, *image_state, normalized_isr, mem_barrier.oldLayout);
1218 } else {
1219 SetImageLayout(cb_state, *image_state, normalized_isr, mem_barrier.newLayout, mem_barrier.oldLayout);
1220 }
unknown86bcb3a2019-07-11 13:05:36 -06001221}
1222
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001223bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1224 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1225 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1226 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Matthew Ruschd7ef5482019-07-16 22:01:54 -07001227 if (disabled.image_layout_validation) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001228 assert(cb_node);
1229 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001230 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001231 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001232
John Zulauff660ad62019-03-23 07:16:05 -06001233 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1234 if (subresource_map) {
1235 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001236 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
John Zulauf5e617452019-11-19 14:44:16 -07001237 for (auto pos = subresource_map->Find(range); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1238 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001239 *error = true;
John Zulauf5e617452019-11-19 14:44:16 -07001240 subres_skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1241 HandleToUint64(cb_node->commandBuffer), layout_mismatch_msg_code,
1242 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1243 "%s layout %s.",
1244 caller, report_data->FormatHandle(image).c_str(), pos->subresource.arrayLayer,
1245 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1246 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001247 }
John Zulauf5e617452019-11-19 14:44:16 -07001248 }
John Zulauff660ad62019-03-23 07:16:05 -06001249 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001250 }
John Zulauff660ad62019-03-23 07:16:05 -06001251
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001252 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1253 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1254 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001255 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1256 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001257 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001258 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_node->commandBuffer),
Dave Houlton51653902018-06-22 17:32:13 -06001259 kVUID_Core_DrawState_InvalidImageLayout,
locke-lunarg9edc2812019-06-17 23:18:52 -06001260 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
Lockee9aeebf2019-03-03 23:50:08 -07001261 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001262 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001263 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001264 if (image_state->shared_presentable) {
1265 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
Cort Stratton7df30962018-05-17 19:45:57 -07001266 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1267 layout_invalid_msg_code,
1268 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1269 string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001270 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001271 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001272 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001273 *error = true;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001274 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Cort Stratton7df30962018-05-17 19:45:57 -07001275 HandleToUint64(cb_node->commandBuffer), layout_invalid_msg_code,
locke-lunarg9edc2812019-06-17 23:18:52 -06001276 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
Lockee9aeebf2019-03-03 23:50:08 -07001277 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1278 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001279 }
1280 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001281 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001282}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001283bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001284 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1285 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001286 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001287 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1288 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1289}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001290
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001291void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001292 FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinski2e495882019-03-06 16:11:56 -07001293 auto renderPass = GetRenderPassState(pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001294 if (!renderPass) return;
1295
Tobias Hectorbbb12282018-10-22 15:17:59 +01001296 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001297 if (framebuffer_state) {
1298 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07001299 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -06001300 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001301 VkImageLayout stencil_layout = kInvalidLayout;
1302 const auto *attachment_description_stencil_layout =
1303 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
1304 if (attachment_description_stencil_layout) {
1305 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1306 }
1307
1308 SetImageViewLayout(pCB, *view_state, pRenderPassInfo->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001309 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001310 }
1311 }
1312}
Dave Houltone19e20d2018-02-02 16:32:41 -07001313
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001314#ifdef VK_USE_PLATFORM_ANDROID_KHR
1315// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1316// This could also move into a seperate core_validation_android.cpp file... ?
1317
1318//
1319// AHB-specific validation within non-AHB APIs
1320//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001321bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001322 bool skip = false;
1323
1324 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1325 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001326 if (0 != ext_fmt_android->externalFormat) {
1327 if (VK_FORMAT_UNDEFINED != create_info->format) {
1328 skip |=
1329 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1330 "VUID-VkImageCreateInfo-pNext-01974",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001331 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
Dave Houltond9611312018-11-19 17:03:36 -07001332 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
1333 }
1334
1335 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
1336 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1337 "VUID-VkImageCreateInfo-pNext-02396",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001338 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001339 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
1340 }
1341
1342 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
1343 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1344 "VUID-VkImageCreateInfo-pNext-02397",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001345 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001346 "non-zero externalFormat, but usage includes bits other than VK_IMAGE_USAGE_SAMPLED_BIT.");
1347 }
1348
1349 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
1350 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1351 "VUID-VkImageCreateInfo-pNext-02398",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001352 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001353 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
1354 }
1355 }
1356
Mark Lobodzinski1ee06e92019-04-19 14:03:53 -06001357 if ((0 != ext_fmt_android->externalFormat) && (0 == ahb_ext_formats_set.count(ext_fmt_android->externalFormat))) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001358 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1359 "VUID-VkExternalFormatANDROID-externalFormat-01894",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001360 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat which has "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001361 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().");
1362 }
1363 }
1364
Dave Houltond9611312018-11-19 17:03:36 -07001365 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001366 if (VK_FORMAT_UNDEFINED == create_info->format) {
1367 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1368 "VUID-VkImageCreateInfo-pNext-01975",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001369 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
Dave Houltond9611312018-11-19 17:03:36 -07001370 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
1371 }
1372 }
1373
1374 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1375 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1376 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001377 skip |=
1378 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1379 "VUID-VkImageCreateInfo-pNext-02393",
1380 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1381 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1382 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001383 }
1384
1385 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
1386 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1387 "VUID-VkImageCreateInfo-pNext-02394",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001388 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
Dave Houltond9611312018-11-19 17:03:36 -07001389 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1390 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1391 create_info->mipLevels, FullMipChainLevels(create_info->extent));
1392 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001393 }
1394
1395 return skip;
1396}
1397
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001398bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001399 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001400 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001401
1402 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001403 if (VK_FORMAT_UNDEFINED != create_info->format) {
1404 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1405 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02399",
1406 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1407 "format member is %s.",
1408 string_VkFormat(create_info->format));
1409 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001410
Dave Houltond9611312018-11-19 17:03:36 -07001411 // Chain must include a compatible ycbcr conversion
1412 bool conv_found = false;
1413 uint64_t external_format = 0;
1414 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1415 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001416 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001417 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001418 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001419 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001420 }
Dave Houltond9611312018-11-19 17:03:36 -07001421 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001422 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001423 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond9611312018-11-19 17:03:36 -07001424 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02400",
1425 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1426 "without a chained VkSamplerYcbcrConversionInfo struct with the same external format.");
1427 }
1428
1429 // Errors in create_info swizzles
1430 if ((create_info->components.r != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1431 (create_info->components.g != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1432 (create_info->components.b != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1433 (create_info->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
1434 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1435 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02401",
1436 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1437 "includes one or more non-identity component swizzles.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001438 }
1439 }
Dave Houltond9611312018-11-19 17:03:36 -07001440
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001441 return skip;
1442}
1443
John Zulaufa26d3c82019-08-14 16:09:08 -06001444bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001445 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001446
John Zulaufa26d3c82019-08-14 16:09:08 -06001447 const IMAGE_STATE *image_state = GetImageState(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001448 if (image_state->imported_ahb && (0 == image_state->GetBoundMemory().size())) {
1449 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
1450 "VUID-vkGetImageSubresourceLayout-image-01895",
Graeme Leese79b60cb2018-11-28 11:51:20 +00001451 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001452 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1453 "bound to memory.");
1454 }
1455 return skip;
1456}
1457
1458#else
1459
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001460bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001461 return false;
1462}
1463
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001464bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001465
John Zulaufa26d3c82019-08-14 16:09:08 -06001466bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001467
1468#endif // VK_USE_PLATFORM_ANDROID_KHR
1469
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001470bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001471 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001472 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001473
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001474 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001475 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001476 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1477 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
1478 return log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1479 "VUID-VkImageCreateInfo-format-00943",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001480 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001481 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001482 }
1483
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001484 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1485 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
1486 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1487 "VUID-VkImageCreateInfo-flags-00949",
1488 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1489 "flag bit is set");
1490 }
1491
1492 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
1493 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1494 "VUID-VkImageCreateInfo-imageType-00954",
1495 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1496 "height (%d) and arrayLayers (%d) must be >= 6.",
1497 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
1498 }
Dave Houlton130c0212018-01-29 13:39:56 -07001499 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001500
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001501 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001502 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1503 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1504 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001505 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001506 "VUID-VkImageCreateInfo-usage-00964",
1507 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1508 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001509 }
1510
1511 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001512 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001513 "VUID-VkImageCreateInfo-usage-00965",
1514 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1515 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001516 }
1517
ByumjinConffx991b6062019-08-14 15:17:53 -07001518 if (device_extensions.vk_ext_fragment_density_map) {
1519 uint32_t ceiling_width =
1520 (uint32_t)ceil((float)device_limits->maxFramebufferWidth /
1521 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, 1.0f));
1522 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1523 skip |=
1524 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1525 "VUID-VkImageCreateInfo-usage-02559",
1526 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1527 "ceiling of device "
1528 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1529 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1530 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
1531 }
1532
1533 uint32_t ceiling_height =
1534 (uint32_t)ceil((float)device_limits->maxFramebufferHeight /
1535 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, 1.0f));
1536 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1537 skip |=
1538 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1539 "VUID-VkImageCreateInfo-usage-02560",
1540 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1541 "ceiling of device "
1542 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1543 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1544 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
1545 }
1546 }
1547
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001548 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001549 VkResult result = VK_SUCCESS;
1550 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1551 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1552 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1553 &format_limits);
1554 } else {
1555 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>();
1556 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1557 image_format_info.type = pCreateInfo->imageType;
1558 image_format_info.tiling = pCreateInfo->tiling;
1559 image_format_info.usage = pCreateInfo->usage;
1560 image_format_info.flags = pCreateInfo->flags;
1561 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1562 format_limits = image_format_properties.imageFormatProperties;
1563 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001564
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001565 if (result == VK_ERROR_FORMAT_NOT_SUPPORTED) {
Lockee87f87c2019-04-23 17:53:10 -06001566#ifdef VK_USE_PLATFORM_ANDROID_KHR
1567 if (!lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext))
1568#endif // VK_USE_PLATFORM_ANDROID_KHR
1569 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1570 "vkCreateImage(): Format %s is not supported for this combination of parameters.",
1571 string_VkFormat(pCreateInfo->format));
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001572 } else {
1573 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1574 const char *format_string = string_VkFormat(pCreateInfo->format);
1575 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1576 "VUID-VkImageCreateInfo-mipLevels-02255",
1577 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1578 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
1579 }
Dave Houlton130c0212018-01-29 13:39:56 -07001580
Dave Houltona585d132019-01-18 13:05:42 -07001581 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1582 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1583 (uint64_t)pCreateInfo->samples;
1584 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * texel_count);
Dave Houlton130c0212018-01-29 13:39:56 -07001585
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001586 // Round up to imageGranularity boundary
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001587 VkDeviceSize imageGranularity = phys_dev_props.limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001588 uint64_t ig_mask = imageGranularity - 1;
1589 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001590
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001591 if (total_size > format_limits.maxResourceSize) {
1592 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1593 kVUID_Core_Image_InvalidFormatLimitsViolation,
1594 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1595 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1596 total_size, format_limits.maxResourceSize);
1597 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001598
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001599 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
1600 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1601 "VUID-VkImageCreateInfo-arrayLayers-02256",
1602 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1603 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
1604 }
1605
1606 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
1607 skip |=
1608 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1609 "VUID-VkImageCreateInfo-samples-02258", "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001610 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001611 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001612 }
1613
sfricke-samsungcead0802020-01-30 22:20:10 -08001614 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
1615 if (FormatRequiresYcbcrConversion(pCreateInfo->format)) {
1616 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
1617 const char *error_vuid = (device_extensions.vk_ext_ycbcr_image_arrays) ? "VUID-VkImageCreateInfo-format-02653"
1618 : "VUID-VkImageCreateInfo-format-02564";
1619 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0, error_vuid,
1620 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
1621 "YCbCr Conversion format, arrayLayers must be 1",
1622 pCreateInfo->arrayLayers);
1623 }
1624
1625 if (pCreateInfo->mipLevels != 1) {
1626 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1627 "VUID-VkImageCreateInfo-format-02561",
1628 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
1629 pCreateInfo->arrayLayers);
1630 }
1631
1632 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
1633 skip |= log_msg(
1634 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1635 "VUID-VkImageCreateInfo-format-02562",
1636 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
1637 string_VkSampleCountFlagBits(pCreateInfo->samples));
1638 }
1639
1640 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
1641 skip |= log_msg(
1642 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1643 "VUID-VkImageCreateInfo-format-02563",
1644 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
1645 string_VkImageType(pCreateInfo->imageType));
1646 }
1647 }
1648
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06001649 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001650 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Dave Houlton12befb92018-06-26 17:16:46 -06001651 "VUID-VkImageCreateInfo-flags-01924",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001652 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
1653 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06001654 }
1655
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001656 if (device_extensions.vk_khr_maintenance2) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06001657 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
1658 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
1659 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
1660 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001661 skip |=
1662 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1663 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1664 "format must be block, ETC or ASTC compressed, but is %s",
1665 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001666 }
1667 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
1668 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001669 skip |=
1670 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1671 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1672 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001673 }
1674 }
1675 }
1676
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001677 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001678 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateImage",
1679 "pCreateInfo->pQueueFamilyIndices", "VUID-VkImageCreateInfo-sharingMode-01420",
1680 "VUID-VkImageCreateInfo-sharingMode-01420", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001681 }
1682
unknown2c877272019-07-11 12:56:50 -06001683 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
1684 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
1685 skip |=
1686 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1687 "VUID-VkImageCreateInfo-format-01577",
1688 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
1689 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
1690 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001691 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001692}
1693
John Zulauf7eeb6f72019-06-17 11:56:36 -06001694void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1695 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
1696 if (VK_SUCCESS != result) return;
1697
1698 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
1699
1700 IMAGE_LAYOUT_STATE image_state;
1701 image_state.layout = pCreateInfo->initialLayout;
1702 image_state.format = pCreateInfo->format;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001703 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001704 imageSubresourceMap[*pImage].push_back(subpair);
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -06001705 imageLayoutMap[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001706}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001707
Jeff Bolz5c801d12019-10-09 10:38:45 -05001708bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001709 const IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06001710 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001711 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001712 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001713 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001714 }
1715 return skip;
1716}
1717
John Zulauf7eeb6f72019-06-17 11:56:36 -06001718void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
1719 // Clean up validation specific data
1720 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001721
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001722 const auto &sub_entry = imageSubresourceMap.find(image);
1723 if (sub_entry != imageSubresourceMap.end()) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001724 for (const auto &pair : sub_entry->second) {
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -06001725 imageLayoutMap.erase(pair);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001726 }
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001727 imageSubresourceMap.erase(sub_entry);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001728 }
John Zulauf7eeb6f72019-06-17 11:56:36 -06001729
1730 // Clean up generic image state
1731 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001732}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001733
John Zulauf07288512019-07-05 11:09:50 -06001734bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001735 bool skip = false;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001736
1737 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
1738 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
1739 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06001740 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001741 }
1742
Dave Houlton1d2022c2017-03-29 11:43:58 -06001743 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001744 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
1745 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001746 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -06001747 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001748 char const str[] = "vkCmdClearColorImage called with compressed image.";
1749 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001750 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001751 }
1752
1753 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
1754 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
1755 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001756 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00002", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001757 }
1758 return skip;
1759}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001760
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001761uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1762 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1763 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001764 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001765 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001766 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001767 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001768}
1769
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001770uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1771 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1772 uint32_t array_layer_count = range->layerCount;
1773 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1774 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001775 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001776 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001777}
1778
John Zulauf07288512019-07-05 11:09:50 -06001779bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1780 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
1781 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001782 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001783 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1784 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001785 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001786 HandleToUint64(image_state->image), "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001787 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1788 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001789 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001790
1791 } else {
1792 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1793 if (!device_extensions.vk_khr_shared_presentable_image) {
1794 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
1795 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1796 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-imageLayout-00005",
1797 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1798 string_VkImageLayout(dest_image_layout));
1799 }
1800 } else {
1801 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
1802 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
1803 skip |= log_msg(
1804 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1805 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-imageLayout-01394",
1806 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
1807 func_name, string_VkImageLayout(dest_image_layout));
1808 }
1809 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001810 }
1811
John Zulauff660ad62019-03-23 07:16:05 -06001812 // Cast to const to prevent creation at validate time.
John Zulauf07288512019-07-05 11:09:50 -06001813 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06001814 if (subresource_map) {
1815 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001816 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06001817 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
John Zulauf5e617452019-11-19 14:44:16 -07001818 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1819 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06001820 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
1821 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1822 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
1823 } else {
1824 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001825 }
John Zulauff660ad62019-03-23 07:16:05 -06001826 subres_skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1827 HandleToUint64(cb_node->commandBuffer), error_code,
1828 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
1829 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
1830 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001831 }
John Zulauf5e617452019-11-19 14:44:16 -07001832 }
John Zulauff660ad62019-03-23 07:16:05 -06001833 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001834 }
1835
1836 return skip;
1837}
1838
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001839bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1840 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001841 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001842 bool skip = false;
1843 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06001844 const auto *cb_node = GetCBState(commandBuffer);
1845 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001846 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001847 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001848 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001849 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001850 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski544def72019-04-19 14:25:59 -06001851 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001852 skip |=
1853 ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
1854 "VUID-vkCmdClearColorImage-image-01993", "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001855 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001856 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001857 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001858 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001859 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001860 skip |= ValidateImageAttributes(image_state, pRanges[i]);
1861 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001862 }
1863 }
1864 return skip;
1865}
1866
John Zulaufeabb4462019-07-05 14:13:03 -06001867void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1868 const VkClearColorValue *pColor, uint32_t rangeCount,
1869 const VkImageSubresourceRange *pRanges) {
1870 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
1871
1872 auto cb_node = GetCBState(commandBuffer);
1873 auto image_state = GetImageState(image);
1874 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001875 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001876 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001877 }
1878 }
1879}
1880
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001881bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1882 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001883 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001884 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001885
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001886 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06001887 const auto *cb_node = GetCBState(commandBuffer);
1888 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001889 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001890 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06001891 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001892 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001893 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001894 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski544def72019-04-19 14:25:59 -06001895 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001896 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
1897 "VUID-vkCmdClearDepthStencilImage-image-01994",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001898 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001899 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001900 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Andrew Fobel3abeb992020-01-20 16:33:22 -05001901
1902 bool any_include_aspect_depth_bit = false;
1903 bool any_include_aspect_stencil_bit = false;
1904
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001905 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001906 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001907 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001908 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001909 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001910 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1911 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001912 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001913 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1914 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001915 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06001916 HandleToUint64(commandBuffer), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001917 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05001918 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
1919 any_include_aspect_depth_bit = true;
1920 }
1921 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
1922 any_include_aspect_stencil_bit = true;
1923 }
1924 }
1925 if (any_include_aspect_stencil_bit) {
1926 const auto image_stencil_struct = lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
1927 if (image_stencil_struct != nullptr) {
1928 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
1929 skip |=
1930 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1931 "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
1932 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
1933 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
1934 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
1935 }
1936 } else {
1937 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
1938 skip |= log_msg(
1939 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1940 "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
1941 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
1942 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
1943 "in VkImageCreateInfo::usage used to create image");
1944 }
1945 }
1946 }
1947 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
1948 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1949 "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
1950 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
1951 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001952 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001953 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001954 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001955 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001956 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00014", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001957 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001958 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1959 char const str[] =
1960 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1961 "set.";
1962 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001963 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00009", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001964 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001965 }
1966 return skip;
1967}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001968
John Zulaufeabb4462019-07-05 14:13:03 -06001969void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1970 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1971 const VkImageSubresourceRange *pRanges) {
1972 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
1973 auto cb_node = GetCBState(commandBuffer);
1974 auto image_state = GetImageState(image);
1975 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001976 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001977 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001978 }
1979 }
1980}
1981
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001982// Returns true if [x, xoffset] and [y, yoffset] overlap
1983static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1984 bool result = false;
1985 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1986 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1987
1988 if (intersection_max > intersection_min) {
1989 result = true;
1990 }
1991 return result;
1992}
1993
Dave Houltonc991cc92018-03-06 11:08:51 -07001994// Returns true if source area of first copy region intersects dest area of second region
1995// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1996static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001997 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001998
Dave Houltonc991cc92018-03-06 11:08:51 -07001999 // Separate planes within a multiplane image cannot intersect
2000 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07002001 return result;
2002 }
2003
Dave Houltonc991cc92018-03-06 11:08:51 -07002004 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
2005 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
2006 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002007 result = true;
2008 switch (type) {
2009 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002010 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002011 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002012 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002013 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002014 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002015 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002016 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002017 break;
2018 default:
2019 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2020 assert(false);
2021 }
2022 }
2023 return result;
2024}
2025
Dave Houltonfc1a4052017-04-27 14:32:45 -06002026// Returns non-zero if offset and extent exceed image extents
2027static const uint32_t x_bit = 1;
2028static const uint32_t y_bit = 2;
2029static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002030static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002031 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002032 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002033 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2034 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002035 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002036 }
2037 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2038 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002039 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002040 }
2041 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2042 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002043 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002044 }
2045 return result;
2046}
2047
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002048// Test if two VkExtent3D structs are equivalent
2049static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2050 bool result = true;
2051 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2052 (extent->depth != other_extent->depth)) {
2053 result = false;
2054 }
2055 return result;
2056}
2057
Dave Houltonee281a52017-12-08 13:51:02 -07002058// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
2059// Destination image texel extents must be adjusted by block size for the dest validation checks
2060VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
2061 VkExtent3D adjusted_extent = extent;
unknown948b6ba2019-09-19 17:32:54 -06002062 if ((FormatIsCompressed(src_format) || FormatIsSinglePlane_422(src_format)) &&
2063 !(FormatIsCompressed(dst_format) || FormatIsSinglePlane_422(dst_format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002064 VkExtent3D block_size = FormatTexelBlockExtent(src_format);
Dave Houltonee281a52017-12-08 13:51:02 -07002065 adjusted_extent.width /= block_size.width;
2066 adjusted_extent.height /= block_size.height;
2067 adjusted_extent.depth /= block_size.depth;
unknown948b6ba2019-09-19 17:32:54 -06002068 } else if (!(FormatIsCompressed(src_format) || FormatIsSinglePlane_422(src_format)) &&
2069 (FormatIsCompressed(dst_format) || FormatIsSinglePlane_422(dst_format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002070 VkExtent3D block_size = FormatTexelBlockExtent(dst_format);
Dave Houltonee281a52017-12-08 13:51:02 -07002071 adjusted_extent.width *= block_size.width;
2072 adjusted_extent.height *= block_size.height;
2073 adjusted_extent.depth *= block_size.depth;
2074 }
2075 return adjusted_extent;
2076}
2077
Dave Houlton6f9059e2017-05-02 17:15:13 -06002078// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002079static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
2080 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06002081
2082 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06002083 if (mip >= img->createInfo.mipLevels) {
2084 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06002085 }
Dave Houlton1150cf52017-04-27 14:38:11 -06002086
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002087 // 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 -06002088 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05002089
Dave Houltone48cd112019-01-03 17:01:18 -07002090 // If multi-plane, adjust per-plane extent
2091 if (FormatIsMultiplane(img->createInfo.format)) {
2092 VkExtent2D divisors = FindMultiplaneExtentDivisors(img->createInfo.format, subresource->aspectMask);
2093 extent.width /= divisors.width;
2094 extent.height /= divisors.height;
2095 }
2096
Jeff Bolzef40fec2018-09-01 22:04:34 -05002097 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
2098 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
Dave Houlton142c4cb2018-10-17 15:04:41 -06002099 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1) >> mip)));
Jeff Bolzef40fec2018-09-01 22:04:34 -05002100 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
2101 } else {
2102 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
2103 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
2104 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
2105 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06002106
Dave Houlton6f9059e2017-05-02 17:15:13 -06002107 // Image arrays have an effective z extent that isn't diminished by mip level
2108 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002109 extent.depth = img->createInfo.arrayLayers;
2110 }
2111
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002112 return extent;
2113}
2114
2115// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002116static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002117 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2118}
2119
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002120// Test if the extent argument has any dimensions set to 0.
2121static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
2122 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
2123}
2124
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002125// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002126VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002127 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2128 VkExtent3D granularity = {0, 0, 0};
Jeff Bolz6835fda2019-10-06 00:15:34 -05002129 auto pPool = cb_node->command_pool.get();
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002130 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002131 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06002132 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002133 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002134 granularity.width *= block_size.width;
2135 granularity.height *= block_size.height;
2136 }
2137 }
2138 return granularity;
2139}
2140
2141// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2142static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2143 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002144 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2145 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002146 valid = false;
2147 }
2148 return valid;
2149}
2150
2151// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002152bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002153 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002154 bool skip = false;
2155 VkExtent3D offset_extent = {};
2156 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2157 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2158 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002159 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002160 // 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 -07002161 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002162 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Cort Stratton420ebd42018-05-04 01:12:23 -04002163 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002164 "%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 "
2165 "image transfer granularity is (w=0, h=0, d=0).",
Petr Krausbc7f5442017-05-14 23:43:38 +02002166 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002167 }
2168 } else {
2169 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2170 // integer multiples of the image transfer granularity.
2171 if (IsExtentAligned(&offset_extent, granularity) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002172 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Cort Stratton420ebd42018-05-04 01:12:23 -04002173 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002174 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2175 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
Petr Krausbc7f5442017-05-14 23:43:38 +02002176 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2177 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002178 }
2179 }
2180 return skip;
2181}
2182
2183// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002184bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002185 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002186 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002187 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002188 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002189 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2190 // subresource extent.
2191 if (IsExtentEqual(extent, subresource_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002192 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Cort Stratton420ebd42018-05-04 01:12:23 -04002193 HandleToUint64(cb_node->commandBuffer), vuid,
Petr Krausbc7f5442017-05-14 23:43:38 +02002194 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2195 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2196 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2197 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002198 }
2199 } else {
2200 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2201 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2202 // subresource extent dimensions.
2203 VkExtent3D offset_extent_sum = {};
2204 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2205 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2206 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002207 bool x_ok = true;
2208 bool y_ok = true;
2209 bool z_ok = true;
2210 switch (image_type) {
2211 case VK_IMAGE_TYPE_3D:
2212 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2213 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002214 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002215 case VK_IMAGE_TYPE_2D:
2216 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2217 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002218 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002219 case VK_IMAGE_TYPE_1D:
2220 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2221 (subresource_extent->width == offset_extent_sum.width));
2222 break;
2223 default:
2224 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2225 assert(false);
2226 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002227 if (!(x_ok && y_ok && z_ok)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002228 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Cort Stratton420ebd42018-05-04 01:12:23 -04002229 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002230 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2231 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2232 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2233 function, i, member, extent->width, extent->height, extent->depth, granularity->width,
2234 granularity->height, granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height,
2235 extent->depth, subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002236 }
2237 }
2238 return skip;
2239}
2240
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002241bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002242 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002243 bool skip = false;
2244 if (mip_level >= img->createInfo.mipLevels) {
2245 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2246 HandleToUint64(cb_node->commandBuffer), vuid,
locke-lunarg9edc2812019-06-17 23:18:52 -06002247 "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.", function, i, member, mip_level,
2248 report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002249 }
2250 return skip;
2251}
2252
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002253bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002254 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002255 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002256 bool skip = false;
2257 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2258 (base_layer + layer_count) > img->createInfo.arrayLayers) {
2259 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2260 HandleToUint64(cb_node->commandBuffer), vuid,
2261 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
locke-lunarg9edc2812019-06-17 23:18:52 -06002262 "%u, but provided %s has %u array layers.",
Lockee9aeebf2019-03-03 23:50:08 -07002263 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2264 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002265 }
2266 return skip;
2267}
2268
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002269// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002270bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002271 const VkBufferImageCopy *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002272 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002273 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002274 VkExtent3D granularity = GetScaledItg(cb_node, img);
2275 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002276 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002277 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002278 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002279 return skip;
2280}
2281
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002282// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002283bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002284 const IMAGE_STATE *dst_img, const VkImageCopy *region,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002285 const uint32_t i, const char *function) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002286 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002287 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002288 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
2289 skip |=
2290 CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002291 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002292 const VkExtent3D extent = region->extent;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002293 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
2294 i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002295
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002296 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002297 granularity = GetScaledItg(cb_node, dst_img);
2298 skip |=
2299 CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002300 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002301 const VkExtent3D dest_effective_extent =
2302 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002303 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002304 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002305 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002306 return skip;
2307}
2308
Dave Houlton6f9059e2017-05-02 17:15:13 -06002309// Validate contents of a VkImageCopy struct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002310bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const VkImageCopy *ic_regions, const IMAGE_STATE *src_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002311 const IMAGE_STATE *dst_state) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002312 bool skip = false;
2313
2314 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002315 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002316
2317 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002318 const VkExtent3D src_copy_extent = region.extent;
2319 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002320 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2321
Dave Houlton6f9059e2017-05-02 17:15:13 -06002322 bool slice_override = false;
2323 uint32_t depth_slices = 0;
2324
2325 // Special case for copying between a 1D/2D array and a 3D image
2326 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2327 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002328 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002329 slice_override = (depth_slices != 1);
2330 } 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 -07002331 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002332 slice_override = (depth_slices != 1);
2333 }
2334
2335 // Do all checks on source image
2336 //
2337 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002338 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
2339 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002340 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00146",
Dave Houltonee281a52017-12-08 13:51:02 -07002341 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002342 "be 0 and 1, respectively.",
2343 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002344 }
2345 }
2346
Dave Houlton533be9f2018-03-26 17:08:30 -06002347 // VUID-VkImageCopy-srcImage-01785
2348 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
2349 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002350 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01785",
Dave Houlton533be9f2018-03-26 17:08:30 -06002351 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002352 "these must be 0 and 1, respectively.",
2353 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002354 }
2355
Dave Houlton533be9f2018-03-26 17:08:30 -06002356 // VUID-VkImageCopy-srcImage-01787
2357 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
2358 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002359 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01787",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002360 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2361 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002362 }
2363
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002364 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002365 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002366 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002367 skip |=
2368 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002369 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002370 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002371 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2372 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002373 }
2374 }
2375 } else { // Pre maint 1
2376 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002377 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002378 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002379 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002380 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2381 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002382 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2383 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002384 }
2385 }
2386 }
2387
Dave Houltonc991cc92018-03-06 11:08:51 -07002388 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002389 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002390 if (FormatIsCompressed(src_state->createInfo.format) ||
2391 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002392 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002393 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002394 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2395 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2396 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002397 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002398 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002399 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002400 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002401 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002402 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002403 }
2404
Dave Houlton94a00372017-12-14 15:08:47 -07002405 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002406 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2407 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002408 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002409 skip |=
2410 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002411 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002412 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002413 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002414 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002415 }
2416
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002417 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002418 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2419 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002420 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002421 skip |=
2422 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002423 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002424 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002425 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002426 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002427 }
2428
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002429 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002430 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2431 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002432 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002433 skip |=
2434 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002435 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002436 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002437 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002438 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002439 }
2440 } // Compressed
2441
2442 // Do all checks on dest image
2443 //
2444 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002445 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002446 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002447 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-00152",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002448 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002449 "these must be 0 and 1, respectively.",
2450 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002451 }
2452 }
2453
Dave Houlton533be9f2018-03-26 17:08:30 -06002454 // VUID-VkImageCopy-dstImage-01786
2455 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
2456 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002457 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01786",
Dave Houlton533be9f2018-03-26 17:08:30 -06002458 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002459 "and 1, respectively.",
2460 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002461 }
2462
2463 // VUID-VkImageCopy-dstImage-01788
2464 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
2465 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002466 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01788",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002467 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2468 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002469 }
2470
2471 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002472 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002473 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002474 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002475 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002476 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2477 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002478 }
2479 }
2480 // VU01199 changed with mnt1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002481 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002482 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002483 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002484 skip |=
2485 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002486 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002487 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002488 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2489 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002490 }
2491 }
2492 } else { // Pre maint 1
2493 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002494 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002495 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002496 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002497 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2498 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002499 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2500 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002501 }
2502 }
2503 }
2504
Dave Houltonc991cc92018-03-06 11:08:51 -07002505 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2506 if (FormatIsCompressed(dst_state->createInfo.format) ||
2507 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002508 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002509
2510 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002511 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2512 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2513 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002514 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002515 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002516 HandleToUint64(dst_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002517 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002518 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002519 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002520 }
2521
Dave Houlton94a00372017-12-14 15:08:47 -07002522 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002523 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2524 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002525 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002526 skip |=
2527 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002528 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002529 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002530 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002531 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002532 }
2533
Dave Houltonee281a52017-12-08 13:51:02 -07002534 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2535 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2536 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002537 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002538 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002539 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002540 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2541 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
Dave Houltonc991cc92018-03-06 11:08:51 -07002542 "height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002543 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002544 }
2545
Dave Houltonee281a52017-12-08 13:51:02 -07002546 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2547 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2548 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002549 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002550 skip |=
2551 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002552 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002553 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002554 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002555 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002556 }
2557 } // Compressed
2558 }
2559 return skip;
2560}
2561
Dave Houltonc991cc92018-03-06 11:08:51 -07002562// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002563bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002564 const IMAGE_STATE *dst_image_state, const VkImageCopy region) const {
Dave Houltonc991cc92018-03-06 11:08:51 -07002565 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002566
2567 // Neither image is multiplane
2568 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2569 // If neither image is multi-plane the aspectMask member of src and dst must match
2570 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2571 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002572 ss << "vkCmdCopyImage(): Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002573 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
2574 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002575 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002576 }
2577 } else {
2578 // Source image multiplane checks
2579 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2580 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2581 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2582 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002583 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002584 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002585 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002586 }
2587 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2588 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2589 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002590 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002591 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002592 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002593 }
2594 // Single-plane to multi-plane
2595 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2596 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2597 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002598 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002599 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002600 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002601 }
2602
2603 // Dest image multiplane checks
2604 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2605 aspect = region.dstSubresource.aspectMask;
2606 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2607 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002608 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002609 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002610 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002611 }
2612 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2613 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2614 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002615 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002616 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002617 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002618 }
2619 // Multi-plane to single-plane
2620 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2621 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2622 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002623 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002624 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002625 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002626 }
2627 }
2628
2629 return skip;
2630}
2631
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002632bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2633 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002634 const VkImageCopy *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002635 const auto *cb_node = GetCBState(commandBuffer);
2636 const auto *src_image_state = GetImageState(srcImage);
2637 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002638 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002639
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002640 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002641
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002642 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2643
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002644 for (uint32_t i = 0; i < regionCount; i++) {
2645 const VkImageCopy region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002646
2647 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2648 VkExtent3D src_copy_extent = region.extent;
2649 VkExtent3D dst_copy_extent =
2650 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
2651
Dave Houlton6f9059e2017-05-02 17:15:13 -06002652 bool slice_override = false;
2653 uint32_t depth_slices = 0;
2654
2655 // Special case for copying between a 1D/2D array and a 3D image
2656 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2657 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2658 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002659 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002660 slice_override = (depth_slices != 1);
2661 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2662 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002663 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002664 slice_override = (depth_slices != 1);
2665 }
2666
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002667 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2668 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
2669 skip |= ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002670 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002671 skip |= ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002672 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002673 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002674 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2675 "VUID-vkCmdCopyImage-srcSubresource-01698");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002676 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002677 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2678 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002679
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002680 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002681 // No chance of mismatch if we're overriding depth slice count
2682 if (!slice_override) {
2683 // The number of depth slices in srcSubresource and dstSubresource must match
2684 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2685 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002686 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2687 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002688 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002689 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2690 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002691 if (src_slices != dst_slices) {
2692 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002693 ss << "vkCmdCopyImage(): number of depth slices in source and destination subresources for pRegions[" << i
Dave Houlton6f9059e2017-05-02 17:15:13 -06002694 << "] do not match";
2695 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002696 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06002697 }
2698 }
2699 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002700 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002701 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002702 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002703 ss << "vkCmdCopyImage(): number of layers in source and destination subresources for pRegions[" << i
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002704 << "] do not match";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002705 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002706 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002707 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002708 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002709
Dave Houltonc991cc92018-03-06 11:08:51 -07002710 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002711 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002712 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region);
Dave Houltonc991cc92018-03-06 11:08:51 -07002713 }
2714
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002715 if (!device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002716 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2717 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002718 char const str[] = "vkCmdCopyImage(): Src and dest aspectMasks for each region must match";
Dave Houltonf5217612018-02-02 16:18:52 -07002719 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002720 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002721 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002722 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002723
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002724 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07002725 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002726 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002727 ss << "vkCmdCopyImage(): pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002728 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
2729 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002730 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002731 }
2732
2733 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07002734 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002735 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002736 ss << "vkCmdCopyImage(): pRegion[" << i
2737 << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002738 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002739 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002740 }
2741
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002742 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
2743 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
2744 // 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 -07002745 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2746 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002747 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002748 ss << "vkCmdCopyImage(): Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002749 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
2750 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
2751 << " ] exceeds the source image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002752 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002753 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00122", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002754 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002755
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002756 // 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 -07002757 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2758 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002759 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002760 ss << "vkCmdCopyImage(): Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002761 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
2762 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
2763 << " ] exceeds the destination image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002764 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002765 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00123", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002766 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002767 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002768
Dave Houltonfc1a4052017-04-27 14:32:45 -06002769 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002770 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2771 if (slice_override) src_copy_extent.depth = depth_slices;
2772 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002773 if (extent_check & x_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002774 skip |=
2775 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2776 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00144",
2777 "vkCmdCopyImage(): Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2778 "width [%1d].",
2779 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002780 }
2781
2782 if (extent_check & y_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002783 skip |=
2784 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2785 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00145",
2786 "vkCmdCopyImage(): Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2787 "height [%1d].",
2788 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002789 }
2790 if (extent_check & z_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002791 skip |=
2792 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2793 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00147",
2794 "vkCmdCopyImage(): Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2795 "depth [%1d].",
2796 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002797 }
2798
Dave Houltonee281a52017-12-08 13:51:02 -07002799 // Adjust dest extent if necessary
2800 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2801 if (slice_override) dst_copy_extent.depth = depth_slices;
2802
2803 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002804 if (extent_check & x_bit) {
2805 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002806 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00150",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002807 "vkCmdCopyImage(): Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002808 "width [%1d].",
2809 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002810 }
2811 if (extent_check & y_bit) {
2812 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002813 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00151",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002814 "vkCmdCopyImage(): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002815 "height [%1d].",
2816 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002817 }
2818 if (extent_check & z_bit) {
2819 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002820 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00153",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002821 "vkCmdCopyImage(): Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002822 "depth [%1d].",
2823 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002824 }
2825
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002826 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2827 // must not overlap in memory
2828 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002829 for (uint32_t j = 0; j < regionCount; j++) {
2830 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
Dave Houltonf5217612018-02-02 16:18:52 -07002831 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002832 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002833 ss << "vkCmdCopyImage(): pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002834 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002835 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002836 }
2837 }
2838 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002839 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002840
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002841 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2842 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2843 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002844 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002845 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2846 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02002847 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002848 HandleToUint64(command_buffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002849 }
2850 } else {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002851 if (!FormatSizesAreEqual(src_image_state->createInfo.format, dst_image_state->createInfo.format, regionCount, pRegions)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002852 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
2853 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002854 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00135", "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002855 }
2856 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002857
Dave Houlton33c22b72017-02-28 13:16:02 -07002858 // Source and dest image sample counts must match
2859 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2860 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
2861 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002862 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002863 }
2864
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002865 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2866 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002867 // Validate that SRC & DST images have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002868 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyImage-srcImage-00126",
2869 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2870 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyImage-dstImage-00131",
2871 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06002872 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002873 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
2874 "VUID-vkCmdCopyImage-srcImage-01995", "VUID-vkCmdCopyImage-srcImage-01995");
2875 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
2876 "VUID-vkCmdCopyImage-dstImage-01996", "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002877 }
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002878 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyImage()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002879 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002880 skip |= ValidateCmd(cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
2881 skip |= InsideRenderPass(cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002882 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002883 const char *invalid_src_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2884 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2885 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
2886 const char *invalid_dst_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2887 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2888 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002889 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002890 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002891 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2892 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002893 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002894 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2895 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002896 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
2897 "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002898 }
2899
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002900 return skip;
2901}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002902
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002903void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2904 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2905 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06002906 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
2907 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06002908 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002909 auto src_image_state = GetImageState(srcImage);
2910 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002911
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002912 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002913 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002914 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
2915 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002916 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002917}
2918
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002919// Returns true if sub_rect is entirely contained within rect
2920static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2921 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2922 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2923 return false;
2924 return true;
2925}
2926
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002927bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002928 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
2929 const VkRect2D &render_area, uint32_t rect_count,
2930 const VkClearRect *clear_rects) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07002931 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07002932 const IMAGE_VIEW_STATE *image_view_state = nullptr;
2933 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07002934 image_view_state = GetImageViewState(framebuffer->createInfo.pAttachments[fb_attachment]);
John Zulauff2582972019-02-09 14:53:30 -07002935 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002936
2937 for (uint32_t j = 0; j < rect_count; j++) {
2938 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002939 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
John Zulauf3a548ef2019-02-01 16:14:07 -07002940 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00016",
2941 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2942 "the current render pass instance.",
2943 j);
2944 }
2945
2946 if (image_view_state) {
2947 // The layers specified by a given element of pRects must be contained within every attachment that
2948 // pAttachments refers to
2949 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
2950 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
2951 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002952 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2953 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00017",
2954 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
2955 "of pAttachment[%d].",
2956 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07002957 }
2958 }
2959 }
2960 return skip;
2961}
2962
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002963bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2964 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002965 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002966 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06002967 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02002968 if (!cb_node) return skip;
2969
2970 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
2971 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
2972 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Petr Kraus2dffb382019-08-10 02:52:12 +02002973 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002974
2975 // Validate that attachment is in reference list of active subpass
2976 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002977 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07002978 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01002979 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002980 const auto *framebuffer = GetFramebufferState(cb_node->activeFramebuffer);
John Zulauf3a548ef2019-02-01 16:14:07 -07002981 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002982
John Zulauf3a548ef2019-02-01 16:14:07 -07002983 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2984 auto clear_desc = &pAttachments[attachment_index];
2985 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002986
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002987 if (0 == clear_desc->aspectMask) {
2988 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002989 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002990 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2991 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002992 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002993 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07002994 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
2995 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
2996 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2997 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
locke-lunarg9edc2812019-06-17 23:18:52 -06002998 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2999 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
3000 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
3001 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
3002 attachment_index, clear_desc->colorAttachment,
3003 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
3004 cb_node->activeSubpass, clear_desc->colorAttachment, color_attachment,
3005 renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07003006
John Zulauff2582972019-02-09 14:53:30 -07003007 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
3008 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003009 } else {
Lockee9aeebf2019-03-03 23:50:08 -07003010 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3011 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
locke-lunarg9edc2812019-06-17 23:18:52 -06003012 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
Lockee9aeebf2019-03-03 23:50:08 -07003013 " subpass %u. colorAttachmentCount=%u",
3014 attachment_index, clear_desc->colorAttachment,
3015 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
3016 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003017 }
John Zulauff2582972019-02-09 14:53:30 -07003018 fb_attachment = color_attachment;
3019
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003020 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
3021 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
3022 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003023 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
John Zulauf3a548ef2019-02-01 16:14:07 -07003024 skip |=
3025 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3026 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003027 }
3028 } else { // Must be depth and/or stencil
3029 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
3030 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003031 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003032 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
John Zulauf3a548ef2019-02-01 16:14:07 -07003033 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-parameter", str,
3034 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003035 }
3036 if (!subpass_desc->pDepthStencilAttachment ||
3037 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
3038 skip |= log_msg(
3039 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003040 HandleToUint64(commandBuffer), kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003041 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003042 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07003043 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003044 }
3045 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003046 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003047 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3048 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06003049 }
3050 }
3051 }
3052 return skip;
3053}
3054
3055void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3056 const VkClearAttachment *pAttachments, uint32_t rectCount,
3057 const VkClearRect *pRects) {
3058 auto *cb_node = GetCBState(commandBuffer);
3059 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
3060 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3061 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
3062 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
3063 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3064 const auto clear_desc = &pAttachments[attachment_index];
3065 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3066 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3067 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3068 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3069 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3070 subpass_desc->pDepthStencilAttachment) {
3071 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3072 }
3073 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003074 if (!clear_rect_copy) {
3075 // We need a copy of the clear rectangles that will persist until the last lambda executes
3076 // but we want to create it as lazily as possible
3077 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003078 }
John Zulauf441558b2019-08-12 11:47:39 -06003079 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3080 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003081 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
John Zulauff1640d12019-08-13 15:39:58 -06003082 const CMD_BUFFER_STATE *prim_cb, VkFramebuffer fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003083 assert(rectCount == clear_rect_copy->size());
John Zulauf441558b2019-08-12 11:47:39 -06003084 const FRAMEBUFFER_STATE *framebuffer = GetFramebufferState(fb);
John Zulauf3a548ef2019-02-01 16:14:07 -07003085 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3086 bool skip = false;
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003087 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3088 rectCount, clear_rect_copy->data());
John Zulauf3a548ef2019-02-01 16:14:07 -07003089 return skip;
3090 };
3091 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003092 }
3093 }
3094 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003095}
3096
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003097bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3098 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003099 const VkImageResolve *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003100 const auto *cb_node = GetCBState(commandBuffer);
3101 const auto *src_image_state = GetImageState(srcImage);
3102 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003103
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003104 bool skip = false;
3105 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003106 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-srcImage-00256");
3107 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-00258");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003108 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003109 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003110 skip |= ValidateCmd(cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
3111 skip |= InsideRenderPass(cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003112 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, "vkCmdResolveImage()",
3113 "VUID-vkCmdResolveImage-dstImage-02003", "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003114
Cort Stratton7df30962018-05-17 19:45:57 -07003115 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003116 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003117 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003118 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3119 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
3120 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003121 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003122 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3123 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003124 // For each region, the number of layers in the image subresource should not be zero
3125 // For each region, src and dest image aspect must be color only
3126 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003127 skip |=
3128 ValidateImageSubresourceLayers(cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()", "srcSubresource", i);
3129 skip |=
3130 ValidateImageSubresourceLayers(cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()", "dstSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003131 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003132 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
3133 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003134 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003135 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
3136 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003137 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i, "vkCmdResolveImage()",
3138 "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
3139 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i, "vkCmdResolveImage()",
3140 "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
3141 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003142 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
3143 "VUID-vkCmdResolveImage-srcSubresource-01711");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003144 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003145 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
3146 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07003147
3148 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003149 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
3150 skip |= log_msg(
3151 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003152 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-layerCount-00267",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003153 "vkCmdResolveImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003154 }
Cort Stratton7df30962018-05-17 19:45:57 -07003155 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003156 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3157 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
3158 char const str[] =
Graeme Leese79b60cb2018-11-28 11:51:20 +00003159 "vkCmdResolveImage(): src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003160 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003161 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003162 }
3163 }
3164
3165 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
3166 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003167 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003168 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003169 }
3170 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
3171 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003172 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003173 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageType, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003174 }
3175 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
3176 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
3177 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003178 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-srcImage-00257", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003179 }
3180 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
3181 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
3182 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003183 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-dstImage-00259", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003184 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003185 } else {
3186 assert(0);
3187 }
3188 return skip;
3189}
3190
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003191bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3192 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003193 const VkImageBlit *pRegions, VkFilter filter) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003194 const auto *cb_node = GetCBState(commandBuffer);
3195 const auto *src_image_state = GetImageState(srcImage);
3196 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003197
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003198 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003199 if (cb_node) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003200 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
John Zulauf5c2750c2018-01-30 15:04:56 -07003201 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003202 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003203 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003204 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003205 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003206 "VUID-vkCmdBlitImage-dstImage-00234");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003207 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
3208 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
Dave Houltond8ed0212018-05-16 17:18:24 -06003209 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003210 ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdBlitImage-srcImage-00219",
3211 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06003212 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003213 ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdBlitImage-dstImage-00224",
3214 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003215 skip |=
3216 ValidateCmdQueueFlags(cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003217 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
3218 skip |= InsideRenderPass(cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003219 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003220 "VUID-vkCmdBlitImage-srcImage-01999", "VUID-vkCmdBlitImage-srcImage-01999");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003221 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003222 "VUID-vkCmdBlitImage-dstImage-02000", "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04003223
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003224 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003225
Dave Houlton33c2d252017-06-09 17:08:32 -06003226 VkFormat src_format = src_image_state->createInfo.format;
3227 VkFormat dst_format = dst_image_state->createInfo.format;
3228 VkImageType src_type = src_image_state->createInfo.imageType;
3229 VkImageType dst_type = dst_image_state->createInfo.imageType;
3230
Cort Stratton186b1a22018-05-01 20:18:06 -04003231 if (VK_FILTER_LINEAR == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003232 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003233 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001",
3234 "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04003235 } else if (VK_FILTER_CUBIC_IMG == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003236 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
3237 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02002",
3238 "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06003239 }
3240
3241 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
3242 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003243 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-filter-00237",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003244 "vkCmdBlitImage(): source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003245 }
3246
Dave Houlton33c2d252017-06-09 17:08:32 -06003247 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
3248 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
3249 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003250 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00228",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003251 "vkCmdBlitImage(): source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003252 }
3253
3254 // Validate consistency for unsigned formats
3255 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3256 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003257 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003258 << "the other one must also have unsigned integer format. "
3259 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3260 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003261 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003262 }
3263
3264 // Validate consistency for signed formats
3265 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3266 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003267 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003268 << "the other one must also have signed integer format. "
3269 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3270 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003271 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003272 }
3273
3274 // Validate filter for Depth/Stencil formats
3275 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3276 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003277 ss << "vkCmdBlitImage(): If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003278 << "then filter must be VK_FILTER_NEAREST.";
3279 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003280 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003281 }
3282
3283 // Validate aspect bits and formats for depth/stencil images
3284 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3285 if (src_format != dst_format) {
3286 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003287 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003288 << "stencil, the other one must have exactly the same format. "
3289 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3290 << string_VkFormat(dst_format);
Dave Houltond8ed0212018-05-16 17:18:24 -06003291 skip |=
3292 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3293 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003294 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003295 } // Depth or Stencil
3296
3297 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003298 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003299 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003300 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3301 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3302 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003303 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003304 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3305 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003306 for (uint32_t i = 0; i < regionCount; i++) {
3307 const VkImageBlit rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003308 bool hit_error = false;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003309 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003310 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3311 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003312 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003313 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3314 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003315 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3316 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
3317 skip |= ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003318 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003319 skip |= ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003320 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003321 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003322 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3323 "VUID-vkCmdBlitImage-srcSubresource-01707");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003324 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003325 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3326 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003327 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003328 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3329 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003330 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003331 ss << "vkCmdBlitImage(): pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003332 skip |=
3333 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3334 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003335 }
Dave Houlton48989f32017-05-26 15:01:46 -06003336 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3337 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003338 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003339 ss << "vkCmdBlitImage(): pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003340 skip |=
3341 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3342 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003343 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003344
3345 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003346 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003347 skip |= log_msg(
3348 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3349 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-layerCount-00239",
3350 "vkCmdBlitImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003351 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003352
Dave Houlton48989f32017-05-26 15:01:46 -06003353 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003354 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003355 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00238",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003356 "vkCmdBlitImage(): aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003357 }
Dave Houlton48989f32017-05-26 15:01:46 -06003358
Dave Houlton33c2d252017-06-09 17:08:32 -06003359 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
3360 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003361 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00241",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003362 "vkCmdBlitImage(): region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003363 "image format %s.",
3364 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003365 }
3366
3367 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
3368 skip |= log_msg(
3369 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003370 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00242",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003371 "vkCmdBlitImage(): region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3372 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003373 }
3374
Dave Houlton48989f32017-05-26 15:01:46 -06003375 // Validate source image offsets
3376 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003377 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003378 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003379 skip |=
3380 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3381 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00245",
3382 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3383 "of (%1d, %1d). These must be (0, 1).",
3384 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003385 }
3386 }
3387
Dave Houlton33c2d252017-06-09 17:08:32 -06003388 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003389 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
3390 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003391 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00247",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003392 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003393 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3394 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003395 }
3396 }
3397
Dave Houlton33c2d252017-06-09 17:08:32 -06003398 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003399 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3400 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003401 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003402 skip |= log_msg(
3403 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3404 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00243",
3405 "vkCmdBlitImage(): region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).", i,
3406 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003407 }
3408 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3409 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003410 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003411 skip |= log_msg(
3412 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003413 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00244",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003414 "vkCmdBlitImage(): region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003415 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003416 }
3417 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3418 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003419 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003420 skip |= log_msg(
3421 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3422 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00246",
3423 "vkCmdBlitImage(): region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).", i,
3424 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003425 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003426 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003427 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003428 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00215",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003429 "vkCmdBlitImage(): region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003430 }
Dave Houlton48989f32017-05-26 15:01:46 -06003431
3432 // Validate dest image offsets
3433 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003434 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003435 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003436 skip |=
3437 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3438 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00250",
3439 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3440 "(%1d, %1d). These must be (0, 1).",
3441 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003442 }
3443 }
3444
Dave Houlton33c2d252017-06-09 17:08:32 -06003445 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003446 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
3447 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003448 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00252",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003449 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003450 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3451 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003452 }
3453 }
3454
Dave Houlton33c2d252017-06-09 17:08:32 -06003455 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003456 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3457 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003458 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003459 skip |= log_msg(
3460 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3461 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00248",
3462 "vkCmdBlitImage(): region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).", i,
3463 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003464 }
3465 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3466 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003467 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003468 skip |= log_msg(
3469 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003470 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00249",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003471 "vkCmdBlitImage(): region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003472 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003473 }
3474 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3475 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003476 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003477 skip |= log_msg(
3478 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3479 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00251",
3480 "vkCmdBlitImage(): region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).", i,
3481 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003482 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003483 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003484 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003485 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00216",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003486 "vkCmdBlitImage(): region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003487 }
3488
Dave Houlton33c2d252017-06-09 17:08:32 -06003489 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3490 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3491 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003492 skip |=
3493 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3494 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00240",
3495 "vkCmdBlitImage(): region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3496 "layerCount other than 1.",
3497 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003498 }
3499 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003500 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003501 } else {
3502 assert(0);
3503 }
3504 return skip;
3505}
3506
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003507void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3508 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3509 const VkImageBlit *pRegions, VkFilter filter) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003510 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3511 pRegions, filter);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003512 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003513 auto src_image_state = GetImageState(srcImage);
3514 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003515
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003516 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003517 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003518 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3519 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003520 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003521}
3522
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003523// 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 -06003524bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const ImageSubresPairLayoutMap &globalImageLayoutMap,
3525 ImageSubresPairLayoutMap *overlayLayoutMap_arg) const {
Matthew Ruschd7ef5482019-07-16 22:01:54 -07003526 if (disabled.image_layout_validation) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003527 bool skip = false;
John Zulauf3b04ebd2019-07-18 14:08:11 -06003528 ImageSubresPairLayoutMap &overlayLayoutMap = *overlayLayoutMap_arg;
John Zulauff660ad62019-03-23 07:16:05 -06003529 // Iterate over the layout maps for each referenced image
3530 for (const auto &layout_map_entry : pCB->image_layout_map) {
3531 const auto image = layout_map_entry.first;
3532 const auto *image_state = GetImageState(image);
3533 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06003534 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06003535 ImageSubresourcePair isr_pair;
3536 isr_pair.image = image;
3537 isr_pair.hasSubresource = true;
John Zulauff660ad62019-03-23 07:16:05 -06003538 // Validate the initial_uses for each subresource referenced
John Zulauf6066f732019-11-21 13:15:10 -07003539 for (const auto &pos : subres_map->InitialLayoutView()) {
3540 isr_pair.subresource = pos.subresource;
3541 VkImageLayout initial_layout = pos.it->second; // Point directly into the RangeMap iterated but the view
John Zulauff660ad62019-03-23 07:16:05 -06003542 VkImageLayout image_layout;
3543 if (FindLayout(overlayLayoutMap, isr_pair, image_layout) || FindLayout(globalImageLayoutMap, isr_pair, image_layout)) {
3544 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
3545 // TODO: Set memory invalid which is in mem_tracker currently
3546 } else if (image_layout != initial_layout) {
John Zulaufb61ed972019-04-09 16:12:35 -06003547 // Need to look up the inital layout *state* to get a bit more information
3548 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(isr_pair.subresource);
3549 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
3550 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
3551 if (!matches) {
3552 std::string formatted_label = FormatDebugLabel(" ", pCB->debug_label);
locke-lunargadbb54c2019-06-26 00:05:17 -06003553 skip |= log_msg(
3554 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3555 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06003556 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
locke-lunargadbb54c2019-06-26 00:05:17 -06003557 "to be in layout %s--instead, current layout is %s.%s",
unknown089cdb82019-07-11 12:58:43 -06003558 report_data->FormatHandle(image).c_str(), isr_pair.subresource.aspectMask,
locke-lunargadbb54c2019-06-26 00:05:17 -06003559 isr_pair.subresource.arrayLayer, isr_pair.subresource.mipLevel, string_VkImageLayout(initial_layout),
3560 string_VkImageLayout(image_layout), formatted_label.c_str());
John Zulaufb61ed972019-04-09 16:12:35 -06003561 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003562 }
3563 }
John Zulauff660ad62019-03-23 07:16:05 -06003564 }
3565
3566 // Update all layout set operations (which will be a subset of the initial_layouts
John Zulauf6066f732019-11-21 13:15:10 -07003567 for (const auto &pos : subres_map->CurrentLayoutView()) {
3568 VkImageLayout layout = pos.it->second;
3569 assert(layout != kInvalidLayout);
3570 isr_pair.subresource = pos.subresource;
3571 SetLayout(overlayLayoutMap, isr_pair, layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003572 }
3573 }
John Zulauff660ad62019-03-23 07:16:05 -06003574
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003575 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003576}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003577
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003578void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06003579 for (const auto &layout_map_entry : pCB->image_layout_map) {
3580 const auto image = layout_map_entry.first;
3581 const auto *image_state = GetImageState(image);
3582 if (!image_state) continue; // Can't set layouts of a dead image
3583 const auto &subres_map = layout_map_entry.second;
3584 ImageSubresourcePair isr_pair;
3585 isr_pair.image = image;
3586 isr_pair.hasSubresource = true;
3587
3588 // Update all layout set operations (which will be a subset of the initial_layouts
John Zulauf6066f732019-11-21 13:15:10 -07003589 for (const auto &pos : subres_map->CurrentLayoutView()) {
3590 VkImageLayout layout = pos.it->second;
3591 assert(layout != kInvalidLayout);
3592 isr_pair.subresource = pos.subresource;
3593 SetGlobalLayout(isr_pair, layout);
John Zulauff660ad62019-03-23 07:16:05 -06003594 }
Tony Barbourdf013b92017-01-25 12:53:48 -07003595 }
3596}
3597
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003598// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003599// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3600// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003601bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3602 const VkImageLayout first_layout, const uint32_t attachment,
John Zulauf9d2b6382019-07-25 15:21:36 -06003603 const VkAttachmentDescription2KHR &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003604 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003605 const char *vuid;
3606 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3607
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003608 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
3609 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003610 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3611 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3612 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003613 skip |=
Shannon McPherson3ea65132018-12-05 10:37:39 -07003614 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003615 "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
Shannon McPherson3ea65132018-12-05 10:37:39 -07003616 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
3617 } else if (!use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3618 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
3619 skip |=
3620 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3621 "VUID-VkRenderPassCreateInfo-pAttachments-00836",
Dave Houltond8ed0212018-05-16 17:18:24 -06003622 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003623 }
3624 }
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003625 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3626 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003627 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01566";
Dave Houltond8ed0212018-05-16 17:18:24 -06003628 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003629 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
Dave Houltond8ed0212018-05-16 17:18:24 -06003630 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003631 }
3632 }
3633
3634 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3635 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003636 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01567";
Dave Houltond8ed0212018-05-16 17:18:24 -06003637 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003638 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
Dave Houltond8ed0212018-05-16 17:18:24 -06003639 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003640 }
3641 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003642 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003643}
3644
Mark Lobodzinskiac02c612020-01-17 14:52:35 -07003645bool CoreChecks::ValidateLayouts(RenderPassCreateVersion rp_version, VkDevice device, const VkRenderPassCreateInfo2KHR *pCreateInfo,
3646 const char *function_name) const {
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003647 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003648 const char *vuid;
3649 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003650
Jason Ekstranda1906302017-12-03 20:16:32 -08003651 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3652 VkFormat format = pCreateInfo->pAttachments[i].format;
3653 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3654 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3655 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003656 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Dave Houlton51653902018-06-22 17:32:13 -06003657 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003658 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
3659 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3660 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3661 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003662 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003663 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003664 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Dave Houlton51653902018-06-22 17:32:13 -06003665 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003666 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3667 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3668 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3669 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003670 }
3671 }
3672 }
3673
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003674 // Track when we're observing the first use of an attachment
3675 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3676 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003677 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003678
3679 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3680 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3681 auto attach_index = subpass.pInputAttachments[j].attachment;
3682 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003683 switch (subpass.pInputAttachments[j].layout) {
3684 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3685 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3686 // These are ideal.
3687 break;
3688
3689 case VK_IMAGE_LAYOUT_GENERAL:
3690 // May not be optimal. TODO: reconsider this warning based on other constraints.
3691 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003692 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003693 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
3694 break;
3695
Tobias Hectorbbb12282018-10-22 15:17:59 +01003696 case VK_IMAGE_LAYOUT_UNDEFINED:
3697 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003698 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Tobias Hectorbbb12282018-10-22 15:17:59 +01003699 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3700 "Layout for input attachment reference %u in subpass %u is %s but must be "
3701 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
Petr Kraus123ba9d2019-08-10 03:01:41 +02003702 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003703 break;
3704
Piers Daniell9af77cd2019-10-16 13:54:12 -06003705 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3706 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3707 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3708 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003709 if (!enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -06003710 skip |= log_msg(
3711 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003712 "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003713 "Layout for input attachment reference %u in subpass %u is %s but must not be "
3714 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3715 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3716 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
3717 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
3718 skip |= log_msg(
3719 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003720 "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003721 "Layout for input attachment reference %u in subpass %u is %s but must not be "
3722 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3723 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3724 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
3725 } else if ((subpass.pInputAttachments[j].aspectMask &
3726 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3727 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3728 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3729 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3730 const auto *attachment_reference_stencil_layout =
3731 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pInputAttachments[j].pNext);
3732 if (attachment_reference_stencil_layout) {
3733 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3734 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3735 attachment_reference_stencil_layout->stencilLayout ==
3736 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3737 attachment_reference_stencil_layout->stencilLayout ==
3738 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3739 attachment_reference_stencil_layout->stencilLayout ==
3740 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3741 attachment_reference_stencil_layout->stencilLayout ==
3742 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3743 attachment_reference_stencil_layout->stencilLayout ==
3744 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3745 attachment_reference_stencil_layout->stencilLayout ==
3746 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3747 attachment_reference_stencil_layout->stencilLayout ==
3748 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3749 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
3750 skip |=
3751 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003752 0, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003753 "In the attachment reference %u in subpass %u with pNext chain instance "
3754 "VkAttachmentReferenceStencilLayoutKHR"
3755 "the stencilLayout member but must not be "
3756 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3757 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3758 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3759 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3760 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3761 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3762 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3763 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3764 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3765 j, i);
3766 }
3767 } else {
3768 skip |=
3769 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003770 "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003771 "When the layout for input attachment reference %u in subpass %u is "
3772 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3773 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3774 "VkAttachmentReferenceStencilLayout instance.",
3775 j, i);
3776 }
3777 }
3778 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3779 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3780 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
3781 skip |= log_msg(
3782 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003783 "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003784 "When the aspectMask for input attachment reference %u in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3785 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3786 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3787 j, i);
3788 }
3789 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3790 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3791 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3792 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003793 "VUID-VkAttachmentReference2-attachment-03317",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003794 "When the aspectMask for input attachment reference %u in subpass %u is "
3795 "VK_IMAGE_ASPECT_STENCIL_BIT "
3796 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3797 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
3798 j, i);
3799 }
3800 }
3801 break;
3802
Graeme Leese668a9862018-10-08 10:40:02 +01003803 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3804 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003805 if (device_extensions.vk_khr_maintenance2) {
Graeme Leese668a9862018-10-08 10:40:02 +01003806 break;
3807 } else {
3808 // Intentionally fall through to generic error message
3809 }
3810 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003811
Cort Stratton7547f772017-05-04 15:18:52 -07003812 default:
3813 // No other layouts are acceptable
3814 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Dave Houlton51653902018-06-22 17:32:13 -06003815 kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003816 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3817 string_VkImageLayout(subpass.pInputAttachments[j].layout));
3818 }
3819
Cort Stratton7547f772017-05-04 15:18:52 -07003820 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003821 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3822 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003823
3824 bool used_as_depth =
3825 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3826 bool used_as_color = false;
3827 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3828 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3829 }
3830 if (!used_as_depth && !used_as_color &&
3831 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08003832 vuid = use_rp2 ? "VUID-VkSubpassDescription2-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
Tobias Hectorbbb12282018-10-22 15:17:59 +01003833 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3834 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
3835 function_name, attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07003836 }
3837 }
3838 attach_first_use[attach_index] = false;
3839 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003840
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003841 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3842 auto attach_index = subpass.pColorAttachments[j].attachment;
3843 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3844
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003845 // TODO: Need a way to validate shared presentable images here, currently just allowing
3846 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3847 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003848 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003849 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003850 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003851 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3852 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003853 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003854
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003855 case VK_IMAGE_LAYOUT_GENERAL:
3856 // May not be optimal; TODO: reconsider this warning based on other constraints?
3857 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003858 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003859 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
3860 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003861
Tobias Hectorbbb12282018-10-22 15:17:59 +01003862 case VK_IMAGE_LAYOUT_UNDEFINED:
3863 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003864 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Tobias Hectorbbb12282018-10-22 15:17:59 +01003865 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3866 "Layout for color attachment reference %u in subpass %u is %s but should be "
3867 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3868 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3869 break;
3870
Piers Daniell9af77cd2019-10-16 13:54:12 -06003871 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3872 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3873 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3874 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003875 if (!enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -06003876 skip |= log_msg(
3877 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003878 "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003879 "Layout for color attachment reference %u in subpass %u is %s but must not be "
3880 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3881 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3882 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3883 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
3884 skip |= log_msg(
3885 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003886 "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003887 "Layout for color attachment reference %u in subpass %u is %s but must not be "
3888 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3889 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3890 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3891 } else if ((subpass.pColorAttachments[j].aspectMask &
3892 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3893 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3894 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3895 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3896 const auto *attachment_reference_stencil_layout =
3897 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pColorAttachments[j].pNext);
3898 if (attachment_reference_stencil_layout) {
3899 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3900 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3901 attachment_reference_stencil_layout->stencilLayout ==
3902 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3903 attachment_reference_stencil_layout->stencilLayout ==
3904 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3905 attachment_reference_stencil_layout->stencilLayout ==
3906 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3907 attachment_reference_stencil_layout->stencilLayout ==
3908 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3909 attachment_reference_stencil_layout->stencilLayout ==
3910 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3911 attachment_reference_stencil_layout->stencilLayout ==
3912 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3913 attachment_reference_stencil_layout->stencilLayout ==
3914 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3915 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
3916 skip |=
3917 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003918 0, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003919 "In the attachment reference %u in subpass %u with pNext chain instance "
3920 "VkAttachmentReferenceStencilLayoutKHR"
3921 "the stencilLayout member but must not be "
3922 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3923 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3924 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3925 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3926 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3927 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3928 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3929 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3930 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3931 j, i);
3932 }
3933 } else {
3934 skip |=
3935 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003936 "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003937 "When the layout for color attachment reference %u in subpass %u is "
3938 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3939 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3940 "VkAttachmentReferenceStencilLayout instance.",
3941 j, i);
3942 }
3943 }
3944 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3945 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3946 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
3947 skip |= log_msg(
3948 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003949 "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003950 "When the aspectMask for color attachment reference %u in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3951 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3952 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3953 j, i);
3954 }
3955 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3956 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3957 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3958 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003959 "VUID-VkAttachmentReference2-attachment-03317",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003960 "When the aspectMask for color attachment reference %u in subpass %u is "
3961 "VK_IMAGE_ASPECT_STENCIL_BIT "
3962 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3963 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
3964 j, i);
3965 }
3966 }
3967 break;
3968
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003969 default:
3970 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Dave Houlton51653902018-06-22 17:32:13 -06003971 kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003972 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3973 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003974 }
3975
John Zulauf4eee2692019-02-09 16:14:25 -07003976 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].attachment != VK_ATTACHMENT_UNUSED) &&
3977 (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
3978 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08003979 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Tobias Hectorbbb12282018-10-22 15:17:59 +01003980 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
John Zulauf4eee2692019-02-09 16:14:25 -07003981 "Layout for resolve attachment reference %u in subpass %u is %s but should be "
Tobias Hectorbbb12282018-10-22 15:17:59 +01003982 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
John Zulauff0f8c2b2019-02-14 12:13:44 -07003983 j, i, string_VkImageLayout(subpass.pResolveAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003984 }
3985
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003986 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003987 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
3988 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003989 }
3990 attach_first_use[attach_index] = false;
3991 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003992
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003993 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3994 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003995 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3996 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3997 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003998 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003999
Dave Houltona9df0ce2018-02-07 10:51:23 -07004000 case VK_IMAGE_LAYOUT_GENERAL:
4001 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
4002 // doing a bunch of transitions.
4003 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06004004 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07004005 "GENERAL layout for depth attachment may not give optimal performance.");
4006 break;
4007
Tobias Hectorbbb12282018-10-22 15:17:59 +01004008 case VK_IMAGE_LAYOUT_UNDEFINED:
4009 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08004010 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Tobias Hectorbbb12282018-10-22 15:17:59 +01004011 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
4012 "Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
4013 "layout or GENERAL.",
4014 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
4015 break;
4016
Piers Daniell9af77cd2019-10-16 13:54:12 -06004017 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
4018 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
4019 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
4020 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07004021 if (!enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -06004022 skip |= log_msg(
4023 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08004024 "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06004025 "Layout for depth attachment reference in subpass %u is %s but must not be "
4026 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4027 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
4028 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
4029 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
4030 skip |= log_msg(
4031 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08004032 "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06004033 "Layout for depth attachment reference in subpass %u is %s but must not be "
4034 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4035 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
4036 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
4037 } else if ((subpass.pDepthStencilAttachment->aspectMask &
4038 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
4039 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
4040 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4041 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
4042 const auto *attachment_reference_stencil_layout =
4043 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pDepthStencilAttachment->pNext);
4044 if (attachment_reference_stencil_layout) {
4045 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
4046 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
4047 attachment_reference_stencil_layout->stencilLayout ==
4048 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
4049 attachment_reference_stencil_layout->stencilLayout ==
4050 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4051 attachment_reference_stencil_layout->stencilLayout ==
4052 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
4053 attachment_reference_stencil_layout->stencilLayout ==
4054 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
4055 attachment_reference_stencil_layout->stencilLayout ==
4056 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
4057 attachment_reference_stencil_layout->stencilLayout ==
4058 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
4059 attachment_reference_stencil_layout->stencilLayout ==
4060 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
4061 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
4062 skip |=
4063 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT,
Mike Schuchardt65847d92019-12-20 13:50:47 -08004064 0, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
Piers Daniell9af77cd2019-10-16 13:54:12 -06004065 "In the attachment reference in subpass %u with pNext chain instance "
4066 "VkAttachmentReferenceStencilLayoutKHR"
4067 "the stencilLayout member but must not be "
4068 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
4069 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
4070 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
4071 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4072 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
4073 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
4074 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
4075 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
4076 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
4077 i);
4078 }
4079 } else {
4080 skip |=
4081 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08004082 "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06004083 "When the layout for depth attachment reference in subpass %u is "
4084 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
4085 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
4086 "VkAttachmentReferenceStencilLayout instance.",
4087 i);
4088 }
4089 }
4090 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
4091 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
4092 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
4093 skip |= log_msg(
4094 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08004095 "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06004096 "When the aspectMask for depth attachment reference in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
4097 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
4098 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
4099 i);
4100 }
4101 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
4102 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4103 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
4104 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08004105 "VUID-VkAttachmentReference2-attachment-03317",
Piers Daniell9af77cd2019-10-16 13:54:12 -06004106 "When the aspectMask for depth attachment reference in subpass %u is "
4107 "VK_IMAGE_ASPECT_STENCIL_BIT "
4108 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
4109 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
4110 i);
4111 }
4112 }
4113 break;
4114
Dave Houltona9df0ce2018-02-07 10:51:23 -07004115 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
4116 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004117 if (device_extensions.vk_khr_maintenance2) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004118 break;
4119 } else {
4120 // Intentionally fall through to generic error message
4121 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06004122 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01004123
Dave Houltona9df0ce2018-02-07 10:51:23 -07004124 default:
4125 // No other layouts are acceptable
4126 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Dave Houlton51653902018-06-22 17:32:13 -06004127 kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07004128 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
4129 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
4130 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004131 }
4132
4133 auto attach_index = subpass.pDepthStencilAttachment->attachment;
4134 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004135 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
4136 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004137 }
4138 attach_first_use[attach_index] = false;
4139 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004140 }
4141 return skip;
4142}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07004143
Mark Lobodzinski96210742017-02-09 10:33:46 -07004144// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4145// is true, verify that (actual & desired) flags == desired
John Zulauf4fea6622019-04-01 11:38:18 -06004146bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const VulkanTypedHandle &typed_handle,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004147 const char *msgCode, char const *func_name, char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004148 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004149 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004150 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004151 if (strict) {
4152 correct_usage = ((actual & desired) == desired);
4153 } else {
4154 correct_usage = ((actual & desired) != 0);
4155 }
4156 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06004157 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06004158 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
John Zulauf4fea6622019-04-01 11:38:18 -06004159 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[typed_handle.type],
4160 typed_handle.handle, kVUID_Core_MemTrack_InvalidUsageFlag,
locke-lunarg9edc2812019-06-17 23:18:52 -06004161 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4162 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004163 } else {
John Zulauf4fea6622019-04-01 11:38:18 -06004164 skip =
4165 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[typed_handle.type], typed_handle.handle,
locke-lunarg9edc2812019-06-17 23:18:52 -06004166 msgCode, "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4167 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004168 }
4169 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004170 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004171}
4172
4173// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4174// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004175bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004176 char const *func_name, char const *usage_string) const {
John Zulauf4fea6622019-04-01 11:38:18 -06004177 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict,
4178 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004179}
4180
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004181bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
John Zulauf07288512019-07-05 11:09:50 -06004182 char const *func_name, const char *linear_vuid, const char *optimal_vuid) const {
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004183 VkFormatProperties format_properties = GetPDFormatProperties(image_state->createInfo.format);
Cort Stratton186b1a22018-05-01 20:18:06 -04004184 bool skip = false;
4185 if (image_state->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
4186 if ((format_properties.linearTilingFeatures & desired) != desired) {
Lockee9aeebf2019-03-03 23:50:08 -07004187 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4188 HandleToUint64(image_state->image), linear_vuid,
locke-lunarg9edc2812019-06-17 23:18:52 -06004189 "In %s, invalid linearTilingFeatures (0x%08X) for format %u used by %s.", func_name,
Lockee9aeebf2019-03-03 23:50:08 -07004190 format_properties.linearTilingFeatures, image_state->createInfo.format,
4191 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04004192 }
4193 } else if (image_state->createInfo.tiling == VK_IMAGE_TILING_OPTIMAL) {
4194 if ((format_properties.optimalTilingFeatures & desired) != desired) {
4195 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4196 HandleToUint64(image_state->image), optimal_vuid,
locke-lunarg9edc2812019-06-17 23:18:52 -06004197 "In %s, invalid optimalTilingFeatures (0x%08X) for format %u used by %s.", func_name,
Cort Stratton186b1a22018-05-01 20:18:06 -04004198 format_properties.optimalTilingFeatures, image_state->createInfo.format,
Lockee9aeebf2019-03-03 23:50:08 -07004199 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04004200 }
4201 }
4202 return skip;
4203}
4204
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004205bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004206 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004207 bool skip = false;
Cort Strattond619a302018-05-17 19:46:32 -07004208 // layerCount must not be zero
4209 if (subresource_layers->layerCount == 0) {
4210 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
4211 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-layerCount-01700",
4212 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
4213 }
4214 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
4215 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
4216 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
4217 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00168",
4218 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
4219 }
4220 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
4221 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
4222 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
4223 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
4224 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00167",
4225 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4226 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4227 func_name, i, member);
4228 }
4229 return skip;
4230}
4231
Mark Lobodzinski96210742017-02-09 10:33:46 -07004232// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4233// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004234bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004235 char const *func_name, char const *usage_string) const {
John Zulauf4fea6622019-04-01 11:38:18 -06004236 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict,
4237 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004238}
4239
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004240bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004241 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004242 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004243
4244 const VkDeviceSize &range = pCreateInfo->range;
4245 if (range != VK_WHOLE_SIZE) {
4246 // Range must be greater than 0
4247 if (range <= 0) {
4248 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4249 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00928",
4250 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4251 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4252 range);
4253 }
4254 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004255 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4256 if (SafeModulo(range, format_size) != 0) {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004257 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4258 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00929",
4259 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4260 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
Petr Kraus5a01b472019-08-10 01:40:28 +02004261 "(%" PRIu32 ").",
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004262 range, format_size);
4263 }
4264 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004265 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
4266 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4267 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00930",
4268 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4269 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4270 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4271 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004272 }
4273 // The sum of range and offset must be less than or equal to the size of buffer
4274 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
4275 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4276 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00931",
4277 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4278 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4279 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4280 range, pCreateInfo->offset, buffer_state->createInfo.size);
4281 }
4282 }
4283 return skip;
4284}
4285
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004286bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004287 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004288 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004289 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4290 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
4291 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4292 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00933",
4293 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
4294 "be supported for uniform texel buffers");
4295 }
4296 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4297 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
4298 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4299 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00934",
4300 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
4301 "be supported for storage texel buffers");
4302 }
4303 return skip;
4304}
4305
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004306bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004307 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004308 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004309
Dave Houltond8ed0212018-05-16 17:18:24 -06004310 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004311
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004312 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!enabled_features.core.sparseBinding)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004313 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Dave Houltond8ed0212018-05-16 17:18:24 -06004314 "VUID-VkBufferCreateInfo-flags-00915",
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004315 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004316 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004317 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06004318
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004319 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!enabled_features.core.sparseResidencyBuffer)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004320 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Dave Houltond8ed0212018-05-16 17:18:24 -06004321 "VUID-VkBufferCreateInfo-flags-00916",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004322 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004323 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06004324 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06004325
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004326 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004327 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Dave Houltond8ed0212018-05-16 17:18:24 -06004328 "VUID-VkBufferCreateInfo-flags-00917",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004329 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004330 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06004331 }
Jeff Bolz87697532019-01-11 22:54:00 -06004332
4333 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
4334 if (chained_devaddr_struct) {
4335 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
4336 chained_devaddr_struct->deviceAddress != 0) {
4337 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
4338 "VUID-VkBufferCreateInfo-deviceAddress-02604",
4339 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
4340 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
4341 }
4342 }
4343
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004344 auto chained_opaqueaddr_struct = lvl_find_in_chain<VkBufferOpaqueCaptureAddressCreateInfoKHR>(pCreateInfo->pNext);
4345 if (chained_opaqueaddr_struct) {
4346 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
4347 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
4348 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
4349 "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
4350 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfoKHR::opaqueCaptureAddress"
4351 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR.");
4352 }
4353 }
4354
Shannon McPherson4984e642019-12-05 13:04:34 -07004355 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
Piers Daniell41b8c5d2020-01-10 15:42:00 -07004356 !enabled_features.core12.bufferDeviceAddressCaptureReplay) {
Jeff Bolz87697532019-01-11 22:54:00 -06004357 skip |= log_msg(
4358 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Shannon McPherson4984e642019-12-05 13:04:34 -07004359 "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004360 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
4361 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
4362 }
4363
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004364 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004365 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateBuffer",
4366 "pCreateInfo->pQueueFamilyIndices", "VUID-VkBufferCreateInfo-sharingMode-01419",
4367 "VUID-VkBufferCreateInfo-sharingMode-01419", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004368 }
4369
Mark Lobodzinski96210742017-02-09 10:33:46 -07004370 return skip;
4371}
4372
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004373bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004374 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004375 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004376 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004377 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4378 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004379 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004380 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4381 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004382 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004383 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4384 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4385 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004386
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004387 // Buffer view offset must be less than the size of buffer
4388 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
4389 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4390 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00925",
4391 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4392 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4393 pCreateInfo->offset, buffer_state->createInfo.size);
4394 }
4395
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004396 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004397 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4398 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4399 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
4400 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4401 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-02749",
4402 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4403 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4404 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
4405 }
4406
4407 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
4408 VkDeviceSize elementSize = FormatElementSize(pCreateInfo->format);
4409 if ((elementSize % 3) == 0) {
4410 elementSize /= 3;
4411 }
4412 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
4413 VkDeviceSize alignmentRequirement =
4414 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4415 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
4416 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4417 }
4418 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
4419 skip |= log_msg(
4420 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4421 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-02750",
4422 "If buffer was created with usage containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
4423 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4424 ") must be a multiple of the lesser of "
4425 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4426 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4427 "(%" PRId32
4428 ") is VK_TRUE, the size of a texel of the requested format. "
4429 "If the size of a texel is a multiple of three bytes, then the size of a "
4430 "single component of format is used instead",
4431 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4432 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4433 }
4434 }
4435 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
4436 VkDeviceSize alignmentRequirement =
4437 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4438 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
4439 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4440 }
4441 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
4442 skip |= log_msg(
4443 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4444 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-02751",
4445 "If buffer was created with usage containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
4446 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4447 ") must be a multiple of the lesser of "
4448 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4449 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4450 "(%" PRId32
4451 ") is VK_TRUE, the size of a texel of the requested format. "
4452 "If the size of a texel is a multiple of three bytes, then the size of a "
4453 "single component of format is used instead",
4454 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4455 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4456 }
4457 }
4458 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004459
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004460 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004461
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004462 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004463 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004464 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004465}
4466
Mark Lobodzinski602de982017-02-09 11:01:33 -07004467// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004468bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004469 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004470 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004471 VkDebugReportObjectTypeEXT objectType = VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT;
4472 if (image != VK_NULL_HANDLE) {
4473 objectType = VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT;
4474 }
4475
Dave Houlton1d2022c2017-03-29 11:43:58 -06004476 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004477 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004478 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004479 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004480 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004481 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004482 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004483 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004484 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004485 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004486 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07004487 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004488 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4489 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004490 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004491 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski602de982017-02-09 11:01:33 -07004492 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004493 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4494 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004495 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004496 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004497 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004498 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004499 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004500 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004501 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004502 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004503 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004504 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004505 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004506 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004507 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004508 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004509 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004510 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004511 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004512 } else if (FormatIsMultiplane(format)) {
4513 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4514 if (3 == FormatPlaneCount(format)) {
4515 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4516 }
4517 if ((aspect_mask & valid_flags) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004518 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houlton501b15b2018-03-30 15:07:41 -06004519 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4520 "set, where n = [0, 1, 2].",
4521 func_name);
4522 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004523 }
4524 return skip;
4525}
4526
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004527bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4528 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
4529 const char *param_name, const char *image_layer_count_var_name,
John Zulauf07288512019-07-05 11:09:50 -06004530 const uint64_t image_handle, SubresourceRangeErrorCodes errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004531 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004532
4533 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004534 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004535 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
Mark Lobodzinski88529492018-04-01 10:38:15 -06004536 errorCodes.base_mip_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004537 "%s: %s.baseMipLevel (= %" PRIu32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004538 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4539 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004540 }
Petr Kraus4d718682017-05-18 03:38:41 +02004541
Petr Krausffa94af2017-08-08 21:46:02 +02004542 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4543 if (subresourceRange.levelCount == 0) {
4544 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
Mark Lobodzinski88529492018-04-01 10:38:15 -06004545 errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004546 } else {
4547 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004548
Petr Krausffa94af2017-08-08 21:46:02 +02004549 if (necessary_mip_count > image_mip_count) {
4550 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
Mark Lobodzinski88529492018-04-01 10:38:15 -06004551 errorCodes.mip_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004552 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004553 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004554 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004555 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004556 }
Petr Kraus4d718682017-05-18 03:38:41 +02004557 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004558 }
Petr Kraus4d718682017-05-18 03:38:41 +02004559
4560 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004561 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004562 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
Mark Lobodzinski88529492018-04-01 10:38:15 -06004563 errorCodes.base_layer_err,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004564 "%s: %s.baseArrayLayer (= %" PRIu32
4565 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4566 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004567 }
Petr Kraus4d718682017-05-18 03:38:41 +02004568
Petr Krausffa94af2017-08-08 21:46:02 +02004569 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4570 if (subresourceRange.layerCount == 0) {
4571 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
Mark Lobodzinski88529492018-04-01 10:38:15 -06004572 errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004573 } else {
4574 const uint64_t necessary_layer_count =
4575 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004576
Petr Krausffa94af2017-08-08 21:46:02 +02004577 if (necessary_layer_count > image_layer_count) {
4578 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
Mark Lobodzinski88529492018-04-01 10:38:15 -06004579 errorCodes.layer_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004580 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004581 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004582 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004583 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004584 }
Petr Kraus4d718682017-05-18 03:38:41 +02004585 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004586 }
Petr Kraus4d718682017-05-18 03:38:41 +02004587
Mark Lobodzinski602de982017-02-09 11:01:33 -07004588 return skip;
4589}
4590
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004591bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004592 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004593 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004594 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4595 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4596 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4597
4598 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4599 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4600
4601 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004602 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4603 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
Shannon McPherson5a0de262019-06-05 10:43:56 -06004604 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-02724"
Dave Houltond8ed0212018-05-16 17:18:24 -06004605 : "VUID-VkImageViewCreateInfo-image-01482")
4606 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4607 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
Shannon McPherson5a0de262019-06-05 10:43:56 -06004608 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
Dave Houltond8ed0212018-05-16 17:18:24 -06004609 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4610 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004611
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004612 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004613 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
4614 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4615}
4616
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004617bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004618 const VkImageSubresourceRange &subresourceRange,
4619 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004620 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004621 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4622 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4623 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4624 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004625
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004626 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4627 "vkCmdClearColorImage", param_name, "arrayLayers", HandleToUint64(image_state->image),
4628 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004629}
4630
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004631bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004632 const VkImageSubresourceRange &subresourceRange,
4633 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004634 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004635 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4636 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4637 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4638 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004639
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004640 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4641 "vkCmdClearDepthStencilImage", param_name, "arrayLayers",
Petr Krausffa94af2017-08-08 21:46:02 +02004642 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4643}
4644
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004645bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004646 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
John Zulaufa4472282019-08-22 14:44:34 -06004647 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004648 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004649 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4650 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4651 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4652 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004653
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004654 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4655 cmd_name, param_name, "arrayLayers", HandleToUint64(image_state->image),
Petr Krausffa94af2017-08-08 21:46:02 +02004656 subresourceRangeErrorCodes);
4657}
4658
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004659bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004660 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004661 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004662 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004663 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004664 skip |=
4665 ValidateImageUsageFlags(image_state,
4666 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
4667 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4668 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV | VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
4669 false, kVUIDUndefined, "vkCreateImageView()",
4670 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
4671 "SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004672 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004673 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004674 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004675 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004676 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004677 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004678
4679 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4680 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004681 VkImageUsageFlags image_usage = image_state->createInfo.usage;
4682 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004683 VkFormat view_format = pCreateInfo->format;
4684 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004685 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004686 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004687
Dave Houltonbd2e2622018-04-10 16:41:14 -06004688 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004689 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004690 if (chained_ivuci_struct) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05004691 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance2) {
4692 if (!device_extensions.vk_ext_separate_stencil_usage) {
4693 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
4694 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4695 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-pNext-02661",
4696 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
4697 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
4698 }
4699 } else {
4700 const auto image_stencil_struct =
4701 lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
4702 if (image_stencil_struct == nullptr) {
4703 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
4704 skip |= log_msg(
4705 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT,
4706 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-pNext-02662",
4707 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
4708 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
4709 "any bits that were not set in VkImageCreateInfo::usage used to create image");
4710 }
4711 } else {
4712 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
4713 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
4714 image_stencil_struct->stencilUsage) {
4715 skip |= log_msg(
4716 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT,
4717 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-pNext-02663",
4718 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4719 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4720 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
4721 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
4722 }
4723 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
4724 (image_usage | chained_ivuci_struct->usage) != image_usage) {
4725 skip |= log_msg(
4726 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT,
4727 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-pNext-02664",
4728 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4729 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4730 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
4731 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
4732 }
4733 }
4734 }
4735 }
4736
Dave Houltonbd2e2622018-04-10 16:41:14 -06004737 image_usage = chained_ivuci_struct->usage;
4738 }
4739
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004740 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4741 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004742 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01004743 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06004744 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01004745 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06004746 std::stringstream ss;
4747 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01004748 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06004749 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Young9d1ac312018-05-21 16:28:27 -06004750 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004751 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01586", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004752 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004753 }
4754 } else {
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004755 if ((!device_extensions.vk_khr_maintenance2 ||
Dave Houltonc7988072018-04-16 11:46:56 -06004756 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
4757 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4758 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
4759 std::stringstream ss;
4760 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06004761 << " is not in the same format compatibility class as "
4762 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004763 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4764 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
Mark Young9d1ac312018-05-21 16:28:27 -06004765 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004766 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01018", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004767 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004768 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004769 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004770 }
4771 } else {
4772 // Format MUST be IDENTICAL to the format the image was created with
4773 if (image_format != view_format) {
4774 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06004775 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07004776 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004777 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Young9d1ac312018-05-21 16:28:27 -06004778 skip |=
4779 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004780 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01019", "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004781 }
4782 }
4783
4784 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004785 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004786
4787 switch (image_type) {
4788 case VK_IMAGE_TYPE_1D:
4789 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004790 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004791 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004792 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4793 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004794 }
4795 break;
4796 case VK_IMAGE_TYPE_2D:
4797 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4798 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4799 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Young9d1ac312018-05-21 16:28:27 -06004800 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004801 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01003",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004802 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4803 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004804 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004805 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004806 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004807 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4808 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004809 }
4810 }
4811 break;
4812 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004813 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06004814 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4815 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4816 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004817 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004818 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004819 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01005",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004820 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4821 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004822 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4823 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004824 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004825 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004826 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004827 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4828 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004829 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4830 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004831 }
4832 } else {
Mark Young9d1ac312018-05-21 16:28:27 -06004833 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004834 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004835 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4836 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004837 }
4838 }
4839 } else {
4840 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Young9d1ac312018-05-21 16:28:27 -06004841 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004842 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004843 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4844 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004845 }
4846 }
4847 break;
4848 default:
4849 break;
4850 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004851
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004852 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004853 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07004854 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004855 }
4856
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004857 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004858 VkFormatFeatureFlags tiling_features = (image_tiling & VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4859 : format_properties.optimalTilingFeatures;
4860
4861 if (tiling_features == 0) {
4862 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004863 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-None-02273",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004864 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4865 "physical device.",
4866 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4867 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4868 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004869 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02274",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004870 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4871 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4872 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4873 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4874 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004875 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02275",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004876 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4877 "VK_IMAGE_USAGE_STORAGE_BIT.",
4878 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4879 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
4880 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4881 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004882 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02276",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004883 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4884 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4885 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4886 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4887 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4888 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004889 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02277",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004890 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4891 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4892 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004893 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004894
Jeff Bolz9af91c52018-09-01 21:53:57 -05004895 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4896 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4897 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004898 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02086",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004899 "vkCreateImageView() If image was created with usage containing "
4900 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4901 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
4902 }
4903 if (view_format != VK_FORMAT_R8_UINT) {
4904 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004905 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02087",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004906 "vkCreateImageView() If image was created with usage containing "
4907 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
4908 }
4909 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004910 }
4911 return skip;
4912}
4913
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004914static inline bool ValidateCmdCopyBufferBounds(const debug_report_data *report_data, const BUFFER_STATE *src_buffer_state,
4915 const BUFFER_STATE *dst_buffer_state, uint32_t regionCount,
4916 const VkBufferCopy *pRegions) {
4917 bool skip = false;
4918
4919 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
4920 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
4921 VkDeviceSize src_min = UINT64_MAX;
4922 VkDeviceSize src_max = 0;
4923 VkDeviceSize dst_min = UINT64_MAX;
4924 VkDeviceSize dst_max = 0;
4925
4926 for (uint32_t i = 0; i < regionCount; i++) {
4927 src_min = std::min(src_min, pRegions[i].srcOffset);
4928 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
4929 dst_min = std::min(dst_min, pRegions[i].dstOffset);
4930 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
4931
4932 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
4933 if (pRegions[i].srcOffset >= src_buffer_size) {
4934 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4935 HandleToUint64(src_buffer_state->buffer), "VUID-vkCmdCopyBuffer-srcOffset-00113",
4936 "vkCmdCopyBuffer(): pRegions[%d].srcOffset (%" PRIuLEAST64
4937 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
4938 i, pRegions[i].srcOffset, i, pRegions[i].size);
4939 }
4940
4941 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
4942 if (pRegions[i].dstOffset >= dst_buffer_size) {
4943 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4944 HandleToUint64(dst_buffer_state->buffer), "VUID-vkCmdCopyBuffer-dstOffset-00114",
4945 "vkCmdCopyBuffer(): pRegions[%d].dstOffset (%" PRIuLEAST64
4946 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
4947 i, pRegions[i].dstOffset, i, pRegions[i].size);
4948 }
4949
4950 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
4951 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
4952 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4953 HandleToUint64(src_buffer_state->buffer), "VUID-vkCmdCopyBuffer-size-00115",
4954 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
4955 ") is greater than the source buffer size (%" PRIuLEAST64
4956 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
4957 i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
4958 }
4959
4960 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
4961 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
4962 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4963 HandleToUint64(dst_buffer_state->buffer), "VUID-vkCmdCopyBuffer-size-00116",
4964 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
4965 ") is greater than the destination buffer size (%" PRIuLEAST64
4966 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
4967 i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
4968 }
4969 }
4970
4971 // The union of the source regions, and the union of the destination regions, must not overlap in memory
4972 if (src_buffer_state->buffer == dst_buffer_state->buffer) {
4973 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
4974 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4975 HandleToUint64(src_buffer_state->buffer), "VUID-vkCmdCopyBuffer-pRegions-00117",
4976 "vkCmdCopyBuffer(): Detected overlap between source and dest regions in memory.");
4977 }
4978 }
4979
4980 return skip;
4981}
4982
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004983bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004984 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06004985 const auto cb_node = GetCBState(commandBuffer);
4986 const auto src_buffer_state = GetBufferState(srcBuffer);
4987 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004988
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004989 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004990 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
4991 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004992 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004993 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004994 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
4995 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06004996 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004997 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
4998 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004999 skip |=
5000 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5001 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005002 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
5003 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005004 skip |= ValidateCmdCopyBufferBounds(report_data, src_buffer_state, dst_buffer_state, regionCount, pRegions);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005005 return skip;
5006}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07005007
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005008bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005009 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005010 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005011 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02005012 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT, HandleToUint64(buffer),
locke-lunarg9edc2812019-06-17 23:18:52 -06005013 kVUID_Core_DrawState_DoubleDestroy, "Cannot free %s that has not been allocated.",
Lockee9aeebf2019-03-03 23:50:08 -07005014 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005015 } else {
5016 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02005017 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005018 HandleToUint64(buffer), "VUID-vkDestroyBuffer-buffer-00922",
locke-lunarg9edc2812019-06-17 23:18:52 -06005019 "Cannot free %s that is in use by a command buffer.", report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005020 }
5021 }
5022 return skip;
5023}
5024
Jeff Bolz5c801d12019-10-09 10:38:45 -05005025bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
5026 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005027 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06005028 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005029
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005030 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005031 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005032 skip |=
5033 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005034 }
5035 return skip;
5036}
5037
Jeff Bolz5c801d12019-10-09 10:38:45 -05005038bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005039 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005040
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005041 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005042 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07005043 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005044 }
5045 return skip;
5046}
5047
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005048bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005049 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07005050 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06005051 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005052 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005053 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005054 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06005055 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005056 }
5057 return skip;
5058}
5059
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005060bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005061 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06005062 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005063 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005064 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005065 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07005066 skip |=
5067 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5068 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005069 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005070 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005071 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
5072 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005073 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005074
5075 if (dstOffset >= buffer_state->createInfo.size) {
5076 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
5077 HandleToUint64(dstBuffer), "VUID-vkCmdFillBuffer-dstOffset-00024",
5078 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
5079 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
5080 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
5081 }
5082
5083 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
5084 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
5085 HandleToUint64(dstBuffer), "VUID-vkCmdFillBuffer-size-00027",
5086 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
5087 ") minus dstOffset (0x%" PRIxLEAST64 ").",
5088 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
5089 }
5090
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005091 return skip;
5092}
5093
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005094bool CoreChecks::ValidateBufferImageCopyData(uint32_t regionCount, const VkBufferImageCopy *pRegions,
5095 const IMAGE_STATE *image_state, const char *function) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005096 bool skip = false;
5097
5098 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005099 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
5100 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005101 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005102 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00199",
Dave Houltona9df0ce2018-02-07 10:51:23 -07005103 "%s(): pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005104 "and 1, respectively.",
5105 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005106 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005107 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005108
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005109 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
5110 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005111 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005112 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00201",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005113 "%s(): pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. For 1D and 2D images these "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005114 "must be 0 and 1, respectively.",
5115 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005116 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005117 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005118
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005119 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
5120 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06005121 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005122 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-baseArrayLayer-00213",
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06005123 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
5124 "For 3D images these must be 0 and 1, respectively.",
5125 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005126 }
5127 }
5128
5129 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07005130 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
Locke497739c2019-03-08 11:50:47 -07005131 uint32_t element_size = FormatElementSize(image_state->createInfo.format, pRegions[i].imageSubresource.aspectMask);
5132
Dave Houltona585d132019-01-18 13:05:42 -07005133 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005134 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005135 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00193",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005136 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07005137 " must be a multiple of this format's texel size (%" PRIu32 ").",
5138 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005139 }
5140
5141 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06005142 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005143 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005144 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00194",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005145 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
5146 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005147 }
5148
5149 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
5150 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005151 skip |=
5152 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005153 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00195",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005154 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
5155 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005156 }
5157
5158 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
5159 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
5160 skip |= log_msg(
5161 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005162 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005163 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
5164 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005165 }
5166
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005167 // Calculate adjusted image extent, accounting for multiplane image factors
5168 VkExtent3D adusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
5169 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
5170 if ((pRegions[i].imageOffset.x < 0) || (pRegions[i].imageOffset.x > static_cast<int32_t>(adusted_image_extent.width)) ||
5171 ((pRegions[i].imageOffset.x + pRegions[i].imageExtent.width) > static_cast<int32_t>(adusted_image_extent.width))) {
5172 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5173 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00197",
5174 "%s(): Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
5175 "zero or <= image subresource width (%d).",
5176 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
5177 adusted_image_extent.width);
5178 }
5179
5180 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
5181 if ((pRegions[i].imageOffset.y < 0) || (pRegions[i].imageOffset.y > static_cast<int32_t>(adusted_image_extent.height)) ||
5182 ((pRegions[i].imageOffset.y + pRegions[i].imageExtent.height) > static_cast<int32_t>(adusted_image_extent.height))) {
5183 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5184 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00198",
5185 "%s(): Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
5186 "zero or <= image subresource height (%d).",
5187 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
5188 adusted_image_extent.height);
5189 }
5190
5191 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
5192 if ((pRegions[i].imageOffset.z < 0) || (pRegions[i].imageOffset.z > static_cast<int32_t>(adusted_image_extent.depth)) ||
5193 ((pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth) > static_cast<int32_t>(adusted_image_extent.depth))) {
5194 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5195 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00200",
5196 "%s(): Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
5197 "zero or <= image subresource depth (%d).",
5198 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
5199 adusted_image_extent.depth);
5200 }
5201
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005202 // subresource aspectMask must have exactly 1 bit set
5203 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
5204 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
5205 if (aspect_mask_bits.count() != 1) {
5206 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005207 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00212",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005208 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005209 }
5210
5211 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06005212 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005213 skip |= log_msg(
5214 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005215 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005216 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
5217 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005218 }
5219
5220 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04005221 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005222 auto block_size = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005223
5224 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06005225 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005226 skip |= log_msg(
5227 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005228 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00203",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005229 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
5230 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005231 }
5232
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005233 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005234 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07005235 skip |= log_msg(
5236 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005237 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00204",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005238 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
5239 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005240 }
5241
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005242 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06005243 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
5244 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
5245 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005246 skip |=
5247 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005248 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00205",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005249 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
5250 "width & height (%d, %d)..",
5251 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005252 }
5253
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005254 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houltona585d132019-01-18 13:05:42 -07005255 uint32_t block_size_in_bytes = FormatElementSize(image_state->createInfo.format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06005256 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005257 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005258 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00206",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005259 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07005260 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005261 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005262 }
Dave Houlton67e9b532017-03-02 17:00:10 -07005263
5264 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07005265 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06005266 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005267 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
5268 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005269 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00207",
Dave Houlton75967fc2017-03-06 17:21:16 -07005270 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005271 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07005272 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005273 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07005274 }
5275
5276 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005277 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005278 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
5279 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005280 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00208",
Dave Houlton75967fc2017-03-06 17:21:16 -07005281 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005282 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07005283 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005284 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07005285 }
5286
5287 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06005288 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005289 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
5290 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005291 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00209",
Dave Houlton75967fc2017-03-06 17:21:16 -07005292 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005293 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07005294 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005295 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07005296 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005297 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005298
5299 // Checks that apply only to multi-planar format images
5300 if (FormatIsMultiplane(image_state->createInfo.format)) {
5301 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
5302 if ((FormatPlaneCount(image_state->createInfo.format) < 3) &&
5303 (pRegions[i].imageSubresource.aspectMask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
5304 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5305 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-01560",
5306 "%s(): pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
5307 "format has three planes.",
5308 function, i);
5309 }
5310
5311 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
5312 if (0 == (pRegions[i].imageSubresource.aspectMask &
5313 (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT))) {
5314 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5315 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-01560",
5316 "%s(): pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
5317 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
5318 function, i);
5319 }
5320 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005321 }
5322
5323 return skip;
5324}
5325
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005326static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06005327 const VkBufferImageCopy *pRegions, const char *func_name, const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005328 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005329 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005330
5331 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005332 VkExtent3D extent = pRegions[i].imageExtent;
5333 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005334
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005335 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
5336 {
Dave Houlton51653902018-06-22 17:32:13 -06005337 skip |=
5338 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
5339 kVUID_Core_Image_ZeroAreaSubregion, "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area",
5340 func_name, i, extent.width, extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005341 }
5342
5343 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
5344
5345 // 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 -06005346 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005347 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005348 if (image_extent.width % block_extent.width) {
5349 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
5350 }
5351 if (image_extent.height % block_extent.height) {
5352 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
5353 }
5354 if (image_extent.depth % block_extent.depth) {
5355 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
5356 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005357 }
5358
Dave Houltonfc1a4052017-04-27 14:32:45 -06005359 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005360 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
Mark Lobodzinski88529492018-04-01 10:38:15 -06005361 msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005362 }
5363 }
5364
5365 return skip;
5366}
5367
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005368static inline bool ValidateBufferBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state,
5369 const BUFFER_STATE *buff_state, uint32_t regionCount, const VkBufferImageCopy *pRegions,
5370 const char *func_name, const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005371 bool skip = false;
5372
5373 VkDeviceSize buffer_size = buff_state->createInfo.size;
5374
5375 for (uint32_t i = 0; i < regionCount; i++) {
5376 VkExtent3D copy_extent = pRegions[i].imageExtent;
5377
5378 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
5379 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Locke497739c2019-03-08 11:50:47 -07005380 VkDeviceSize unit_size = FormatElementSize(image_state->createInfo.format,
5381 pRegions[i].imageSubresource.aspectMask); // size (bytes) of texel or block
Dave Houltonf3229d52017-02-21 15:59:08 -07005382
Tom Cooperb2550c72018-10-15 13:08:41 +01005383 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005384 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houltona585d132019-01-18 13:05:42 -07005385 auto block_dim = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005386 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
5387 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
5388
5389 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
5390 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
5391 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005392 }
5393
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005394 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
5395 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
5396 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07005397 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005398 } else {
5399 // Calculate buffer offset of final copied byte, + 1.
5400 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
5401 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
5402 max_buffer_offset *= unit_size; // convert to bytes
5403 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005404
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005405 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06005406 skip |=
5407 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
5408 msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i, buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005409 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005410 }
5411 }
5412
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005413 return skip;
5414}
5415
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005416bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005417 VkBuffer dstBuffer, uint32_t regionCount,
5418 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005419 const auto cb_node = GetCBState(commandBuffer);
5420 const auto src_image_state = GetImageState(srcImage);
5421 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005422
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005423 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005424
5425 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005426 skip |= ValidateCmd(cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005427
5428 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005429 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005430
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005431 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07005432
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005433 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
5434 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005435 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005436 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005437 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005438 }
Dave Houlton0ef27492018-04-04 11:41:48 -06005439 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005440 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Chris Forbese8ba09a2017-06-01 17:39:02 -07005441 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005442 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005443
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005444 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005445 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005446 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
5447 skip |=
5448 ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005449
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005450 // Validate that SRC image & DST buffer have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005451 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005452 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
5453 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005454 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005455 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
5456 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06005457 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005458 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImageToBuffer()",
5459 "VUID-vkCmdCopyImageToBuffer-srcImage-01998",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005460 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04005461 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005462 skip |= InsideRenderPass(cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005463 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005464 const char *src_invalid_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5465 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
5466 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005467 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005468 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
Cort Strattond619a302018-05-17 19:46:32 -07005469 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005470 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005471 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
5472 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005473 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5474 cb_node, src_image_state, &pRegions[i], i, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
5475 skip |=
5476 ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyImageToBuffer()",
5477 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
5478 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005479 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
5480 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005481 }
5482 return skip;
5483}
5484
John Zulauf1686f232019-07-09 16:27:11 -06005485void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5486 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
5487 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
5488
5489 auto cb_node = GetCBState(commandBuffer);
5490 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06005491 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005492 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005493 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005494 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005495}
5496
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005497bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5498 VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005499 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005500 const auto cb_node = GetCBState(commandBuffer);
5501 const auto src_buffer_state = GetBufferState(srcBuffer);
5502 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005503
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005504 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005505
5506 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005507 skip |= ValidateCmd(cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005508
5509 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005510 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005511 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005512 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
5513 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005514 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005515 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005516 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005517 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005518 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005519 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Chris Forbese8ba09a2017-06-01 17:39:02 -07005520 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005521 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005522 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005523 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005524 skip |=
5525 ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
5526 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005527 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005528 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
5529 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005530 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005531 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
5532 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06005533 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005534 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyBufferToImage()",
5535 "VUID-vkCmdCopyBufferToImage-dstImage-01997",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005536 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04005537 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005538 skip |= InsideRenderPass(cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005539 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005540 const char *dst_invalid_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5541 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
5542 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005543 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005544 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
Cort Strattond619a302018-05-17 19:46:32 -07005545 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005546 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005547 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
5548 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005549 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5550 cb_node, dst_image_state, &pRegions[i], i, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
5551 skip |=
5552 ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyBufferToImage()",
5553 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
5554 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005555 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
5556 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005557 }
5558 return skip;
5559}
5560
John Zulauf1686f232019-07-09 16:27:11 -06005561void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5562 VkImageLayout dstImageLayout, uint32_t regionCount,
5563 const VkBufferImageCopy *pRegions) {
5564 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
5565
5566 auto cb_node = GetCBState(commandBuffer);
5567 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06005568 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005569 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005570 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005571 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005572}
Mike Weiblen672b58b2017-02-21 14:32:53 -07005573
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005574bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005575 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005576 bool skip = false;
5577 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
5578
Dave Houlton1d960ff2018-01-19 12:17:05 -07005579 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07005580 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
5581 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
5582 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02005583 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
Dave Houltond8ed0212018-05-16 17:18:24 -06005584 "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005585 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005586 }
5587
John Zulaufa26d3c82019-08-14 16:09:08 -06005588 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005589 if (!image_entry) {
5590 return skip;
5591 }
5592
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005593 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
5594 if (device_extensions.vk_ext_image_drm_format_modifier) {
5595 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
5596 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
5597 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5598 HandleToUint64(image), "VUID-vkGetImageSubresourceLayout-image-02270",
5599 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
5600 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
5601 }
5602 } else {
5603 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
5604 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5605 HandleToUint64(image), "VUID-vkGetImageSubresourceLayout-image-00996",
5606 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
5607 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07005608 }
5609
Dave Houlton1d960ff2018-01-19 12:17:05 -07005610 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005611 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005612 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5613 "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
5614 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
5615 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005616 }
5617
Dave Houlton1d960ff2018-01-19 12:17:05 -07005618 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005619 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005620 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5621 "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
5622 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
5623 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005624 }
5625
Dave Houlton1d960ff2018-01-19 12:17:05 -07005626 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07005627 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005628 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
5629 if (FormatIsMultiplane(img_format)) {
5630 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
5631 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
5632 if (FormatPlaneCount(img_format) > 2u) {
5633 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
5634 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
5635 }
5636 if (sub_aspect != (sub_aspect & allowed_flags)) {
5637 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5638 HandleToUint64(image), vuid,
5639 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
5640 ") must be a single-plane specifier flag.",
5641 sub_aspect);
5642 }
5643 } else if (FormatIsColor(img_format)) {
5644 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
5645 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5646 HandleToUint64(image), kVUID_Core_DrawState_InvalidImageAspect,
5647 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
5648 "VK_IMAGE_ASPECT_COLOR.");
5649 }
5650 } else if (FormatIsDepthOrStencil(img_format)) {
5651 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
5652 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07005653 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005654 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5655 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
5656 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
5657 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Dave Houlton1d960ff2018-01-19 12:17:05 -07005658 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005659 HandleToUint64(image), "VUID-vkGetImageSubresourceLayout-tiling-02271",
5660 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
5661 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005662 }
5663 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005664
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005665 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005666 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005667 }
5668
Mike Weiblen672b58b2017-02-21 14:32:53 -07005669 return skip;
5670}