blob: 4e16e8e63714b274d651318933bb8967752ca231 [file] [log] [blame]
Jeff Bolz87697532019-01-11 22:54:00 -06001/* Copyright (c) 2015-2019 The Khronos Group Inc.
2 * Copyright (c) 2015-2019 Valve Corporation
3 * Copyright (c) 2015-2019 LunarG, Inc.
4 * Copyright (C) 2015-2019 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
23// Allow use of STL min and max functions in Windows
24#define NOMINMAX
25
Dave Houlton0d4ad6f2018-09-05 14:53:34 -060026#include <cmath>
27#include <set>
Mark Lobodzinski90224de2017-01-26 15:23:11 -070028#include <sstream>
Petr Kraus4d718682017-05-18 03:38:41 +020029#include <string>
Mark Lobodzinski90224de2017-01-26 15:23:11 -070030
31#include "vk_enum_string_helper.h"
Petr Kraus5a01b472019-08-10 01:40:28 +020032#include "vk_format_utils.h"
Mark Lobodzinski90224de2017-01-26 15:23:11 -070033#include "vk_layer_data.h"
34#include "vk_layer_utils.h"
35#include "vk_layer_logging.h"
Dave Houltonbd2e2622018-04-10 16:41:14 -060036#include "vk_typemap_helper.h"
Mark Lobodzinski90224de2017-01-26 15:23:11 -070037
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -070038#include "chassis.h"
Mark Lobodzinski76d76662019-02-14 14:38:21 -070039#include "core_validation.h"
40#include "shader_validation.h"
41#include "descriptor_sets.h"
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070042#include "buffer_validation.h"
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -070043
John Zulauff660ad62019-03-23 07:16:05 -060044// Transfer VkImageSubresourceLayers into VkImageSubresourceRange struct
45static VkImageSubresourceRange RangeFromLayers(const VkImageSubresourceLayers &subresource_layers) {
46 VkImageSubresourceRange subresource_range;
47 subresource_range.aspectMask = subresource_layers.aspectMask;
48 subresource_range.baseArrayLayer = subresource_layers.baseArrayLayer;
49 subresource_range.layerCount = subresource_layers.layerCount;
50 subresource_range.baseMipLevel = subresource_layers.mipLevel;
51 subresource_range.levelCount = 1;
52 return subresource_range;
53}
54
55IMAGE_STATE::IMAGE_STATE(VkImage img, const VkImageCreateInfo *pCreateInfo)
56 : image(img),
57 createInfo(*pCreateInfo),
58 valid(false),
59 acquired(false),
60 shared_presentable(false),
61 layout_locked(false),
62 get_sparse_reqs_called(false),
63 sparse_metadata_required(false),
64 sparse_metadata_bound(false),
65 imported_ahb(false),
66 has_ahb_format(false),
67 ahb_format(0),
68 full_range{},
unknown09edc722019-06-21 15:49:38 -060069 create_from_swapchain(VK_NULL_HANDLE),
70 bind_swapchain(VK_NULL_HANDLE),
unknown08c57af2019-06-21 16:33:35 -060071 bind_swapchain_imageIndex(0),
72 sparse_requirements{} {
John Zulauff660ad62019-03-23 07:16:05 -060073 if ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) && (createInfo.queueFamilyIndexCount > 0)) {
74 uint32_t *pQueueFamilyIndices = new uint32_t[createInfo.queueFamilyIndexCount];
75 for (uint32_t i = 0; i < createInfo.queueFamilyIndexCount; i++) {
76 pQueueFamilyIndices[i] = pCreateInfo->pQueueFamilyIndices[i];
77 }
78 createInfo.pQueueFamilyIndices = pQueueFamilyIndices;
79 }
80
81 if (createInfo.flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) {
82 sparse = true;
83 }
84 const auto format = createInfo.format;
85 VkImageSubresourceRange init_range{0, 0, VK_REMAINING_MIP_LEVELS, 0, VK_REMAINING_ARRAY_LAYERS};
86 if (FormatIsColor(format) || FormatIsMultiplane(format)) {
87 init_range.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT; // Normalization will expand this for multiplane
88 } else {
89 init_range.aspectMask =
90 (FormatHasDepth(format) ? VK_IMAGE_ASPECT_DEPTH_BIT : 0) | (FormatHasStencil(format) ? VK_IMAGE_ASPECT_STENCIL_BIT : 0);
91 }
92 full_range = NormalizeSubresourceRange(*this, init_range);
Locked8af3732019-05-10 09:47:56 -060093
94#ifdef VK_USE_PLATFORM_ANDROID_KHR
95 auto external_format = lvl_find_in_chain<VkExternalFormatANDROID>(createInfo.pNext);
96 if (external_format) {
97 external_format_android = external_format->externalFormat;
98 } else {
99 // If externalFormat is zero, the effect is as if the VkExternalFormatANDROID structure was not present.
100 external_format_android = 0;
101 }
102#endif // VK_USE_PLATFORM_ANDROID_KHR
John Zulauff660ad62019-03-23 07:16:05 -0600103}
104
105IMAGE_VIEW_STATE::IMAGE_VIEW_STATE(const IMAGE_STATE *image_state, VkImageView iv, const VkImageViewCreateInfo *ci)
106 : image_view(iv), create_info(*ci), normalized_subresource_range(ci->subresourceRange), samplerConversion(VK_NULL_HANDLE) {
107 auto *conversionInfo = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info.pNext);
108 if (conversionInfo) samplerConversion = conversionInfo->conversion;
109 if (image_state) {
110 // A light normalization of the createInfo range
111 auto &sub_res_range = create_info.subresourceRange;
112 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
113 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
114
115 // Cache a full normalization (for "full image/whole image" comparisons)
116 normalized_subresource_range = NormalizeSubresourceRange(*image_state, ci->subresourceRange);
Jeff Bolz6cede832019-08-09 23:30:39 -0500117 samples = image_state->createInfo.samples;
118 descriptor_format_bits = DescriptorRequirementsBitsFromFormat(create_info.format);
John Zulauff660ad62019-03-23 07:16:05 -0600119 }
120}
121
Dave Houltond9611312018-11-19 17:03:36 -0700122uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
123 // uint cast applies floor()
124 return 1u + (uint32_t)log2(std::max({height, width, depth}));
125}
126
127uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
128
129uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
130
John Zulauff660ad62019-03-23 07:16:05 -0600131VkImageSubresourceRange NormalizeSubresourceRange(const IMAGE_STATE &image_state, const VkImageSubresourceRange &range) {
132 const VkImageCreateInfo &image_create_info = image_state.createInfo;
133 VkImageSubresourceRange norm = range;
134 norm.levelCount = ResolveRemainingLevels(&range, image_create_info.mipLevels);
135
136 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
137 // <arrayLayers> can potentially alias.
138 uint32_t layer_limit = (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR))
139 ? image_create_info.extent.depth
140 : image_create_info.arrayLayers;
141 norm.layerCount = ResolveRemainingLayers(&range, layer_limit);
142
143 // For multiplanar formats, IMAGE_ASPECT_COLOR is equivalent to adding the aspect of the individual planes
144 VkImageAspectFlags &aspect_mask = norm.aspectMask;
145 if (FormatIsMultiplane(image_create_info.format)) {
146 if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
147 aspect_mask &= ~VK_IMAGE_ASPECT_COLOR_BIT;
148 aspect_mask |= (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
149 if (FormatPlaneCount(image_create_info.format) > 2) {
150 aspect_mask |= VK_IMAGE_ASPECT_PLANE_2_BIT;
151 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700152 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700153 }
John Zulauff660ad62019-03-23 07:16:05 -0600154 return norm;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700155}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700156
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700157template <class OBJECT, class LAYOUT>
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700158void CoreChecks::SetLayout(OBJECT *pObject, VkImage image, VkImageSubresource range, const LAYOUT &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700159 ImageSubresourcePair imgpair = {image, true, range};
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700160 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
161 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
162 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
163 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600164 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700165 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
166 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
167 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700168 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700169}
170
171template <class OBJECT, class LAYOUT>
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700172void CoreChecks::SetLayout(OBJECT *pObject, ImageSubresourcePair imgpair, const LAYOUT &layout, VkImageAspectFlags aspectMask) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700173 if (imgpair.subresource.aspectMask & aspectMask) {
174 imgpair.subresource.aspectMask = aspectMask;
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700175 SetLayout(pObject, imgpair, layout);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700176 }
177}
178
Tony Barbourdf013b92017-01-25 12:53:48 -0700179// Set the layout in supplied map
John Zulauf3b04ebd2019-07-18 14:08:11 -0600180void CoreChecks::SetLayout(ImageSubresPairLayoutMap &imageLayoutMap, ImageSubresourcePair imgpair, VkImageLayout layout) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700181 auto it = imageLayoutMap.find(imgpair);
182 if (it != imageLayoutMap.end()) {
183 it->second.layout = layout; // Update
184 } else {
185 imageLayoutMap[imgpair].layout = layout; // Insert
186 }
Tony Barbourdf013b92017-01-25 12:53:48 -0700187}
188
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700189bool CoreChecks::FindLayoutVerifyLayout(ImageSubresourcePair imgpair, VkImageLayout &layout, const VkImageAspectFlags aspectMask) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700190 if (!(imgpair.subresource.aspectMask & aspectMask)) {
191 return false;
192 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700193 VkImageAspectFlags oldAspectMask = imgpair.subresource.aspectMask;
194 imgpair.subresource.aspectMask = aspectMask;
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600195 auto imgsubIt = imageLayoutMap.find(imgpair);
196 if (imgsubIt == imageLayoutMap.end()) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700197 return false;
198 }
199 if (layout != VK_IMAGE_LAYOUT_MAX_ENUM && layout != imgsubIt->second.layout) {
Petr Krausbc7f5442017-05-14 23:43:38 +0200200 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 -0600201 kVUID_Core_DrawState_InvalidLayout,
locke-lunarg9edc2812019-06-17 23:18:52 -0600202 "Cannot query for %s layout when combined aspect mask %d has multiple layout types: %s and %s",
Lockee9aeebf2019-03-03 23:50:08 -0700203 report_data->FormatHandle(imgpair.image).c_str(), oldAspectMask, string_VkImageLayout(layout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700204 string_VkImageLayout(imgsubIt->second.layout));
205 }
206 layout = imgsubIt->second.layout;
207 return true;
208}
209
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700210// Find layout(s) on the global level
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700211bool CoreChecks::FindGlobalLayout(ImageSubresourcePair imgpair, VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700212 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700213 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
214 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
215 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
216 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600217 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700218 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
219 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
220 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700221 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700222 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
223 imgpair = {imgpair.image, false, VkImageSubresource()};
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600224 auto imgsubIt = imageLayoutMap.find(imgpair);
225 if (imgsubIt == imageLayoutMap.end()) return false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700226 layout = imgsubIt->second.layout;
227 }
228 return true;
229}
230
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700231bool CoreChecks::FindLayouts(VkImage image, std::vector<VkImageLayout> &layouts) {
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -0600232 auto sub_data = imageSubresourceMap.find(image);
233 if (sub_data == imageSubresourceMap.end()) return false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700234 auto image_state = GetImageState(image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700235 if (!image_state) return false;
236 bool ignoreGlobal = false;
237 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
238 if (sub_data->second.size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
239 ignoreGlobal = true;
240 }
241 for (auto imgsubpair : sub_data->second) {
242 if (ignoreGlobal && !imgsubpair.hasSubresource) continue;
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600243 auto img_data = imageLayoutMap.find(imgsubpair);
244 if (img_data != imageLayoutMap.end()) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700245 layouts.push_back(img_data->second.layout);
246 }
247 }
248 return true;
249}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700250
John Zulauf3b04ebd2019-07-18 14:08:11 -0600251bool CoreChecks::FindLayout(const ImageSubresPairLayoutMap &imageLayoutMap, ImageSubresourcePair imgpair, VkImageLayout &layout,
252 const VkImageAspectFlags aspectMask) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700253 if (!(imgpair.subresource.aspectMask & aspectMask)) {
254 return false;
255 }
256 imgpair.subresource.aspectMask = aspectMask;
257 auto imgsubIt = imageLayoutMap.find(imgpair);
258 if (imgsubIt == imageLayoutMap.end()) {
259 return false;
260 }
261 layout = imgsubIt->second.layout;
262 return true;
Tony Barboure0c5cc92017-02-08 13:53:39 -0700263}
Tony Barbourdf013b92017-01-25 12:53:48 -0700264
265// find layout in supplied map
John Zulauf3b04ebd2019-07-18 14:08:11 -0600266bool CoreChecks::FindLayout(const ImageSubresPairLayoutMap &imageLayoutMap, ImageSubresourcePair imgpair,
267 VkImageLayout &layout) const {
Tony Barbourdf013b92017-01-25 12:53:48 -0700268 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
269 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
270 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
271 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
272 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600273 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700274 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
275 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
276 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
277 }
278 // Image+subresource not found, look for image handle w/o subresource
Tony Barbourdf013b92017-01-25 12:53:48 -0700279 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
280 imgpair = {imgpair.image, false, VkImageSubresource()};
281 auto imgsubIt = imageLayoutMap.find(imgpair);
282 if (imgsubIt == imageLayoutMap.end()) return false;
283 layout = imgsubIt->second.layout;
284 }
285 return true;
286}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700287
288// Set the layout on the global level
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700289void CoreChecks::SetGlobalLayout(ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700290 VkImage &image = imgpair.image;
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600291 auto data = imageLayoutMap.find(imgpair);
292 if (data != imageLayoutMap.end()) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700293 data->second.layout = layout; // Update
294 } else {
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600295 imageLayoutMap[imgpair].layout = layout; // Insert
Dave Houltonb3f4b282018-02-22 16:25:16 -0700296 }
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -0600297 auto &image_subresources = imageSubresourceMap[image];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700298 auto subresource = std::find(image_subresources.begin(), image_subresources.end(), imgpair);
299 if (subresource == image_subresources.end()) {
300 image_subresources.push_back(imgpair);
301 }
302}
303
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600304// Set image layout for given VkImageSubresourceRange struct
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600305void CoreChecks::SetImageLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600306 const VkImageSubresourceRange &image_subresource_range, VkImageLayout layout,
307 VkImageLayout expected_layout) {
308 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
309 assert(subresource_map); // the non-const getter must return a valid pointer
John Zulauf4ec24ec2019-05-02 17:22:59 -0600310 if (subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600311 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700312 }
313}
John Zulauff660ad62019-03-23 07:16:05 -0600314
315// Set the initial image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600316void CoreChecks::SetImageViewInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
Jeff Bolz3e333222019-08-10 23:00:38 -0500317 if (disabled.image_layout_validation) {
318 return;
319 }
John Zulauff660ad62019-03-23 07:16:05 -0600320 IMAGE_STATE *image_state = GetImageState(view_state.create_info.image);
321 if (image_state) {
322 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
John Zulauf4ec24ec2019-05-02 17:22:59 -0600323 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, view_state.normalized_subresource_range, layout, &view_state);
John Zulauff660ad62019-03-23 07:16:05 -0600324 }
325}
326
327// Set the initial image layout for a passed non-normalized subresource range
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600328void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600329 const VkImageSubresourceRange &range, VkImageLayout layout) {
330 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
331 assert(subresource_map);
John Zulauf4ec24ec2019-05-02 17:22:59 -0600332 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(image_state, range), layout);
John Zulauff660ad62019-03-23 07:16:05 -0600333}
334
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600335void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, VkImage image, const VkImageSubresourceRange &range,
John Zulauff660ad62019-03-23 07:16:05 -0600336 VkImageLayout layout) {
337 const IMAGE_STATE *image_state = GetImageState(image);
338 if (!image_state) return;
339 SetImageInitialLayout(cb_node, *image_state, range, layout);
340};
341
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600342void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600343 const VkImageSubresourceLayers &layers, VkImageLayout layout) {
344 SetImageInitialLayout(cb_node, image_state, RangeFromLayers(layers), layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600345}
Dave Houltonddd65c52018-05-08 14:58:01 -0600346
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600347// Set image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600348void CoreChecks::SetImageViewLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
John Zulauff660ad62019-03-23 07:16:05 -0600349 IMAGE_STATE *image_state = GetImageState(view_state.create_info.image);
350 if (!image_state) return; // TODO: track/report stale image references
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600351
John Zulauff660ad62019-03-23 07:16:05 -0600352 VkImageSubresourceRange sub_range = view_state.normalized_subresource_range;
Dave Houltonddd65c52018-05-08 14:58:01 -0600353 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
354 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
John Zulauff660ad62019-03-23 07:16:05 -0600355 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) && (view_state.create_info.viewType != VK_IMAGE_VIEW_TYPE_3D)) {
Dave Houltonddd65c52018-05-08 14:58:01 -0600356 sub_range.baseArrayLayer = 0;
357 sub_range.layerCount = image_state->createInfo.extent.depth;
358 }
359
John Zulauff660ad62019-03-23 07:16:05 -0600360 SetImageLayout(cb_node, *image_state, sub_range, layout);
John Zulauf4ccf5c02018-09-21 11:46:18 -0600361}
362
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700363bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
364 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700365 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600366 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100367 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700368 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100369 const char *vuid;
370 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
371
372 if (!image_state) {
373 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
374 "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
locke-lunarg9edc2812019-06-17 23:18:52 -0600375 "Render Pass begin with %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
Lockee9aeebf2019-03-03 23:50:08 -0700376 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
377 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100378 return skip;
379 }
380
381 auto image_usage = image_state->createInfo.usage;
382
383 // Check for layouts that mismatch image usages in the framebuffer
384 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
385 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
386 skip |=
387 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 -0600388 "Layout/usage mismatch for attachment %u in %s"
389 " - the %s is %s but the image attached to %s via %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100390 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600391 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
392 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100393 }
394
395 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
396 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
397 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
398 skip |=
399 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 -0600400 "Layout/usage mismatch for attachment %u in %s"
401 " - the %s is %s but the image attached to %s via %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100402 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600403 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
404 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100405 }
406
407 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
408 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
409 skip |=
410 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 -0600411 "Layout/usage mismatch for attachment %u in %s"
412 " - the %s is %s but the image attached to %s via %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100413 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600414 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
415 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100416 }
417
418 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
419 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
420 skip |=
421 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 -0600422 "Layout/usage mismatch for attachment %u in %s"
423 " - the %s is %s but the image attached to %s via %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100424 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600425 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
426 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100427 }
428
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600429 if (device_extensions.vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100430 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
431 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
432 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
433 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
434 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
435 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Lockee9aeebf2019-03-03 23:50:08 -0700436 skip |= log_msg(
437 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 -0600438 "Layout/usage mismatch for attachment %u in %s"
439 " - the %s is %s but the image attached to %s via %s"
Lockee9aeebf2019-03-03 23:50:08 -0700440 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600441 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
442 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100443 }
444 } else {
445 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
446 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
447 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
448 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
449 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
450 HandleToUint64(image), "VUID-vkCmdBeginRenderPass-initialLayout-00896",
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_DEPTH_STENCIL_ATTACHMENT_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600454 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
455 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
Lockee9aeebf2019-03-03 23:50:08 -0700456 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100457 }
458 }
459 return skip;
460}
461
John Zulauf17a01bb2019-08-09 16:41:19 -0600462bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700463 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600464 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600465 bool skip = false;
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700466 auto const pRenderPassInfo = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700467 auto const &framebufferInfo = framebuffer_state->createInfo;
Tobias Hectorc9057422019-07-23 12:15:52 +0100468 const VkImageView *attachments = framebufferInfo.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100469
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700470 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100471 auto framebuffer = framebuffer_state->framebuffer;
472
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700473 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600474 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 -0600475 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700476 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700477 }
John Zulauf8e308292018-09-21 11:34:37 -0600478
Tobias Hectorc9057422019-07-23 12:15:52 +0100479 const auto *attachmentInfo = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
480 if (((framebufferInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) != 0) && attachmentInfo != nullptr) {
481 attachments = attachmentInfo->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100482 }
483
Tobias Hectorc9057422019-07-23 12:15:52 +0100484 if (attachments != nullptr) {
485 const auto *const_pCB = static_cast<const CMD_BUFFER_STATE *>(pCB);
486 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
487 auto image_view = attachments[i];
488 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100489
Tobias Hectorc9057422019-07-23 12:15:52 +0100490 if (!view_state) {
491 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_RENDER_PASS_EXT,
492 HandleToUint64(pRenderPassBegin->renderPass), "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
493 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
494 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
495 report_data->FormatHandle(image_view).c_str());
496 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100497 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100498
499 const VkImage image = view_state->create_info.image;
500 const IMAGE_STATE *image_state = GetImageState(image);
501
502 if (!image_state) {
503 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_RENDER_PASS_EXT,
504 HandleToUint64(pRenderPassBegin->renderPass), "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
505 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
506 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
507 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
508 continue;
509 }
510 auto attachment_initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
511 auto final_layout = pRenderPassInfo->pAttachments[i].finalLayout;
512
513 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
514 // in common with the non-const version.)
515 const ImageSubresourceLayoutMap *subresource_map =
516 (attachment_initial_layout != VK_IMAGE_LAYOUT_UNDEFINED) ? GetImageSubresourceLayoutMap(const_pCB, image) : nullptr;
517
518 if (subresource_map) { // If no layout information for image yet, will be checked at QueueSubmit time
519 LayoutUseCheckAndMessage layout_check(subresource_map);
520 bool subres_skip = false;
521 auto subresource_cb = [this, i, attachment_initial_layout, &layout_check, &subres_skip](
522 const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
523 if (!layout_check.Check(subres, attachment_initial_layout, layout, initial_layout)) {
524 subres_skip |=
525 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
526 kVUID_Core_DrawState_InvalidRenderpass,
527 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
528 "and the %s layout of the attachment is %s. The layouts must match, or the render "
529 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
530 i, string_VkImageLayout(attachment_initial_layout), layout_check.message,
531 string_VkImageLayout(layout_check.layout));
532 }
533 return !subres_skip; // quit checking subresources once we fail once
534 };
535
536 subresource_map->ForRange(view_state->normalized_subresource_range, subresource_cb);
537 skip |= subres_skip;
538 }
539
540 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view,
541 framebuffer, render_pass, i, "initial layout");
542
543 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer,
544 render_pass, i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100545 }
546
Tobias Hectorc9057422019-07-23 12:15:52 +0100547 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
548 auto &subpass = pRenderPassInfo->pSubpasses[j];
549 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
550 auto &attachment_ref = subpass.pInputAttachments[k];
551 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
552 auto image_view = attachments[attachment_ref.attachment];
553 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100554
Tobias Hectorc9057422019-07-23 12:15:52 +0100555 if (view_state) {
556 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700557 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
558 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100559 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100560 }
561 }
562 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100563
Tobias Hectorc9057422019-07-23 12:15:52 +0100564 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
565 auto &attachment_ref = subpass.pColorAttachments[k];
566 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
567 auto image_view = attachments[attachment_ref.attachment];
568 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100569
Tobias Hectorc9057422019-07-23 12:15:52 +0100570 if (view_state) {
571 auto image = view_state->create_info.image;
572 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
573 framebuffer, render_pass, attachment_ref.attachment,
574 "color attachment layout");
575 if (subpass.pResolveAttachments) {
576 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
577 rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
578 attachment_ref.attachment, "resolve attachment layout");
579 }
580 }
581 }
582 }
583
584 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
585 auto &attachment_ref = *subpass.pDepthStencilAttachment;
586 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
587 auto image_view = attachments[attachment_ref.attachment];
588 auto view_state = GetImageViewState(image_view);
589
590 if (view_state) {
591 auto image = view_state->create_info.image;
592 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
593 framebuffer, render_pass, attachment_ref.attachment,
594 "input attachment layout");
595 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100596 }
597 }
598 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700599 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600600 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700601}
602
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600603void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700604 const safe_VkAttachmentReference2KHR &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700605 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700606 auto image_view = GetAttachmentImageViewState(pFramebuffer, ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600607 if (image_view) {
John Zulauff660ad62019-03-23 07:16:05 -0600608 SetImageViewLayout(pCB, *image_view, ref.layout);
John Zulauf8e308292018-09-21 11:34:37 -0600609 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700610 }
611}
612
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600613void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
614 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700615 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700616
617 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700618 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700619 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700620 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700621 }
622 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700623 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700624 }
625 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700626 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700627 }
628 }
629}
630
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700631// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
632// 1. Transition into initialLayout state
633// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600634void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700635 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700636 // First transition into initialLayout
637 auto const rpci = render_pass_state->createInfo.ptr();
638 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700639 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -0600640 if (view_state) {
John Zulauff660ad62019-03-23 07:16:05 -0600641 SetImageViewLayout(cb_state, *view_state, rpci->pAttachments[i].initialLayout);
John Zulauf8e308292018-09-21 11:34:37 -0600642 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700643 }
644 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700645 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700646}
647
Dave Houlton10b39482017-03-16 13:18:15 -0600648bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600649 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600650 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600651 }
652 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600653 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600654 }
655 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600656 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600657 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700658 if (0 !=
659 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
660 if (FormatPlaneCount(format) == 1) return false;
661 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600662 return true;
663}
664
Mike Weiblen62d08a32017-03-07 22:18:27 -0700665// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Petr Krausad0096a2019-08-09 18:35:04 +0200666bool CoreChecks::ValidateBarrierLayoutToImageUsage(const VkImageMemoryBarrier &img_barrier, bool new_not_old,
667 VkImageUsageFlags usage_flags, const char *func_name,
668 const char *barrier_pname) {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700669 bool skip = false;
Petr Krausad0096a2019-08-09 18:35:04 +0200670 const VkImageLayout layout = (new_not_old) ? img_barrier.newLayout : img_barrier.oldLayout;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600671 const char *msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700672
673 switch (layout) {
674 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
675 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600676 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700677 }
678 break;
679 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
680 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600681 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700682 }
683 break;
684 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
685 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600686 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700687 }
688 break;
689 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
690 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600691 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700692 }
693 break;
694 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
695 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600696 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700697 }
698 break;
699 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
700 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600701 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700702 }
703 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600704 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500705 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
706 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
707 }
708 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700709 default:
710 // Other VkImageLayout values do not have VUs defined in this context.
711 break;
712 }
713
Dave Houlton8e9f6542018-05-18 12:18:22 -0600714 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600715 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 +0200716 HandleToUint64(img_barrier.image), msg_code,
717 "%s: Image barrier %s %s Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".", func_name,
718 barrier_pname, ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
719 report_data->FormatHandle(img_barrier.image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700720 }
721 return skip;
722}
723
724// Verify image barriers are compatible with the images they reference.
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600725bool CoreChecks::ValidateBarriersToImages(CMD_BUFFER_STATE const *cb_state, uint32_t imageMemoryBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700726 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700727 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700728
Petr Krausad0096a2019-08-09 18:35:04 +0200729 // Scoreboard for checking for duplicate and inconsistent barriers to images
730 struct ImageBarrierScoreboardEntry {
731 uint32_t index;
732 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
733 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
734 const VkImageMemoryBarrier *barrier;
735 };
736 using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
737 using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
738
John Zulauf463c51e2018-05-31 13:29:20 -0600739 // Scoreboard for duplicate layout transition barriers within the list
740 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
741 ImageBarrierScoreboardImageMap layout_transitions;
742
Mike Weiblen62d08a32017-03-07 22:18:27 -0700743 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +0200744 const auto &img_barrier = pImageMemoryBarriers[i];
745 const std::string barrier_pname = "pImageMemoryBarrier[" + std::to_string(i) + "]";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700746
John Zulauf463c51e2018-05-31 13:29:20 -0600747 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
748 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
749 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +0200750 if (img_barrier.oldLayout != img_barrier.newLayout) {
751 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
752 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -0600753 if (image_it != layout_transitions.end()) {
754 auto &subres_map = image_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200755 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -0600756 if (subres_it != subres_map.end()) {
757 auto &entry = subres_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200758 if ((entry.barrier->newLayout != img_barrier.oldLayout) &&
759 (img_barrier.oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
760 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
John Zulauf463c51e2018-05-31 13:29:20 -0600761 skip = log_msg(
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700762 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
763 HandleToUint64(cb_state->commandBuffer), "VUID-VkImageMemoryBarrier-oldLayout-01197",
Petr Krausad0096a2019-08-09 18:35:04 +0200764 "%s: %s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600765 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
766 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Petr Krausad0096a2019-08-09 18:35:04 +0200767 func_name, barrier_pname.c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
768 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
769 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600770 }
771 entry = new_entry;
772 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200773 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600774 }
775 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200776 layout_transitions[img_barrier.image][img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600777 }
778 }
779
Petr Krausad0096a2019-08-09 18:35:04 +0200780 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600781 if (image_state) {
782 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Petr Krausad0096a2019-08-09 18:35:04 +0200783 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, false, usage_flags, func_name, barrier_pname.c_str());
784 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, true, usage_flags, func_name, barrier_pname.c_str());
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600785
786 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
787 if (image_state->layout_locked) {
788 // TODO: Add unique id for error when available
Dave Houlton33c2d252017-06-09 17:08:32 -0600789 skip |= log_msg(
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700790 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Krausad0096a2019-08-09 18:35:04 +0200791 HandleToUint64(img_barrier.image), 0,
locke-lunarg9edc2812019-06-17 23:18:52 -0600792 "Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600793 " 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 +0200794 report_data->FormatHandle(img_barrier.image).c_str(), string_VkImageLayout(img_barrier.oldLayout),
795 string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600796 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600797
John Zulauff660ad62019-03-23 07:16:05 -0600798 VkImageCreateInfo *image_create_info = &image_state->createInfo;
799 // For a Depth/Stencil image both aspects MUST be set
800 if (FormatIsDepthAndStencil(image_create_info->format)) {
Petr Krausad0096a2019-08-09 18:35:04 +0200801 auto const aspect_mask = img_barrier.subresourceRange.aspectMask;
John Zulauff660ad62019-03-23 07:16:05 -0600802 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
803 if ((aspect_mask & ds_mask) != (ds_mask)) {
804 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), "VUID-VkImageMemoryBarrier-image-01207",
806 "%s: Image barrier %s references %s of format %s that must have the depth and stencil "
John Zulauff660ad62019-03-23 07:16:05 -0600807 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
Petr Krausad0096a2019-08-09 18:35:04 +0200808 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
John Zulauff660ad62019-03-23 07:16:05 -0600809 string_VkFormat(image_create_info->format), aspect_mask);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700810 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700811 }
John Zulauff660ad62019-03-23 07:16:05 -0600812
Petr Krausad0096a2019-08-09 18:35:04 +0200813 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier.image);
814 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -0600815 // TODO: Set memory invalid which is in mem_tracker currently
816 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
817 // subresource.
818 } else if (subresource_map) {
819 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -0600820 LayoutUseCheckAndMessage layout_check(subresource_map);
Petr Krausad0096a2019-08-09 18:35:04 +0200821 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier.subresourceRange);
John Zulauf02a204c2019-04-23 18:52:11 -0600822 auto subres_callback = [this, img_barrier, cb_state, &layout_check, &subres_skip](
John Zulauff660ad62019-03-23 07:16:05 -0600823 const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
Petr Krausad0096a2019-08-09 18:35:04 +0200824 if (!layout_check.Check(subres, img_barrier.oldLayout, layout, initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600825 subres_skip =
826 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
827 HandleToUint64(cb_state->commandBuffer), "VUID-VkImageMemoryBarrier-oldLayout-01197",
locke-lunarg9edc2812019-06-17 23:18:52 -0600828 "For %s you cannot transition the layout of aspect=%d level=%d layer=%d from %s when the "
John Zulauff660ad62019-03-23 07:16:05 -0600829 "%s layout is %s.",
Petr Krausad0096a2019-08-09 18:35:04 +0200830 report_data->FormatHandle(img_barrier.image).c_str(), subres.aspectMask, subres.mipLevel,
831 subres.arrayLayer, string_VkImageLayout(img_barrier.oldLayout), layout_check.message,
John Zulauff660ad62019-03-23 07:16:05 -0600832 string_VkImageLayout(layout_check.layout));
833 }
834 return !subres_skip;
835 };
836 subresource_map->ForRange(normalized_isr, subres_callback);
837 skip |= subres_skip;
838 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700839 }
840 }
841 return skip;
842}
843
John Zulaufe3d1c8a2019-08-12 14:34:58 -0600844bool CoreChecks::IsReleaseOp(CMD_BUFFER_STATE *cb_state, const VkImageMemoryBarrier &barrier) const {
Petr Krausad0096a2019-08-09 18:35:04 +0200845 if (!IsTransferOp(&barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700846
Mark Lobodzinskic2a15b02019-04-25 12:06:02 -0600847 auto pool = GetCommandPoolState(cb_state->createInfo.commandPool);
Petr Krausad0096a2019-08-09 18:35:04 +0200848 return pool && TempIsReleaseOp<VkImageMemoryBarrier, true>(pool, &barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700849}
850
John Zulauf6b4aae82018-05-09 13:03:36 -0600851template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600852bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700853 const Barrier *barriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600854 using BarrierRecord = QFOTransferBarrier<Barrier>;
855 bool skip = false;
Mark Lobodzinskic2a15b02019-04-25 12:06:02 -0600856 auto pool = GetCommandPoolState(cb_state->createInfo.commandPool);
John Zulauf6b4aae82018-05-09 13:03:36 -0600857 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
858 const char *barrier_name = BarrierRecord::BarrierName();
859 const char *handle_name = BarrierRecord::HandleName();
860 const char *transfer_type = nullptr;
861 for (uint32_t b = 0; b < barrier_count; b++) {
862 if (!IsTransferOp(&barriers[b])) continue;
863 const BarrierRecord *barrier_record = nullptr;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700864 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) &&
865 !IsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600866 const auto found = barrier_sets.release.find(barriers[b]);
867 if (found != barrier_sets.release.cend()) {
868 barrier_record = &(*found);
869 transfer_type = "releasing";
870 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600871 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
872 !IsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600873 const auto found = barrier_sets.acquire.find(barriers[b]);
874 if (found != barrier_sets.acquire.cend()) {
875 barrier_record = &(*found);
876 transfer_type = "acquiring";
877 }
878 }
879 if (barrier_record != nullptr) {
Lockee9aeebf2019-03-03 23:50:08 -0700880 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
881 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInCB(),
882 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
883 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
884 func_name, barrier_name, b, transfer_type, handle_name,
885 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
886 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -0600887 }
888 }
889 return skip;
890}
891
892template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600893void CoreChecks::RecordQFOTransferBarriers(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count, const Barrier *barriers) {
Mark Lobodzinskic2a15b02019-04-25 12:06:02 -0600894 auto pool = GetCommandPoolState(cb_state->createInfo.commandPool);
John Zulauf6b4aae82018-05-09 13:03:36 -0600895 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
896 for (uint32_t b = 0; b < barrier_count; b++) {
897 if (!IsTransferOp(&barriers[b])) continue;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700898 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barriers[b]) &&
899 !IsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600900 barrier_sets.release.emplace(barriers[b]);
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600901 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
902 !IsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600903 barrier_sets.acquire.emplace(barriers[b]);
904 }
905 }
906}
907
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600908bool CoreChecks::ValidateBarriersQFOTransferUniqueness(const char *func_name, CMD_BUFFER_STATE *cb_state,
909 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700910 uint32_t imageMemBarrierCount,
911 const VkImageMemoryBarrier *pImageMemBarriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600912 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700913 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
914 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -0600915 return skip;
916}
917
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600918void CoreChecks::RecordBarriersQFOTransfers(CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700919 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
920 const VkImageMemoryBarrier *pImageMemBarriers) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700921 RecordQFOTransferBarriers(cb_state, bufferBarrierCount, pBufferMemBarriers);
922 RecordQFOTransferBarriers(cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -0600923}
924
925template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600926bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
John Zulauf3b04ebd2019-07-18 14:08:11 -0600927 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600928 // Record to the scoreboard or report that we have a duplication
929 bool skip = false;
930 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
931 if (!inserted.second && inserted.first->second != cb_state) {
932 // 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 -0700933 skip = log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
934 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
935 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
locke-lunarg9edc2812019-06-17 23:18:52 -0600936 " duplicates existing barrier submitted in this batch from %s.",
Lockee9aeebf2019-03-03 23:50:08 -0700937 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
938 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex, barrier.dstQueueFamilyIndex,
John Zulauf7eb94822019-04-05 09:38:46 -0600939 report_data->FormatHandle(inserted.first->second->commandBuffer).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -0600940 }
941 return skip;
942}
943
944template <typename Barrier>
John Zulauf3b04ebd2019-07-18 14:08:11 -0600945bool CoreChecks::ValidateQueuedQFOTransferBarriers(const CMD_BUFFER_STATE *cb_state,
946 QFOTransferCBScoreboards<Barrier> *scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600947 using BarrierRecord = QFOTransferBarrier<Barrier>;
948 using TypeTag = typename BarrierRecord::Tag;
949 bool skip = false;
John Zulauf6b4aae82018-05-09 13:03:36 -0600950 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -0700951 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -0600952 const char *barrier_name = BarrierRecord::BarrierName();
953 const char *handle_name = BarrierRecord::HandleName();
954 // No release should have an extant duplicate (WARNING)
955 for (const auto &release : cb_barriers.release) {
956 // Check the global pending release barriers
957 const auto set_it = global_release_barriers.find(release.handle);
958 if (set_it != global_release_barriers.cend()) {
959 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
960 const auto found = set_for_handle.find(release);
961 if (found != set_for_handle.cend()) {
962 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
963 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
Lockee9aeebf2019-03-03 23:50:08 -0700964 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
John Zulauf6b4aae82018-05-09 13:03:36 -0600965 " to dstQueueFamilyIndex %" PRIu32
966 " duplicates existing barrier queued for execution, without intervening acquire operation.",
Lockee9aeebf2019-03-03 23:50:08 -0700967 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
John Zulauf6b4aae82018-05-09 13:03:36 -0600968 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
969 }
970 }
971 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
972 }
973 // Each acquire must have a matching release (ERROR)
974 for (const auto &acquire : cb_barriers.acquire) {
975 const auto set_it = global_release_barriers.find(acquire.handle);
976 bool matching_release_found = false;
977 if (set_it != global_release_barriers.cend()) {
978 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
979 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
980 }
981 if (!matching_release_found) {
982 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
983 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
Lockee9aeebf2019-03-03 23:50:08 -0700984 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
985 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
986 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
John Zulauf6b4aae82018-05-09 13:03:36 -0600987 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
988 }
989 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
990 }
991 return skip;
992}
993
John Zulauf3b04ebd2019-07-18 14:08:11 -0600994bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700995 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
John Zulauf3b04ebd2019-07-18 14:08:11 -0600996 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600997 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700998 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state, qfo_image_scoreboards);
999 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state, qfo_buffer_scoreboards);
John Zulauf6b4aae82018-05-09 13:03:36 -06001000 return skip;
1001}
1002
1003template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001004void CoreChecks::RecordQueuedQFOTransferBarriers(CMD_BUFFER_STATE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001005 using BarrierRecord = QFOTransferBarrier<Barrier>;
1006 using TypeTag = typename BarrierRecord::Tag;
1007 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001008 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001009
1010 // Add release barriers from this submit to the global map
1011 for (const auto &release : cb_barriers.release) {
1012 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1013 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1014 global_release_barriers[release.handle].insert(release);
1015 }
1016
1017 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1018 for (const auto &acquire : cb_barriers.acquire) {
1019 // NOTE: We're not using [] because we don't want to create entries for missing releases
1020 auto set_it = global_release_barriers.find(acquire.handle);
1021 if (set_it != global_release_barriers.end()) {
1022 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1023 set_for_handle.erase(acquire);
1024 if (set_for_handle.size() == 0) { // Clean up empty sets
1025 global_release_barriers.erase(set_it);
1026 }
1027 }
1028 }
1029}
1030
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001031void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001032 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state);
1033 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001034}
1035
John Zulauf6b4aae82018-05-09 13:03:36 -06001036// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001037void CoreChecks::EraseQFOImageRelaseBarriers(const VkImage &image) { EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image); }
John Zulauf6b4aae82018-05-09 13:03:36 -06001038
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001039void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001040 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001041 for (uint32_t i = 0; i < memBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +02001042 const auto &mem_barrier = pImgMemBarriers[i];
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001043
Chris Forbes4de4b132017-08-21 11:27:08 -07001044 // For ownership transfers, the barrier is specified twice; as a release
1045 // operation on the yielding queue family, and as an acquire operation
1046 // on the acquiring queue family. This barrier may also include a layout
1047 // transition, which occurs 'between' the two operations. For validation
1048 // purposes it doesn't seem important which side performs the layout
1049 // transition, but it must not be performed twice. We'll arbitrarily
1050 // choose to perform it as part of the acquire operation.
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001051 if (IsReleaseOp(cb_state, mem_barrier)) {
Chris Forbes4de4b132017-08-21 11:27:08 -07001052 continue;
1053 }
1054
Petr Krausad0096a2019-08-09 18:35:04 +02001055 auto *image_state = GetImageState(mem_barrier.image);
John Zulauff660ad62019-03-23 07:16:05 -06001056 if (!image_state) continue;
1057
Petr Krausad0096a2019-08-09 18:35:04 +02001058 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier.subresourceRange);
John Zulauff660ad62019-03-23 07:16:05 -06001059 const auto &image_create_info = image_state->createInfo;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001060
Dave Houltonb3f4b282018-02-22 16:25:16 -07001061 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1062 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1063 // for all (potential) layer sub_resources.
John Zulauff660ad62019-03-23 07:16:05 -06001064 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
1065 normalized_isr.baseArrayLayer = 0;
1066 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
Dave Houltonb3f4b282018-02-22 16:25:16 -07001067 }
1068
Petr Krausad0096a2019-08-09 18:35:04 +02001069 SetImageLayout(cb_state, *image_state, normalized_isr, mem_barrier.newLayout, mem_barrier.oldLayout);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001070 }
1071}
1072
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001073bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1074 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1075 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1076 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Matthew Ruschd7ef5482019-07-16 22:01:54 -07001077 if (disabled.image_layout_validation) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001078 assert(cb_node);
1079 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001080 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001081 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001082
John Zulauff660ad62019-03-23 07:16:05 -06001083 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1084 if (subresource_map) {
1085 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001086 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
1087 auto subresource_cb = [this, explicit_layout, cb_node, layout_mismatch_msg_code, caller, image, &layout_check, &error,
John Zulaufabcc8292019-04-08 18:07:44 -06001088 &subres_skip](const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
John Zulauf02a204c2019-04-23 18:52:11 -06001089 if (!layout_check.Check(subres, explicit_layout, layout, initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001090 *error = true;
John Zulauff660ad62019-03-23 07:16:05 -06001091 subres_skip |=
1092 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1093 HandleToUint64(cb_node->commandBuffer), layout_mismatch_msg_code,
locke-lunarg9edc2812019-06-17 23:18:52 -06001094 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
John Zulauff660ad62019-03-23 07:16:05 -06001095 "%s layout %s.",
1096 caller, report_data->FormatHandle(image).c_str(), subres.arrayLayer, subres.mipLevel,
1097 string_VkImageLayout(explicit_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001098 }
John Zulauff660ad62019-03-23 07:16:05 -06001099 return !subres_skip;
1100 };
1101 subresource_map->ForRange(range, subresource_cb);
1102 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001103 }
John Zulauff660ad62019-03-23 07:16:05 -06001104
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001105 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1106 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1107 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001108 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1109 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001110 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001111 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_node->commandBuffer),
Dave Houlton51653902018-06-22 17:32:13 -06001112 kVUID_Core_DrawState_InvalidImageLayout,
locke-lunarg9edc2812019-06-17 23:18:52 -06001113 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
Lockee9aeebf2019-03-03 23:50:08 -07001114 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001115 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001116 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001117 if (image_state->shared_presentable) {
1118 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
Cort Stratton7df30962018-05-17 19:45:57 -07001119 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1120 layout_invalid_msg_code,
1121 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1122 string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001123 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001124 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001125 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001126 *error = true;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001127 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 -07001128 HandleToUint64(cb_node->commandBuffer), layout_invalid_msg_code,
locke-lunarg9edc2812019-06-17 23:18:52 -06001129 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
Lockee9aeebf2019-03-03 23:50:08 -07001130 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1131 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001132 }
1133 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001134 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001135}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001136bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001137 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1138 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001139 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001140 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1141 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1142}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001143
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001144void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001145 FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinski2e495882019-03-06 16:11:56 -07001146 auto renderPass = GetRenderPassState(pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001147 if (!renderPass) return;
1148
Tobias Hectorbbb12282018-10-22 15:17:59 +01001149 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001150 if (framebuffer_state) {
1151 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07001152 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -06001153 if (view_state) {
John Zulauff660ad62019-03-23 07:16:05 -06001154 SetImageViewLayout(pCB, *view_state, pRenderPassInfo->pAttachments[i].finalLayout);
John Zulauf8e308292018-09-21 11:34:37 -06001155 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001156 }
1157 }
1158}
Dave Houltone19e20d2018-02-02 16:32:41 -07001159
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001160#ifdef VK_USE_PLATFORM_ANDROID_KHR
1161// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1162// This could also move into a seperate core_validation_android.cpp file... ?
1163
1164//
1165// AHB-specific validation within non-AHB APIs
1166//
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001167bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001168 bool skip = false;
1169
1170 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1171 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001172 if (0 != ext_fmt_android->externalFormat) {
1173 if (VK_FORMAT_UNDEFINED != create_info->format) {
1174 skip |=
1175 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1176 "VUID-VkImageCreateInfo-pNext-01974",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001177 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
Dave Houltond9611312018-11-19 17:03:36 -07001178 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
1179 }
1180
1181 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
1182 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1183 "VUID-VkImageCreateInfo-pNext-02396",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001184 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001185 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
1186 }
1187
1188 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
1189 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1190 "VUID-VkImageCreateInfo-pNext-02397",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001191 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001192 "non-zero externalFormat, but usage includes bits other than VK_IMAGE_USAGE_SAMPLED_BIT.");
1193 }
1194
1195 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
1196 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1197 "VUID-VkImageCreateInfo-pNext-02398",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001198 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001199 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
1200 }
1201 }
1202
Mark Lobodzinski1ee06e92019-04-19 14:03:53 -06001203 if ((0 != ext_fmt_android->externalFormat) && (0 == ahb_ext_formats_set.count(ext_fmt_android->externalFormat))) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001204 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1205 "VUID-VkExternalFormatANDROID-externalFormat-01894",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001206 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat which has "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001207 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().");
1208 }
1209 }
1210
Dave Houltond9611312018-11-19 17:03:36 -07001211 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001212 if (VK_FORMAT_UNDEFINED == create_info->format) {
1213 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1214 "VUID-VkImageCreateInfo-pNext-01975",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001215 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
Dave Houltond9611312018-11-19 17:03:36 -07001216 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
1217 }
1218 }
1219
1220 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1221 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1222 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001223 skip |=
1224 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1225 "VUID-VkImageCreateInfo-pNext-02393",
1226 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1227 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1228 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001229 }
1230
1231 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
1232 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1233 "VUID-VkImageCreateInfo-pNext-02394",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001234 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
Dave Houltond9611312018-11-19 17:03:36 -07001235 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1236 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1237 create_info->mipLevels, FullMipChainLevels(create_info->extent));
1238 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001239 }
1240
1241 return skip;
1242}
1243
John Zulauf7eeb6f72019-06-17 11:56:36 -06001244void ValidationStateTracker::RecordCreateImageANDROID(const VkImageCreateInfo *create_info, IMAGE_STATE *is_node) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001245 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1246 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1247 is_node->imported_ahb = true;
1248 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001249 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
egdaniel1f4d2a42019-02-04 10:25:38 -05001250 if (ext_fmt_android && (0 != ext_fmt_android->externalFormat)) {
Dave Houltond3e046d2018-11-28 13:08:09 -07001251 is_node->has_ahb_format = true;
1252 is_node->ahb_format = ext_fmt_android->externalFormat;
1253 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001254}
1255
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001256bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001257 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001258 IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001259
1260 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001261 if (VK_FORMAT_UNDEFINED != create_info->format) {
1262 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1263 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02399",
1264 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1265 "format member is %s.",
1266 string_VkFormat(create_info->format));
1267 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001268
Dave Houltond9611312018-11-19 17:03:36 -07001269 // Chain must include a compatible ycbcr conversion
1270 bool conv_found = false;
1271 uint64_t external_format = 0;
1272 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1273 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001274 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001275 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001276 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001277 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001278 }
Dave Houltond9611312018-11-19 17:03:36 -07001279 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001280 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001281 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 -07001282 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02400",
1283 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1284 "without a chained VkSamplerYcbcrConversionInfo struct with the same external format.");
1285 }
1286
1287 // Errors in create_info swizzles
1288 if ((create_info->components.r != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1289 (create_info->components.g != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1290 (create_info->components.b != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1291 (create_info->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
1292 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1293 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02401",
1294 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1295 "includes one or more non-identity component swizzles.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001296 }
1297 }
Dave Houltond9611312018-11-19 17:03:36 -07001298
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001299 return skip;
1300}
1301
John Zulaufa26d3c82019-08-14 16:09:08 -06001302bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001303 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001304
John Zulaufa26d3c82019-08-14 16:09:08 -06001305 const IMAGE_STATE *image_state = GetImageState(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001306 if (image_state->imported_ahb && (0 == image_state->GetBoundMemory().size())) {
1307 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
1308 "VUID-vkGetImageSubresourceLayout-image-01895",
Graeme Leese79b60cb2018-11-28 11:51:20 +00001309 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001310 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1311 "bound to memory.");
1312 }
1313 return skip;
1314}
1315
1316#else
1317
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001318bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001319 return false;
1320}
1321
John Zulauf7eeb6f72019-06-17 11:56:36 -06001322void ValidationStateTracker::RecordCreateImageANDROID(const VkImageCreateInfo *create_info, IMAGE_STATE *is_node) {}
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001323
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001324bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001325
John Zulaufa26d3c82019-08-14 16:09:08 -06001326bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001327
1328#endif // VK_USE_PLATFORM_ANDROID_KHR
1329
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001330bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1331 const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001332 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001333
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001334 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001335 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001336 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1337 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
1338 return log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1339 "VUID-VkImageCreateInfo-format-00943",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001340 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001341 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001342 }
1343
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001344 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1345 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
1346 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1347 "VUID-VkImageCreateInfo-flags-00949",
1348 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1349 "flag bit is set");
1350 }
1351
1352 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
1353 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1354 "VUID-VkImageCreateInfo-imageType-00954",
1355 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1356 "height (%d) and arrayLayers (%d) must be >= 6.",
1357 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
1358 }
Dave Houlton130c0212018-01-29 13:39:56 -07001359 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001360
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001361 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001362 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1363 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1364 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001365 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 +00001366 "VUID-VkImageCreateInfo-usage-00964",
1367 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1368 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001369 }
1370
1371 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001372 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 +00001373 "VUID-VkImageCreateInfo-usage-00965",
1374 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1375 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001376 }
1377
ByumjinConffx991b6062019-08-14 15:17:53 -07001378 if (device_extensions.vk_ext_fragment_density_map) {
1379 uint32_t ceiling_width =
1380 (uint32_t)ceil((float)device_limits->maxFramebufferWidth /
1381 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, 1.0f));
1382 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1383 skip |=
1384 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1385 "VUID-VkImageCreateInfo-usage-02559",
1386 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1387 "ceiling of device "
1388 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1389 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1390 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
1391 }
1392
1393 uint32_t ceiling_height =
1394 (uint32_t)ceil((float)device_limits->maxFramebufferHeight /
1395 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, 1.0f));
1396 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1397 skip |=
1398 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1399 "VUID-VkImageCreateInfo-usage-02560",
1400 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1401 "ceiling of device "
1402 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1403 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1404 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
1405 }
1406 }
1407
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001408 VkImageFormatProperties format_limits = {};
Mark Lobodzinski5c048802019-03-07 10:47:31 -07001409 VkResult res = GetPDImageFormatProperties(pCreateInfo, &format_limits);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001410 if (res == VK_ERROR_FORMAT_NOT_SUPPORTED) {
Lockee87f87c2019-04-23 17:53:10 -06001411#ifdef VK_USE_PLATFORM_ANDROID_KHR
1412 if (!lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext))
1413#endif // VK_USE_PLATFORM_ANDROID_KHR
1414 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1415 "vkCreateImage(): Format %s is not supported for this combination of parameters.",
1416 string_VkFormat(pCreateInfo->format));
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001417 } else {
1418 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1419 const char *format_string = string_VkFormat(pCreateInfo->format);
1420 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1421 "VUID-VkImageCreateInfo-mipLevels-02255",
1422 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1423 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
1424 }
Dave Houlton130c0212018-01-29 13:39:56 -07001425
Dave Houltona585d132019-01-18 13:05:42 -07001426 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1427 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1428 (uint64_t)pCreateInfo->samples;
1429 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * texel_count);
Dave Houlton130c0212018-01-29 13:39:56 -07001430
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001431 // Round up to imageGranularity boundary
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001432 VkDeviceSize imageGranularity = phys_dev_props.limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001433 uint64_t ig_mask = imageGranularity - 1;
1434 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001435
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001436 if (total_size > format_limits.maxResourceSize) {
1437 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1438 kVUID_Core_Image_InvalidFormatLimitsViolation,
1439 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1440 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1441 total_size, format_limits.maxResourceSize);
1442 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001443
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001444 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
1445 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1446 "VUID-VkImageCreateInfo-arrayLayers-02256",
1447 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1448 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
1449 }
1450
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001451 if (device_extensions.vk_khr_sampler_ycbcr_conversion && FormatRequiresYcbcrConversion(pCreateInfo->format) &&
1452 !device_extensions.vk_ext_ycbcr_image_arrays && pCreateInfo->arrayLayers > 1) {
Piers Daniell10a5c762019-03-11 12:44:50 -06001453 skip |= log_msg(
1454 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1455 "VUID-VkImageCreateInfo-format-02653",
1456 "vkCreateImage(): arrayLayers=%d exceeds the maximum allowed of 1 for formats requiring sampler ycbcr conversion",
1457 pCreateInfo->arrayLayers);
1458 }
1459
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001460 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
1461 skip |=
1462 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1463 "VUID-VkImageCreateInfo-samples-02258", "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001464 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001465 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001466 }
1467
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06001468 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001469 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 -06001470 "VUID-VkImageCreateInfo-flags-01924",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001471 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
1472 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06001473 }
1474
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001475 if (device_extensions.vk_khr_maintenance2) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06001476 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
1477 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
1478 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
1479 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001480 skip |=
1481 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1482 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1483 "format must be block, ETC or ASTC compressed, but is %s",
1484 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001485 }
1486 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
1487 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001488 skip |=
1489 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1490 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1491 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001492 }
1493 }
1494 }
1495
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001496 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001497 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateImage",
1498 "pCreateInfo->pQueueFamilyIndices", "VUID-VkImageCreateInfo-sharingMode-01420",
1499 "VUID-VkImageCreateInfo-sharingMode-01420", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001500 }
1501
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001502 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001503}
1504
John Zulauf7eeb6f72019-06-17 11:56:36 -06001505void ValidationStateTracker::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1506 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07001507 if (VK_SUCCESS != result) return;
John Zulauf4db45df2019-07-23 06:10:40 -06001508 std::unique_ptr<IMAGE_STATE> is_node(new IMAGE_STATE(*pImage, pCreateInfo));
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001509 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
John Zulauf4db45df2019-07-23 06:10:40 -06001510 RecordCreateImageANDROID(pCreateInfo, is_node.get());
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001511 }
unknown09edc722019-06-21 15:49:38 -06001512 const auto swapchain_info = lvl_find_in_chain<VkImageSwapchainCreateInfoKHR>(pCreateInfo->pNext);
1513 if (swapchain_info) {
1514 is_node->create_from_swapchain = swapchain_info->swapchain;
1515 }
John Zulauf4db45df2019-07-23 06:10:40 -06001516
1517 bool pre_fetch_memory_reqs = true;
1518#ifdef VK_USE_PLATFORM_ANDROID_KHR
1519 if (is_node->external_format_android) {
1520 // Do not fetch requirements for external memory images
1521 pre_fetch_memory_reqs = false;
1522 }
1523#endif
1524 // Record the memory requirements in case they won't be queried
1525 if (pre_fetch_memory_reqs) {
1526 DispatchGetImageMemoryRequirements(device, *pImage, &is_node->requirements);
1527 }
1528 imageMap.insert(std::make_pair(*pImage, std::move(is_node)));
John Zulauf7eeb6f72019-06-17 11:56:36 -06001529}
1530
1531void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1532 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
1533 if (VK_SUCCESS != result) return;
1534
1535 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
1536
1537 IMAGE_LAYOUT_STATE image_state;
1538 image_state.layout = pCreateInfo->initialLayout;
1539 image_state.format = pCreateInfo->format;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001540 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001541 imageSubresourceMap[*pImage].push_back(subpair);
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -06001542 imageLayoutMap[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001543}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001544
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001545bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001546 IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06001547 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001548 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001549 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001550 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001551 }
1552 return skip;
1553}
1554
John Zulauf7eeb6f72019-06-17 11:56:36 -06001555void ValidationStateTracker::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidfa64112019-03-04 12:17:24 -07001556 if (!image) return;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001557 IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06001558 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001559 InvalidateCommandBuffers(image_state->cb_bindings, obj_struct);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001560 // Clean up memory mapping, bindings and range references for image
1561 for (auto mem_binding : image_state->GetBoundMemory()) {
Mark Lobodzinski0a41e0e2019-04-25 12:12:40 -06001562 auto mem_info = GetDevMemState(mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001563 if (mem_info) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001564 RemoveImageMemoryRange(obj_struct.handle, mem_info);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001565 }
1566 }
John Zulauf4fea6622019-04-01 11:38:18 -06001567 ClearMemoryObjectBindings(obj_struct);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001568 // Remove image from imageMap
Mark Lobodzinski34e04bf2019-04-19 13:31:53 -06001569 imageMap.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06001570}
1571
1572void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
1573 // Clean up validation specific data
1574 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001575
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001576 const auto &sub_entry = imageSubresourceMap.find(image);
1577 if (sub_entry != imageSubresourceMap.end()) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001578 for (const auto &pair : sub_entry->second) {
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -06001579 imageLayoutMap.erase(pair);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001580 }
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001581 imageSubresourceMap.erase(sub_entry);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001582 }
John Zulauf7eeb6f72019-06-17 11:56:36 -06001583
1584 // Clean up generic image state
1585 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001586}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001587
John Zulauf07288512019-07-05 11:09:50 -06001588bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001589 bool skip = false;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001590
1591 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
1592 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
1593 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 -06001594 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001595 }
1596
Dave Houlton1d2022c2017-03-29 11:43:58 -06001597 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001598 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
1599 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 -06001600 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -06001601 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001602 char const str[] = "vkCmdClearColorImage called with compressed image.";
1603 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 -06001604 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001605 }
1606
1607 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
1608 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
1609 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 -06001610 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00002", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001611 }
1612 return skip;
1613}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001614
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001615uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1616 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1617 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001618 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001619 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001620 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001621 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001622}
1623
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001624uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1625 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1626 uint32_t array_layer_count = range->layerCount;
1627 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1628 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001629 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001630 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001631}
1632
John Zulauf07288512019-07-05 11:09:50 -06001633bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1634 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
1635 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001636 bool skip = false;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001637
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001638 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
1639 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001640 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1641 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001642 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06001643 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001644 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
1645 }
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001646 } else if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR == dest_image_layout) {
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001647 if (!device_extensions.vk_khr_shared_presentable_image) {
Tobin Ehlisfb0661c2017-05-11 08:52:51 -06001648 // TODO: Add unique error id when available.
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001649 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001650 HandleToUint64(image_state->image), 0,
Dave Houlton33c2d252017-06-09 17:08:32 -06001651 "Must enable VK_KHR_shared_presentable_image extension before creating images with a layout type "
1652 "of VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.");
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001653
1654 } else {
1655 if (image_state->shared_presentable) {
1656 skip |= log_msg(
1657 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001658 HandleToUint64(image_state->image), 0,
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001659 "Layout for shared presentable cleared image is %s but can only be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1660 string_VkImageLayout(dest_image_layout));
1661 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001662 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001663 } else {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06001664 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00005";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001665 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001666 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00012";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001667 } else {
1668 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1669 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001670 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001671 HandleToUint64(image_state->image), error_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001672 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1673 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001674 }
1675 }
1676
John Zulauff660ad62019-03-23 07:16:05 -06001677 // Cast to const to prevent creation at validate time.
John Zulauf07288512019-07-05 11:09:50 -06001678 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06001679 if (subresource_map) {
1680 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001681 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06001682 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
John Zulauf02a204c2019-04-23 18:52:11 -06001683 auto subres_callback = [this, cb_node, dest_image_layout, func_name, &layout_check, &subres_skip](
John Zulauff660ad62019-03-23 07:16:05 -06001684 const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
John Zulauf02a204c2019-04-23 18:52:11 -06001685 if (!layout_check.Check(subres, dest_image_layout, layout, initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06001686 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
1687 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1688 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
1689 } else {
1690 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001691 }
John Zulauff660ad62019-03-23 07:16:05 -06001692 subres_skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1693 HandleToUint64(cb_node->commandBuffer), error_code,
1694 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
1695 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
1696 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001697 }
John Zulauff660ad62019-03-23 07:16:05 -06001698 return !subres_skip;
1699 };
1700 subresource_map->ForRange(normalized_isr, subres_callback);
1701 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001702 }
1703
1704 return skip;
1705}
1706
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001707bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1708 const VkClearColorValue *pColor, uint32_t rangeCount,
1709 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001710 bool skip = false;
1711 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06001712 const auto *cb_node = GetCBState(commandBuffer);
1713 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001714 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001715 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001716 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001717 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001718 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski544def72019-04-19 14:25:59 -06001719 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001720 skip |=
1721 ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
1722 "VUID-vkCmdClearColorImage-image-01993", "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001723 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001724 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001725 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001726 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001727 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001728 skip |= ValidateImageAttributes(image_state, pRanges[i]);
1729 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001730 }
1731 }
1732 return skip;
1733}
1734
John Zulaufeabb4462019-07-05 14:13:03 -06001735void ValidationStateTracker::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image,
1736 VkImageLayout imageLayout, const VkClearColorValue *pColor,
1737 uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06001738 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001739 auto image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001740 if (cb_node && image_state) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001741 AddCommandBufferBindingImage(cb_node, image_state);
John Zulaufeabb4462019-07-05 14:13:03 -06001742 }
1743}
1744
1745void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1746 const VkClearColorValue *pColor, uint32_t rangeCount,
1747 const VkImageSubresourceRange *pRanges) {
1748 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
1749
1750 auto cb_node = GetCBState(commandBuffer);
1751 auto image_state = GetImageState(image);
1752 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001753 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001754 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001755 }
1756 }
1757}
1758
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001759bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1760 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1761 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001762 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001763
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001764 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06001765 const auto *cb_node = GetCBState(commandBuffer);
1766 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001767 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001768 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06001769 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001770 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001771 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001772 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski544def72019-04-19 14:25:59 -06001773 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001774 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
1775 "VUID-vkCmdClearDepthStencilImage-image-01994",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001776 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001777 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001778 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001779 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001780 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001781 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001782 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001783 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001784 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1785 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001786 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001787 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1788 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001789 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 -06001790 HandleToUint64(commandBuffer), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001791 }
1792 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001793 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001794 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001795 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 -06001796 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00014", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001797 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001798 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1799 char const str[] =
1800 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1801 "set.";
1802 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 -06001803 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00009", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001804 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001805 }
1806 return skip;
1807}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001808
John Zulaufeabb4462019-07-05 14:13:03 -06001809void ValidationStateTracker::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image,
1810 VkImageLayout imageLayout,
1811 const VkClearDepthStencilValue *pDepthStencil,
1812 uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06001813 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001814 auto image_state = GetImageState(image);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001815 if (cb_node && image_state) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001816 AddCommandBufferBindingImage(cb_node, image_state);
John Zulaufeabb4462019-07-05 14:13:03 -06001817 }
1818}
1819
1820void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1821 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1822 const VkImageSubresourceRange *pRanges) {
1823 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
1824 auto cb_node = GetCBState(commandBuffer);
1825 auto image_state = GetImageState(image);
1826 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001827 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001828 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001829 }
1830 }
1831}
1832
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001833// Returns true if [x, xoffset] and [y, yoffset] overlap
1834static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1835 bool result = false;
1836 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1837 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1838
1839 if (intersection_max > intersection_min) {
1840 result = true;
1841 }
1842 return result;
1843}
1844
Dave Houltonc991cc92018-03-06 11:08:51 -07001845// Returns true if source area of first copy region intersects dest area of second region
1846// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1847static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001848 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001849
Dave Houltonc991cc92018-03-06 11:08:51 -07001850 // Separate planes within a multiplane image cannot intersect
1851 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07001852 return result;
1853 }
1854
Dave Houltonc991cc92018-03-06 11:08:51 -07001855 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
1856 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
1857 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001858 result = true;
1859 switch (type) {
1860 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001861 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001862 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001863 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001864 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001865 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001866 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001867 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001868 break;
1869 default:
1870 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1871 assert(false);
1872 }
1873 }
1874 return result;
1875}
1876
Dave Houltonfc1a4052017-04-27 14:32:45 -06001877// Returns non-zero if offset and extent exceed image extents
1878static const uint32_t x_bit = 1;
1879static const uint32_t y_bit = 2;
1880static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001881static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001882 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001883 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001884 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1885 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001886 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001887 }
1888 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1889 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001890 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001891 }
1892 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1893 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001894 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001895 }
1896 return result;
1897}
1898
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001899// Test if two VkExtent3D structs are equivalent
1900static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1901 bool result = true;
1902 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1903 (extent->depth != other_extent->depth)) {
1904 result = false;
1905 }
1906 return result;
1907}
1908
Dave Houltonee281a52017-12-08 13:51:02 -07001909// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1910// Destination image texel extents must be adjusted by block size for the dest validation checks
1911VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1912 VkExtent3D adjusted_extent = extent;
1913 if ((FormatIsCompressed(src_format) && (!FormatIsCompressed(dst_format)))) {
Dave Houltona585d132019-01-18 13:05:42 -07001914 VkExtent3D block_size = FormatTexelBlockExtent(src_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001915 adjusted_extent.width /= block_size.width;
1916 adjusted_extent.height /= block_size.height;
1917 adjusted_extent.depth /= block_size.depth;
1918 } else if ((!FormatIsCompressed(src_format) && (FormatIsCompressed(dst_format)))) {
Dave Houltona585d132019-01-18 13:05:42 -07001919 VkExtent3D block_size = FormatTexelBlockExtent(dst_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001920 adjusted_extent.width *= block_size.width;
1921 adjusted_extent.height *= block_size.height;
1922 adjusted_extent.depth *= block_size.depth;
1923 }
1924 return adjusted_extent;
1925}
1926
Dave Houlton6f9059e2017-05-02 17:15:13 -06001927// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001928static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1929 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001930
1931 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06001932 if (mip >= img->createInfo.mipLevels) {
1933 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06001934 }
Dave Houlton1150cf52017-04-27 14:38:11 -06001935
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001936 // 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 -06001937 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05001938
Dave Houltone48cd112019-01-03 17:01:18 -07001939 // If multi-plane, adjust per-plane extent
1940 if (FormatIsMultiplane(img->createInfo.format)) {
1941 VkExtent2D divisors = FindMultiplaneExtentDivisors(img->createInfo.format, subresource->aspectMask);
1942 extent.width /= divisors.width;
1943 extent.height /= divisors.height;
1944 }
1945
Jeff Bolzef40fec2018-09-01 22:04:34 -05001946 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
1947 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
Dave Houlton142c4cb2018-10-17 15:04:41 -06001948 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1) >> mip)));
Jeff Bolzef40fec2018-09-01 22:04:34 -05001949 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
1950 } else {
1951 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1952 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1953 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
1954 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06001955
Dave Houlton6f9059e2017-05-02 17:15:13 -06001956 // Image arrays have an effective z extent that isn't diminished by mip level
1957 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001958 extent.depth = img->createInfo.arrayLayers;
1959 }
1960
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001961 return extent;
1962}
1963
1964// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001965static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001966 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1967}
1968
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001969// Test if the extent argument has any dimensions set to 0.
1970static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1971 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1972}
1973
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001974// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001975VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001976 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1977 VkExtent3D granularity = {0, 0, 0};
Mark Lobodzinskic2a15b02019-04-25 12:06:02 -06001978 auto pPool = GetCommandPoolState(cb_node->createInfo.commandPool);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001979 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001980 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001981 if (FormatIsCompressed(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07001982 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001983 granularity.width *= block_size.width;
1984 granularity.height *= block_size.height;
1985 }
1986 }
1987 return granularity;
1988}
1989
1990// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1991static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1992 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001993 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
1994 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001995 valid = false;
1996 }
1997 return valid;
1998}
1999
2000// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002001bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002002 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002003 bool skip = false;
2004 VkExtent3D offset_extent = {};
2005 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2006 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2007 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002008 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002009 // 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 -07002010 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002011 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 -04002012 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002013 "%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 "
2014 "image transfer granularity is (w=0, h=0, d=0).",
Petr Krausbc7f5442017-05-14 23:43:38 +02002015 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002016 }
2017 } else {
2018 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2019 // integer multiples of the image transfer granularity.
2020 if (IsExtentAligned(&offset_extent, granularity) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002021 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 -04002022 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002023 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2024 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
Petr Krausbc7f5442017-05-14 23:43:38 +02002025 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2026 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002027 }
2028 }
2029 return skip;
2030}
2031
2032// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002033bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002034 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002035 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002036 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002037 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002038 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2039 // subresource extent.
2040 if (IsExtentEqual(extent, subresource_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002041 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 -04002042 HandleToUint64(cb_node->commandBuffer), vuid,
Petr Krausbc7f5442017-05-14 23:43:38 +02002043 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2044 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2045 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2046 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002047 }
2048 } else {
2049 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2050 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2051 // subresource extent dimensions.
2052 VkExtent3D offset_extent_sum = {};
2053 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2054 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2055 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002056 bool x_ok = true;
2057 bool y_ok = true;
2058 bool z_ok = true;
2059 switch (image_type) {
2060 case VK_IMAGE_TYPE_3D:
2061 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2062 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002063 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002064 case VK_IMAGE_TYPE_2D:
2065 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2066 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002067 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002068 case VK_IMAGE_TYPE_1D:
2069 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2070 (subresource_extent->width == offset_extent_sum.width));
2071 break;
2072 default:
2073 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2074 assert(false);
2075 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002076 if (!(x_ok && y_ok && z_ok)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002077 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 -04002078 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002079 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2080 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2081 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2082 function, i, member, extent->width, extent->height, extent->depth, granularity->width,
2083 granularity->height, granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height,
2084 extent->depth, subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002085 }
2086 }
2087 return skip;
2088}
2089
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002090bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002091 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002092 bool skip = false;
2093 if (mip_level >= img->createInfo.mipLevels) {
2094 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2095 HandleToUint64(cb_node->commandBuffer), vuid,
locke-lunarg9edc2812019-06-17 23:18:52 -06002096 "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.", function, i, member, mip_level,
2097 report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002098 }
2099 return skip;
2100}
2101
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002102bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002103 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002104 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002105 bool skip = false;
2106 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2107 (base_layer + layer_count) > img->createInfo.arrayLayers) {
2108 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2109 HandleToUint64(cb_node->commandBuffer), vuid,
2110 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
locke-lunarg9edc2812019-06-17 23:18:52 -06002111 "%u, but provided %s has %u array layers.",
Lockee9aeebf2019-03-03 23:50:08 -07002112 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2113 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002114 }
2115 return skip;
2116}
2117
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002118// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002119bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002120 const VkBufferImageCopy *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002121 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002122 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002123 VkExtent3D granularity = GetScaledItg(cb_node, img);
2124 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002125 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002126 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002127 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002128 return skip;
2129}
2130
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002131// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002132bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002133 const IMAGE_STATE *dst_img, const VkImageCopy *region,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002134 const uint32_t i, const char *function) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002135 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002136 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002137 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
2138 skip |=
2139 CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002140 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002141 const VkExtent3D extent = region->extent;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002142 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
2143 i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002144
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002145 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002146 granularity = GetScaledItg(cb_node, dst_img);
2147 skip |=
2148 CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002149 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002150 const VkExtent3D dest_effective_extent =
2151 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002152 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002153 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002154 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002155 return skip;
2156}
2157
Dave Houlton6f9059e2017-05-02 17:15:13 -06002158// Validate contents of a VkImageCopy struct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002159bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const VkImageCopy *ic_regions, const IMAGE_STATE *src_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002160 const IMAGE_STATE *dst_state) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002161 bool skip = false;
2162
2163 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002164 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002165
2166 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002167 const VkExtent3D src_copy_extent = region.extent;
2168 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002169 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2170
Dave Houlton6f9059e2017-05-02 17:15:13 -06002171 bool slice_override = false;
2172 uint32_t depth_slices = 0;
2173
2174 // Special case for copying between a 1D/2D array and a 3D image
2175 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2176 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002177 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002178 slice_override = (depth_slices != 1);
2179 } 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 -07002180 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002181 slice_override = (depth_slices != 1);
2182 }
2183
2184 // Do all checks on source image
2185 //
2186 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002187 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
2188 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 -06002189 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00146",
Dave Houltonee281a52017-12-08 13:51:02 -07002190 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002191 "be 0 and 1, respectively.",
2192 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002193 }
2194 }
2195
Dave Houlton533be9f2018-03-26 17:08:30 -06002196 // VUID-VkImageCopy-srcImage-01785
2197 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
2198 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 -06002199 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01785",
Dave Houlton533be9f2018-03-26 17:08:30 -06002200 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002201 "these must be 0 and 1, respectively.",
2202 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002203 }
2204
Dave Houlton533be9f2018-03-26 17:08:30 -06002205 // VUID-VkImageCopy-srcImage-01787
2206 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
2207 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 -06002208 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01787",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002209 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2210 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002211 }
2212
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002213 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002214 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002215 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002216 skip |=
2217 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002218 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002219 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002220 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2221 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002222 }
2223 }
2224 } else { // Pre maint 1
2225 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002226 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002227 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 -06002228 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002229 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2230 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002231 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2232 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002233 }
2234 }
2235 }
2236
Dave Houltonc991cc92018-03-06 11:08:51 -07002237 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002238 bool ext_ycbcr = device_extensions.vk_khr_sampler_ycbcr_conversion;
Dave Houltonc991cc92018-03-06 11:08:51 -07002239 if (FormatIsCompressed(src_state->createInfo.format) ||
2240 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002241 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002242 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002243 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2244 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2245 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002246 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002247 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 -07002248 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002249 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002250 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002251 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002252 }
2253
Dave Houlton94a00372017-12-14 15:08:47 -07002254 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002255 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2256 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002257 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002258 skip |=
2259 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002260 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002261 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002262 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002263 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002264 }
2265
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002266 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002267 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2268 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002269 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002270 skip |=
2271 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002272 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002273 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002274 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002275 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002276 }
2277
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002278 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002279 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2280 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002281 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002282 skip |=
2283 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002284 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002285 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002286 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002287 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002288 }
2289 } // Compressed
2290
2291 // Do all checks on dest image
2292 //
2293 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002294 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002295 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 -06002296 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-00152",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002297 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002298 "these must be 0 and 1, respectively.",
2299 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002300 }
2301 }
2302
Dave Houlton533be9f2018-03-26 17:08:30 -06002303 // VUID-VkImageCopy-dstImage-01786
2304 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
2305 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 -06002306 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01786",
Dave Houlton533be9f2018-03-26 17:08:30 -06002307 "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 -06002308 "and 1, respectively.",
2309 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002310 }
2311
2312 // VUID-VkImageCopy-dstImage-01788
2313 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
2314 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 -06002315 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01788",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002316 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2317 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002318 }
2319
2320 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002321 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002322 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 -06002323 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002324 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002325 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2326 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002327 }
2328 }
2329 // VU01199 changed with mnt1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002330 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002331 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002332 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002333 skip |=
2334 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002335 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002336 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002337 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2338 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002339 }
2340 }
2341 } else { // Pre maint 1
2342 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002343 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002344 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 -06002345 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002346 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2347 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002348 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2349 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002350 }
2351 }
2352 }
2353
Dave Houltonc991cc92018-03-06 11:08:51 -07002354 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2355 if (FormatIsCompressed(dst_state->createInfo.format) ||
2356 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002357 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002358
2359 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002360 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2361 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2362 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002363 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002364 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 -07002365 HandleToUint64(dst_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002366 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002367 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002368 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002369 }
2370
Dave Houlton94a00372017-12-14 15:08:47 -07002371 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002372 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2373 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002374 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002375 skip |=
2376 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002377 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002378 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002379 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002380 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002381 }
2382
Dave Houltonee281a52017-12-08 13:51:02 -07002383 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2384 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2385 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002386 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002387 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 -07002388 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002389 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2390 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
Dave Houltonc991cc92018-03-06 11:08:51 -07002391 "height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002392 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002393 }
2394
Dave Houltonee281a52017-12-08 13:51:02 -07002395 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2396 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2397 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002398 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002399 skip |=
2400 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002401 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002402 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002403 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002404 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002405 }
2406 } // Compressed
2407 }
2408 return skip;
2409}
2410
Dave Houltonc991cc92018-03-06 11:08:51 -07002411// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002412bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002413 const IMAGE_STATE *dst_image_state, const VkImageCopy region) const {
Dave Houltonc991cc92018-03-06 11:08:51 -07002414 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002415
2416 // Neither image is multiplane
2417 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2418 // If neither image is multi-plane the aspectMask member of src and dst must match
2419 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2420 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002421 ss << "vkCmdCopyImage(): Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002422 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
2423 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 -06002424 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002425 }
2426 } else {
2427 // Source image multiplane checks
2428 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2429 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2430 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2431 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002432 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002433 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 -06002434 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002435 }
2436 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2437 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2438 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002439 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002440 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 -06002441 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002442 }
2443 // Single-plane to multi-plane
2444 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2445 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2446 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002447 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002448 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 -06002449 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002450 }
2451
2452 // Dest image multiplane checks
2453 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2454 aspect = region.dstSubresource.aspectMask;
2455 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2456 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002457 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002458 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 -06002459 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002460 }
2461 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2462 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2463 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002464 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002465 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 -06002466 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002467 }
2468 // Multi-plane to single-plane
2469 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2470 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2471 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002472 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002473 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 -06002474 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002475 }
2476 }
2477
2478 return skip;
2479}
2480
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002481bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2482 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2483 const VkImageCopy *pRegions) {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002484 const auto *cb_node = GetCBState(commandBuffer);
2485 const auto *src_image_state = GetImageState(srcImage);
2486 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002487 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002488
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002489 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002490
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002491 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2492
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002493 for (uint32_t i = 0; i < regionCount; i++) {
2494 const VkImageCopy region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002495
2496 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2497 VkExtent3D src_copy_extent = region.extent;
2498 VkExtent3D dst_copy_extent =
2499 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
2500
Dave Houlton6f9059e2017-05-02 17:15:13 -06002501 bool slice_override = false;
2502 uint32_t depth_slices = 0;
2503
2504 // Special case for copying between a 1D/2D array and a 3D image
2505 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2506 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2507 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002508 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002509 slice_override = (depth_slices != 1);
2510 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2511 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002512 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002513 slice_override = (depth_slices != 1);
2514 }
2515
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002516 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2517 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
2518 skip |= ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002519 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002520 skip |= ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002521 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002522 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002523 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2524 "VUID-vkCmdCopyImage-srcSubresource-01698");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002525 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002526 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2527 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002528
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002529 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002530 // No chance of mismatch if we're overriding depth slice count
2531 if (!slice_override) {
2532 // The number of depth slices in srcSubresource and dstSubresource must match
2533 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2534 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002535 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2536 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002537 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002538 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2539 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002540 if (src_slices != dst_slices) {
2541 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002542 ss << "vkCmdCopyImage(): number of depth slices in source and destination subresources for pRegions[" << i
Dave Houlton6f9059e2017-05-02 17:15:13 -06002543 << "] do not match";
2544 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 -06002545 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06002546 }
2547 }
2548 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002549 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002550 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002551 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002552 ss << "vkCmdCopyImage(): number of layers in source and destination subresources for pRegions[" << i
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002553 << "] do not match";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002554 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 -06002555 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002556 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002557 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002558
Dave Houltonc991cc92018-03-06 11:08:51 -07002559 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002560 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002561 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region);
Dave Houltonc991cc92018-03-06 11:08:51 -07002562 }
2563
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002564 if (!device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002565 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2566 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002567 char const str[] = "vkCmdCopyImage(): Src and dest aspectMasks for each region must match";
Dave Houltonf5217612018-02-02 16:18:52 -07002568 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 -06002569 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002570 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002571 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002572
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002573 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07002574 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002575 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002576 ss << "vkCmdCopyImage(): pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002577 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
2578 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 -06002579 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002580 }
2581
2582 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07002583 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002584 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002585 ss << "vkCmdCopyImage(): pRegion[" << i
2586 << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002587 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 -06002588 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002589 }
2590
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002591 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
2592 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
2593 // 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 -07002594 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2595 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002596 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002597 ss << "vkCmdCopyImage(): Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002598 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
2599 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
2600 << " ] exceeds the source image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002601 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 -06002602 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00122", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002603 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002604
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002605 // 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 -07002606 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2607 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002608 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002609 ss << "vkCmdCopyImage(): Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002610 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
2611 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
2612 << " ] exceeds the destination image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002613 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 -06002614 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00123", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002615 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002616 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002617
Dave Houltonfc1a4052017-04-27 14:32:45 -06002618 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002619 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2620 if (slice_override) src_copy_extent.depth = depth_slices;
2621 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002622 if (extent_check & x_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002623 skip |=
2624 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2625 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00144",
2626 "vkCmdCopyImage(): Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2627 "width [%1d].",
2628 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002629 }
2630
2631 if (extent_check & y_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002632 skip |=
2633 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2634 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00145",
2635 "vkCmdCopyImage(): Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2636 "height [%1d].",
2637 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002638 }
2639 if (extent_check & z_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002640 skip |=
2641 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2642 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00147",
2643 "vkCmdCopyImage(): Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2644 "depth [%1d].",
2645 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002646 }
2647
Dave Houltonee281a52017-12-08 13:51:02 -07002648 // Adjust dest extent if necessary
2649 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2650 if (slice_override) dst_copy_extent.depth = depth_slices;
2651
2652 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002653 if (extent_check & x_bit) {
2654 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 -06002655 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00150",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002656 "vkCmdCopyImage(): Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002657 "width [%1d].",
2658 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002659 }
2660 if (extent_check & y_bit) {
2661 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 -06002662 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00151",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002663 "vkCmdCopyImage(): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002664 "height [%1d].",
2665 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002666 }
2667 if (extent_check & z_bit) {
2668 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 -06002669 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00153",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002670 "vkCmdCopyImage(): Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002671 "depth [%1d].",
2672 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002673 }
2674
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002675 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2676 // must not overlap in memory
2677 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002678 for (uint32_t j = 0; j < regionCount; j++) {
2679 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
Dave Houltonf5217612018-02-02 16:18:52 -07002680 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002681 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002682 ss << "vkCmdCopyImage(): pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002683 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 -06002684 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002685 }
2686 }
2687 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002688 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002689
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002690 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2691 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2692 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002693 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002694 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2695 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02002696 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 -06002697 HandleToUint64(command_buffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002698 }
2699 } else {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002700 if (!FormatSizesAreEqual(src_image_state->createInfo.format, dst_image_state->createInfo.format, regionCount, pRegions)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002701 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
2702 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 -06002703 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00135", "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002704 }
2705 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002706
Dave Houlton33c22b72017-02-28 13:16:02 -07002707 // Source and dest image sample counts must match
2708 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2709 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
2710 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 -06002711 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002712 }
2713
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002714 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2715 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002716 // Validate that SRC & DST images have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002717 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyImage-srcImage-00126",
2718 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2719 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyImage-dstImage-00131",
2720 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06002721 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002722 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
2723 "VUID-vkCmdCopyImage-srcImage-01995", "VUID-vkCmdCopyImage-srcImage-01995");
2724 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
2725 "VUID-vkCmdCopyImage-dstImage-01996", "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002726 }
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002727 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyImage()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002728 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002729 skip |= ValidateCmd(cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
2730 skip |= InsideRenderPass(cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002731 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002732 const char *invalid_src_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2733 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2734 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
2735 const char *invalid_dst_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2736 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2737 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002738 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002739 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002740 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2741 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002742 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002743 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2744 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002745 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
2746 "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002747 }
2748
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002749 return skip;
2750}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002751
John Zulauf8f6d4ee2019-07-05 16:31:57 -06002752void ValidationStateTracker::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage,
2753 VkImageLayout srcImageLayout, VkImage dstImage, VkImageLayout dstImageLayout,
2754 uint32_t regionCount, const VkImageCopy *pRegions) {
2755 auto cb_node = GetCBState(commandBuffer);
2756 auto src_image_state = GetImageState(srcImage);
2757 auto dst_image_state = GetImageState(dstImage);
2758
2759 // Update bindings between images and cmd buffer
2760 AddCommandBufferBindingImage(cb_node, src_image_state);
2761 AddCommandBufferBindingImage(cb_node, dst_image_state);
2762}
2763
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002764void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2765 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2766 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06002767 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
2768 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06002769 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002770 auto src_image_state = GetImageState(srcImage);
2771 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002772
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002773 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002774 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002775 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
2776 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002777 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002778}
2779
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002780// Returns true if sub_rect is entirely contained within rect
2781static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2782 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2783 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2784 return false;
2785 return true;
2786}
2787
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002788bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002789 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
2790 const VkRect2D &render_area, uint32_t rect_count,
2791 const VkClearRect *clear_rects) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07002792 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07002793 const IMAGE_VIEW_STATE *image_view_state = nullptr;
2794 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07002795 image_view_state = GetImageViewState(framebuffer->createInfo.pAttachments[fb_attachment]);
John Zulauff2582972019-02-09 14:53:30 -07002796 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002797
2798 for (uint32_t j = 0; j < rect_count; j++) {
2799 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002800 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 -07002801 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00016",
2802 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2803 "the current render pass instance.",
2804 j);
2805 }
2806
2807 if (image_view_state) {
2808 // The layers specified by a given element of pRects must be contained within every attachment that
2809 // pAttachments refers to
2810 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
2811 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
2812 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002813 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2814 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00017",
2815 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
2816 "of pAttachment[%d].",
2817 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07002818 }
2819 }
2820 }
2821 return skip;
2822}
2823
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002824bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2825 const VkClearAttachment *pAttachments, uint32_t rectCount,
2826 const VkClearRect *pRects) {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002827 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06002828 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02002829 if (!cb_node) return skip;
2830
2831 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
2832 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
2833 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
2834 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
2835 if (!cb_node->hasDrawCmd && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
2836 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
2837 // There are times where app needs to use ClearAttachments (generally when reusing a buffer inside of a render pass)
2838 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
2839 // CmdClearAttachments.
2840 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Lockee9aeebf2019-03-03 23:50:08 -07002841 HandleToUint64(commandBuffer), kVUID_Core_DrawState_ClearCmdBeforeDraw,
locke-lunarg9edc2812019-06-17 23:18:52 -06002842 "vkCmdClearAttachments() issued on %s prior to any Draw Cmds. It is recommended you "
Lockee9aeebf2019-03-03 23:50:08 -07002843 "use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
2844 report_data->FormatHandle(commandBuffer).c_str());
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002845 }
Petr Kraus2dffb382019-08-10 02:52:12 +02002846 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002847
2848 // Validate that attachment is in reference list of active subpass
2849 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002850 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07002851 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01002852 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002853 const auto *framebuffer = GetFramebufferState(cb_node->activeFramebuffer);
John Zulauf3a548ef2019-02-01 16:14:07 -07002854 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002855
John Zulauf3a548ef2019-02-01 16:14:07 -07002856 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2857 auto clear_desc = &pAttachments[attachment_index];
2858 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002859
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002860 if (0 == clear_desc->aspectMask) {
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(commandBuffer), "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002863 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2864 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 -06002865 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002866 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07002867 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
2868 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
2869 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2870 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
locke-lunarg9edc2812019-06-17 23:18:52 -06002871 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2872 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
2873 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
2874 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
2875 attachment_index, clear_desc->colorAttachment,
2876 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
2877 cb_node->activeSubpass, clear_desc->colorAttachment, color_attachment,
2878 renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07002879
John Zulauff2582972019-02-09 14:53:30 -07002880 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
2881 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002882 } else {
Lockee9aeebf2019-03-03 23:50:08 -07002883 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2884 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
locke-lunarg9edc2812019-06-17 23:18:52 -06002885 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
Lockee9aeebf2019-03-03 23:50:08 -07002886 " subpass %u. colorAttachmentCount=%u",
2887 attachment_index, clear_desc->colorAttachment,
2888 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
2889 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002890 }
John Zulauff2582972019-02-09 14:53:30 -07002891 fb_attachment = color_attachment;
2892
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002893 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2894 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2895 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002896 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
John Zulauf3a548ef2019-02-01 16:14:07 -07002897 skip |=
2898 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2899 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002900 }
2901 } else { // Must be depth and/or stencil
2902 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2903 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002904 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002905 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 -07002906 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-parameter", str,
2907 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002908 }
2909 if (!subpass_desc->pDepthStencilAttachment ||
2910 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
2911 skip |= log_msg(
2912 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002913 HandleToUint64(commandBuffer), kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002914 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002915 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07002916 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002917 }
2918 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002919 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002920 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
2921 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06002922 }
2923 }
2924 }
2925 return skip;
2926}
2927
2928void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2929 const VkClearAttachment *pAttachments, uint32_t rectCount,
2930 const VkClearRect *pRects) {
2931 auto *cb_node = GetCBState(commandBuffer);
2932 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
2933 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
2934 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
2935 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
2936 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2937 const auto clear_desc = &pAttachments[attachment_index];
2938 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
2939 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
2940 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
2941 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2942 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
2943 subpass_desc->pDepthStencilAttachment) {
2944 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
2945 }
2946 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07002947 if (!clear_rect_copy) {
2948 // We need a copy of the clear rectangles that will persist until the last lambda executes
2949 // but we want to create it as lazily as possible
2950 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002951 }
John Zulauf441558b2019-08-12 11:47:39 -06002952 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
2953 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002954 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
John Zulauff1640d12019-08-13 15:39:58 -06002955 const CMD_BUFFER_STATE *prim_cb, VkFramebuffer fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07002956 assert(rectCount == clear_rect_copy->size());
John Zulauf441558b2019-08-12 11:47:39 -06002957 const FRAMEBUFFER_STATE *framebuffer = GetFramebufferState(fb);
John Zulauf3a548ef2019-02-01 16:14:07 -07002958 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
2959 bool skip = false;
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002960 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
2961 rectCount, clear_rect_copy->data());
John Zulauf3a548ef2019-02-01 16:14:07 -07002962 return skip;
2963 };
2964 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002965 }
2966 }
2967 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002968}
2969
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002970bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2971 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2972 const VkImageResolve *pRegions) {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002973 const auto *cb_node = GetCBState(commandBuffer);
2974 const auto *src_image_state = GetImageState(srcImage);
2975 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002976
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002977 bool skip = false;
2978 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002979 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-srcImage-00256");
2980 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-00258");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002981 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002982 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002983 skip |= ValidateCmd(cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
2984 skip |= InsideRenderPass(cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002985 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, "vkCmdResolveImage()",
2986 "VUID-vkCmdResolveImage-dstImage-02003", "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002987
Cort Stratton7df30962018-05-17 19:45:57 -07002988 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002989 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002990 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002991 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
2992 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
2993 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002994 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002995 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
2996 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002997 // For each region, the number of layers in the image subresource should not be zero
2998 // For each region, src and dest image aspect must be color only
2999 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003000 skip |=
3001 ValidateImageSubresourceLayers(cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()", "srcSubresource", i);
3002 skip |=
3003 ValidateImageSubresourceLayers(cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()", "dstSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003004 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003005 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
3006 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003007 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003008 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
3009 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003010 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i, "vkCmdResolveImage()",
3011 "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
3012 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i, "vkCmdResolveImage()",
3013 "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
3014 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003015 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
3016 "VUID-vkCmdResolveImage-srcSubresource-01711");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003017 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003018 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
3019 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07003020
3021 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003022 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
3023 skip |= log_msg(
3024 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003025 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-layerCount-00267",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003026 "vkCmdResolveImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003027 }
Cort Stratton7df30962018-05-17 19:45:57 -07003028 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003029 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3030 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
3031 char const str[] =
Graeme Leese79b60cb2018-11-28 11:51:20 +00003032 "vkCmdResolveImage(): src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003033 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 -06003034 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003035 }
3036 }
3037
3038 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
3039 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003040 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 -06003041 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003042 }
3043 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
3044 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003045 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 -06003046 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageType, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003047 }
3048 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
3049 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
3050 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 -06003051 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-srcImage-00257", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003052 }
3053 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
3054 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
3055 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 -06003056 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-dstImage-00259", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003057 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003058 } else {
3059 assert(0);
3060 }
3061 return skip;
3062}
3063
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003064void ValidationStateTracker::PreCallRecordCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage,
3065 VkImageLayout srcImageLayout, VkImage dstImage,
3066 VkImageLayout dstImageLayout, uint32_t regionCount,
3067 const VkImageResolve *pRegions) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003068 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003069 auto src_image_state = GetImageState(srcImage);
3070 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003071
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003072 // Update bindings between images and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003073 AddCommandBufferBindingImage(cb_node, src_image_state);
3074 AddCommandBufferBindingImage(cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003075}
3076
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003077bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3078 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3079 const VkImageBlit *pRegions, VkFilter filter) {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003080 const auto *cb_node = GetCBState(commandBuffer);
3081 const auto *src_image_state = GetImageState(srcImage);
3082 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003083
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003084 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003085 if (cb_node) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003086 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
John Zulauf5c2750c2018-01-30 15:04:56 -07003087 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003088 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003089 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003090 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003091 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003092 "VUID-vkCmdBlitImage-dstImage-00234");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003093 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
3094 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
Dave Houltond8ed0212018-05-16 17:18:24 -06003095 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003096 ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdBlitImage-srcImage-00219",
3097 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06003098 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003099 ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdBlitImage-dstImage-00224",
3100 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003101 skip |=
3102 ValidateCmdQueueFlags(cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003103 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
3104 skip |= InsideRenderPass(cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003105 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003106 "VUID-vkCmdBlitImage-srcImage-01999", "VUID-vkCmdBlitImage-srcImage-01999");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003107 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003108 "VUID-vkCmdBlitImage-dstImage-02000", "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04003109
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003110 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003111
Dave Houlton33c2d252017-06-09 17:08:32 -06003112 VkFormat src_format = src_image_state->createInfo.format;
3113 VkFormat dst_format = dst_image_state->createInfo.format;
3114 VkImageType src_type = src_image_state->createInfo.imageType;
3115 VkImageType dst_type = dst_image_state->createInfo.imageType;
3116
Cort Stratton186b1a22018-05-01 20:18:06 -04003117 if (VK_FILTER_LINEAR == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003118 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003119 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001",
3120 "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04003121 } else if (VK_FILTER_CUBIC_IMG == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003122 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
3123 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02002",
3124 "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06003125 }
3126
3127 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
3128 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 -06003129 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-filter-00237",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003130 "vkCmdBlitImage(): source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003131 }
3132
Dave Houlton33c2d252017-06-09 17:08:32 -06003133 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
3134 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
3135 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 -06003136 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00228",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003137 "vkCmdBlitImage(): source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003138 }
3139
3140 // Validate consistency for unsigned formats
3141 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3142 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003143 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003144 << "the other one must also have unsigned integer format. "
3145 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3146 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 -06003147 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003148 }
3149
3150 // Validate consistency for signed formats
3151 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3152 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003153 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003154 << "the other one must also have signed integer format. "
3155 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3156 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 -06003157 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003158 }
3159
3160 // Validate filter for Depth/Stencil formats
3161 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3162 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003163 ss << "vkCmdBlitImage(): If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003164 << "then filter must be VK_FILTER_NEAREST.";
3165 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 -06003166 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003167 }
3168
3169 // Validate aspect bits and formats for depth/stencil images
3170 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3171 if (src_format != dst_format) {
3172 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003173 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003174 << "stencil, the other one must have exactly the same format. "
3175 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3176 << string_VkFormat(dst_format);
Dave Houltond8ed0212018-05-16 17:18:24 -06003177 skip |=
3178 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3179 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003180 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003181 } // Depth or Stencil
3182
3183 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003184 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003185 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003186 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3187 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3188 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003189 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003190 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3191 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003192 for (uint32_t i = 0; i < regionCount; i++) {
3193 const VkImageBlit rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003194 bool hit_error = false;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003195 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003196 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3197 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003198 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003199 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3200 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003201 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3202 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
3203 skip |= ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003204 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003205 skip |= ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003206 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003207 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003208 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3209 "VUID-vkCmdBlitImage-srcSubresource-01707");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003210 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003211 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3212 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003213 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003214 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3215 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003216 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003217 ss << "vkCmdBlitImage(): pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003218 skip |=
3219 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3220 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003221 }
Dave Houlton48989f32017-05-26 15:01:46 -06003222 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3223 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003224 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003225 ss << "vkCmdBlitImage(): pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003226 skip |=
3227 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3228 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003229 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003230
3231 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003232 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003233 skip |= log_msg(
3234 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3235 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-layerCount-00239",
3236 "vkCmdBlitImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003237 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003238
Dave Houlton48989f32017-05-26 15:01:46 -06003239 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003240 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 -06003241 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00238",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003242 "vkCmdBlitImage(): aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003243 }
Dave Houlton48989f32017-05-26 15:01:46 -06003244
Dave Houlton33c2d252017-06-09 17:08:32 -06003245 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
3246 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 -06003247 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00241",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003248 "vkCmdBlitImage(): region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003249 "image format %s.",
3250 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003251 }
3252
3253 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
3254 skip |= log_msg(
3255 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003256 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00242",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003257 "vkCmdBlitImage(): region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3258 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003259 }
3260
Dave Houlton48989f32017-05-26 15:01:46 -06003261 // Validate source image offsets
3262 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003263 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003264 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003265 skip |=
3266 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3267 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00245",
3268 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3269 "of (%1d, %1d). These must be (0, 1).",
3270 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003271 }
3272 }
3273
Dave Houlton33c2d252017-06-09 17:08:32 -06003274 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003275 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
3276 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 -06003277 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00247",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003278 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003279 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3280 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003281 }
3282 }
3283
Dave Houlton33c2d252017-06-09 17:08:32 -06003284 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003285 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3286 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003287 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003288 skip |= log_msg(
3289 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3290 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00243",
3291 "vkCmdBlitImage(): region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).", i,
3292 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003293 }
3294 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3295 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003296 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003297 skip |= log_msg(
3298 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003299 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00244",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003300 "vkCmdBlitImage(): region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003301 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003302 }
3303 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3304 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003305 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003306 skip |= log_msg(
3307 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3308 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00246",
3309 "vkCmdBlitImage(): region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).", i,
3310 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003311 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003312 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003313 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 -06003314 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00215",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003315 "vkCmdBlitImage(): region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003316 }
Dave Houlton48989f32017-05-26 15:01:46 -06003317
3318 // Validate dest image offsets
3319 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003320 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003321 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003322 skip |=
3323 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3324 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00250",
3325 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3326 "(%1d, %1d). These must be (0, 1).",
3327 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003328 }
3329 }
3330
Dave Houlton33c2d252017-06-09 17:08:32 -06003331 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003332 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
3333 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 -06003334 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00252",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003335 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003336 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3337 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003338 }
3339 }
3340
Dave Houlton33c2d252017-06-09 17:08:32 -06003341 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003342 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3343 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003344 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003345 skip |= log_msg(
3346 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3347 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00248",
3348 "vkCmdBlitImage(): region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).", i,
3349 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003350 }
3351 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3352 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003353 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003354 skip |= log_msg(
3355 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003356 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00249",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003357 "vkCmdBlitImage(): region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003358 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003359 }
3360 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3361 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003362 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003363 skip |= log_msg(
3364 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3365 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00251",
3366 "vkCmdBlitImage(): region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).", i,
3367 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003368 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003369 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003370 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 -06003371 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00216",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003372 "vkCmdBlitImage(): region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003373 }
3374
Dave Houlton33c2d252017-06-09 17:08:32 -06003375 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3376 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3377 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003378 skip |=
3379 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3380 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00240",
3381 "vkCmdBlitImage(): region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3382 "layerCount other than 1.",
3383 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003384 }
3385 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003386 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003387 } else {
3388 assert(0);
3389 }
3390 return skip;
3391}
3392
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003393void ValidationStateTracker::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage,
3394 VkImageLayout srcImageLayout, VkImage dstImage, VkImageLayout dstImageLayout,
3395 uint32_t regionCount, const VkImageBlit *pRegions, VkFilter filter) {
3396 auto cb_node = GetCBState(commandBuffer);
3397 auto src_image_state = GetImageState(srcImage);
3398 auto dst_image_state = GetImageState(dstImage);
3399
3400 // Update bindings between images and cmd buffer
3401 AddCommandBufferBindingImage(cb_node, src_image_state);
3402 AddCommandBufferBindingImage(cb_node, dst_image_state);
3403}
3404
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003405void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3406 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3407 const VkImageBlit *pRegions, VkFilter filter) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003408 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3409 pRegions, filter);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003410 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003411 auto src_image_state = GetImageState(srcImage);
3412 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003413
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003414 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003415 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003416 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3417 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003418 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003419}
3420
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003421// 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 -06003422bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const ImageSubresPairLayoutMap &globalImageLayoutMap,
3423 ImageSubresPairLayoutMap *overlayLayoutMap_arg) const {
Matthew Ruschd7ef5482019-07-16 22:01:54 -07003424 if (disabled.image_layout_validation) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003425 bool skip = false;
John Zulauf3b04ebd2019-07-18 14:08:11 -06003426 ImageSubresPairLayoutMap &overlayLayoutMap = *overlayLayoutMap_arg;
John Zulauff660ad62019-03-23 07:16:05 -06003427 // Iterate over the layout maps for each referenced image
3428 for (const auto &layout_map_entry : pCB->image_layout_map) {
3429 const auto image = layout_map_entry.first;
3430 const auto *image_state = GetImageState(image);
3431 if (!image_state) continue; // Can't check layouts of a dead image
locke-lunargadbb54c2019-06-26 00:05:17 -06003432 auto subres_map = layout_map_entry.second.get();
John Zulauff660ad62019-03-23 07:16:05 -06003433 ImageSubresourcePair isr_pair;
3434 isr_pair.image = image;
3435 isr_pair.hasSubresource = true;
Tony Barbourdf013b92017-01-25 12:53:48 -07003436
locke-lunargadbb54c2019-06-26 00:05:17 -06003437 std::string bind_swapchain_msg = "";
3438 if (image_state->bind_swapchain) {
3439 auto swapchain_node = GetSwapchainState(image_state->bind_swapchain);
3440 const auto swapchain_image = swapchain_node->images[image_state->bind_swapchain_imageIndex];
3441 isr_pair.image = swapchain_image;
3442
3443 string_sprintf(&bind_swapchain_msg, "bind %s imageIndex %d (%s)",
3444 report_data->FormatHandle(image_state->bind_swapchain).c_str(), image_state->bind_swapchain_imageIndex,
3445 report_data->FormatHandle(swapchain_image).c_str());
3446 }
3447
John Zulauff660ad62019-03-23 07:16:05 -06003448 // Validate the initial_uses for each subresource referenced
3449 for (auto it_init = subres_map->BeginInitialUse(); !it_init.AtEnd(); ++it_init) {
3450 isr_pair.subresource = (*it_init).subresource;
3451 VkImageLayout initial_layout = (*it_init).layout;
3452 VkImageLayout image_layout;
3453 if (FindLayout(overlayLayoutMap, isr_pair, image_layout) || FindLayout(globalImageLayoutMap, isr_pair, image_layout)) {
3454 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
3455 // TODO: Set memory invalid which is in mem_tracker currently
3456 } else if (image_layout != initial_layout) {
John Zulaufb61ed972019-04-09 16:12:35 -06003457 // Need to look up the inital layout *state* to get a bit more information
3458 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(isr_pair.subresource);
3459 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
3460 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
3461 if (!matches) {
3462 std::string formatted_label = FormatDebugLabel(" ", pCB->debug_label);
locke-lunargadbb54c2019-06-26 00:05:17 -06003463 skip |= log_msg(
3464 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3465 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
3466 "Submitted command buffer expects %s %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
3467 "to be in layout %s--instead, current layout is %s.%s",
3468 report_data->FormatHandle(image).c_str(), bind_swapchain_msg.c_str(), isr_pair.subresource.aspectMask,
3469 isr_pair.subresource.arrayLayer, isr_pair.subresource.mipLevel, string_VkImageLayout(initial_layout),
3470 string_VkImageLayout(image_layout), formatted_label.c_str());
John Zulaufb61ed972019-04-09 16:12:35 -06003471 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003472 }
3473 }
John Zulauff660ad62019-03-23 07:16:05 -06003474 }
3475
3476 // Update all layout set operations (which will be a subset of the initial_layouts
3477 for (auto it_set = subres_map->BeginSetLayout(); !it_set.AtEnd(); ++it_set) {
3478 VkImageLayout layout = (*it_set).layout;
3479 isr_pair.subresource = (*it_set).subresource;
3480 SetLayout(overlayLayoutMap, isr_pair, layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003481 }
3482 }
John Zulauff660ad62019-03-23 07:16:05 -06003483
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003484 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003485}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003486
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003487void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06003488 for (const auto &layout_map_entry : pCB->image_layout_map) {
3489 const auto image = layout_map_entry.first;
3490 const auto *image_state = GetImageState(image);
3491 if (!image_state) continue; // Can't set layouts of a dead image
3492 const auto &subres_map = layout_map_entry.second;
3493 ImageSubresourcePair isr_pair;
3494 isr_pair.image = image;
3495 isr_pair.hasSubresource = true;
3496
3497 // Update all layout set operations (which will be a subset of the initial_layouts
3498 for (auto it_set = subres_map->BeginSetLayout(); !it_set.AtEnd(); ++it_set) {
3499 VkImageLayout layout = (*it_set).layout;
3500 isr_pair.subresource = (*it_set).subresource;
3501 SetGlobalLayout(isr_pair, layout);
3502 }
Tony Barbourdf013b92017-01-25 12:53:48 -07003503 }
3504}
3505
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003506// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003507// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3508// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003509bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3510 const VkImageLayout first_layout, const uint32_t attachment,
John Zulauf9d2b6382019-07-25 15:21:36 -06003511 const VkAttachmentDescription2KHR &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003512 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003513 const char *vuid;
3514 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3515
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003516 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
3517 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003518 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3519 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3520 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003521 skip |=
Shannon McPherson3ea65132018-12-05 10:37:39 -07003522 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3523 "VUID-VkRenderPassCreateInfo2KHR-pAttachments-02522",
3524 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
3525 } else if (!use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3526 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
3527 skip |=
3528 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3529 "VUID-VkRenderPassCreateInfo-pAttachments-00836",
Dave Houltond8ed0212018-05-16 17:18:24 -06003530 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003531 }
3532 }
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003533 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3534 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003535 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01566";
Dave Houltond8ed0212018-05-16 17:18:24 -06003536 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003537 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 -06003538 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003539 }
3540 }
3541
3542 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3543 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003544 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01567";
Dave Houltond8ed0212018-05-16 17:18:24 -06003545 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003546 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 -06003547 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003548 }
3549 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003550 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003551}
3552
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003553bool CoreChecks::ValidateLayouts(RenderPassCreateVersion rp_version, VkDevice device,
John Zulauf9d2b6382019-07-25 15:21:36 -06003554 const VkRenderPassCreateInfo2KHR *pCreateInfo) const {
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003555 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003556 const char *vuid;
3557 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3558 const char *const function_name = use_rp2 ? "vkCreateRenderPass2KHR()" : "vkCreateRenderPass()";
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003559
Jason Ekstranda1906302017-12-03 20:16:32 -08003560 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3561 VkFormat format = pCreateInfo->pAttachments[i].format;
3562 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3563 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3564 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003565 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 -06003566 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003567 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
3568 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3569 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3570 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003571 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003572 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003573 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 -06003574 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003575 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3576 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3577 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3578 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003579 }
3580 }
3581 }
3582
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003583 // Track when we're observing the first use of an attachment
3584 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3585 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003586 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003587
3588 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3589 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3590 auto attach_index = subpass.pInputAttachments[j].attachment;
3591 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003592 switch (subpass.pInputAttachments[j].layout) {
3593 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3594 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3595 // These are ideal.
3596 break;
3597
3598 case VK_IMAGE_LAYOUT_GENERAL:
3599 // May not be optimal. TODO: reconsider this warning based on other constraints.
3600 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003601 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003602 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
3603 break;
3604
Tobias Hectorbbb12282018-10-22 15:17:59 +01003605 case VK_IMAGE_LAYOUT_UNDEFINED:
3606 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3607 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3608 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3609 "Layout for input attachment reference %u in subpass %u is %s but must be "
3610 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
Petr Kraus123ba9d2019-08-10 03:01:41 +02003611 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003612 break;
3613
Graeme Leese668a9862018-10-08 10:40:02 +01003614 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3615 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003616 if (device_extensions.vk_khr_maintenance2) {
Graeme Leese668a9862018-10-08 10:40:02 +01003617 break;
3618 } else {
3619 // Intentionally fall through to generic error message
3620 }
3621 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003622
Cort Stratton7547f772017-05-04 15:18:52 -07003623 default:
3624 // No other layouts are acceptable
3625 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 -06003626 kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003627 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3628 string_VkImageLayout(subpass.pInputAttachments[j].layout));
3629 }
3630
Cort Stratton7547f772017-05-04 15:18:52 -07003631 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003632 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3633 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003634
3635 bool used_as_depth =
3636 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3637 bool used_as_color = false;
3638 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3639 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3640 }
3641 if (!used_as_depth && !used_as_color &&
3642 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003643 vuid = use_rp2 ? "VUID-VkSubpassDescription2KHR-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
3644 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3645 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
3646 function_name, attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07003647 }
3648 }
3649 attach_first_use[attach_index] = false;
3650 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003651
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003652 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3653 auto attach_index = subpass.pColorAttachments[j].attachment;
3654 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3655
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003656 // TODO: Need a way to validate shared presentable images here, currently just allowing
3657 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3658 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003659 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003660 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003661 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003662 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3663 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003664 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003665
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003666 case VK_IMAGE_LAYOUT_GENERAL:
3667 // May not be optimal; TODO: reconsider this warning based on other constraints?
3668 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003669 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003670 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
3671 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003672
Tobias Hectorbbb12282018-10-22 15:17:59 +01003673 case VK_IMAGE_LAYOUT_UNDEFINED:
3674 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3675 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3676 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3677 "Layout for color attachment reference %u in subpass %u is %s but should be "
3678 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3679 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3680 break;
3681
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003682 default:
3683 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 -06003684 kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003685 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3686 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003687 }
3688
John Zulauf4eee2692019-02-09 16:14:25 -07003689 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].attachment != VK_ATTACHMENT_UNUSED) &&
3690 (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
3691 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003692 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3693 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 -07003694 "Layout for resolve attachment reference %u in subpass %u is %s but should be "
Tobias Hectorbbb12282018-10-22 15:17:59 +01003695 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
John Zulauff0f8c2b2019-02-14 12:13:44 -07003696 j, i, string_VkImageLayout(subpass.pResolveAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003697 }
3698
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003699 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003700 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
3701 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003702 }
3703 attach_first_use[attach_index] = false;
3704 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003705
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003706 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3707 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003708 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3709 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3710 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003711 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003712
Dave Houltona9df0ce2018-02-07 10:51:23 -07003713 case VK_IMAGE_LAYOUT_GENERAL:
3714 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3715 // doing a bunch of transitions.
3716 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003717 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003718 "GENERAL layout for depth attachment may not give optimal performance.");
3719 break;
3720
Tobias Hectorbbb12282018-10-22 15:17:59 +01003721 case VK_IMAGE_LAYOUT_UNDEFINED:
3722 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3723 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3724 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3725 "Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
3726 "layout or GENERAL.",
3727 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3728 break;
3729
Dave Houltona9df0ce2018-02-07 10:51:23 -07003730 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3731 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003732 if (device_extensions.vk_khr_maintenance2) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003733 break;
3734 } else {
3735 // Intentionally fall through to generic error message
3736 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06003737 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003738
Dave Houltona9df0ce2018-02-07 10:51:23 -07003739 default:
3740 // No other layouts are acceptable
3741 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 -06003742 kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003743 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3744 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
3745 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003746 }
3747
3748 auto attach_index = subpass.pDepthStencilAttachment->attachment;
3749 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003750 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
3751 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003752 }
3753 attach_first_use[attach_index] = false;
3754 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003755 }
3756 return skip;
3757}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003758
Mark Lobodzinski96210742017-02-09 10:33:46 -07003759// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
3760// is true, verify that (actual & desired) flags == desired
John Zulauf4fea6622019-04-01 11:38:18 -06003761bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const VulkanTypedHandle &typed_handle,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003762 const char *msgCode, char const *func_name, char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003763 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003764 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06003765 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003766 if (strict) {
3767 correct_usage = ((actual & desired) == desired);
3768 } else {
3769 correct_usage = ((actual & desired) != 0);
3770 }
3771 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06003772 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06003773 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
John Zulauf4fea6622019-04-01 11:38:18 -06003774 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[typed_handle.type],
3775 typed_handle.handle, kVUID_Core_MemTrack_InvalidUsageFlag,
locke-lunarg9edc2812019-06-17 23:18:52 -06003776 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
3777 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003778 } else {
John Zulauf4fea6622019-04-01 11:38:18 -06003779 skip =
3780 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 -06003781 msgCode, "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
3782 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003783 }
3784 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003785 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003786}
3787
3788// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3789// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003790bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003791 char const *func_name, char const *usage_string) const {
John Zulauf4fea6622019-04-01 11:38:18 -06003792 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict,
3793 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003794}
3795
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003796bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
John Zulauf07288512019-07-05 11:09:50 -06003797 char const *func_name, const char *linear_vuid, const char *optimal_vuid) const {
Mark Lobodzinski5c048802019-03-07 10:47:31 -07003798 VkFormatProperties format_properties = GetPDFormatProperties(image_state->createInfo.format);
Cort Stratton186b1a22018-05-01 20:18:06 -04003799 bool skip = false;
3800 if (image_state->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
3801 if ((format_properties.linearTilingFeatures & desired) != desired) {
Lockee9aeebf2019-03-03 23:50:08 -07003802 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3803 HandleToUint64(image_state->image), linear_vuid,
locke-lunarg9edc2812019-06-17 23:18:52 -06003804 "In %s, invalid linearTilingFeatures (0x%08X) for format %u used by %s.", func_name,
Lockee9aeebf2019-03-03 23:50:08 -07003805 format_properties.linearTilingFeatures, image_state->createInfo.format,
3806 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04003807 }
3808 } else if (image_state->createInfo.tiling == VK_IMAGE_TILING_OPTIMAL) {
3809 if ((format_properties.optimalTilingFeatures & desired) != desired) {
3810 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3811 HandleToUint64(image_state->image), optimal_vuid,
locke-lunarg9edc2812019-06-17 23:18:52 -06003812 "In %s, invalid optimalTilingFeatures (0x%08X) for format %u used by %s.", func_name,
Cort Stratton186b1a22018-05-01 20:18:06 -04003813 format_properties.optimalTilingFeatures, image_state->createInfo.format,
Lockee9aeebf2019-03-03 23:50:08 -07003814 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04003815 }
3816 }
3817 return skip;
3818}
3819
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003820bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003821 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07003822 bool skip = false;
Cort Strattond619a302018-05-17 19:46:32 -07003823 // layerCount must not be zero
3824 if (subresource_layers->layerCount == 0) {
3825 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3826 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-layerCount-01700",
3827 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
3828 }
3829 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
3830 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
3831 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3832 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00168",
3833 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
3834 }
3835 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
3836 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3837 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
3838 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3839 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00167",
3840 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
3841 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3842 func_name, i, member);
3843 }
3844 return skip;
3845}
3846
Mark Lobodzinski96210742017-02-09 10:33:46 -07003847// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3848// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003849bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06003850 char const *func_name, char const *usage_string) const {
John Zulauf4fea6622019-04-01 11:38:18 -06003851 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict,
3852 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003853}
3854
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003855bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
3856 const VkPhysicalDeviceLimits *device_limits) {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003857 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003858
3859 const VkDeviceSize &range = pCreateInfo->range;
3860 if (range != VK_WHOLE_SIZE) {
3861 // Range must be greater than 0
3862 if (range <= 0) {
3863 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3864 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00928",
3865 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3866 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
3867 range);
3868 }
3869 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02003870 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
3871 if (SafeModulo(range, format_size) != 0) {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003872 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3873 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00929",
3874 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3875 ") 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 +02003876 "(%" PRIu32 ").",
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003877 range, format_size);
3878 }
3879 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02003880 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
3881 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3882 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00930",
3883 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3884 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
3885 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
3886 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003887 }
3888 // The sum of range and offset must be less than or equal to the size of buffer
3889 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
3890 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3891 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00931",
3892 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3893 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
3894 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
3895 range, pCreateInfo->offset, buffer_state->createInfo.size);
3896 }
3897 }
3898 return skip;
3899}
3900
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003901bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) {
Shannon McPherson265383a2018-06-21 15:37:52 -06003902 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07003903 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06003904 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
3905 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
3906 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3907 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00933",
3908 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
3909 "be supported for uniform texel buffers");
3910 }
3911 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
3912 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
3913 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3914 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00934",
3915 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
3916 "be supported for storage texel buffers");
3917 }
3918 return skip;
3919}
3920
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003921bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
3922 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003923 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003924
Dave Houltond8ed0212018-05-16 17:18:24 -06003925 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003926
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06003927 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!enabled_features.core.sparseBinding)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003928 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 -06003929 "VUID-VkBufferCreateInfo-flags-00915",
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003930 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003931 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003932 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003933
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06003934 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!enabled_features.core.sparseResidencyBuffer)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003935 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 -06003936 "VUID-VkBufferCreateInfo-flags-00916",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003937 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003938 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003939 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003940
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06003941 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003942 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 -06003943 "VUID-VkBufferCreateInfo-flags-00917",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003944 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003945 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003946 }
Jeff Bolz87697532019-01-11 22:54:00 -06003947
3948 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
3949 if (chained_devaddr_struct) {
3950 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
3951 chained_devaddr_struct->deviceAddress != 0) {
3952 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3953 "VUID-VkBufferCreateInfo-deviceAddress-02604",
3954 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
3955 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
3956 }
3957 }
3958
3959 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06003960 !enabled_features.buffer_address.bufferDeviceAddressCaptureReplay) {
Jeff Bolz87697532019-01-11 22:54:00 -06003961 skip |= log_msg(
3962 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3963 "VUID-VkBufferCreateInfo-flags-02605",
3964 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
3965 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
3966 }
3967
3968 if ((pCreateInfo->usage & VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_EXT) &&
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06003969 !enabled_features.buffer_address.bufferDeviceAddress) {
Jeff Bolz87697532019-01-11 22:54:00 -06003970 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3971 "VUID-VkBufferCreateInfo-usage-02606",
3972 "vkCreateBuffer(): the bufferDeviceAddress device feature is disabled: Buffers cannot be created with "
3973 "the VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_EXT set.");
3974 }
3975
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07003976 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003977 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateBuffer",
3978 "pCreateInfo->pQueueFamilyIndices", "VUID-VkBufferCreateInfo-sharingMode-01419",
3979 "VUID-VkBufferCreateInfo-sharingMode-01419", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07003980 }
3981
Mark Lobodzinski96210742017-02-09 10:33:46 -07003982 return skip;
3983}
3984
John Zulauf7eeb6f72019-06-17 11:56:36 -06003985void ValidationStateTracker::PostCallRecordCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
3986 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer,
3987 VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07003988 if (result != VK_SUCCESS) return;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003989 // TODO : This doesn't create deep copy of pQueueFamilyIndices so need to fix that if/when we want that data to be valid
John Zulauf4db45df2019-07-23 06:10:40 -06003990 std::unique_ptr<BUFFER_STATE> buffer_state(new BUFFER_STATE(*pBuffer, pCreateInfo));
3991
3992 // Get a set of requirements in the case the app does not
3993 DispatchGetBufferMemoryRequirements(device, *pBuffer, &buffer_state->requirements);
3994
3995 bufferMap.insert(std::make_pair(*pBuffer, std::move(buffer_state)));
Mark Lobodzinski96210742017-02-09 10:33:46 -07003996}
3997
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003998bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
3999 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004000 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004001 BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004002 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4003 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004004 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004005 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4006 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004007 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004008 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4009 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4010 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004011
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004012 // Buffer view offset must be less than the size of buffer
4013 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
4014 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4015 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00925",
4016 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4017 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4018 pCreateInfo->offset, buffer_state->createInfo.size);
4019 }
4020
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004021 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004022 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4023 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4024 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
4025 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4026 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-02749",
4027 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4028 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4029 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
4030 }
4031
4032 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
4033 VkDeviceSize elementSize = FormatElementSize(pCreateInfo->format);
4034 if ((elementSize % 3) == 0) {
4035 elementSize /= 3;
4036 }
4037 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
4038 VkDeviceSize alignmentRequirement =
4039 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4040 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
4041 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4042 }
4043 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
4044 skip |= log_msg(
4045 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4046 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-02750",
4047 "If buffer was created with usage containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
4048 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4049 ") must be a multiple of the lesser of "
4050 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4051 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4052 "(%" PRId32
4053 ") is VK_TRUE, the size of a texel of the requested format. "
4054 "If the size of a texel is a multiple of three bytes, then the size of a "
4055 "single component of format is used instead",
4056 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4057 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4058 }
4059 }
4060 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
4061 VkDeviceSize alignmentRequirement =
4062 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4063 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
4064 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4065 }
4066 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
4067 skip |= log_msg(
4068 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4069 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-02751",
4070 "If buffer was created with usage containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
4071 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4072 ") must be a multiple of the lesser of "
4073 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4074 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4075 "(%" PRId32
4076 ") is VK_TRUE, the size of a texel of the requested format. "
4077 "If the size of a texel is a multiple of three bytes, then the size of a "
4078 "single component of format is used instead",
4079 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4080 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4081 }
4082 }
4083 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004084
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004085 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004086
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004087 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004088 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004089 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004090}
4091
John Zulauf7eeb6f72019-06-17 11:56:36 -06004092void ValidationStateTracker::PostCallRecordCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
4093 const VkAllocationCallbacks *pAllocator, VkBufferView *pView,
4094 VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07004095 if (result != VK_SUCCESS) return;
Mark Lobodzinskie0befe42019-04-19 13:49:08 -06004096 bufferViewMap[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
Mark Lobodzinski96210742017-02-09 10:33:46 -07004097}
Mark Lobodzinski602de982017-02-09 11:01:33 -07004098
4099// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004100bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004101 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004102 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004103 VkDebugReportObjectTypeEXT objectType = VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT;
4104 if (image != VK_NULL_HANDLE) {
4105 objectType = VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT;
4106 }
4107
Dave Houlton1d2022c2017-03-29 11:43:58 -06004108 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004109 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004110 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004111 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004112 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004113 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004114 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004115 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004116 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004117 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004118 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07004119 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004120 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4121 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004122 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004123 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski602de982017-02-09 11:01:33 -07004124 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004125 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4126 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004127 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004128 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004129 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004130 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004131 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004132 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004133 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004134 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004135 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004136 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004137 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004138 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004139 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004140 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004141 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004142 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004143 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004144 } else if (FormatIsMultiplane(format)) {
4145 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4146 if (3 == FormatPlaneCount(format)) {
4147 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4148 }
4149 if ((aspect_mask & valid_flags) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004150 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houlton501b15b2018-03-30 15:07:41 -06004151 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4152 "set, where n = [0, 1, 2].",
4153 func_name);
4154 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004155 }
4156 return skip;
4157}
4158
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004159bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4160 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
4161 const char *param_name, const char *image_layer_count_var_name,
John Zulauf07288512019-07-05 11:09:50 -06004162 const uint64_t image_handle, SubresourceRangeErrorCodes errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004163 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004164
4165 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004166 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004167 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 -06004168 errorCodes.base_mip_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004169 "%s: %s.baseMipLevel (= %" PRIu32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004170 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4171 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004172 }
Petr Kraus4d718682017-05-18 03:38:41 +02004173
Petr Krausffa94af2017-08-08 21:46:02 +02004174 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4175 if (subresourceRange.levelCount == 0) {
4176 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 -06004177 errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004178 } else {
4179 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004180
Petr Krausffa94af2017-08-08 21:46:02 +02004181 if (necessary_mip_count > image_mip_count) {
4182 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 -06004183 errorCodes.mip_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004184 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004185 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004186 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004187 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004188 }
Petr Kraus4d718682017-05-18 03:38:41 +02004189 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004190 }
Petr Kraus4d718682017-05-18 03:38:41 +02004191
4192 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004193 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004194 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 -06004195 errorCodes.base_layer_err,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004196 "%s: %s.baseArrayLayer (= %" PRIu32
4197 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4198 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004199 }
Petr Kraus4d718682017-05-18 03:38:41 +02004200
Petr Krausffa94af2017-08-08 21:46:02 +02004201 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4202 if (subresourceRange.layerCount == 0) {
4203 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 -06004204 errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004205 } else {
4206 const uint64_t necessary_layer_count =
4207 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004208
Petr Krausffa94af2017-08-08 21:46:02 +02004209 if (necessary_layer_count > image_layer_count) {
4210 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 -06004211 errorCodes.layer_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004212 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004213 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004214 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004215 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004216 }
Petr Kraus4d718682017-05-18 03:38:41 +02004217 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004218 }
Petr Kraus4d718682017-05-18 03:38:41 +02004219
Mark Lobodzinski602de982017-02-09 11:01:33 -07004220 return skip;
4221}
4222
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004223bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004224 const VkImageSubresourceRange &subresourceRange) {
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004225 bool is_khr_maintenance1 = device_extensions.vk_khr_maintenance1;
Petr Krausffa94af2017-08-08 21:46:02 +02004226 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4227 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4228 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4229
4230 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4231 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4232
4233 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004234 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4235 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
Shannon McPherson5a0de262019-06-05 10:43:56 -06004236 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-02724"
Dave Houltond8ed0212018-05-16 17:18:24 -06004237 : "VUID-VkImageViewCreateInfo-image-01482")
4238 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4239 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
Shannon McPherson5a0de262019-06-05 10:43:56 -06004240 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
Dave Houltond8ed0212018-05-16 17:18:24 -06004241 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4242 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004243
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004244 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004245 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
4246 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4247}
4248
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004249bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004250 const VkImageSubresourceRange &subresourceRange,
4251 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004252 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004253 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4254 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4255 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4256 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004257
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004258 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4259 "vkCmdClearColorImage", param_name, "arrayLayers", HandleToUint64(image_state->image),
4260 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004261}
4262
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004263bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004264 const VkImageSubresourceRange &subresourceRange,
4265 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004266 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004267 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4268 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4269 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4270 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004271
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004272 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4273 "vkCmdClearDepthStencilImage", param_name, "arrayLayers",
Petr Krausffa94af2017-08-08 21:46:02 +02004274 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4275}
4276
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004277bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004278 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
4279 const char *param_name) {
Petr Krausffa94af2017-08-08 21:46:02 +02004280 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004281 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4282 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4283 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4284 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004285
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004286 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4287 cmd_name, param_name, "arrayLayers", HandleToUint64(image_state->image),
Petr Krausffa94af2017-08-08 21:46:02 +02004288 subresourceRangeErrorCodes);
4289}
4290
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004291bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
4292 const VkAllocationCallbacks *pAllocator, VkImageView *pView) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004293 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004294 IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004295 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004296 skip |=
4297 ValidateImageUsageFlags(image_state,
4298 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
4299 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4300 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV | VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
4301 false, kVUIDUndefined, "vkCreateImageView()",
4302 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
4303 "SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004304 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004305 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004306 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004307 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004308 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004309 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004310
4311 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4312 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004313 VkImageUsageFlags image_usage = image_state->createInfo.usage;
4314 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004315 VkFormat view_format = pCreateInfo->format;
4316 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004317 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004318 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004319
Dave Houltonbd2e2622018-04-10 16:41:14 -06004320 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004321 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004322 if (chained_ivuci_struct) {
Dave Houltonbd2e2622018-04-10 16:41:14 -06004323 image_usage = chained_ivuci_struct->usage;
4324 }
4325
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004326 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4327 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004328 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01004329 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06004330 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01004331 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06004332 std::stringstream ss;
4333 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01004334 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06004335 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Young9d1ac312018-05-21 16:28:27 -06004336 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 -07004337 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01586", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004338 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004339 }
4340 } else {
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004341 if ((!device_extensions.vk_khr_maintenance2 ||
Dave Houltonc7988072018-04-16 11:46:56 -06004342 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
4343 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4344 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
4345 std::stringstream ss;
4346 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06004347 << " is not in the same format compatibility class as "
4348 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004349 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4350 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
Mark Young9d1ac312018-05-21 16:28:27 -06004351 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 -07004352 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01018", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004353 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004354 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004355 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004356 }
4357 } else {
4358 // Format MUST be IDENTICAL to the format the image was created with
4359 if (image_format != view_format) {
4360 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06004361 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07004362 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004363 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Young9d1ac312018-05-21 16:28:27 -06004364 skip |=
4365 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004366 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01019", "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004367 }
4368 }
4369
4370 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004371 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004372
4373 switch (image_type) {
4374 case VK_IMAGE_TYPE_1D:
4375 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004376 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 -07004377 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004378 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4379 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004380 }
4381 break;
4382 case VK_IMAGE_TYPE_2D:
4383 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4384 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4385 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Young9d1ac312018-05-21 16:28:27 -06004386 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 -07004387 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01003",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004388 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4389 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004390 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004391 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 -07004392 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004393 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4394 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004395 }
4396 }
4397 break;
4398 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004399 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06004400 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4401 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4402 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004403 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004404 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004405 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01005",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004406 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4407 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004408 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4409 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004410 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004411 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004412 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004413 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4414 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004415 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4416 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004417 }
4418 } else {
Mark Young9d1ac312018-05-21 16:28:27 -06004419 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 -07004420 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004421 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4422 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004423 }
4424 }
4425 } else {
4426 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Young9d1ac312018-05-21 16:28:27 -06004427 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 -07004428 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004429 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4430 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004431 }
4432 }
4433 break;
4434 default:
4435 break;
4436 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004437
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004438 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004439 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07004440 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004441 }
4442
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004443 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004444 VkFormatFeatureFlags tiling_features = (image_tiling & VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4445 : format_properties.optimalTilingFeatures;
4446
4447 if (tiling_features == 0) {
4448 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 -07004449 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-None-02273",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004450 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4451 "physical device.",
4452 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4453 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4454 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 -07004455 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02274",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004456 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4457 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4458 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4459 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4460 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 -07004461 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02275",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004462 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4463 "VK_IMAGE_USAGE_STORAGE_BIT.",
4464 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4465 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
4466 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4467 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 -07004468 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02276",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004469 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4470 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4471 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4472 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4473 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4474 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 -07004475 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02277",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004476 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4477 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4478 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004479 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004480
Jeff Bolz9af91c52018-09-01 21:53:57 -05004481 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4482 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4483 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 -07004484 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02086",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004485 "vkCreateImageView() If image was created with usage containing "
4486 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4487 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
4488 }
4489 if (view_format != VK_FORMAT_R8_UINT) {
4490 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 -07004491 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02087",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004492 "vkCreateImageView() If image was created with usage containing "
4493 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
4494 }
4495 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004496 }
4497 return skip;
4498}
4499
John Zulauf7eeb6f72019-06-17 11:56:36 -06004500void ValidationStateTracker::PostCallRecordCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
4501 const VkAllocationCallbacks *pAllocator, VkImageView *pView,
4502 VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07004503 if (result != VK_SUCCESS) return;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004504 auto image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski81b02a12019-04-19 13:58:43 -06004505 imageViewMap[*pView] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(image_state, *pView, pCreateInfo));
Mark Lobodzinski602de982017-02-09 11:01:33 -07004506}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004507
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004508bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
4509 uint32_t regionCount, const VkBufferCopy *pRegions) {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06004510 const auto cb_node = GetCBState(commandBuffer);
4511 const auto src_buffer_state = GetBufferState(srcBuffer);
4512 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004513
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004514 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004515 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
4516 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004517 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004518 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004519 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
4520 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06004521 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004522 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
4523 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004524 skip |=
4525 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4526 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004527 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
4528 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004529 return skip;
4530}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004531
John Zulauf1686f232019-07-09 16:27:11 -06004532void ValidationStateTracker::PreCallRecordCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
4533 uint32_t regionCount, const VkBufferCopy *pRegions) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004534 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004535 auto src_buffer_state = GetBufferState(srcBuffer);
4536 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004537
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004538 // Update bindings between buffers and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004539 AddCommandBufferBindingBuffer(cb_node, src_buffer_state);
4540 AddCommandBufferBindingBuffer(cb_node, dst_buffer_state);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004541}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004542
Mark Lobodzinskif933db92019-03-09 12:58:03 -07004543bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004544 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004545 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004546 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004547 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 -06004548 kVUID_Core_DrawState_DoubleDestroy, "Cannot free %s that has not been allocated.",
Lockee9aeebf2019-03-03 23:50:08 -07004549 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004550 } else {
4551 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004552 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 -06004553 HandleToUint64(buffer), "VUID-vkDestroyBuffer-buffer-00922",
locke-lunarg9edc2812019-06-17 23:18:52 -06004554 "Cannot free %s that is in use by a command buffer.", report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004555 }
4556 }
4557 return skip;
4558}
4559
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004560bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07004561 IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06004562 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004563
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004564 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004565 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004566 skip |=
4567 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004568 }
4569 return skip;
4570}
4571
John Zulauf7eeb6f72019-06-17 11:56:36 -06004572void ValidationStateTracker::PreCallRecordDestroyImageView(VkDevice device, VkImageView imageView,
4573 const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07004574 IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004575 if (!image_view_state) return;
John Zulauf4fea6622019-04-01 11:38:18 -06004576 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004577
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004578 // Any bound cmd buffers are now invalid
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004579 InvalidateCommandBuffers(image_view_state->cb_bindings, obj_struct);
Mark Lobodzinski81b02a12019-04-19 13:58:43 -06004580 imageViewMap.erase(imageView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004581}
4582
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004583bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004584 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004585
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004586 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004587 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07004588 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004589 }
4590 return skip;
4591}
4592
John Zulauf7eeb6f72019-06-17 11:56:36 -06004593void ValidationStateTracker::PreCallRecordDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004594 if (!buffer) return;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004595 auto buffer_state = GetBufferState(buffer);
John Zulauf4fea6622019-04-01 11:38:18 -06004596 const VulkanTypedHandle obj_struct(buffer, kVulkanObjectTypeBuffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004597
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004598 InvalidateCommandBuffers(buffer_state->cb_bindings, obj_struct);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004599 for (auto mem_binding : buffer_state->GetBoundMemory()) {
Mark Lobodzinski0a41e0e2019-04-25 12:12:40 -06004600 auto mem_info = GetDevMemState(mem_binding);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004601 if (mem_info) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004602 RemoveBufferMemoryRange(HandleToUint64(buffer), mem_info);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004603 }
4604 }
John Zulauf4fea6622019-04-01 11:38:18 -06004605 ClearMemoryObjectBindings(obj_struct);
Mark Lobodzinski3baa8172019-04-19 13:47:30 -06004606 bufferMap.erase(buffer_state->buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004607}
4608
John Zulauf7eeb6f72019-06-17 11:56:36 -06004609void CoreChecks::PreCallRecordDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
4610 if (!buffer) return;
4611
4612 // Clean up validation specific data
4613 EraseQFOReleaseBarriers<VkBufferMemoryBarrier>(buffer);
4614
4615 // Clean up generic buffer state
4616 StateTracker::PreCallRecordDestroyBuffer(device, buffer, pAllocator);
4617}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004618bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
4619 const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07004620 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06004621 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004622 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004623 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004624 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06004625 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004626 }
4627 return skip;
4628}
4629
John Zulauf7eeb6f72019-06-17 11:56:36 -06004630void ValidationStateTracker::PreCallRecordDestroyBufferView(VkDevice device, VkBufferView bufferView,
4631 const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004632 if (!bufferView) return;
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07004633 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06004634 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004635
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004636 // Any bound cmd buffers are now invalid
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004637 InvalidateCommandBuffers(buffer_view_state->cb_bindings, obj_struct);
Mark Lobodzinskie0befe42019-04-19 13:49:08 -06004638 bufferViewMap.erase(bufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004639}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004640
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004641bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
4642 VkDeviceSize size, uint32_t data) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004643 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004644 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004645 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004646 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004647 skip |=
4648 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4649 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004650 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004651 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004652 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
4653 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004654 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004655 return skip;
4656}
4657
John Zulauf1686f232019-07-09 16:27:11 -06004658void ValidationStateTracker::PreCallRecordCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
4659 VkDeviceSize size, uint32_t data) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004660 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004661 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004662 // Update bindings between buffer and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004663 AddCommandBufferBindingBuffer(cb_node, buffer_state);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004664}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004665
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004666bool CoreChecks::ValidateBufferImageCopyData(uint32_t regionCount, const VkBufferImageCopy *pRegions, IMAGE_STATE *image_state,
4667 const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004668 bool skip = false;
4669
4670 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004671 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
4672 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004673 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 -06004674 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00199",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004675 "%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 -06004676 "and 1, respectively.",
4677 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004678 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004679 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004680
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004681 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
4682 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004683 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 -06004684 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00201",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004685 "%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 -06004686 "must be 0 and 1, respectively.",
4687 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004688 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004689 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004690
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004691 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
4692 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004693 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 -06004694 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-baseArrayLayer-00213",
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004695 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
4696 "For 3D images these must be 0 and 1, respectively.",
4697 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004698 }
4699 }
4700
4701 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07004702 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
Locke497739c2019-03-08 11:50:47 -07004703 uint32_t element_size = FormatElementSize(image_state->createInfo.format, pRegions[i].imageSubresource.aspectMask);
4704
Dave Houltona585d132019-01-18 13:05:42 -07004705 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004706 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 -06004707 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00193",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004708 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07004709 " must be a multiple of this format's texel size (%" PRIu32 ").",
4710 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004711 }
4712
4713 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06004714 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004715 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 -06004716 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00194",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004717 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
4718 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004719 }
4720
4721 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
4722 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004723 skip |=
4724 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004725 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00195",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004726 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
4727 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004728 }
4729
4730 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
4731 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
4732 skip |= log_msg(
4733 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004734 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004735 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
4736 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004737 }
4738
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06004739 // Calculate adjusted image extent, accounting for multiplane image factors
4740 VkExtent3D adusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
4741 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
4742 if ((pRegions[i].imageOffset.x < 0) || (pRegions[i].imageOffset.x > static_cast<int32_t>(adusted_image_extent.width)) ||
4743 ((pRegions[i].imageOffset.x + pRegions[i].imageExtent.width) > static_cast<int32_t>(adusted_image_extent.width))) {
4744 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4745 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00197",
4746 "%s(): Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
4747 "zero or <= image subresource width (%d).",
4748 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
4749 adusted_image_extent.width);
4750 }
4751
4752 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
4753 if ((pRegions[i].imageOffset.y < 0) || (pRegions[i].imageOffset.y > static_cast<int32_t>(adusted_image_extent.height)) ||
4754 ((pRegions[i].imageOffset.y + pRegions[i].imageExtent.height) > static_cast<int32_t>(adusted_image_extent.height))) {
4755 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4756 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00198",
4757 "%s(): Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
4758 "zero or <= image subresource height (%d).",
4759 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
4760 adusted_image_extent.height);
4761 }
4762
4763 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
4764 if ((pRegions[i].imageOffset.z < 0) || (pRegions[i].imageOffset.z > static_cast<int32_t>(adusted_image_extent.depth)) ||
4765 ((pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth) > static_cast<int32_t>(adusted_image_extent.depth))) {
4766 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4767 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00200",
4768 "%s(): Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
4769 "zero or <= image subresource depth (%d).",
4770 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
4771 adusted_image_extent.depth);
4772 }
4773
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004774 // subresource aspectMask must have exactly 1 bit set
4775 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
4776 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
4777 if (aspect_mask_bits.count() != 1) {
4778 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 -06004779 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00212",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004780 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004781 }
4782
4783 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06004784 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004785 skip |= log_msg(
4786 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004787 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004788 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
4789 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004790 }
4791
4792 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04004793 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07004794 auto block_size = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004795
4796 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06004797 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004798 skip |= log_msg(
4799 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004800 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00203",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004801 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
4802 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004803 }
4804
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004805 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004806 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004807 skip |= log_msg(
4808 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004809 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00204",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004810 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
4811 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004812 }
4813
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004814 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06004815 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
4816 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
4817 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004818 skip |=
4819 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004820 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00205",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004821 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
4822 "width & height (%d, %d)..",
4823 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004824 }
4825
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004826 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houltona585d132019-01-18 13:05:42 -07004827 uint32_t block_size_in_bytes = FormatElementSize(image_state->createInfo.format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06004828 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004829 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 -06004830 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00206",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004831 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07004832 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004833 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004834 }
Dave Houlton67e9b532017-03-02 17:00:10 -07004835
4836 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07004837 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06004838 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004839 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
4840 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 -06004841 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00207",
Dave Houlton75967fc2017-03-06 17:21:16 -07004842 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004843 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004844 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004845 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07004846 }
4847
4848 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004849 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004850 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
4851 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 -06004852 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00208",
Dave Houlton75967fc2017-03-06 17:21:16 -07004853 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004854 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004855 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004856 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07004857 }
4858
4859 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06004860 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004861 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
4862 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 -06004863 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00209",
Dave Houlton75967fc2017-03-06 17:21:16 -07004864 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004865 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004866 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004867 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07004868 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004869 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004870 }
4871
4872 return skip;
4873}
4874
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004875static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06004876 const VkBufferImageCopy *pRegions, const char *func_name, const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004877 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004878 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004879
4880 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004881 VkExtent3D extent = pRegions[i].imageExtent;
4882 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004883
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004884 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
4885 {
Dave Houlton51653902018-06-22 17:32:13 -06004886 skip |=
4887 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4888 kVUID_Core_Image_ZeroAreaSubregion, "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area",
4889 func_name, i, extent.width, extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004890 }
4891
4892 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
4893
4894 // If we're using a compressed format, valid extent is rounded up to multiple of block size (per 18.1)
Dave Houlton1d2022c2017-03-29 11:43:58 -06004895 if (FormatIsCompressed(image_info->format)) {
Dave Houltona585d132019-01-18 13:05:42 -07004896 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004897 if (image_extent.width % block_extent.width) {
4898 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
4899 }
4900 if (image_extent.height % block_extent.height) {
4901 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
4902 }
4903 if (image_extent.depth % block_extent.depth) {
4904 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
4905 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004906 }
4907
Dave Houltonfc1a4052017-04-27 14:32:45 -06004908 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004909 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 -06004910 msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004911 }
4912 }
4913
4914 return skip;
4915}
4916
Chris Forbese8ba09a2017-06-01 17:39:02 -07004917static inline bool ValidateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
Dave Houlton33c2d252017-06-09 17:08:32 -06004918 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06004919 const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004920 bool skip = false;
4921
4922 VkDeviceSize buffer_size = buff_state->createInfo.size;
4923
4924 for (uint32_t i = 0; i < regionCount; i++) {
4925 VkExtent3D copy_extent = pRegions[i].imageExtent;
4926
4927 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
4928 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Locke497739c2019-03-08 11:50:47 -07004929 VkDeviceSize unit_size = FormatElementSize(image_state->createInfo.format,
4930 pRegions[i].imageSubresource.aspectMask); // size (bytes) of texel or block
Dave Houltonf3229d52017-02-21 15:59:08 -07004931
Tom Cooperb2550c72018-10-15 13:08:41 +01004932 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004933 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houltona585d132019-01-18 13:05:42 -07004934 auto block_dim = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004935 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
4936 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
4937
4938 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
4939 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
4940 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004941 }
4942
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004943 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
4944 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
4945 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07004946 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004947 } else {
4948 // Calculate buffer offset of final copied byte, + 1.
4949 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
4950 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
4951 max_buffer_offset *= unit_size; // convert to bytes
4952 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004953
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004954 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06004955 skip |=
4956 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4957 msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i, buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004958 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004959 }
4960 }
4961
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004962 return skip;
4963}
4964
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004965bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4966 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06004967 const auto cb_node = GetCBState(commandBuffer);
4968 const auto src_image_state = GetImageState(srcImage);
4969 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004970
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004971 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004972
4973 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004974 skip |= ValidateCmd(cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004975
4976 // Command pool must support graphics, compute, or transfer operations
John Zulaufe3d1c8a2019-08-12 14:34:58 -06004977 const auto pPool = GetCommandPoolState(cb_node->createInfo.commandPool);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004978
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004979 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07004980
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004981 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4982 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 -06004983 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004984 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004985 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004986 }
Dave Houlton0ef27492018-04-04 11:41:48 -06004987 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004988 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Chris Forbese8ba09a2017-06-01 17:39:02 -07004989 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004990 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004991
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004992 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06004993 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004994 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
4995 skip |=
4996 ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004997
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004998 // Validate that SRC image & DST buffer have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004999 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005000 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
5001 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005002 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005003 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
5004 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06005005 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005006 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImageToBuffer()",
5007 "VUID-vkCmdCopyImageToBuffer-srcImage-01998",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005008 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04005009 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005010 skip |= InsideRenderPass(cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005011 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005012 const char *src_invalid_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5013 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
5014 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005015 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005016 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
Cort Strattond619a302018-05-17 19:46:32 -07005017 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005018 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005019 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
5020 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005021 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5022 cb_node, src_image_state, &pRegions[i], i, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
5023 skip |=
5024 ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyImageToBuffer()",
5025 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
5026 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005027 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
5028 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005029 }
5030 return skip;
5031}
5032
John Zulauf1686f232019-07-09 16:27:11 -06005033void ValidationStateTracker::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage,
5034 VkImageLayout srcImageLayout, VkBuffer dstBuffer,
5035 uint32_t regionCount, const VkBufferImageCopy *pRegions) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06005036 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07005037 auto src_image_state = GetImageState(srcImage);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005038 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005039
John Zulauf1686f232019-07-09 16:27:11 -06005040 // Update bindings between buffer/image and cmd buffer
5041 AddCommandBufferBindingImage(cb_node, src_image_state);
5042 AddCommandBufferBindingBuffer(cb_node, dst_buffer_state);
5043}
5044void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5045 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
5046 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
5047
5048 auto cb_node = GetCBState(commandBuffer);
5049 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06005050 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005051 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005052 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005053 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005054}
5055
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005056bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5057 VkImageLayout dstImageLayout, uint32_t regionCount,
5058 const VkBufferImageCopy *pRegions) {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005059 const auto cb_node = GetCBState(commandBuffer);
5060 const auto src_buffer_state = GetBufferState(srcBuffer);
5061 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005062
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005063 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005064
5065 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005066 skip |= ValidateCmd(cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005067
5068 // Command pool must support graphics, compute, or transfer operations
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005069 const auto pPool = GetCommandPoolState(cb_node->createInfo.commandPool);
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005070 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005071 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
5072 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 -06005073 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005074 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005075 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005076 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005077 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005078 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Chris Forbese8ba09a2017-06-01 17:39:02 -07005079 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005080 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005081 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005082 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005083 skip |=
5084 ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
5085 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005086 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005087 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
5088 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005089 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005090 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
5091 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06005092 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005093 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyBufferToImage()",
5094 "VUID-vkCmdCopyBufferToImage-dstImage-01997",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005095 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04005096 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005097 skip |= InsideRenderPass(cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005098 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005099 const char *dst_invalid_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5100 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
5101 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005102 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005103 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
Cort Strattond619a302018-05-17 19:46:32 -07005104 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005105 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005106 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
5107 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005108 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5109 cb_node, dst_image_state, &pRegions[i], i, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
5110 skip |=
5111 ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyBufferToImage()",
5112 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
5113 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005114 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
5115 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005116 }
5117 return skip;
5118}
5119
John Zulauf1686f232019-07-09 16:27:11 -06005120void ValidationStateTracker::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5121 VkImageLayout dstImageLayout, uint32_t regionCount,
5122 const VkBufferImageCopy *pRegions) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06005123 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005124 auto src_buffer_state = GetBufferState(srcBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07005125 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005126
John Zulauf1686f232019-07-09 16:27:11 -06005127 AddCommandBufferBindingBuffer(cb_node, src_buffer_state);
5128 AddCommandBufferBindingImage(cb_node, dst_image_state);
5129}
5130
5131void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5132 VkImageLayout dstImageLayout, uint32_t regionCount,
5133 const VkBufferImageCopy *pRegions) {
5134 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
5135
5136 auto cb_node = GetCBState(commandBuffer);
5137 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06005138 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005139 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005140 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005141 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005142}
Mike Weiblen672b58b2017-02-21 14:32:53 -07005143
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005144bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
5145 VkSubresourceLayout *pLayout) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005146 bool skip = false;
5147 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
5148
Dave Houlton1d960ff2018-01-19 12:17:05 -07005149 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07005150 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
5151 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
5152 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02005153 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 -06005154 "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005155 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005156 }
5157
John Zulaufa26d3c82019-08-14 16:09:08 -06005158 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005159 if (!image_entry) {
5160 return skip;
5161 }
5162
Dave Houlton1d960ff2018-01-19 12:17:05 -07005163 // image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
Mike Weiblen672b58b2017-02-21 14:32:53 -07005164 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005165 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5166 "VUID-vkGetImageSubresourceLayout-image-00996",
5167 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005168 }
5169
Dave Houlton1d960ff2018-01-19 12:17:05 -07005170 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005171 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005172 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5173 "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
5174 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
5175 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005176 }
5177
Dave Houlton1d960ff2018-01-19 12:17:05 -07005178 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005179 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005180 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5181 "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
5182 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
5183 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005184 }
5185
Dave Houlton1d960ff2018-01-19 12:17:05 -07005186 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07005187 const VkFormat img_format = image_entry->createInfo.format;
Dave Houlton1d960ff2018-01-19 12:17:05 -07005188 if (FormatIsMultiplane(img_format)) {
5189 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06005190 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07005191 if (FormatPlaneCount(img_format) > 2u) {
5192 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
Dave Houltond8ed0212018-05-16 17:18:24 -06005193 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07005194 }
5195 if (sub_aspect != (sub_aspect & allowed_flags)) {
5196 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06005197 HandleToUint64(image), vuid,
Dave Houlton1d960ff2018-01-19 12:17:05 -07005198 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005199 ") must be a single-plane specifier flag.",
5200 sub_aspect);
Dave Houlton1d960ff2018-01-19 12:17:05 -07005201 }
5202 } else if (FormatIsColor(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005203 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Dave Houlton852287e2018-01-19 15:11:51 -07005204 skip |= log_msg(
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06005205 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
Dave Houltond8ed0212018-05-16 17:18:24 -06005206 "VUID-VkImageSubresource-aspectMask-parameter",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005207 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005208 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06005209 } else if (FormatIsDepthOrStencil(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005210 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06005211 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 -06005212 HandleToUint64(image), "VUID-VkImageSubresource-aspectMask-parameter",
Mike Weiblen672b58b2017-02-21 14:32:53 -07005213 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005214 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005215 }
5216 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005217
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005218 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005219 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005220 }
5221
Mike Weiblen672b58b2017-02-21 14:32:53 -07005222 return skip;
5223}