blob: 669e151f641ec763c544376fd5f14069452b157f [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"
32#include "vk_layer_data.h"
33#include "vk_layer_utils.h"
34#include "vk_layer_logging.h"
Dave Houltonbd2e2622018-04-10 16:41:14 -060035#include "vk_typemap_helper.h"
Mark Lobodzinski90224de2017-01-26 15:23:11 -070036
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -070037#include "chassis.h"
Mark Lobodzinski76d76662019-02-14 14:38:21 -070038#include "core_validation.h"
39#include "shader_validation.h"
40#include "descriptor_sets.h"
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070041#include "buffer_validation.h"
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -070042
John Zulauff660ad62019-03-23 07:16:05 -060043// Transfer VkImageSubresourceLayers into VkImageSubresourceRange struct
44static VkImageSubresourceRange RangeFromLayers(const VkImageSubresourceLayers &subresource_layers) {
45 VkImageSubresourceRange subresource_range;
46 subresource_range.aspectMask = subresource_layers.aspectMask;
47 subresource_range.baseArrayLayer = subresource_layers.baseArrayLayer;
48 subresource_range.layerCount = subresource_layers.layerCount;
49 subresource_range.baseMipLevel = subresource_layers.mipLevel;
50 subresource_range.levelCount = 1;
51 return subresource_range;
52}
53
54IMAGE_STATE::IMAGE_STATE(VkImage img, const VkImageCreateInfo *pCreateInfo)
55 : image(img),
56 createInfo(*pCreateInfo),
57 valid(false),
58 acquired(false),
59 shared_presentable(false),
60 layout_locked(false),
61 get_sparse_reqs_called(false),
62 sparse_metadata_required(false),
63 sparse_metadata_bound(false),
64 imported_ahb(false),
65 has_ahb_format(false),
66 ahb_format(0),
67 full_range{},
unknown09edc722019-06-21 15:49:38 -060068 create_from_swapchain(VK_NULL_HANDLE),
69 bind_swapchain(VK_NULL_HANDLE),
unknown08c57af2019-06-21 16:33:35 -060070 bind_swapchain_imageIndex(0),
71 sparse_requirements{} {
John Zulauff660ad62019-03-23 07:16:05 -060072 if ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) && (createInfo.queueFamilyIndexCount > 0)) {
73 uint32_t *pQueueFamilyIndices = new uint32_t[createInfo.queueFamilyIndexCount];
74 for (uint32_t i = 0; i < createInfo.queueFamilyIndexCount; i++) {
75 pQueueFamilyIndices[i] = pCreateInfo->pQueueFamilyIndices[i];
76 }
77 createInfo.pQueueFamilyIndices = pQueueFamilyIndices;
78 }
79
80 if (createInfo.flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) {
81 sparse = true;
82 }
83 const auto format = createInfo.format;
84 VkImageSubresourceRange init_range{0, 0, VK_REMAINING_MIP_LEVELS, 0, VK_REMAINING_ARRAY_LAYERS};
85 if (FormatIsColor(format) || FormatIsMultiplane(format)) {
86 init_range.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT; // Normalization will expand this for multiplane
87 } else {
88 init_range.aspectMask =
89 (FormatHasDepth(format) ? VK_IMAGE_ASPECT_DEPTH_BIT : 0) | (FormatHasStencil(format) ? VK_IMAGE_ASPECT_STENCIL_BIT : 0);
90 }
91 full_range = NormalizeSubresourceRange(*this, init_range);
Locked8af3732019-05-10 09:47:56 -060092
93#ifdef VK_USE_PLATFORM_ANDROID_KHR
94 auto external_format = lvl_find_in_chain<VkExternalFormatANDROID>(createInfo.pNext);
95 if (external_format) {
96 external_format_android = external_format->externalFormat;
97 } else {
98 // If externalFormat is zero, the effect is as if the VkExternalFormatANDROID structure was not present.
99 external_format_android = 0;
100 }
101#endif // VK_USE_PLATFORM_ANDROID_KHR
John Zulauff660ad62019-03-23 07:16:05 -0600102}
103
104IMAGE_VIEW_STATE::IMAGE_VIEW_STATE(const IMAGE_STATE *image_state, VkImageView iv, const VkImageViewCreateInfo *ci)
105 : image_view(iv), create_info(*ci), normalized_subresource_range(ci->subresourceRange), samplerConversion(VK_NULL_HANDLE) {
106 auto *conversionInfo = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info.pNext);
107 if (conversionInfo) samplerConversion = conversionInfo->conversion;
108 if (image_state) {
109 // A light normalization of the createInfo range
110 auto &sub_res_range = create_info.subresourceRange;
111 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
112 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
113
114 // Cache a full normalization (for "full image/whole image" comparisons)
115 normalized_subresource_range = NormalizeSubresourceRange(*image_state, ci->subresourceRange);
116 }
117}
118
Dave Houltond9611312018-11-19 17:03:36 -0700119uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
120 // uint cast applies floor()
121 return 1u + (uint32_t)log2(std::max({height, width, depth}));
122}
123
124uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
125
126uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
127
John Zulauff660ad62019-03-23 07:16:05 -0600128VkImageSubresourceRange NormalizeSubresourceRange(const IMAGE_STATE &image_state, const VkImageSubresourceRange &range) {
129 const VkImageCreateInfo &image_create_info = image_state.createInfo;
130 VkImageSubresourceRange norm = range;
131 norm.levelCount = ResolveRemainingLevels(&range, image_create_info.mipLevels);
132
133 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
134 // <arrayLayers> can potentially alias.
135 uint32_t layer_limit = (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR))
136 ? image_create_info.extent.depth
137 : image_create_info.arrayLayers;
138 norm.layerCount = ResolveRemainingLayers(&range, layer_limit);
139
140 // For multiplanar formats, IMAGE_ASPECT_COLOR is equivalent to adding the aspect of the individual planes
141 VkImageAspectFlags &aspect_mask = norm.aspectMask;
142 if (FormatIsMultiplane(image_create_info.format)) {
143 if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
144 aspect_mask &= ~VK_IMAGE_ASPECT_COLOR_BIT;
145 aspect_mask |= (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
146 if (FormatPlaneCount(image_create_info.format) > 2) {
147 aspect_mask |= VK_IMAGE_ASPECT_PLANE_2_BIT;
148 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700149 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700150 }
John Zulauff660ad62019-03-23 07:16:05 -0600151 return norm;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700152}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700153
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700154template <class OBJECT, class LAYOUT>
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700155void CoreChecks::SetLayout(OBJECT *pObject, VkImage image, VkImageSubresource range, const LAYOUT &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700156 ImageSubresourcePair imgpair = {image, true, range};
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700157 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
158 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
159 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
160 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600161 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700162 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
163 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
164 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700165 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700166}
167
168template <class OBJECT, class LAYOUT>
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700169void CoreChecks::SetLayout(OBJECT *pObject, ImageSubresourcePair imgpair, const LAYOUT &layout, VkImageAspectFlags aspectMask) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700170 if (imgpair.subresource.aspectMask & aspectMask) {
171 imgpair.subresource.aspectMask = aspectMask;
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700172 SetLayout(pObject, imgpair, layout);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700173 }
174}
175
Tony Barbourdf013b92017-01-25 12:53:48 -0700176// Set the layout in supplied map
John Zulauf3b04ebd2019-07-18 14:08:11 -0600177void CoreChecks::SetLayout(ImageSubresPairLayoutMap &imageLayoutMap, ImageSubresourcePair imgpair, VkImageLayout layout) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700178 auto it = imageLayoutMap.find(imgpair);
179 if (it != imageLayoutMap.end()) {
180 it->second.layout = layout; // Update
181 } else {
182 imageLayoutMap[imgpair].layout = layout; // Insert
183 }
Tony Barbourdf013b92017-01-25 12:53:48 -0700184}
185
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700186bool CoreChecks::FindLayoutVerifyLayout(ImageSubresourcePair imgpair, VkImageLayout &layout, const VkImageAspectFlags aspectMask) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700187 if (!(imgpair.subresource.aspectMask & aspectMask)) {
188 return false;
189 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700190 VkImageAspectFlags oldAspectMask = imgpair.subresource.aspectMask;
191 imgpair.subresource.aspectMask = aspectMask;
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600192 auto imgsubIt = imageLayoutMap.find(imgpair);
193 if (imgsubIt == imageLayoutMap.end()) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700194 return false;
195 }
196 if (layout != VK_IMAGE_LAYOUT_MAX_ENUM && layout != imgsubIt->second.layout) {
Petr Krausbc7f5442017-05-14 23:43:38 +0200197 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 -0600198 kVUID_Core_DrawState_InvalidLayout,
locke-lunarg9edc2812019-06-17 23:18:52 -0600199 "Cannot query for %s layout when combined aspect mask %d has multiple layout types: %s and %s",
Lockee9aeebf2019-03-03 23:50:08 -0700200 report_data->FormatHandle(imgpair.image).c_str(), oldAspectMask, string_VkImageLayout(layout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700201 string_VkImageLayout(imgsubIt->second.layout));
202 }
203 layout = imgsubIt->second.layout;
204 return true;
205}
206
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700207// Find layout(s) on the global level
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700208bool CoreChecks::FindGlobalLayout(ImageSubresourcePair imgpair, VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700209 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700210 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
211 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
212 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
213 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600214 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700215 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
216 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
217 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700218 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700219 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
220 imgpair = {imgpair.image, false, VkImageSubresource()};
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600221 auto imgsubIt = imageLayoutMap.find(imgpair);
222 if (imgsubIt == imageLayoutMap.end()) return false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700223 layout = imgsubIt->second.layout;
224 }
225 return true;
226}
227
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700228bool CoreChecks::FindLayouts(VkImage image, std::vector<VkImageLayout> &layouts) {
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -0600229 auto sub_data = imageSubresourceMap.find(image);
230 if (sub_data == imageSubresourceMap.end()) return false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700231 auto image_state = GetImageState(image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700232 if (!image_state) return false;
233 bool ignoreGlobal = false;
234 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
235 if (sub_data->second.size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
236 ignoreGlobal = true;
237 }
238 for (auto imgsubpair : sub_data->second) {
239 if (ignoreGlobal && !imgsubpair.hasSubresource) continue;
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600240 auto img_data = imageLayoutMap.find(imgsubpair);
241 if (img_data != imageLayoutMap.end()) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700242 layouts.push_back(img_data->second.layout);
243 }
244 }
245 return true;
246}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700247
John Zulauf3b04ebd2019-07-18 14:08:11 -0600248bool CoreChecks::FindLayout(const ImageSubresPairLayoutMap &imageLayoutMap, ImageSubresourcePair imgpair, VkImageLayout &layout,
249 const VkImageAspectFlags aspectMask) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700250 if (!(imgpair.subresource.aspectMask & aspectMask)) {
251 return false;
252 }
253 imgpair.subresource.aspectMask = aspectMask;
254 auto imgsubIt = imageLayoutMap.find(imgpair);
255 if (imgsubIt == imageLayoutMap.end()) {
256 return false;
257 }
258 layout = imgsubIt->second.layout;
259 return true;
Tony Barboure0c5cc92017-02-08 13:53:39 -0700260}
Tony Barbourdf013b92017-01-25 12:53:48 -0700261
262// find layout in supplied map
John Zulauf3b04ebd2019-07-18 14:08:11 -0600263bool CoreChecks::FindLayout(const ImageSubresPairLayoutMap &imageLayoutMap, ImageSubresourcePair imgpair,
264 VkImageLayout &layout) const {
Tony Barbourdf013b92017-01-25 12:53:48 -0700265 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
266 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
267 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
268 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
269 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600270 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700271 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
272 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
273 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
274 }
275 // Image+subresource not found, look for image handle w/o subresource
Tony Barbourdf013b92017-01-25 12:53:48 -0700276 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
277 imgpair = {imgpair.image, false, VkImageSubresource()};
278 auto imgsubIt = imageLayoutMap.find(imgpair);
279 if (imgsubIt == imageLayoutMap.end()) return false;
280 layout = imgsubIt->second.layout;
281 }
282 return true;
283}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700284
285// Set the layout on the global level
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700286void CoreChecks::SetGlobalLayout(ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700287 VkImage &image = imgpair.image;
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600288 auto data = imageLayoutMap.find(imgpair);
289 if (data != imageLayoutMap.end()) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700290 data->second.layout = layout; // Update
291 } else {
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600292 imageLayoutMap[imgpair].layout = layout; // Insert
Dave Houltonb3f4b282018-02-22 16:25:16 -0700293 }
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -0600294 auto &image_subresources = imageSubresourceMap[image];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700295 auto subresource = std::find(image_subresources.begin(), image_subresources.end(), imgpair);
296 if (subresource == image_subresources.end()) {
297 image_subresources.push_back(imgpair);
298 }
299}
300
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600301// Set image layout for given VkImageSubresourceRange struct
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600302void CoreChecks::SetImageLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600303 const VkImageSubresourceRange &image_subresource_range, VkImageLayout layout,
304 VkImageLayout expected_layout) {
305 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
306 assert(subresource_map); // the non-const getter must return a valid pointer
John Zulauf4ec24ec2019-05-02 17:22:59 -0600307 if (subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600308 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700309 }
310}
John Zulauff660ad62019-03-23 07:16:05 -0600311
312// Set the initial image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600313void CoreChecks::SetImageViewInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
Jeff Bolz3e333222019-08-10 23:00:38 -0500314 if (disabled.image_layout_validation) {
315 return;
316 }
John Zulauff660ad62019-03-23 07:16:05 -0600317 IMAGE_STATE *image_state = GetImageState(view_state.create_info.image);
318 if (image_state) {
319 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
John Zulauf4ec24ec2019-05-02 17:22:59 -0600320 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, view_state.normalized_subresource_range, layout, &view_state);
John Zulauff660ad62019-03-23 07:16:05 -0600321 }
322}
323
324// Set the initial image layout for a passed non-normalized subresource range
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600325void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600326 const VkImageSubresourceRange &range, VkImageLayout layout) {
327 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
328 assert(subresource_map);
John Zulauf4ec24ec2019-05-02 17:22:59 -0600329 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(image_state, range), layout);
John Zulauff660ad62019-03-23 07:16:05 -0600330}
331
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600332void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, VkImage image, const VkImageSubresourceRange &range,
John Zulauff660ad62019-03-23 07:16:05 -0600333 VkImageLayout layout) {
334 const IMAGE_STATE *image_state = GetImageState(image);
335 if (!image_state) return;
336 SetImageInitialLayout(cb_node, *image_state, range, layout);
337};
338
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600339void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600340 const VkImageSubresourceLayers &layers, VkImageLayout layout) {
341 SetImageInitialLayout(cb_node, image_state, RangeFromLayers(layers), layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600342}
Dave Houltonddd65c52018-05-08 14:58:01 -0600343
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600344// Set image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600345void CoreChecks::SetImageViewLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
John Zulauff660ad62019-03-23 07:16:05 -0600346 IMAGE_STATE *image_state = GetImageState(view_state.create_info.image);
347 if (!image_state) return; // TODO: track/report stale image references
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600348
John Zulauff660ad62019-03-23 07:16:05 -0600349 VkImageSubresourceRange sub_range = view_state.normalized_subresource_range;
Dave Houltonddd65c52018-05-08 14:58:01 -0600350 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
351 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
John Zulauff660ad62019-03-23 07:16:05 -0600352 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 -0600353 sub_range.baseArrayLayer = 0;
354 sub_range.layerCount = image_state->createInfo.extent.depth;
355 }
356
John Zulauff660ad62019-03-23 07:16:05 -0600357 SetImageLayout(cb_node, *image_state, sub_range, layout);
John Zulauf4ccf5c02018-09-21 11:46:18 -0600358}
359
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700360bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
361 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700362 VkFramebuffer framebuffer, VkRenderPass renderpass,
363 uint32_t attachment_index, const char *variable_name) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100364 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700365 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100366 const char *vuid;
367 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
368
369 if (!image_state) {
370 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
371 "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
locke-lunarg9edc2812019-06-17 23:18:52 -0600372 "Render Pass begin with %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
Lockee9aeebf2019-03-03 23:50:08 -0700373 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
374 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100375 return skip;
376 }
377
378 auto image_usage = image_state->createInfo.usage;
379
380 // Check for layouts that mismatch image usages in the framebuffer
381 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
382 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
383 skip |=
384 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 -0600385 "Layout/usage mismatch for attachment %u in %s"
386 " - the %s is %s but the image attached to %s via %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100387 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600388 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
389 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100390 }
391
392 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
393 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
394 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
395 skip |=
396 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 -0600397 "Layout/usage mismatch for attachment %u in %s"
398 " - the %s is %s but the image attached to %s via %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100399 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600400 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
401 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100402 }
403
404 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
405 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
406 skip |=
407 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 -0600408 "Layout/usage mismatch for attachment %u in %s"
409 " - the %s is %s but the image attached to %s via %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100410 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600411 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
412 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100413 }
414
415 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
416 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
417 skip |=
418 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 -0600419 "Layout/usage mismatch for attachment %u in %s"
420 " - the %s is %s but the image attached to %s via %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100421 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600422 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
423 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100424 }
425
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600426 if (device_extensions.vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100427 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
428 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
429 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
430 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
431 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
432 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Lockee9aeebf2019-03-03 23:50:08 -0700433 skip |= log_msg(
434 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 -0600435 "Layout/usage mismatch for attachment %u in %s"
436 " - the %s is %s but the image attached to %s via %s"
Lockee9aeebf2019-03-03 23:50:08 -0700437 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600438 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
439 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100440 }
441 } else {
442 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
443 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
444 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
445 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
446 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
447 HandleToUint64(image), "VUID-vkCmdBeginRenderPass-initialLayout-00896",
locke-lunarg9edc2812019-06-17 23:18:52 -0600448 "Layout/usage mismatch for attachment %u in %s"
449 " - the %s is %s but the image attached to %s via %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100450 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600451 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
452 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
Lockee9aeebf2019-03-03 23:50:08 -0700453 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100454 }
455 }
456 return skip;
457}
458
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600459bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700460 const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700461 const FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600462 bool skip = false;
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700463 auto const pRenderPassInfo = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700464 auto const &framebufferInfo = framebuffer_state->createInfo;
Tobias Hectorc9057422019-07-23 12:15:52 +0100465 const VkImageView *attachments = framebufferInfo.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100466
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700467 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100468 auto framebuffer = framebuffer_state->framebuffer;
469
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700470 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600471 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 -0600472 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700473 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700474 }
John Zulauf8e308292018-09-21 11:34:37 -0600475
Tobias Hectorc9057422019-07-23 12:15:52 +0100476 const auto *attachmentInfo = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
477 if (((framebufferInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) != 0) && attachmentInfo != nullptr) {
478 attachments = attachmentInfo->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100479 }
480
Tobias Hectorc9057422019-07-23 12:15:52 +0100481 if (attachments != nullptr) {
482 const auto *const_pCB = static_cast<const CMD_BUFFER_STATE *>(pCB);
483 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
484 auto image_view = attachments[i];
485 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100486
Tobias Hectorc9057422019-07-23 12:15:52 +0100487 if (!view_state) {
488 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_RENDER_PASS_EXT,
489 HandleToUint64(pRenderPassBegin->renderPass), "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
490 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
491 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
492 report_data->FormatHandle(image_view).c_str());
493 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100494 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100495
496 const VkImage image = view_state->create_info.image;
497 const IMAGE_STATE *image_state = GetImageState(image);
498
499 if (!image_state) {
500 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_RENDER_PASS_EXT,
501 HandleToUint64(pRenderPassBegin->renderPass), "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
502 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
503 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
504 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
505 continue;
506 }
507 auto attachment_initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
508 auto final_layout = pRenderPassInfo->pAttachments[i].finalLayout;
509
510 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
511 // in common with the non-const version.)
512 const ImageSubresourceLayoutMap *subresource_map =
513 (attachment_initial_layout != VK_IMAGE_LAYOUT_UNDEFINED) ? GetImageSubresourceLayoutMap(const_pCB, image) : nullptr;
514
515 if (subresource_map) { // If no layout information for image yet, will be checked at QueueSubmit time
516 LayoutUseCheckAndMessage layout_check(subresource_map);
517 bool subres_skip = false;
518 auto subresource_cb = [this, i, attachment_initial_layout, &layout_check, &subres_skip](
519 const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
520 if (!layout_check.Check(subres, attachment_initial_layout, layout, initial_layout)) {
521 subres_skip |=
522 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
523 kVUID_Core_DrawState_InvalidRenderpass,
524 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
525 "and the %s layout of the attachment is %s. The layouts must match, or the render "
526 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
527 i, string_VkImageLayout(attachment_initial_layout), layout_check.message,
528 string_VkImageLayout(layout_check.layout));
529 }
530 return !subres_skip; // quit checking subresources once we fail once
531 };
532
533 subresource_map->ForRange(view_state->normalized_subresource_range, subresource_cb);
534 skip |= subres_skip;
535 }
536
537 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view,
538 framebuffer, render_pass, i, "initial layout");
539
540 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer,
541 render_pass, i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100542 }
543
Tobias Hectorc9057422019-07-23 12:15:52 +0100544 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
545 auto &subpass = pRenderPassInfo->pSubpasses[j];
546 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
547 auto &attachment_ref = subpass.pInputAttachments[k];
548 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
549 auto image_view = attachments[attachment_ref.attachment];
550 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100551
Tobias Hectorc9057422019-07-23 12:15:52 +0100552 if (view_state) {
553 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700554 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
555 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100556 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100557 }
558 }
559 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100560
Tobias Hectorc9057422019-07-23 12:15:52 +0100561 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
562 auto &attachment_ref = subpass.pColorAttachments[k];
563 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
564 auto image_view = attachments[attachment_ref.attachment];
565 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100566
Tobias Hectorc9057422019-07-23 12:15:52 +0100567 if (view_state) {
568 auto image = view_state->create_info.image;
569 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
570 framebuffer, render_pass, attachment_ref.attachment,
571 "color attachment layout");
572 if (subpass.pResolveAttachments) {
573 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
574 rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
575 attachment_ref.attachment, "resolve attachment layout");
576 }
577 }
578 }
579 }
580
581 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
582 auto &attachment_ref = *subpass.pDepthStencilAttachment;
583 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
584 auto image_view = attachments[attachment_ref.attachment];
585 auto view_state = GetImageViewState(image_view);
586
587 if (view_state) {
588 auto image = view_state->create_info.image;
589 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
590 framebuffer, render_pass, attachment_ref.attachment,
591 "input attachment layout");
592 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100593 }
594 }
595 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700596 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600597 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700598}
599
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600600void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700601 const safe_VkAttachmentReference2KHR &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700602 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700603 auto image_view = GetAttachmentImageViewState(pFramebuffer, ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600604 if (image_view) {
John Zulauff660ad62019-03-23 07:16:05 -0600605 SetImageViewLayout(pCB, *image_view, ref.layout);
John Zulauf8e308292018-09-21 11:34:37 -0600606 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700607 }
608}
609
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600610void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
611 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700612 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700613
614 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700615 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700616 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700617 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700618 }
619 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700620 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700621 }
622 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700623 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700624 }
625 }
626}
627
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700628// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
629// 1. Transition into initialLayout state
630// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600631void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700632 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700633 // First transition into initialLayout
634 auto const rpci = render_pass_state->createInfo.ptr();
635 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700636 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -0600637 if (view_state) {
John Zulauff660ad62019-03-23 07:16:05 -0600638 SetImageViewLayout(cb_state, *view_state, rpci->pAttachments[i].initialLayout);
John Zulauf8e308292018-09-21 11:34:37 -0600639 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700640 }
641 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700642 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700643}
644
Dave Houlton10b39482017-03-16 13:18:15 -0600645bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600646 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600647 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600648 }
649 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600650 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600651 }
652 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600653 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600654 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700655 if (0 !=
656 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
657 if (FormatPlaneCount(format) == 1) return false;
658 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600659 return true;
660}
661
Mike Weiblen62d08a32017-03-07 22:18:27 -0700662// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Petr Krausad0096a2019-08-09 18:35:04 +0200663bool CoreChecks::ValidateBarrierLayoutToImageUsage(const VkImageMemoryBarrier &img_barrier, bool new_not_old,
664 VkImageUsageFlags usage_flags, const char *func_name,
665 const char *barrier_pname) {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700666 bool skip = false;
Petr Krausad0096a2019-08-09 18:35:04 +0200667 const VkImageLayout layout = (new_not_old) ? img_barrier.newLayout : img_barrier.oldLayout;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600668 const char *msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700669
670 switch (layout) {
671 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
672 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600673 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700674 }
675 break;
676 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
677 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600678 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700679 }
680 break;
681 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
682 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600683 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700684 }
685 break;
686 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
687 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600688 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700689 }
690 break;
691 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
692 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600693 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700694 }
695 break;
696 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
697 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600698 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700699 }
700 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600701 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500702 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
703 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
704 }
705 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700706 default:
707 // Other VkImageLayout values do not have VUs defined in this context.
708 break;
709 }
710
Dave Houlton8e9f6542018-05-18 12:18:22 -0600711 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600712 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 +0200713 HandleToUint64(img_barrier.image), msg_code,
714 "%s: Image barrier %s %s Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".", func_name,
715 barrier_pname, ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
716 report_data->FormatHandle(img_barrier.image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700717 }
718 return skip;
719}
720
721// Verify image barriers are compatible with the images they reference.
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600722bool CoreChecks::ValidateBarriersToImages(CMD_BUFFER_STATE const *cb_state, uint32_t imageMemoryBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700723 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700724 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700725
Petr Krausad0096a2019-08-09 18:35:04 +0200726 // Scoreboard for checking for duplicate and inconsistent barriers to images
727 struct ImageBarrierScoreboardEntry {
728 uint32_t index;
729 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
730 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
731 const VkImageMemoryBarrier *barrier;
732 };
733 using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
734 using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
735
John Zulauf463c51e2018-05-31 13:29:20 -0600736 // Scoreboard for duplicate layout transition barriers within the list
737 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
738 ImageBarrierScoreboardImageMap layout_transitions;
739
Mike Weiblen62d08a32017-03-07 22:18:27 -0700740 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +0200741 const auto &img_barrier = pImageMemoryBarriers[i];
742 const std::string barrier_pname = "pImageMemoryBarrier[" + std::to_string(i) + "]";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700743
John Zulauf463c51e2018-05-31 13:29:20 -0600744 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
745 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
746 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +0200747 if (img_barrier.oldLayout != img_barrier.newLayout) {
748 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
749 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -0600750 if (image_it != layout_transitions.end()) {
751 auto &subres_map = image_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200752 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -0600753 if (subres_it != subres_map.end()) {
754 auto &entry = subres_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200755 if ((entry.barrier->newLayout != img_barrier.oldLayout) &&
756 (img_barrier.oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
757 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
John Zulauf463c51e2018-05-31 13:29:20 -0600758 skip = log_msg(
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700759 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
760 HandleToUint64(cb_state->commandBuffer), "VUID-VkImageMemoryBarrier-oldLayout-01197",
Petr Krausad0096a2019-08-09 18:35:04 +0200761 "%s: %s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600762 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
763 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Petr Krausad0096a2019-08-09 18:35:04 +0200764 func_name, barrier_pname.c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
765 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
766 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600767 }
768 entry = new_entry;
769 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200770 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600771 }
772 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200773 layout_transitions[img_barrier.image][img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600774 }
775 }
776
Petr Krausad0096a2019-08-09 18:35:04 +0200777 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600778 if (image_state) {
779 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Petr Krausad0096a2019-08-09 18:35:04 +0200780 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, false, usage_flags, func_name, barrier_pname.c_str());
781 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, true, usage_flags, func_name, barrier_pname.c_str());
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600782
783 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
784 if (image_state->layout_locked) {
785 // TODO: Add unique id for error when available
Dave Houlton33c2d252017-06-09 17:08:32 -0600786 skip |= log_msg(
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700787 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Krausad0096a2019-08-09 18:35:04 +0200788 HandleToUint64(img_barrier.image), 0,
locke-lunarg9edc2812019-06-17 23:18:52 -0600789 "Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600790 " 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 +0200791 report_data->FormatHandle(img_barrier.image).c_str(), string_VkImageLayout(img_barrier.oldLayout),
792 string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600793 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600794
John Zulauff660ad62019-03-23 07:16:05 -0600795 VkImageCreateInfo *image_create_info = &image_state->createInfo;
796 // For a Depth/Stencil image both aspects MUST be set
797 if (FormatIsDepthAndStencil(image_create_info->format)) {
Petr Krausad0096a2019-08-09 18:35:04 +0200798 auto const aspect_mask = img_barrier.subresourceRange.aspectMask;
John Zulauff660ad62019-03-23 07:16:05 -0600799 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
800 if ((aspect_mask & ds_mask) != (ds_mask)) {
801 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 +0200802 HandleToUint64(img_barrier.image), "VUID-VkImageMemoryBarrier-image-01207",
803 "%s: Image barrier %s references %s of format %s that must have the depth and stencil "
John Zulauff660ad62019-03-23 07:16:05 -0600804 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
Petr Krausad0096a2019-08-09 18:35:04 +0200805 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
John Zulauff660ad62019-03-23 07:16:05 -0600806 string_VkFormat(image_create_info->format), aspect_mask);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700807 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700808 }
John Zulauff660ad62019-03-23 07:16:05 -0600809
Petr Krausad0096a2019-08-09 18:35:04 +0200810 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier.image);
811 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -0600812 // TODO: Set memory invalid which is in mem_tracker currently
813 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
814 // subresource.
815 } else if (subresource_map) {
816 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -0600817 LayoutUseCheckAndMessage layout_check(subresource_map);
Petr Krausad0096a2019-08-09 18:35:04 +0200818 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier.subresourceRange);
John Zulauf02a204c2019-04-23 18:52:11 -0600819 auto subres_callback = [this, img_barrier, cb_state, &layout_check, &subres_skip](
John Zulauff660ad62019-03-23 07:16:05 -0600820 const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
Petr Krausad0096a2019-08-09 18:35:04 +0200821 if (!layout_check.Check(subres, img_barrier.oldLayout, layout, initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600822 subres_skip =
823 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
824 HandleToUint64(cb_state->commandBuffer), "VUID-VkImageMemoryBarrier-oldLayout-01197",
locke-lunarg9edc2812019-06-17 23:18:52 -0600825 "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 -0600826 "%s layout is %s.",
Petr Krausad0096a2019-08-09 18:35:04 +0200827 report_data->FormatHandle(img_barrier.image).c_str(), subres.aspectMask, subres.mipLevel,
828 subres.arrayLayer, string_VkImageLayout(img_barrier.oldLayout), layout_check.message,
John Zulauff660ad62019-03-23 07:16:05 -0600829 string_VkImageLayout(layout_check.layout));
830 }
831 return !subres_skip;
832 };
833 subresource_map->ForRange(normalized_isr, subres_callback);
834 skip |= subres_skip;
835 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700836 }
837 }
838 return skip;
839}
840
Petr Krausad0096a2019-08-09 18:35:04 +0200841bool CoreChecks::IsReleaseOp(CMD_BUFFER_STATE *cb_state, const VkImageMemoryBarrier &barrier) {
842 if (!IsTransferOp(&barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700843
Mark Lobodzinskic2a15b02019-04-25 12:06:02 -0600844 auto pool = GetCommandPoolState(cb_state->createInfo.commandPool);
Petr Krausad0096a2019-08-09 18:35:04 +0200845 return pool && TempIsReleaseOp<VkImageMemoryBarrier, true>(pool, &barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700846}
847
John Zulauf6b4aae82018-05-09 13:03:36 -0600848template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600849bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700850 const Barrier *barriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600851 using BarrierRecord = QFOTransferBarrier<Barrier>;
852 bool skip = false;
Mark Lobodzinskic2a15b02019-04-25 12:06:02 -0600853 auto pool = GetCommandPoolState(cb_state->createInfo.commandPool);
John Zulauf6b4aae82018-05-09 13:03:36 -0600854 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
855 const char *barrier_name = BarrierRecord::BarrierName();
856 const char *handle_name = BarrierRecord::HandleName();
857 const char *transfer_type = nullptr;
858 for (uint32_t b = 0; b < barrier_count; b++) {
859 if (!IsTransferOp(&barriers[b])) continue;
860 const BarrierRecord *barrier_record = nullptr;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700861 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) &&
862 !IsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600863 const auto found = barrier_sets.release.find(barriers[b]);
864 if (found != barrier_sets.release.cend()) {
865 barrier_record = &(*found);
866 transfer_type = "releasing";
867 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600868 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
869 !IsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600870 const auto found = barrier_sets.acquire.find(barriers[b]);
871 if (found != barrier_sets.acquire.cend()) {
872 barrier_record = &(*found);
873 transfer_type = "acquiring";
874 }
875 }
876 if (barrier_record != nullptr) {
Lockee9aeebf2019-03-03 23:50:08 -0700877 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
878 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInCB(),
879 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
880 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
881 func_name, barrier_name, b, transfer_type, handle_name,
882 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
883 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -0600884 }
885 }
886 return skip;
887}
888
889template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600890void CoreChecks::RecordQFOTransferBarriers(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count, const Barrier *barriers) {
Mark Lobodzinskic2a15b02019-04-25 12:06:02 -0600891 auto pool = GetCommandPoolState(cb_state->createInfo.commandPool);
John Zulauf6b4aae82018-05-09 13:03:36 -0600892 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
893 for (uint32_t b = 0; b < barrier_count; b++) {
894 if (!IsTransferOp(&barriers[b])) continue;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700895 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barriers[b]) &&
896 !IsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600897 barrier_sets.release.emplace(barriers[b]);
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600898 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
899 !IsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600900 barrier_sets.acquire.emplace(barriers[b]);
901 }
902 }
903}
904
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600905bool CoreChecks::ValidateBarriersQFOTransferUniqueness(const char *func_name, CMD_BUFFER_STATE *cb_state,
906 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700907 uint32_t imageMemBarrierCount,
908 const VkImageMemoryBarrier *pImageMemBarriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600909 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700910 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
911 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -0600912 return skip;
913}
914
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600915void CoreChecks::RecordBarriersQFOTransfers(CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700916 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
917 const VkImageMemoryBarrier *pImageMemBarriers) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700918 RecordQFOTransferBarriers(cb_state, bufferBarrierCount, pBufferMemBarriers);
919 RecordQFOTransferBarriers(cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -0600920}
921
922template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600923bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
John Zulauf3b04ebd2019-07-18 14:08:11 -0600924 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600925 // Record to the scoreboard or report that we have a duplication
926 bool skip = false;
927 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
928 if (!inserted.second && inserted.first->second != cb_state) {
929 // 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 -0700930 skip = log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
931 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
932 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
locke-lunarg9edc2812019-06-17 23:18:52 -0600933 " duplicates existing barrier submitted in this batch from %s.",
Lockee9aeebf2019-03-03 23:50:08 -0700934 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
935 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex, barrier.dstQueueFamilyIndex,
John Zulauf7eb94822019-04-05 09:38:46 -0600936 report_data->FormatHandle(inserted.first->second->commandBuffer).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -0600937 }
938 return skip;
939}
940
941template <typename Barrier>
John Zulauf3b04ebd2019-07-18 14:08:11 -0600942bool CoreChecks::ValidateQueuedQFOTransferBarriers(const CMD_BUFFER_STATE *cb_state,
943 QFOTransferCBScoreboards<Barrier> *scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600944 using BarrierRecord = QFOTransferBarrier<Barrier>;
945 using TypeTag = typename BarrierRecord::Tag;
946 bool skip = false;
John Zulauf6b4aae82018-05-09 13:03:36 -0600947 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -0700948 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -0600949 const char *barrier_name = BarrierRecord::BarrierName();
950 const char *handle_name = BarrierRecord::HandleName();
951 // No release should have an extant duplicate (WARNING)
952 for (const auto &release : cb_barriers.release) {
953 // Check the global pending release barriers
954 const auto set_it = global_release_barriers.find(release.handle);
955 if (set_it != global_release_barriers.cend()) {
956 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
957 const auto found = set_for_handle.find(release);
958 if (found != set_for_handle.cend()) {
959 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
960 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
Lockee9aeebf2019-03-03 23:50:08 -0700961 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
John Zulauf6b4aae82018-05-09 13:03:36 -0600962 " to dstQueueFamilyIndex %" PRIu32
963 " duplicates existing barrier queued for execution, without intervening acquire operation.",
Lockee9aeebf2019-03-03 23:50:08 -0700964 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
John Zulauf6b4aae82018-05-09 13:03:36 -0600965 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
966 }
967 }
968 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
969 }
970 // Each acquire must have a matching release (ERROR)
971 for (const auto &acquire : cb_barriers.acquire) {
972 const auto set_it = global_release_barriers.find(acquire.handle);
973 bool matching_release_found = false;
974 if (set_it != global_release_barriers.cend()) {
975 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
976 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
977 }
978 if (!matching_release_found) {
979 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
980 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
Lockee9aeebf2019-03-03 23:50:08 -0700981 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
982 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
983 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
John Zulauf6b4aae82018-05-09 13:03:36 -0600984 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
985 }
986 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
987 }
988 return skip;
989}
990
John Zulauf3b04ebd2019-07-18 14:08:11 -0600991bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700992 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
John Zulauf3b04ebd2019-07-18 14:08:11 -0600993 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600994 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700995 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state, qfo_image_scoreboards);
996 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state, qfo_buffer_scoreboards);
John Zulauf6b4aae82018-05-09 13:03:36 -0600997 return skip;
998}
999
1000template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001001void CoreChecks::RecordQueuedQFOTransferBarriers(CMD_BUFFER_STATE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001002 using BarrierRecord = QFOTransferBarrier<Barrier>;
1003 using TypeTag = typename BarrierRecord::Tag;
1004 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001005 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001006
1007 // Add release barriers from this submit to the global map
1008 for (const auto &release : cb_barriers.release) {
1009 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1010 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1011 global_release_barriers[release.handle].insert(release);
1012 }
1013
1014 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1015 for (const auto &acquire : cb_barriers.acquire) {
1016 // NOTE: We're not using [] because we don't want to create entries for missing releases
1017 auto set_it = global_release_barriers.find(acquire.handle);
1018 if (set_it != global_release_barriers.end()) {
1019 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1020 set_for_handle.erase(acquire);
1021 if (set_for_handle.size() == 0) { // Clean up empty sets
1022 global_release_barriers.erase(set_it);
1023 }
1024 }
1025 }
1026}
1027
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001028void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001029 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state);
1030 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001031}
1032
John Zulauf6b4aae82018-05-09 13:03:36 -06001033// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001034void CoreChecks::EraseQFOImageRelaseBarriers(const VkImage &image) { EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image); }
John Zulauf6b4aae82018-05-09 13:03:36 -06001035
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001036void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001037 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001038 for (uint32_t i = 0; i < memBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +02001039 const auto &mem_barrier = pImgMemBarriers[i];
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001040
Chris Forbes4de4b132017-08-21 11:27:08 -07001041 // For ownership transfers, the barrier is specified twice; as a release
1042 // operation on the yielding queue family, and as an acquire operation
1043 // on the acquiring queue family. This barrier may also include a layout
1044 // transition, which occurs 'between' the two operations. For validation
1045 // purposes it doesn't seem important which side performs the layout
1046 // transition, but it must not be performed twice. We'll arbitrarily
1047 // choose to perform it as part of the acquire operation.
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001048 if (IsReleaseOp(cb_state, mem_barrier)) {
Chris Forbes4de4b132017-08-21 11:27:08 -07001049 continue;
1050 }
1051
Petr Krausad0096a2019-08-09 18:35:04 +02001052 auto *image_state = GetImageState(mem_barrier.image);
John Zulauff660ad62019-03-23 07:16:05 -06001053 if (!image_state) continue;
1054
Petr Krausad0096a2019-08-09 18:35:04 +02001055 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier.subresourceRange);
John Zulauff660ad62019-03-23 07:16:05 -06001056 const auto &image_create_info = image_state->createInfo;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001057
Dave Houltonb3f4b282018-02-22 16:25:16 -07001058 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1059 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1060 // for all (potential) layer sub_resources.
John Zulauff660ad62019-03-23 07:16:05 -06001061 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
1062 normalized_isr.baseArrayLayer = 0;
1063 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
Dave Houltonb3f4b282018-02-22 16:25:16 -07001064 }
1065
Petr Krausad0096a2019-08-09 18:35:04 +02001066 SetImageLayout(cb_state, *image_state, normalized_isr, mem_barrier.newLayout, mem_barrier.oldLayout);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001067 }
1068}
1069
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001070bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1071 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1072 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1073 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Matthew Ruschd7ef5482019-07-16 22:01:54 -07001074 if (disabled.image_layout_validation) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001075 assert(cb_node);
1076 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001077 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001078 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001079
John Zulauff660ad62019-03-23 07:16:05 -06001080 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1081 if (subresource_map) {
1082 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001083 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
1084 auto subresource_cb = [this, explicit_layout, cb_node, layout_mismatch_msg_code, caller, image, &layout_check, &error,
John Zulaufabcc8292019-04-08 18:07:44 -06001085 &subres_skip](const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
John Zulauf02a204c2019-04-23 18:52:11 -06001086 if (!layout_check.Check(subres, explicit_layout, layout, initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001087 *error = true;
John Zulauff660ad62019-03-23 07:16:05 -06001088 subres_skip |=
1089 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1090 HandleToUint64(cb_node->commandBuffer), layout_mismatch_msg_code,
locke-lunarg9edc2812019-06-17 23:18:52 -06001091 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
John Zulauff660ad62019-03-23 07:16:05 -06001092 "%s layout %s.",
1093 caller, report_data->FormatHandle(image).c_str(), subres.arrayLayer, subres.mipLevel,
1094 string_VkImageLayout(explicit_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001095 }
John Zulauff660ad62019-03-23 07:16:05 -06001096 return !subres_skip;
1097 };
1098 subresource_map->ForRange(range, subresource_cb);
1099 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001100 }
John Zulauff660ad62019-03-23 07:16:05 -06001101
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001102 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1103 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1104 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001105 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1106 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001107 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001108 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_node->commandBuffer),
Dave Houlton51653902018-06-22 17:32:13 -06001109 kVUID_Core_DrawState_InvalidImageLayout,
locke-lunarg9edc2812019-06-17 23:18:52 -06001110 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
Lockee9aeebf2019-03-03 23:50:08 -07001111 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001112 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001113 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001114 if (image_state->shared_presentable) {
1115 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
Cort Stratton7df30962018-05-17 19:45:57 -07001116 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1117 layout_invalid_msg_code,
1118 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1119 string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001120 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001121 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001122 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001123 *error = true;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001124 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 -07001125 HandleToUint64(cb_node->commandBuffer), layout_invalid_msg_code,
locke-lunarg9edc2812019-06-17 23:18:52 -06001126 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
Lockee9aeebf2019-03-03 23:50:08 -07001127 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1128 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001129 }
1130 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001131 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001132}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001133bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001134 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1135 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001136 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001137 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1138 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1139}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001140
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001141void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001142 FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinski2e495882019-03-06 16:11:56 -07001143 auto renderPass = GetRenderPassState(pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001144 if (!renderPass) return;
1145
Tobias Hectorbbb12282018-10-22 15:17:59 +01001146 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001147 if (framebuffer_state) {
1148 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07001149 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -06001150 if (view_state) {
John Zulauff660ad62019-03-23 07:16:05 -06001151 SetImageViewLayout(pCB, *view_state, pRenderPassInfo->pAttachments[i].finalLayout);
John Zulauf8e308292018-09-21 11:34:37 -06001152 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001153 }
1154 }
1155}
Dave Houltone19e20d2018-02-02 16:32:41 -07001156
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001157#ifdef VK_USE_PLATFORM_ANDROID_KHR
1158// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1159// This could also move into a seperate core_validation_android.cpp file... ?
1160
1161//
1162// AHB-specific validation within non-AHB APIs
1163//
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001164bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001165 bool skip = false;
1166
1167 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1168 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001169 if (0 != ext_fmt_android->externalFormat) {
1170 if (VK_FORMAT_UNDEFINED != create_info->format) {
1171 skip |=
1172 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1173 "VUID-VkImageCreateInfo-pNext-01974",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001174 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
Dave Houltond9611312018-11-19 17:03:36 -07001175 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
1176 }
1177
1178 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
1179 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1180 "VUID-VkImageCreateInfo-pNext-02396",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001181 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001182 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
1183 }
1184
1185 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
1186 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1187 "VUID-VkImageCreateInfo-pNext-02397",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001188 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001189 "non-zero externalFormat, but usage includes bits other than VK_IMAGE_USAGE_SAMPLED_BIT.");
1190 }
1191
1192 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
1193 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1194 "VUID-VkImageCreateInfo-pNext-02398",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001195 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001196 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
1197 }
1198 }
1199
Mark Lobodzinski1ee06e92019-04-19 14:03:53 -06001200 if ((0 != ext_fmt_android->externalFormat) && (0 == ahb_ext_formats_set.count(ext_fmt_android->externalFormat))) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001201 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1202 "VUID-VkExternalFormatANDROID-externalFormat-01894",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001203 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat which has "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001204 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().");
1205 }
1206 }
1207
Dave Houltond9611312018-11-19 17:03:36 -07001208 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001209 if (VK_FORMAT_UNDEFINED == create_info->format) {
1210 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1211 "VUID-VkImageCreateInfo-pNext-01975",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001212 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
Dave Houltond9611312018-11-19 17:03:36 -07001213 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
1214 }
1215 }
1216
1217 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1218 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1219 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001220 skip |=
1221 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1222 "VUID-VkImageCreateInfo-pNext-02393",
1223 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1224 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1225 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001226 }
1227
1228 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
1229 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1230 "VUID-VkImageCreateInfo-pNext-02394",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001231 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
Dave Houltond9611312018-11-19 17:03:36 -07001232 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1233 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1234 create_info->mipLevels, FullMipChainLevels(create_info->extent));
1235 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001236 }
1237
1238 return skip;
1239}
1240
John Zulauf7eeb6f72019-06-17 11:56:36 -06001241void ValidationStateTracker::RecordCreateImageANDROID(const VkImageCreateInfo *create_info, IMAGE_STATE *is_node) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001242 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1243 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1244 is_node->imported_ahb = true;
1245 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001246 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
egdaniel1f4d2a42019-02-04 10:25:38 -05001247 if (ext_fmt_android && (0 != ext_fmt_android->externalFormat)) {
Dave Houltond3e046d2018-11-28 13:08:09 -07001248 is_node->has_ahb_format = true;
1249 is_node->ahb_format = ext_fmt_android->externalFormat;
1250 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001251}
1252
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001253bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001254 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001255 IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001256
1257 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001258 if (VK_FORMAT_UNDEFINED != create_info->format) {
1259 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1260 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02399",
1261 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1262 "format member is %s.",
1263 string_VkFormat(create_info->format));
1264 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001265
Dave Houltond9611312018-11-19 17:03:36 -07001266 // Chain must include a compatible ycbcr conversion
1267 bool conv_found = false;
1268 uint64_t external_format = 0;
1269 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1270 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001271 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001272 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001273 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001274 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001275 }
Dave Houltond9611312018-11-19 17:03:36 -07001276 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001277 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001278 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 -07001279 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02400",
1280 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1281 "without a chained VkSamplerYcbcrConversionInfo struct with the same external format.");
1282 }
1283
1284 // Errors in create_info swizzles
1285 if ((create_info->components.r != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1286 (create_info->components.g != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1287 (create_info->components.b != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1288 (create_info->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
1289 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1290 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02401",
1291 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1292 "includes one or more non-identity component swizzles.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001293 }
1294 }
Dave Houltond9611312018-11-19 17:03:36 -07001295
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001296 return skip;
1297}
1298
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001299bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001300 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001301
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001302 IMAGE_STATE *image_state = GetImageState(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001303 if (image_state->imported_ahb && (0 == image_state->GetBoundMemory().size())) {
1304 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
1305 "VUID-vkGetImageSubresourceLayout-image-01895",
Graeme Leese79b60cb2018-11-28 11:51:20 +00001306 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001307 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1308 "bound to memory.");
1309 }
1310 return skip;
1311}
1312
1313#else
1314
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001315bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001316 return false;
1317}
1318
John Zulauf7eeb6f72019-06-17 11:56:36 -06001319void ValidationStateTracker::RecordCreateImageANDROID(const VkImageCreateInfo *create_info, IMAGE_STATE *is_node) {}
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001320
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001321bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001322
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001323bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001324
1325#endif // VK_USE_PLATFORM_ANDROID_KHR
1326
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001327bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1328 const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001329 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001330
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001331 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001332 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001333 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1334 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
1335 return log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1336 "VUID-VkImageCreateInfo-format-00943",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001337 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001338 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001339 }
1340
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001341 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1342 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
1343 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1344 "VUID-VkImageCreateInfo-flags-00949",
1345 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1346 "flag bit is set");
1347 }
1348
1349 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
1350 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1351 "VUID-VkImageCreateInfo-imageType-00954",
1352 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1353 "height (%d) and arrayLayers (%d) must be >= 6.",
1354 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
1355 }
Dave Houlton130c0212018-01-29 13:39:56 -07001356 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001357
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001358 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001359 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1360 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1361 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001362 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 +00001363 "VUID-VkImageCreateInfo-usage-00964",
1364 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1365 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001366 }
1367
1368 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001369 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 +00001370 "VUID-VkImageCreateInfo-usage-00965",
1371 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1372 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001373 }
1374
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001375 VkImageFormatProperties format_limits = {};
Mark Lobodzinski5c048802019-03-07 10:47:31 -07001376 VkResult res = GetPDImageFormatProperties(pCreateInfo, &format_limits);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001377 if (res == VK_ERROR_FORMAT_NOT_SUPPORTED) {
Lockee87f87c2019-04-23 17:53:10 -06001378#ifdef VK_USE_PLATFORM_ANDROID_KHR
1379 if (!lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext))
1380#endif // VK_USE_PLATFORM_ANDROID_KHR
1381 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1382 "vkCreateImage(): Format %s is not supported for this combination of parameters.",
1383 string_VkFormat(pCreateInfo->format));
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001384 } else {
1385 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1386 const char *format_string = string_VkFormat(pCreateInfo->format);
1387 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1388 "VUID-VkImageCreateInfo-mipLevels-02255",
1389 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1390 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
1391 }
Dave Houlton130c0212018-01-29 13:39:56 -07001392
Dave Houltona585d132019-01-18 13:05:42 -07001393 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1394 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1395 (uint64_t)pCreateInfo->samples;
1396 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * texel_count);
Dave Houlton130c0212018-01-29 13:39:56 -07001397
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001398 // Round up to imageGranularity boundary
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001399 VkDeviceSize imageGranularity = phys_dev_props.limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001400 uint64_t ig_mask = imageGranularity - 1;
1401 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001402
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001403 if (total_size > format_limits.maxResourceSize) {
1404 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1405 kVUID_Core_Image_InvalidFormatLimitsViolation,
1406 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1407 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1408 total_size, format_limits.maxResourceSize);
1409 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001410
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001411 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
1412 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1413 "VUID-VkImageCreateInfo-arrayLayers-02256",
1414 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1415 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
1416 }
1417
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001418 if (device_extensions.vk_khr_sampler_ycbcr_conversion && FormatRequiresYcbcrConversion(pCreateInfo->format) &&
1419 !device_extensions.vk_ext_ycbcr_image_arrays && pCreateInfo->arrayLayers > 1) {
Piers Daniell10a5c762019-03-11 12:44:50 -06001420 skip |= log_msg(
1421 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1422 "VUID-VkImageCreateInfo-format-02653",
1423 "vkCreateImage(): arrayLayers=%d exceeds the maximum allowed of 1 for formats requiring sampler ycbcr conversion",
1424 pCreateInfo->arrayLayers);
1425 }
1426
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001427 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
1428 skip |=
1429 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1430 "VUID-VkImageCreateInfo-samples-02258", "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001431 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001432 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001433 }
1434
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06001435 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001436 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 -06001437 "VUID-VkImageCreateInfo-flags-01924",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001438 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
1439 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06001440 }
1441
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001442 if (device_extensions.vk_khr_maintenance2) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06001443 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
1444 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
1445 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
1446 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001447 skip |=
1448 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1449 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1450 "format must be block, ETC or ASTC compressed, but is %s",
1451 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001452 }
1453 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
1454 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001455 skip |=
1456 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1457 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1458 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001459 }
1460 }
1461 }
1462
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001463 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001464 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateImage",
1465 "pCreateInfo->pQueueFamilyIndices", "VUID-VkImageCreateInfo-sharingMode-01420",
1466 "VUID-VkImageCreateInfo-sharingMode-01420", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001467 }
1468
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001469 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001470}
1471
John Zulauf7eeb6f72019-06-17 11:56:36 -06001472void ValidationStateTracker::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1473 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07001474 if (VK_SUCCESS != result) return;
John Zulauf4db45df2019-07-23 06:10:40 -06001475 std::unique_ptr<IMAGE_STATE> is_node(new IMAGE_STATE(*pImage, pCreateInfo));
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001476 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
John Zulauf4db45df2019-07-23 06:10:40 -06001477 RecordCreateImageANDROID(pCreateInfo, is_node.get());
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001478 }
unknown09edc722019-06-21 15:49:38 -06001479 const auto swapchain_info = lvl_find_in_chain<VkImageSwapchainCreateInfoKHR>(pCreateInfo->pNext);
1480 if (swapchain_info) {
1481 is_node->create_from_swapchain = swapchain_info->swapchain;
1482 }
John Zulauf4db45df2019-07-23 06:10:40 -06001483
1484 bool pre_fetch_memory_reqs = true;
1485#ifdef VK_USE_PLATFORM_ANDROID_KHR
1486 if (is_node->external_format_android) {
1487 // Do not fetch requirements for external memory images
1488 pre_fetch_memory_reqs = false;
1489 }
1490#endif
1491 // Record the memory requirements in case they won't be queried
1492 if (pre_fetch_memory_reqs) {
1493 DispatchGetImageMemoryRequirements(device, *pImage, &is_node->requirements);
1494 }
1495 imageMap.insert(std::make_pair(*pImage, std::move(is_node)));
John Zulauf7eeb6f72019-06-17 11:56:36 -06001496}
1497
1498void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1499 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
1500 if (VK_SUCCESS != result) return;
1501
1502 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
1503
1504 IMAGE_LAYOUT_STATE image_state;
1505 image_state.layout = pCreateInfo->initialLayout;
1506 image_state.format = pCreateInfo->format;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001507 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001508 imageSubresourceMap[*pImage].push_back(subpair);
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -06001509 imageLayoutMap[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001510}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001511
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001512bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001513 IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06001514 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001515 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001516 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001517 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001518 }
1519 return skip;
1520}
1521
John Zulauf7eeb6f72019-06-17 11:56:36 -06001522void ValidationStateTracker::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidfa64112019-03-04 12:17:24 -07001523 if (!image) return;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001524 IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06001525 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001526 InvalidateCommandBuffers(image_state->cb_bindings, obj_struct);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001527 // Clean up memory mapping, bindings and range references for image
1528 for (auto mem_binding : image_state->GetBoundMemory()) {
Mark Lobodzinski0a41e0e2019-04-25 12:12:40 -06001529 auto mem_info = GetDevMemState(mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001530 if (mem_info) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001531 RemoveImageMemoryRange(obj_struct.handle, mem_info);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001532 }
1533 }
John Zulauf4fea6622019-04-01 11:38:18 -06001534 ClearMemoryObjectBindings(obj_struct);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001535 // Remove image from imageMap
Mark Lobodzinski34e04bf2019-04-19 13:31:53 -06001536 imageMap.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06001537}
1538
1539void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
1540 // Clean up validation specific data
1541 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001542
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001543 const auto &sub_entry = imageSubresourceMap.find(image);
1544 if (sub_entry != imageSubresourceMap.end()) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001545 for (const auto &pair : sub_entry->second) {
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -06001546 imageLayoutMap.erase(pair);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001547 }
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001548 imageSubresourceMap.erase(sub_entry);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001549 }
John Zulauf7eeb6f72019-06-17 11:56:36 -06001550
1551 // Clean up generic image state
1552 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001553}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001554
John Zulauf07288512019-07-05 11:09:50 -06001555bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001556 bool skip = false;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001557
1558 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
1559 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
1560 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 -06001561 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001562 }
1563
Dave Houlton1d2022c2017-03-29 11:43:58 -06001564 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001565 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
1566 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 -06001567 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -06001568 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001569 char const str[] = "vkCmdClearColorImage called with compressed image.";
1570 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 -06001571 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001572 }
1573
1574 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
1575 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
1576 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 -06001577 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00002", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001578 }
1579 return skip;
1580}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001581
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001582uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1583 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1584 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001585 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001586 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001587 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001588 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001589}
1590
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001591uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1592 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1593 uint32_t array_layer_count = range->layerCount;
1594 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1595 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001596 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001597 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001598}
1599
John Zulauf07288512019-07-05 11:09:50 -06001600bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1601 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
1602 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001603 bool skip = false;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001604
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001605 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
1606 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001607 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1608 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001609 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 -06001610 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001611 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
1612 }
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001613 } else if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR == dest_image_layout) {
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001614 if (!device_extensions.vk_khr_shared_presentable_image) {
Tobin Ehlisfb0661c2017-05-11 08:52:51 -06001615 // TODO: Add unique error id when available.
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001616 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 -06001617 HandleToUint64(image_state->image), 0,
Dave Houlton33c2d252017-06-09 17:08:32 -06001618 "Must enable VK_KHR_shared_presentable_image extension before creating images with a layout type "
1619 "of VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.");
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001620
1621 } else {
1622 if (image_state->shared_presentable) {
1623 skip |= log_msg(
1624 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001625 HandleToUint64(image_state->image), 0,
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001626 "Layout for shared presentable cleared image is %s but can only be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1627 string_VkImageLayout(dest_image_layout));
1628 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001629 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001630 } else {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06001631 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00005";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001632 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001633 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00012";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001634 } else {
1635 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1636 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001637 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 -06001638 HandleToUint64(image_state->image), error_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001639 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1640 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001641 }
1642 }
1643
John Zulauff660ad62019-03-23 07:16:05 -06001644 // Cast to const to prevent creation at validate time.
John Zulauf07288512019-07-05 11:09:50 -06001645 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06001646 if (subresource_map) {
1647 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001648 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06001649 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
John Zulauf02a204c2019-04-23 18:52:11 -06001650 auto subres_callback = [this, cb_node, dest_image_layout, func_name, &layout_check, &subres_skip](
John Zulauff660ad62019-03-23 07:16:05 -06001651 const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
John Zulauf02a204c2019-04-23 18:52:11 -06001652 if (!layout_check.Check(subres, dest_image_layout, layout, initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06001653 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
1654 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1655 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
1656 } else {
1657 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001658 }
John Zulauff660ad62019-03-23 07:16:05 -06001659 subres_skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1660 HandleToUint64(cb_node->commandBuffer), error_code,
1661 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
1662 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
1663 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001664 }
John Zulauff660ad62019-03-23 07:16:05 -06001665 return !subres_skip;
1666 };
1667 subresource_map->ForRange(normalized_isr, subres_callback);
1668 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001669 }
1670
1671 return skip;
1672}
1673
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001674bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1675 const VkClearColorValue *pColor, uint32_t rangeCount,
1676 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001677 bool skip = false;
1678 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06001679 const auto *cb_node = GetCBState(commandBuffer);
1680 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001681 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001682 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001683 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001684 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001685 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski544def72019-04-19 14:25:59 -06001686 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001687 skip |=
1688 ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
1689 "VUID-vkCmdClearColorImage-image-01993", "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001690 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001691 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001692 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001693 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001694 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001695 skip |= ValidateImageAttributes(image_state, pRanges[i]);
1696 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001697 }
1698 }
1699 return skip;
1700}
1701
John Zulaufeabb4462019-07-05 14:13:03 -06001702void ValidationStateTracker::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image,
1703 VkImageLayout imageLayout, const VkClearColorValue *pColor,
1704 uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06001705 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001706 auto image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001707 if (cb_node && image_state) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001708 AddCommandBufferBindingImage(cb_node, image_state);
John Zulaufeabb4462019-07-05 14:13:03 -06001709 }
1710}
1711
1712void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1713 const VkClearColorValue *pColor, uint32_t rangeCount,
1714 const VkImageSubresourceRange *pRanges) {
1715 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
1716
1717 auto cb_node = GetCBState(commandBuffer);
1718 auto image_state = GetImageState(image);
1719 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001720 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001721 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001722 }
1723 }
1724}
1725
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001726bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1727 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1728 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001729 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001730
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001731 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06001732 const auto *cb_node = GetCBState(commandBuffer);
1733 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001734 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001735 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06001736 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001737 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001738 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001739 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski544def72019-04-19 14:25:59 -06001740 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001741 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
1742 "VUID-vkCmdClearDepthStencilImage-image-01994",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001743 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001744 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001745 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001746 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001747 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001748 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001749 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001750 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001751 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1752 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001753 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001754 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1755 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001756 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 -06001757 HandleToUint64(commandBuffer), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001758 }
1759 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001760 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001761 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001762 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 -06001763 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00014", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001764 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001765 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1766 char const str[] =
1767 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1768 "set.";
1769 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 -06001770 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00009", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001771 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001772 }
1773 return skip;
1774}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001775
John Zulaufeabb4462019-07-05 14:13:03 -06001776void ValidationStateTracker::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image,
1777 VkImageLayout imageLayout,
1778 const VkClearDepthStencilValue *pDepthStencil,
1779 uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06001780 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001781 auto image_state = GetImageState(image);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001782 if (cb_node && image_state) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001783 AddCommandBufferBindingImage(cb_node, image_state);
John Zulaufeabb4462019-07-05 14:13:03 -06001784 }
1785}
1786
1787void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1788 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1789 const VkImageSubresourceRange *pRanges) {
1790 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
1791 auto cb_node = GetCBState(commandBuffer);
1792 auto image_state = GetImageState(image);
1793 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001794 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001795 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001796 }
1797 }
1798}
1799
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001800// Returns true if [x, xoffset] and [y, yoffset] overlap
1801static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1802 bool result = false;
1803 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1804 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1805
1806 if (intersection_max > intersection_min) {
1807 result = true;
1808 }
1809 return result;
1810}
1811
Dave Houltonc991cc92018-03-06 11:08:51 -07001812// Returns true if source area of first copy region intersects dest area of second region
1813// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1814static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001815 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001816
Dave Houltonc991cc92018-03-06 11:08:51 -07001817 // Separate planes within a multiplane image cannot intersect
1818 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07001819 return result;
1820 }
1821
Dave Houltonc991cc92018-03-06 11:08:51 -07001822 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
1823 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
1824 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001825 result = true;
1826 switch (type) {
1827 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001828 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001829 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001830 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001831 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001832 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001833 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001834 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001835 break;
1836 default:
1837 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1838 assert(false);
1839 }
1840 }
1841 return result;
1842}
1843
Dave Houltonfc1a4052017-04-27 14:32:45 -06001844// Returns non-zero if offset and extent exceed image extents
1845static const uint32_t x_bit = 1;
1846static const uint32_t y_bit = 2;
1847static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001848static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001849 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001850 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001851 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1852 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001853 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001854 }
1855 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1856 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001857 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001858 }
1859 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1860 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001861 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001862 }
1863 return result;
1864}
1865
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001866// Test if two VkExtent3D structs are equivalent
1867static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1868 bool result = true;
1869 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1870 (extent->depth != other_extent->depth)) {
1871 result = false;
1872 }
1873 return result;
1874}
1875
Dave Houltonee281a52017-12-08 13:51:02 -07001876// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1877// Destination image texel extents must be adjusted by block size for the dest validation checks
1878VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1879 VkExtent3D adjusted_extent = extent;
1880 if ((FormatIsCompressed(src_format) && (!FormatIsCompressed(dst_format)))) {
Dave Houltona585d132019-01-18 13:05:42 -07001881 VkExtent3D block_size = FormatTexelBlockExtent(src_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001882 adjusted_extent.width /= block_size.width;
1883 adjusted_extent.height /= block_size.height;
1884 adjusted_extent.depth /= block_size.depth;
1885 } else if ((!FormatIsCompressed(src_format) && (FormatIsCompressed(dst_format)))) {
Dave Houltona585d132019-01-18 13:05:42 -07001886 VkExtent3D block_size = FormatTexelBlockExtent(dst_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001887 adjusted_extent.width *= block_size.width;
1888 adjusted_extent.height *= block_size.height;
1889 adjusted_extent.depth *= block_size.depth;
1890 }
1891 return adjusted_extent;
1892}
1893
Dave Houlton6f9059e2017-05-02 17:15:13 -06001894// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001895static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1896 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001897
1898 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06001899 if (mip >= img->createInfo.mipLevels) {
1900 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06001901 }
Dave Houlton1150cf52017-04-27 14:38:11 -06001902
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001903 // 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 -06001904 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05001905
Dave Houltone48cd112019-01-03 17:01:18 -07001906 // If multi-plane, adjust per-plane extent
1907 if (FormatIsMultiplane(img->createInfo.format)) {
1908 VkExtent2D divisors = FindMultiplaneExtentDivisors(img->createInfo.format, subresource->aspectMask);
1909 extent.width /= divisors.width;
1910 extent.height /= divisors.height;
1911 }
1912
Jeff Bolzef40fec2018-09-01 22:04:34 -05001913 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
1914 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
Dave Houlton142c4cb2018-10-17 15:04:41 -06001915 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1) >> mip)));
Jeff Bolzef40fec2018-09-01 22:04:34 -05001916 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
1917 } else {
1918 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1919 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1920 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
1921 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06001922
Dave Houlton6f9059e2017-05-02 17:15:13 -06001923 // Image arrays have an effective z extent that isn't diminished by mip level
1924 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001925 extent.depth = img->createInfo.arrayLayers;
1926 }
1927
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001928 return extent;
1929}
1930
1931// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001932static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001933 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1934}
1935
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001936// Test if the extent argument has any dimensions set to 0.
1937static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1938 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1939}
1940
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001941// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001942VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001943 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1944 VkExtent3D granularity = {0, 0, 0};
Mark Lobodzinskic2a15b02019-04-25 12:06:02 -06001945 auto pPool = GetCommandPoolState(cb_node->createInfo.commandPool);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001946 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001947 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001948 if (FormatIsCompressed(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07001949 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001950 granularity.width *= block_size.width;
1951 granularity.height *= block_size.height;
1952 }
1953 }
1954 return granularity;
1955}
1956
1957// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1958static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1959 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001960 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
1961 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001962 valid = false;
1963 }
1964 return valid;
1965}
1966
1967// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001968bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001969 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001970 bool skip = false;
1971 VkExtent3D offset_extent = {};
1972 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1973 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1974 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001975 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001976 // 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 -07001977 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001978 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 -04001979 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001980 "%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 "
1981 "image transfer granularity is (w=0, h=0, d=0).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001982 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001983 }
1984 } else {
1985 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1986 // integer multiples of the image transfer granularity.
1987 if (IsExtentAligned(&offset_extent, granularity) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001988 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 -04001989 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001990 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
1991 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001992 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
1993 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001994 }
1995 }
1996 return skip;
1997}
1998
1999// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002000bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002001 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
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;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002004 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002005 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2006 // subresource extent.
2007 if (IsExtentEqual(extent, subresource_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002008 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 -04002009 HandleToUint64(cb_node->commandBuffer), vuid,
Petr Krausbc7f5442017-05-14 23:43:38 +02002010 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2011 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2012 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2013 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002014 }
2015 } else {
2016 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2017 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2018 // subresource extent dimensions.
2019 VkExtent3D offset_extent_sum = {};
2020 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2021 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2022 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002023 bool x_ok = true;
2024 bool y_ok = true;
2025 bool z_ok = true;
2026 switch (image_type) {
2027 case VK_IMAGE_TYPE_3D:
2028 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2029 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002030 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002031 case VK_IMAGE_TYPE_2D:
2032 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2033 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002034 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002035 case VK_IMAGE_TYPE_1D:
2036 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2037 (subresource_extent->width == offset_extent_sum.width));
2038 break;
2039 default:
2040 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2041 assert(false);
2042 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002043 if (!(x_ok && y_ok && z_ok)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002044 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 -04002045 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002046 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2047 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2048 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2049 function, i, member, extent->width, extent->height, extent->depth, granularity->width,
2050 granularity->height, granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height,
2051 extent->depth, subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002052 }
2053 }
2054 return skip;
2055}
2056
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002057bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002058 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002059 bool skip = false;
2060 if (mip_level >= img->createInfo.mipLevels) {
2061 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2062 HandleToUint64(cb_node->commandBuffer), vuid,
locke-lunarg9edc2812019-06-17 23:18:52 -06002063 "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.", function, i, member, mip_level,
2064 report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002065 }
2066 return skip;
2067}
2068
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002069bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002070 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002071 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002072 bool skip = false;
2073 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2074 (base_layer + layer_count) > img->createInfo.arrayLayers) {
2075 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2076 HandleToUint64(cb_node->commandBuffer), vuid,
2077 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
locke-lunarg9edc2812019-06-17 23:18:52 -06002078 "%u, but provided %s has %u array layers.",
Lockee9aeebf2019-03-03 23:50:08 -07002079 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2080 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002081 }
2082 return skip;
2083}
2084
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002085// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002086bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002087 const VkBufferImageCopy *region, const uint32_t i,
2088 const char *function, const char *vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002089 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002090 VkExtent3D granularity = GetScaledItg(cb_node, img);
2091 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002092 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002093 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002094 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002095 return skip;
2096}
2097
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002098// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002099bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002100 const IMAGE_STATE *dst_img, const VkImageCopy *region,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002101 const uint32_t i, const char *function) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002102 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002103 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002104 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
2105 skip |=
2106 CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002107 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002108 const VkExtent3D extent = region->extent;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002109 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
2110 i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002111
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002112 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002113 granularity = GetScaledItg(cb_node, dst_img);
2114 skip |=
2115 CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002116 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002117 const VkExtent3D dest_effective_extent =
2118 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002119 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002120 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002121 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002122 return skip;
2123}
2124
Dave Houlton6f9059e2017-05-02 17:15:13 -06002125// Validate contents of a VkImageCopy struct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002126bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const VkImageCopy *ic_regions, const IMAGE_STATE *src_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002127 const IMAGE_STATE *dst_state) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002128 bool skip = false;
2129
2130 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002131 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002132
2133 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002134 const VkExtent3D src_copy_extent = region.extent;
2135 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002136 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2137
Dave Houlton6f9059e2017-05-02 17:15:13 -06002138 bool slice_override = false;
2139 uint32_t depth_slices = 0;
2140
2141 // Special case for copying between a 1D/2D array and a 3D image
2142 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2143 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002144 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002145 slice_override = (depth_slices != 1);
2146 } 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 -07002147 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002148 slice_override = (depth_slices != 1);
2149 }
2150
2151 // Do all checks on source image
2152 //
2153 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002154 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
2155 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 -06002156 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00146",
Dave Houltonee281a52017-12-08 13:51:02 -07002157 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002158 "be 0 and 1, respectively.",
2159 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002160 }
2161 }
2162
Dave Houlton533be9f2018-03-26 17:08:30 -06002163 // VUID-VkImageCopy-srcImage-01785
2164 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
2165 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 -06002166 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01785",
Dave Houlton533be9f2018-03-26 17:08:30 -06002167 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002168 "these must be 0 and 1, respectively.",
2169 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002170 }
2171
Dave Houlton533be9f2018-03-26 17:08:30 -06002172 // VUID-VkImageCopy-srcImage-01787
2173 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
2174 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 -06002175 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01787",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002176 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2177 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002178 }
2179
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002180 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002181 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002182 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002183 skip |=
2184 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002185 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002186 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002187 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2188 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002189 }
2190 }
2191 } else { // Pre maint 1
2192 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002193 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002194 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 -06002195 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002196 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2197 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002198 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2199 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002200 }
2201 }
2202 }
2203
Dave Houltonc991cc92018-03-06 11:08:51 -07002204 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002205 bool ext_ycbcr = device_extensions.vk_khr_sampler_ycbcr_conversion;
Dave Houltonc991cc92018-03-06 11:08:51 -07002206 if (FormatIsCompressed(src_state->createInfo.format) ||
2207 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002208 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002209 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002210 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2211 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2212 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002213 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002214 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 -07002215 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002216 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002217 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002218 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002219 }
2220
Dave Houlton94a00372017-12-14 15:08:47 -07002221 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002222 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2223 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002224 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002225 skip |=
2226 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002227 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002228 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002229 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002230 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002231 }
2232
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002233 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002234 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2235 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002236 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002237 skip |=
2238 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002239 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002240 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002241 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002242 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002243 }
2244
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002245 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002246 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2247 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002248 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002249 skip |=
2250 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002251 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002252 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002253 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002254 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002255 }
2256 } // Compressed
2257
2258 // Do all checks on dest image
2259 //
2260 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002261 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002262 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 -06002263 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-00152",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002264 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002265 "these must be 0 and 1, respectively.",
2266 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002267 }
2268 }
2269
Dave Houlton533be9f2018-03-26 17:08:30 -06002270 // VUID-VkImageCopy-dstImage-01786
2271 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
2272 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 -06002273 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01786",
Dave Houlton533be9f2018-03-26 17:08:30 -06002274 "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 -06002275 "and 1, respectively.",
2276 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002277 }
2278
2279 // VUID-VkImageCopy-dstImage-01788
2280 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
2281 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 -06002282 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01788",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002283 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2284 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002285 }
2286
2287 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002288 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002289 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 -06002290 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002291 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002292 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2293 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002294 }
2295 }
2296 // VU01199 changed with mnt1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002297 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002298 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002299 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002300 skip |=
2301 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002302 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002303 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002304 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2305 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002306 }
2307 }
2308 } else { // Pre maint 1
2309 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002310 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002311 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 -06002312 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002313 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2314 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002315 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2316 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002317 }
2318 }
2319 }
2320
Dave Houltonc991cc92018-03-06 11:08:51 -07002321 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2322 if (FormatIsCompressed(dst_state->createInfo.format) ||
2323 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002324 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002325
2326 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002327 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2328 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2329 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002330 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002331 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 -07002332 HandleToUint64(dst_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002333 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002334 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002335 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002336 }
2337
Dave Houlton94a00372017-12-14 15:08:47 -07002338 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002339 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2340 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002341 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002342 skip |=
2343 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002344 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002345 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002346 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002347 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002348 }
2349
Dave Houltonee281a52017-12-08 13:51:02 -07002350 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2351 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2352 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002353 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002354 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 -07002355 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002356 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2357 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
Dave Houltonc991cc92018-03-06 11:08:51 -07002358 "height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002359 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002360 }
2361
Dave Houltonee281a52017-12-08 13:51:02 -07002362 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2363 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2364 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002365 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002366 skip |=
2367 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002368 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002369 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002370 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002371 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002372 }
2373 } // Compressed
2374 }
2375 return skip;
2376}
2377
Dave Houltonc991cc92018-03-06 11:08:51 -07002378// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002379bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002380 const IMAGE_STATE *dst_image_state, const VkImageCopy region) const {
Dave Houltonc991cc92018-03-06 11:08:51 -07002381 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002382
2383 // Neither image is multiplane
2384 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2385 // If neither image is multi-plane the aspectMask member of src and dst must match
2386 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2387 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002388 ss << "vkCmdCopyImage(): Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002389 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
2390 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 -06002391 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002392 }
2393 } else {
2394 // Source image multiplane checks
2395 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2396 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2397 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2398 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002399 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002400 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 -06002401 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002402 }
2403 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2404 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2405 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002406 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002407 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 -06002408 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002409 }
2410 // Single-plane to multi-plane
2411 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2412 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2413 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002414 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002415 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 -06002416 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002417 }
2418
2419 // Dest image multiplane checks
2420 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2421 aspect = region.dstSubresource.aspectMask;
2422 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2423 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002424 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002425 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 -06002426 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002427 }
2428 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2429 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2430 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002431 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002432 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 -06002433 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002434 }
2435 // Multi-plane to single-plane
2436 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2437 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2438 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002439 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
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-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002442 }
2443 }
2444
2445 return skip;
2446}
2447
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002448bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2449 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2450 const VkImageCopy *pRegions) {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002451 const auto *cb_node = GetCBState(commandBuffer);
2452 const auto *src_image_state = GetImageState(srcImage);
2453 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002454 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002455
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002456 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002457
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002458 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2459
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002460 for (uint32_t i = 0; i < regionCount; i++) {
2461 const VkImageCopy region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002462
2463 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2464 VkExtent3D src_copy_extent = region.extent;
2465 VkExtent3D dst_copy_extent =
2466 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
2467
Dave Houlton6f9059e2017-05-02 17:15:13 -06002468 bool slice_override = false;
2469 uint32_t depth_slices = 0;
2470
2471 // Special case for copying between a 1D/2D array and a 3D image
2472 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2473 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2474 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002475 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002476 slice_override = (depth_slices != 1);
2477 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2478 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002479 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002480 slice_override = (depth_slices != 1);
2481 }
2482
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002483 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2484 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
2485 skip |= ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002486 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002487 skip |= ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002488 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002489 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002490 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2491 "VUID-vkCmdCopyImage-srcSubresource-01698");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002492 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002493 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2494 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002495
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002496 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002497 // No chance of mismatch if we're overriding depth slice count
2498 if (!slice_override) {
2499 // The number of depth slices in srcSubresource and dstSubresource must match
2500 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2501 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002502 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2503 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002504 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002505 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2506 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002507 if (src_slices != dst_slices) {
2508 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002509 ss << "vkCmdCopyImage(): number of depth slices in source and destination subresources for pRegions[" << i
Dave Houlton6f9059e2017-05-02 17:15:13 -06002510 << "] do not match";
2511 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 -06002512 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06002513 }
2514 }
2515 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002516 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002517 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002518 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002519 ss << "vkCmdCopyImage(): number of layers in source and destination subresources for pRegions[" << i
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002520 << "] do not match";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002521 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 -06002522 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002523 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002524 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002525
Dave Houltonc991cc92018-03-06 11:08:51 -07002526 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002527 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002528 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region);
Dave Houltonc991cc92018-03-06 11:08:51 -07002529 }
2530
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002531 if (!device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002532 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2533 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002534 char const str[] = "vkCmdCopyImage(): Src and dest aspectMasks for each region must match";
Dave Houltonf5217612018-02-02 16:18:52 -07002535 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 -06002536 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002537 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002538 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002539
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002540 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07002541 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002542 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002543 ss << "vkCmdCopyImage(): pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002544 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
2545 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 -06002546 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002547 }
2548
2549 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07002550 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002551 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002552 ss << "vkCmdCopyImage(): pRegion[" << i
2553 << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
Dave Houlton4eaaf3a2017-03-14 11:31:20 -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-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002556 }
2557
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002558 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
2559 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
2560 // 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 -07002561 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2562 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002563 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002564 ss << "vkCmdCopyImage(): Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002565 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
2566 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
2567 << " ] exceeds the source image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002568 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-vkCmdCopyImage-pRegions-00122", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002570 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002571
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002572 // 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 -07002573 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2574 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002575 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002576 ss << "vkCmdCopyImage(): Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002577 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
2578 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
2579 << " ] exceeds the destination image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002580 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 -06002581 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00123", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002582 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002583 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002584
Dave Houltonfc1a4052017-04-27 14:32:45 -06002585 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002586 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2587 if (slice_override) src_copy_extent.depth = depth_slices;
2588 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002589 if (extent_check & x_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002590 skip |=
2591 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2592 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00144",
2593 "vkCmdCopyImage(): Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2594 "width [%1d].",
2595 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002596 }
2597
2598 if (extent_check & y_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002599 skip |=
2600 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2601 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00145",
2602 "vkCmdCopyImage(): Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2603 "height [%1d].",
2604 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002605 }
2606 if (extent_check & z_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002607 skip |=
2608 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2609 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00147",
2610 "vkCmdCopyImage(): Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2611 "depth [%1d].",
2612 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002613 }
2614
Dave Houltonee281a52017-12-08 13:51:02 -07002615 // Adjust dest extent if necessary
2616 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2617 if (slice_override) dst_copy_extent.depth = depth_slices;
2618
2619 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002620 if (extent_check & x_bit) {
2621 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 -06002622 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00150",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002623 "vkCmdCopyImage(): Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002624 "width [%1d].",
2625 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002626 }
2627 if (extent_check & y_bit) {
2628 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 -06002629 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00151",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002630 "vkCmdCopyImage(): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002631 "height [%1d].",
2632 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002633 }
2634 if (extent_check & z_bit) {
2635 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 -06002636 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00153",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002637 "vkCmdCopyImage(): Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002638 "depth [%1d].",
2639 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002640 }
2641
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002642 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2643 // must not overlap in memory
2644 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002645 for (uint32_t j = 0; j < regionCount; j++) {
2646 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
Dave Houltonf5217612018-02-02 16:18:52 -07002647 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002648 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002649 ss << "vkCmdCopyImage(): pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002650 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 -06002651 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002652 }
2653 }
2654 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002655 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002656
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002657 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2658 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2659 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002660 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002661 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2662 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02002663 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 -06002664 HandleToUint64(command_buffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002665 }
2666 } else {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002667 if (!FormatSizesAreEqual(src_image_state->createInfo.format, dst_image_state->createInfo.format, regionCount, pRegions)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002668 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
2669 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 -06002670 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00135", "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002671 }
2672 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002673
Dave Houlton33c22b72017-02-28 13:16:02 -07002674 // Source and dest image sample counts must match
2675 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2676 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
2677 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 -06002678 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002679 }
2680
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002681 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2682 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002683 // Validate that SRC & DST images have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002684 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyImage-srcImage-00126",
2685 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2686 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyImage-dstImage-00131",
2687 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06002688 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002689 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
2690 "VUID-vkCmdCopyImage-srcImage-01995", "VUID-vkCmdCopyImage-srcImage-01995");
2691 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
2692 "VUID-vkCmdCopyImage-dstImage-01996", "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002693 }
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002694 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyImage()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002695 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002696 skip |= ValidateCmd(cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
2697 skip |= InsideRenderPass(cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002698 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002699 const char *invalid_src_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2700 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2701 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
2702 const char *invalid_dst_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2703 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2704 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002705 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002706 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002707 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2708 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002709 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002710 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2711 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002712 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
2713 "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002714 }
2715
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002716 return skip;
2717}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002718
John Zulauf8f6d4ee2019-07-05 16:31:57 -06002719void ValidationStateTracker::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage,
2720 VkImageLayout srcImageLayout, VkImage dstImage, VkImageLayout dstImageLayout,
2721 uint32_t regionCount, const VkImageCopy *pRegions) {
2722 auto cb_node = GetCBState(commandBuffer);
2723 auto src_image_state = GetImageState(srcImage);
2724 auto dst_image_state = GetImageState(dstImage);
2725
2726 // Update bindings between images and cmd buffer
2727 AddCommandBufferBindingImage(cb_node, src_image_state);
2728 AddCommandBufferBindingImage(cb_node, dst_image_state);
2729}
2730
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002731void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2732 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2733 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06002734 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
2735 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06002736 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002737 auto src_image_state = GetImageState(srcImage);
2738 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002739
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002740 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002741 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002742 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
2743 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002744 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002745}
2746
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002747// Returns true if sub_rect is entirely contained within rect
2748static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2749 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2750 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2751 return false;
2752 return true;
2753}
2754
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002755bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002756 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
2757 const VkRect2D &render_area, uint32_t rect_count,
2758 const VkClearRect *clear_rects) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07002759 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07002760 const IMAGE_VIEW_STATE *image_view_state = nullptr;
2761 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07002762 image_view_state = GetImageViewState(framebuffer->createInfo.pAttachments[fb_attachment]);
John Zulauff2582972019-02-09 14:53:30 -07002763 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002764
2765 for (uint32_t j = 0; j < rect_count; j++) {
2766 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002767 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 -07002768 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00016",
2769 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2770 "the current render pass instance.",
2771 j);
2772 }
2773
2774 if (image_view_state) {
2775 // The layers specified by a given element of pRects must be contained within every attachment that
2776 // pAttachments refers to
2777 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
2778 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
2779 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002780 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2781 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00017",
2782 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
2783 "of pAttachment[%d].",
2784 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07002785 }
2786 }
2787 }
2788 return skip;
2789}
2790
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002791bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2792 const VkClearAttachment *pAttachments, uint32_t rectCount,
2793 const VkClearRect *pRects) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06002794 CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002795
2796 bool skip = false;
2797 if (cb_node) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002798 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002799 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002800 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002801 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
Chris Forbes05375e72017-04-21 13:15:15 -07002802 if (!cb_node->hasDrawCmd && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002803 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
2804 // There are times where app needs to use ClearAttachments (generally when reusing a buffer inside of a render pass)
Mark Lobodzinskid833bb72017-02-22 10:55:30 -07002805 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
2806 // CmdClearAttachments.
Lockee9aeebf2019-03-03 23:50:08 -07002807 skip |=
2808 log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2809 HandleToUint64(commandBuffer), kVUID_Core_DrawState_ClearCmdBeforeDraw,
locke-lunarg9edc2812019-06-17 23:18:52 -06002810 "vkCmdClearAttachments() issued on %s prior to any Draw Cmds. It is recommended you "
Lockee9aeebf2019-03-03 23:50:08 -07002811 "use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
2812 report_data->FormatHandle(commandBuffer).c_str());
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002813 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002814 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002815 }
2816
2817 // Validate that attachment is in reference list of active subpass
2818 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002819 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07002820 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01002821 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002822 const auto *framebuffer = GetFramebufferState(cb_node->activeFramebuffer);
John Zulauf3a548ef2019-02-01 16:14:07 -07002823 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
2824 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002825
John Zulauf3a548ef2019-02-01 16:14:07 -07002826 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2827 auto clear_desc = &pAttachments[attachment_index];
2828 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002829
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002830 if (0 == clear_desc->aspectMask) {
2831 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 -06002832 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002833 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2834 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002835 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002836 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07002837 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
2838 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
2839 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2840 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
locke-lunarg9edc2812019-06-17 23:18:52 -06002841 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2842 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
2843 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
2844 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
2845 attachment_index, clear_desc->colorAttachment,
2846 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
2847 cb_node->activeSubpass, clear_desc->colorAttachment, color_attachment,
2848 renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07002849
John Zulauff2582972019-02-09 14:53:30 -07002850 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
2851 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002852 } else {
Lockee9aeebf2019-03-03 23:50:08 -07002853 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2854 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
locke-lunarg9edc2812019-06-17 23:18:52 -06002855 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
Lockee9aeebf2019-03-03 23:50:08 -07002856 " subpass %u. colorAttachmentCount=%u",
2857 attachment_index, clear_desc->colorAttachment,
2858 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
2859 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002860 }
John Zulauff2582972019-02-09 14:53:30 -07002861 fb_attachment = color_attachment;
2862
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002863 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2864 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2865 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002866 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
John Zulauf3a548ef2019-02-01 16:14:07 -07002867 skip |=
2868 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2869 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002870 }
2871 } else { // Must be depth and/or stencil
2872 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2873 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002874 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002875 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 -07002876 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-parameter", str,
2877 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002878 }
2879 if (!subpass_desc->pDepthStencilAttachment ||
2880 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
2881 skip |= log_msg(
2882 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002883 HandleToUint64(commandBuffer), kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002884 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002885 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07002886 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002887 }
2888 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002889 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002890 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
2891 rectCount, pRects);
John Zulauf3a548ef2019-02-01 16:14:07 -07002892 } else {
2893 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
2894 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
2895 if (!clear_rect_copy) {
2896 // We need a copy of the clear rectangles that will persist until the last lambda executes
2897 // but we want to create it as lazily as possible
2898 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002899 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002900
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002901 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002902 CMD_BUFFER_STATE *prim_cb, VkFramebuffer fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07002903 assert(rectCount == clear_rect_copy->size());
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002904 FRAMEBUFFER_STATE *framebuffer = GetFramebufferState(fb);
John Zulauf3a548ef2019-02-01 16:14:07 -07002905 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
2906 bool skip = false;
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002907 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
2908 rectCount, clear_rect_copy->data());
John Zulauf3a548ef2019-02-01 16:14:07 -07002909 return skip;
2910 };
2911 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002912 }
2913 }
2914 }
2915 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002916}
2917
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002918bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2919 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2920 const VkImageResolve *pRegions) {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002921 const auto *cb_node = GetCBState(commandBuffer);
2922 const auto *src_image_state = GetImageState(srcImage);
2923 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002924
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002925 bool skip = false;
2926 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002927 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-srcImage-00256");
2928 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-00258");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002929 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002930 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002931 skip |= ValidateCmd(cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
2932 skip |= InsideRenderPass(cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002933 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, "vkCmdResolveImage()",
2934 "VUID-vkCmdResolveImage-dstImage-02003", "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002935
Cort Stratton7df30962018-05-17 19:45:57 -07002936 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002937 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002938 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002939 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
2940 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
2941 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002942 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002943 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
2944 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002945 // For each region, the number of layers in the image subresource should not be zero
2946 // For each region, src and dest image aspect must be color only
2947 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002948 skip |=
2949 ValidateImageSubresourceLayers(cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()", "srcSubresource", i);
2950 skip |=
2951 ValidateImageSubresourceLayers(cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()", "dstSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002952 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002953 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
2954 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002955 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002956 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
2957 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002958 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i, "vkCmdResolveImage()",
2959 "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
2960 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i, "vkCmdResolveImage()",
2961 "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
2962 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002963 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2964 "VUID-vkCmdResolveImage-srcSubresource-01711");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002965 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002966 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2967 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07002968
2969 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002970 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
2971 skip |= log_msg(
2972 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002973 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-layerCount-00267",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002974 "vkCmdResolveImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002975 }
Cort Stratton7df30962018-05-17 19:45:57 -07002976 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002977 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
2978 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
2979 char const str[] =
Graeme Leese79b60cb2018-11-28 11:51:20 +00002980 "vkCmdResolveImage(): src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002981 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 -06002982 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002983 }
2984 }
2985
2986 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2987 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002988 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 -06002989 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002990 }
2991 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
2992 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002993 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 -06002994 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageType, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002995 }
2996 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
2997 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
2998 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 -06002999 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-srcImage-00257", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003000 }
3001 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
3002 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
3003 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 -06003004 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-dstImage-00259", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003005 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003006 } else {
3007 assert(0);
3008 }
3009 return skip;
3010}
3011
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003012void ValidationStateTracker::PreCallRecordCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage,
3013 VkImageLayout srcImageLayout, VkImage dstImage,
3014 VkImageLayout dstImageLayout, uint32_t regionCount,
3015 const VkImageResolve *pRegions) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003016 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003017 auto src_image_state = GetImageState(srcImage);
3018 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003019
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003020 // Update bindings between images and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003021 AddCommandBufferBindingImage(cb_node, src_image_state);
3022 AddCommandBufferBindingImage(cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003023}
3024
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003025bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3026 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3027 const VkImageBlit *pRegions, VkFilter filter) {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003028 const auto *cb_node = GetCBState(commandBuffer);
3029 const auto *src_image_state = GetImageState(srcImage);
3030 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003031
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003032 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003033 if (cb_node) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003034 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
John Zulauf5c2750c2018-01-30 15:04:56 -07003035 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003036 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003037 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003038 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003039 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003040 "VUID-vkCmdBlitImage-dstImage-00234");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003041 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
3042 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
Dave Houltond8ed0212018-05-16 17:18:24 -06003043 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003044 ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdBlitImage-srcImage-00219",
3045 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06003046 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003047 ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdBlitImage-dstImage-00224",
3048 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003049 skip |=
3050 ValidateCmdQueueFlags(cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003051 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
3052 skip |= InsideRenderPass(cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003053 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003054 "VUID-vkCmdBlitImage-srcImage-01999", "VUID-vkCmdBlitImage-srcImage-01999");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003055 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003056 "VUID-vkCmdBlitImage-dstImage-02000", "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04003057
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003058 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003059
Dave Houlton33c2d252017-06-09 17:08:32 -06003060 VkFormat src_format = src_image_state->createInfo.format;
3061 VkFormat dst_format = dst_image_state->createInfo.format;
3062 VkImageType src_type = src_image_state->createInfo.imageType;
3063 VkImageType dst_type = dst_image_state->createInfo.imageType;
3064
Cort Stratton186b1a22018-05-01 20:18:06 -04003065 if (VK_FILTER_LINEAR == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003066 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003067 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001",
3068 "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04003069 } else if (VK_FILTER_CUBIC_IMG == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003070 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
3071 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02002",
3072 "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06003073 }
3074
3075 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
3076 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 -06003077 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-filter-00237",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003078 "vkCmdBlitImage(): source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003079 }
3080
Dave Houlton33c2d252017-06-09 17:08:32 -06003081 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
3082 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
3083 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 -06003084 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00228",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003085 "vkCmdBlitImage(): source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003086 }
3087
3088 // Validate consistency for unsigned formats
3089 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3090 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003091 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003092 << "the other one must also have unsigned integer format. "
3093 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3094 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 -06003095 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003096 }
3097
3098 // Validate consistency for signed formats
3099 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3100 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003101 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003102 << "the other one must also have signed integer format. "
3103 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3104 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 -06003105 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003106 }
3107
3108 // Validate filter for Depth/Stencil formats
3109 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3110 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003111 ss << "vkCmdBlitImage(): If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003112 << "then filter must be VK_FILTER_NEAREST.";
3113 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 -06003114 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003115 }
3116
3117 // Validate aspect bits and formats for depth/stencil images
3118 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3119 if (src_format != dst_format) {
3120 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003121 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003122 << "stencil, the other one must have exactly the same format. "
3123 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3124 << string_VkFormat(dst_format);
Dave Houltond8ed0212018-05-16 17:18:24 -06003125 skip |=
3126 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3127 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003128 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003129 } // Depth or Stencil
3130
3131 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003132 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003133 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003134 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3135 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3136 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003137 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003138 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3139 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003140 for (uint32_t i = 0; i < regionCount; i++) {
3141 const VkImageBlit rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003142 bool hit_error = false;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003143 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003144 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3145 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003146 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003147 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3148 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003149 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3150 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
3151 skip |= ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003152 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003153 skip |= ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003154 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003155 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003156 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3157 "VUID-vkCmdBlitImage-srcSubresource-01707");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003158 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003159 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3160 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003161 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003162 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3163 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003164 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003165 ss << "vkCmdBlitImage(): pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003166 skip |=
3167 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3168 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003169 }
Dave Houlton48989f32017-05-26 15:01:46 -06003170 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3171 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003172 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003173 ss << "vkCmdBlitImage(): pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003174 skip |=
3175 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3176 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003177 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003178
3179 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003180 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003181 skip |= log_msg(
3182 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3183 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-layerCount-00239",
3184 "vkCmdBlitImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003185 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003186
Dave Houlton48989f32017-05-26 15:01:46 -06003187 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003188 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 -06003189 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00238",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003190 "vkCmdBlitImage(): aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003191 }
Dave Houlton48989f32017-05-26 15:01:46 -06003192
Dave Houlton33c2d252017-06-09 17:08:32 -06003193 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
3194 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 -06003195 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00241",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003196 "vkCmdBlitImage(): region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003197 "image format %s.",
3198 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003199 }
3200
3201 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
3202 skip |= log_msg(
3203 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003204 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00242",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003205 "vkCmdBlitImage(): region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3206 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003207 }
3208
Dave Houlton48989f32017-05-26 15:01:46 -06003209 // Validate source image offsets
3210 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003211 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003212 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003213 skip |=
3214 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3215 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00245",
3216 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3217 "of (%1d, %1d). These must be (0, 1).",
3218 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003219 }
3220 }
3221
Dave Houlton33c2d252017-06-09 17:08:32 -06003222 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003223 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
3224 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 -06003225 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00247",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003226 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003227 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3228 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003229 }
3230 }
3231
Dave Houlton33c2d252017-06-09 17:08:32 -06003232 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003233 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3234 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003235 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003236 skip |= log_msg(
3237 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3238 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00243",
3239 "vkCmdBlitImage(): region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).", i,
3240 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003241 }
3242 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3243 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003244 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003245 skip |= log_msg(
3246 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-srcOffset-00244",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003248 "vkCmdBlitImage(): region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003249 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003250 }
3251 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3252 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003253 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003254 skip |= log_msg(
3255 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3256 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00246",
3257 "vkCmdBlitImage(): region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).", i,
3258 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003259 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003260 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003261 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 -06003262 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00215",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003263 "vkCmdBlitImage(): region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003264 }
Dave Houlton48989f32017-05-26 15:01:46 -06003265
3266 // Validate dest image offsets
3267 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003268 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003269 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003270 skip |=
3271 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3272 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00250",
3273 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3274 "(%1d, %1d). These must be (0, 1).",
3275 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003276 }
3277 }
3278
Dave Houlton33c2d252017-06-09 17:08:32 -06003279 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003280 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
3281 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 -06003282 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00252",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003283 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003284 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3285 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003286 }
3287 }
3288
Dave Houlton33c2d252017-06-09 17:08:32 -06003289 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003290 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3291 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003292 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003293 skip |= log_msg(
3294 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3295 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00248",
3296 "vkCmdBlitImage(): region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).", i,
3297 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003298 }
3299 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3300 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003301 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003302 skip |= log_msg(
3303 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003304 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00249",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003305 "vkCmdBlitImage(): region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003306 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003307 }
3308 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3309 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003310 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003311 skip |= log_msg(
3312 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3313 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00251",
3314 "vkCmdBlitImage(): region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).", i,
3315 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003316 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003317 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003318 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 -06003319 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00216",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003320 "vkCmdBlitImage(): region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003321 }
3322
Dave Houlton33c2d252017-06-09 17:08:32 -06003323 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3324 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3325 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003326 skip |=
3327 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3328 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00240",
3329 "vkCmdBlitImage(): region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3330 "layerCount other than 1.",
3331 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003332 }
3333 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003334 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003335 } else {
3336 assert(0);
3337 }
3338 return skip;
3339}
3340
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003341void ValidationStateTracker::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage,
3342 VkImageLayout srcImageLayout, VkImage dstImage, VkImageLayout dstImageLayout,
3343 uint32_t regionCount, const VkImageBlit *pRegions, VkFilter filter) {
3344 auto cb_node = GetCBState(commandBuffer);
3345 auto src_image_state = GetImageState(srcImage);
3346 auto dst_image_state = GetImageState(dstImage);
3347
3348 // Update bindings between images and cmd buffer
3349 AddCommandBufferBindingImage(cb_node, src_image_state);
3350 AddCommandBufferBindingImage(cb_node, dst_image_state);
3351}
3352
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003353void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3354 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3355 const VkImageBlit *pRegions, VkFilter filter) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003356 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3357 pRegions, filter);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003358 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003359 auto src_image_state = GetImageState(srcImage);
3360 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003361
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003362 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003363 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003364 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3365 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003366 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003367}
3368
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003369// 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 -06003370bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const ImageSubresPairLayoutMap &globalImageLayoutMap,
3371 ImageSubresPairLayoutMap *overlayLayoutMap_arg) const {
Matthew Ruschd7ef5482019-07-16 22:01:54 -07003372 if (disabled.image_layout_validation) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003373 bool skip = false;
John Zulauf3b04ebd2019-07-18 14:08:11 -06003374 ImageSubresPairLayoutMap &overlayLayoutMap = *overlayLayoutMap_arg;
John Zulauff660ad62019-03-23 07:16:05 -06003375 // Iterate over the layout maps for each referenced image
3376 for (const auto &layout_map_entry : pCB->image_layout_map) {
3377 const auto image = layout_map_entry.first;
3378 const auto *image_state = GetImageState(image);
3379 if (!image_state) continue; // Can't check layouts of a dead image
locke-lunargadbb54c2019-06-26 00:05:17 -06003380 auto subres_map = layout_map_entry.second.get();
John Zulauff660ad62019-03-23 07:16:05 -06003381 ImageSubresourcePair isr_pair;
3382 isr_pair.image = image;
3383 isr_pair.hasSubresource = true;
Tony Barbourdf013b92017-01-25 12:53:48 -07003384
locke-lunargadbb54c2019-06-26 00:05:17 -06003385 std::string bind_swapchain_msg = "";
3386 if (image_state->bind_swapchain) {
3387 auto swapchain_node = GetSwapchainState(image_state->bind_swapchain);
3388 const auto swapchain_image = swapchain_node->images[image_state->bind_swapchain_imageIndex];
3389 isr_pair.image = swapchain_image;
3390
3391 string_sprintf(&bind_swapchain_msg, "bind %s imageIndex %d (%s)",
3392 report_data->FormatHandle(image_state->bind_swapchain).c_str(), image_state->bind_swapchain_imageIndex,
3393 report_data->FormatHandle(swapchain_image).c_str());
3394 }
3395
John Zulauff660ad62019-03-23 07:16:05 -06003396 // Validate the initial_uses for each subresource referenced
3397 for (auto it_init = subres_map->BeginInitialUse(); !it_init.AtEnd(); ++it_init) {
3398 isr_pair.subresource = (*it_init).subresource;
3399 VkImageLayout initial_layout = (*it_init).layout;
3400 VkImageLayout image_layout;
3401 if (FindLayout(overlayLayoutMap, isr_pair, image_layout) || FindLayout(globalImageLayoutMap, isr_pair, image_layout)) {
3402 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
3403 // TODO: Set memory invalid which is in mem_tracker currently
3404 } else if (image_layout != initial_layout) {
John Zulaufb61ed972019-04-09 16:12:35 -06003405 // Need to look up the inital layout *state* to get a bit more information
3406 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(isr_pair.subresource);
3407 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
3408 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
3409 if (!matches) {
3410 std::string formatted_label = FormatDebugLabel(" ", pCB->debug_label);
locke-lunargadbb54c2019-06-26 00:05:17 -06003411 skip |= log_msg(
3412 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3413 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
3414 "Submitted command buffer expects %s %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
3415 "to be in layout %s--instead, current layout is %s.%s",
3416 report_data->FormatHandle(image).c_str(), bind_swapchain_msg.c_str(), isr_pair.subresource.aspectMask,
3417 isr_pair.subresource.arrayLayer, isr_pair.subresource.mipLevel, string_VkImageLayout(initial_layout),
3418 string_VkImageLayout(image_layout), formatted_label.c_str());
John Zulaufb61ed972019-04-09 16:12:35 -06003419 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003420 }
3421 }
John Zulauff660ad62019-03-23 07:16:05 -06003422 }
3423
3424 // Update all layout set operations (which will be a subset of the initial_layouts
3425 for (auto it_set = subres_map->BeginSetLayout(); !it_set.AtEnd(); ++it_set) {
3426 VkImageLayout layout = (*it_set).layout;
3427 isr_pair.subresource = (*it_set).subresource;
3428 SetLayout(overlayLayoutMap, isr_pair, layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003429 }
3430 }
John Zulauff660ad62019-03-23 07:16:05 -06003431
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003432 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003433}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003434
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003435void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06003436 for (const auto &layout_map_entry : pCB->image_layout_map) {
3437 const auto image = layout_map_entry.first;
3438 const auto *image_state = GetImageState(image);
3439 if (!image_state) continue; // Can't set layouts of a dead image
3440 const auto &subres_map = layout_map_entry.second;
3441 ImageSubresourcePair isr_pair;
3442 isr_pair.image = image;
3443 isr_pair.hasSubresource = true;
3444
3445 // Update all layout set operations (which will be a subset of the initial_layouts
3446 for (auto it_set = subres_map->BeginSetLayout(); !it_set.AtEnd(); ++it_set) {
3447 VkImageLayout layout = (*it_set).layout;
3448 isr_pair.subresource = (*it_set).subresource;
3449 SetGlobalLayout(isr_pair, layout);
3450 }
Tony Barbourdf013b92017-01-25 12:53:48 -07003451 }
3452}
3453
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003454// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003455// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3456// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003457bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3458 const VkImageLayout first_layout, const uint32_t attachment,
John Zulauf9d2b6382019-07-25 15:21:36 -06003459 const VkAttachmentDescription2KHR &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003460 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003461 const char *vuid;
3462 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3463
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003464 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
3465 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003466 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3467 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3468 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003469 skip |=
Shannon McPherson3ea65132018-12-05 10:37:39 -07003470 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3471 "VUID-VkRenderPassCreateInfo2KHR-pAttachments-02522",
3472 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
3473 } else if (!use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3474 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
3475 skip |=
3476 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3477 "VUID-VkRenderPassCreateInfo-pAttachments-00836",
Dave Houltond8ed0212018-05-16 17:18:24 -06003478 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003479 }
3480 }
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003481 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3482 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003483 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01566";
Dave Houltond8ed0212018-05-16 17:18:24 -06003484 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003485 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 -06003486 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003487 }
3488 }
3489
3490 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3491 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003492 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01567";
Dave Houltond8ed0212018-05-16 17:18:24 -06003493 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003494 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 -06003495 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003496 }
3497 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003498 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003499}
3500
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003501bool CoreChecks::ValidateLayouts(RenderPassCreateVersion rp_version, VkDevice device,
John Zulauf9d2b6382019-07-25 15:21:36 -06003502 const VkRenderPassCreateInfo2KHR *pCreateInfo) const {
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003503 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003504 const char *vuid;
3505 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3506 const char *const function_name = use_rp2 ? "vkCreateRenderPass2KHR()" : "vkCreateRenderPass()";
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003507
Jason Ekstranda1906302017-12-03 20:16:32 -08003508 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3509 VkFormat format = pCreateInfo->pAttachments[i].format;
3510 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3511 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3512 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003513 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 -06003514 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003515 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
3516 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3517 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3518 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003519 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003520 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003521 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 -06003522 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003523 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3524 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3525 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3526 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003527 }
3528 }
3529 }
3530
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003531 // Track when we're observing the first use of an attachment
3532 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3533 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003534 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003535
3536 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3537 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3538 auto attach_index = subpass.pInputAttachments[j].attachment;
3539 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003540 switch (subpass.pInputAttachments[j].layout) {
3541 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3542 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3543 // These are ideal.
3544 break;
3545
3546 case VK_IMAGE_LAYOUT_GENERAL:
3547 // May not be optimal. TODO: reconsider this warning based on other constraints.
3548 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003549 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003550 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
3551 break;
3552
Tobias Hectorbbb12282018-10-22 15:17:59 +01003553 case VK_IMAGE_LAYOUT_UNDEFINED:
3554 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3555 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3556 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3557 "Layout for input attachment reference %u in subpass %u is %s but must be "
3558 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
3559 j, i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3560 break;
3561
Graeme Leese668a9862018-10-08 10:40:02 +01003562 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3563 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003564 if (device_extensions.vk_khr_maintenance2) {
Graeme Leese668a9862018-10-08 10:40:02 +01003565 break;
3566 } else {
3567 // Intentionally fall through to generic error message
3568 }
3569 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003570
Cort Stratton7547f772017-05-04 15:18:52 -07003571 default:
3572 // No other layouts are acceptable
3573 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 -06003574 kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003575 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3576 string_VkImageLayout(subpass.pInputAttachments[j].layout));
3577 }
3578
Cort Stratton7547f772017-05-04 15:18:52 -07003579 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003580 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3581 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003582
3583 bool used_as_depth =
3584 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3585 bool used_as_color = false;
3586 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3587 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3588 }
3589 if (!used_as_depth && !used_as_color &&
3590 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003591 vuid = use_rp2 ? "VUID-VkSubpassDescription2KHR-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
3592 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3593 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
3594 function_name, attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07003595 }
3596 }
3597 attach_first_use[attach_index] = false;
3598 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003599
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003600 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3601 auto attach_index = subpass.pColorAttachments[j].attachment;
3602 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3603
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003604 // TODO: Need a way to validate shared presentable images here, currently just allowing
3605 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3606 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003607 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003608 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003609 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003610 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3611 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003612 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003613
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003614 case VK_IMAGE_LAYOUT_GENERAL:
3615 // May not be optimal; TODO: reconsider this warning based on other constraints?
3616 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003617 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003618 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
3619 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003620
Tobias Hectorbbb12282018-10-22 15:17:59 +01003621 case VK_IMAGE_LAYOUT_UNDEFINED:
3622 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3623 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3624 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3625 "Layout for color attachment reference %u in subpass %u is %s but should be "
3626 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3627 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3628 break;
3629
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003630 default:
3631 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 -06003632 kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003633 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3634 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003635 }
3636
John Zulauf4eee2692019-02-09 16:14:25 -07003637 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].attachment != VK_ATTACHMENT_UNUSED) &&
3638 (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
3639 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003640 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3641 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 -07003642 "Layout for resolve attachment reference %u in subpass %u is %s but should be "
Tobias Hectorbbb12282018-10-22 15:17:59 +01003643 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
John Zulauff0f8c2b2019-02-14 12:13:44 -07003644 j, i, string_VkImageLayout(subpass.pResolveAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003645 }
3646
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003647 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003648 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
3649 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003650 }
3651 attach_first_use[attach_index] = false;
3652 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003653
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003654 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3655 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003656 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3657 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3658 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003659 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003660
Dave Houltona9df0ce2018-02-07 10:51:23 -07003661 case VK_IMAGE_LAYOUT_GENERAL:
3662 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3663 // doing a bunch of transitions.
3664 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003665 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003666 "GENERAL layout for depth attachment may not give optimal performance.");
3667 break;
3668
Tobias Hectorbbb12282018-10-22 15:17:59 +01003669 case VK_IMAGE_LAYOUT_UNDEFINED:
3670 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3671 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3672 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3673 "Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
3674 "layout or GENERAL.",
3675 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3676 break;
3677
Dave Houltona9df0ce2018-02-07 10:51:23 -07003678 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3679 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003680 if (device_extensions.vk_khr_maintenance2) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003681 break;
3682 } else {
3683 // Intentionally fall through to generic error message
3684 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06003685 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003686
Dave Houltona9df0ce2018-02-07 10:51:23 -07003687 default:
3688 // No other layouts are acceptable
3689 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 -06003690 kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003691 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3692 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
3693 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003694 }
3695
3696 auto attach_index = subpass.pDepthStencilAttachment->attachment;
3697 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003698 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
3699 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003700 }
3701 attach_first_use[attach_index] = false;
3702 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003703 }
3704 return skip;
3705}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003706
Mark Lobodzinski96210742017-02-09 10:33:46 -07003707// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
3708// is true, verify that (actual & desired) flags == desired
John Zulauf4fea6622019-04-01 11:38:18 -06003709bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const VulkanTypedHandle &typed_handle,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003710 const char *msgCode, char const *func_name, char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003711 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003712 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06003713 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003714 if (strict) {
3715 correct_usage = ((actual & desired) == desired);
3716 } else {
3717 correct_usage = ((actual & desired) != 0);
3718 }
3719 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06003720 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06003721 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
John Zulauf4fea6622019-04-01 11:38:18 -06003722 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[typed_handle.type],
3723 typed_handle.handle, kVUID_Core_MemTrack_InvalidUsageFlag,
locke-lunarg9edc2812019-06-17 23:18:52 -06003724 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
3725 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003726 } else {
John Zulauf4fea6622019-04-01 11:38:18 -06003727 skip =
3728 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 -06003729 msgCode, "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
3730 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003731 }
3732 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003733 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003734}
3735
3736// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3737// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003738bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003739 char const *func_name, char const *usage_string) const {
John Zulauf4fea6622019-04-01 11:38:18 -06003740 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict,
3741 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003742}
3743
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003744bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
John Zulauf07288512019-07-05 11:09:50 -06003745 char const *func_name, const char *linear_vuid, const char *optimal_vuid) const {
Mark Lobodzinski5c048802019-03-07 10:47:31 -07003746 VkFormatProperties format_properties = GetPDFormatProperties(image_state->createInfo.format);
Cort Stratton186b1a22018-05-01 20:18:06 -04003747 bool skip = false;
3748 if (image_state->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
3749 if ((format_properties.linearTilingFeatures & desired) != desired) {
Lockee9aeebf2019-03-03 23:50:08 -07003750 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3751 HandleToUint64(image_state->image), linear_vuid,
locke-lunarg9edc2812019-06-17 23:18:52 -06003752 "In %s, invalid linearTilingFeatures (0x%08X) for format %u used by %s.", func_name,
Lockee9aeebf2019-03-03 23:50:08 -07003753 format_properties.linearTilingFeatures, image_state->createInfo.format,
3754 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04003755 }
3756 } else if (image_state->createInfo.tiling == VK_IMAGE_TILING_OPTIMAL) {
3757 if ((format_properties.optimalTilingFeatures & desired) != desired) {
3758 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3759 HandleToUint64(image_state->image), optimal_vuid,
locke-lunarg9edc2812019-06-17 23:18:52 -06003760 "In %s, invalid optimalTilingFeatures (0x%08X) for format %u used by %s.", func_name,
Cort Stratton186b1a22018-05-01 20:18:06 -04003761 format_properties.optimalTilingFeatures, image_state->createInfo.format,
Lockee9aeebf2019-03-03 23:50:08 -07003762 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04003763 }
3764 }
3765 return skip;
3766}
3767
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003768bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003769 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07003770 bool skip = false;
Cort Strattond619a302018-05-17 19:46:32 -07003771 // layerCount must not be zero
3772 if (subresource_layers->layerCount == 0) {
3773 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3774 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-layerCount-01700",
3775 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
3776 }
3777 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
3778 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
3779 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3780 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00168",
3781 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
3782 }
3783 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
3784 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3785 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
3786 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3787 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00167",
3788 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
3789 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3790 func_name, i, member);
3791 }
3792 return skip;
3793}
3794
Mark Lobodzinski96210742017-02-09 10:33:46 -07003795// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3796// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003797bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06003798 char const *func_name, char const *usage_string) const {
John Zulauf4fea6622019-04-01 11:38:18 -06003799 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict,
3800 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003801}
3802
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003803bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
3804 const VkPhysicalDeviceLimits *device_limits) {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003805 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003806
3807 const VkDeviceSize &range = pCreateInfo->range;
3808 if (range != VK_WHOLE_SIZE) {
3809 // Range must be greater than 0
3810 if (range <= 0) {
3811 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3812 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00928",
3813 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3814 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
3815 range);
3816 }
3817 // Range must be a multiple of the element size of format
Dave Houltona585d132019-01-18 13:05:42 -07003818 const size_t format_size = FormatElementSize(pCreateInfo->format);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003819 if (range % format_size != 0) {
3820 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3821 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00929",
3822 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3823 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
3824 "(" PRINTF_SIZE_T_SPECIFIER ").",
3825 range, format_size);
3826 }
3827 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
3828 if (range / format_size > device_limits->maxTexelBufferElements) {
3829 skip |=
3830 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3831 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00930",
3832 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3833 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (" PRINTF_SIZE_T_SPECIFIER
3834 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
3835 range, format_size, device_limits->maxTexelBufferElements);
3836 }
3837 // The sum of range and offset must be less than or equal to the size of buffer
3838 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
3839 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3840 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00931",
3841 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3842 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
3843 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
3844 range, pCreateInfo->offset, buffer_state->createInfo.size);
3845 }
3846 }
3847 return skip;
3848}
3849
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003850bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) {
Shannon McPherson265383a2018-06-21 15:37:52 -06003851 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07003852 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06003853 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
3854 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
3855 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3856 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00933",
3857 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
3858 "be supported for uniform texel buffers");
3859 }
3860 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
3861 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
3862 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3863 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00934",
3864 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
3865 "be supported for storage texel buffers");
3866 }
3867 return skip;
3868}
3869
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003870bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
3871 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003872 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003873
Dave Houltond8ed0212018-05-16 17:18:24 -06003874 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003875
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06003876 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!enabled_features.core.sparseBinding)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003877 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 -06003878 "VUID-VkBufferCreateInfo-flags-00915",
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003879 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003880 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003881 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003882
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06003883 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!enabled_features.core.sparseResidencyBuffer)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003884 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 -06003885 "VUID-VkBufferCreateInfo-flags-00916",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003886 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003887 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003888 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003889
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06003890 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003891 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 -06003892 "VUID-VkBufferCreateInfo-flags-00917",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003893 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003894 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003895 }
Jeff Bolz87697532019-01-11 22:54:00 -06003896
3897 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
3898 if (chained_devaddr_struct) {
3899 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
3900 chained_devaddr_struct->deviceAddress != 0) {
3901 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3902 "VUID-VkBufferCreateInfo-deviceAddress-02604",
3903 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
3904 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
3905 }
3906 }
3907
3908 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06003909 !enabled_features.buffer_address.bufferDeviceAddressCaptureReplay) {
Jeff Bolz87697532019-01-11 22:54:00 -06003910 skip |= log_msg(
3911 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3912 "VUID-VkBufferCreateInfo-flags-02605",
3913 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
3914 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
3915 }
3916
3917 if ((pCreateInfo->usage & VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_EXT) &&
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06003918 !enabled_features.buffer_address.bufferDeviceAddress) {
Jeff Bolz87697532019-01-11 22:54:00 -06003919 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3920 "VUID-VkBufferCreateInfo-usage-02606",
3921 "vkCreateBuffer(): the bufferDeviceAddress device feature is disabled: Buffers cannot be created with "
3922 "the VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_EXT set.");
3923 }
3924
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07003925 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003926 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateBuffer",
3927 "pCreateInfo->pQueueFamilyIndices", "VUID-VkBufferCreateInfo-sharingMode-01419",
3928 "VUID-VkBufferCreateInfo-sharingMode-01419", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07003929 }
3930
Mark Lobodzinski96210742017-02-09 10:33:46 -07003931 return skip;
3932}
3933
John Zulauf7eeb6f72019-06-17 11:56:36 -06003934void ValidationStateTracker::PostCallRecordCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
3935 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer,
3936 VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07003937 if (result != VK_SUCCESS) return;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003938 // 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 -06003939 std::unique_ptr<BUFFER_STATE> buffer_state(new BUFFER_STATE(*pBuffer, pCreateInfo));
3940
3941 // Get a set of requirements in the case the app does not
3942 DispatchGetBufferMemoryRequirements(device, *pBuffer, &buffer_state->requirements);
3943
3944 bufferMap.insert(std::make_pair(*pBuffer, std::move(buffer_state)));
Mark Lobodzinski96210742017-02-09 10:33:46 -07003945}
3946
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003947bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
3948 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003949 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07003950 BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003951 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
3952 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003953 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07003954 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
3955 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003956 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06003957 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
3958 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
3959 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06003960
Shannon McPherson0eb84f62018-06-18 16:32:40 -06003961 // Buffer view offset must be less than the size of buffer
3962 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
3963 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3964 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00925",
3965 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3966 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
3967 pCreateInfo->offset, buffer_state->createInfo.size);
3968 }
3969
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06003970 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05003971 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
3972 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
3973 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
3974 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3975 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-02749",
3976 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3977 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
3978 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
3979 }
3980
3981 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
3982 VkDeviceSize elementSize = FormatElementSize(pCreateInfo->format);
3983 if ((elementSize % 3) == 0) {
3984 elementSize /= 3;
3985 }
3986 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
3987 VkDeviceSize alignmentRequirement =
3988 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
3989 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
3990 alignmentRequirement = std::min(alignmentRequirement, elementSize);
3991 }
3992 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
3993 skip |= log_msg(
3994 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3995 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-02750",
3996 "If buffer was created with usage containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
3997 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3998 ") must be a multiple of the lesser of "
3999 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4000 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4001 "(%" PRId32
4002 ") is VK_TRUE, the size of a texel of the requested format. "
4003 "If the size of a texel is a multiple of three bytes, then the size of a "
4004 "single component of format is used instead",
4005 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4006 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4007 }
4008 }
4009 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
4010 VkDeviceSize alignmentRequirement =
4011 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4012 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
4013 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4014 }
4015 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
4016 skip |= log_msg(
4017 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4018 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-02751",
4019 "If buffer was created with usage containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
4020 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4021 ") must be a multiple of the lesser of "
4022 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4023 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4024 "(%" PRId32
4025 ") is VK_TRUE, the size of a texel of the requested format. "
4026 "If the size of a texel is a multiple of three bytes, then the size of a "
4027 "single component of format is used instead",
4028 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4029 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4030 }
4031 }
4032 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004033
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004034 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004035
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004036 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004037 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004038 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004039}
4040
John Zulauf7eeb6f72019-06-17 11:56:36 -06004041void ValidationStateTracker::PostCallRecordCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
4042 const VkAllocationCallbacks *pAllocator, VkBufferView *pView,
4043 VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07004044 if (result != VK_SUCCESS) return;
Mark Lobodzinskie0befe42019-04-19 13:49:08 -06004045 bufferViewMap[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
Mark Lobodzinski96210742017-02-09 10:33:46 -07004046}
Mark Lobodzinski602de982017-02-09 11:01:33 -07004047
4048// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004049bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004050 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004051 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004052 VkDebugReportObjectTypeEXT objectType = VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT;
4053 if (image != VK_NULL_HANDLE) {
4054 objectType = VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT;
4055 }
4056
Dave Houlton1d2022c2017-03-29 11:43:58 -06004057 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004058 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004059 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004060 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004061 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004062 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004063 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004064 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004065 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004066 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004067 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07004068 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004069 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4070 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004071 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004072 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski602de982017-02-09 11:01:33 -07004073 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004074 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4075 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004076 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004077 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004078 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004079 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004080 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004081 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004082 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004083 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004084 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004085 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004086 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004087 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004088 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004089 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004090 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004091 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004092 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004093 } else if (FormatIsMultiplane(format)) {
4094 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4095 if (3 == FormatPlaneCount(format)) {
4096 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4097 }
4098 if ((aspect_mask & valid_flags) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004099 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houlton501b15b2018-03-30 15:07:41 -06004100 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4101 "set, where n = [0, 1, 2].",
4102 func_name);
4103 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004104 }
4105 return skip;
4106}
4107
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004108bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4109 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
4110 const char *param_name, const char *image_layer_count_var_name,
John Zulauf07288512019-07-05 11:09:50 -06004111 const uint64_t image_handle, SubresourceRangeErrorCodes errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004112 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004113
4114 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004115 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004116 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 -06004117 errorCodes.base_mip_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004118 "%s: %s.baseMipLevel (= %" PRIu32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004119 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4120 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004121 }
Petr Kraus4d718682017-05-18 03:38:41 +02004122
Petr Krausffa94af2017-08-08 21:46:02 +02004123 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4124 if (subresourceRange.levelCount == 0) {
4125 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 -06004126 errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004127 } else {
4128 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004129
Petr Krausffa94af2017-08-08 21:46:02 +02004130 if (necessary_mip_count > image_mip_count) {
4131 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 -06004132 errorCodes.mip_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004133 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004134 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004135 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004136 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004137 }
Petr Kraus4d718682017-05-18 03:38:41 +02004138 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004139 }
Petr Kraus4d718682017-05-18 03:38:41 +02004140
4141 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004142 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004143 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 -06004144 errorCodes.base_layer_err,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004145 "%s: %s.baseArrayLayer (= %" PRIu32
4146 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4147 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004148 }
Petr Kraus4d718682017-05-18 03:38:41 +02004149
Petr Krausffa94af2017-08-08 21:46:02 +02004150 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4151 if (subresourceRange.layerCount == 0) {
4152 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 -06004153 errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004154 } else {
4155 const uint64_t necessary_layer_count =
4156 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004157
Petr Krausffa94af2017-08-08 21:46:02 +02004158 if (necessary_layer_count > image_layer_count) {
4159 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 -06004160 errorCodes.layer_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004161 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004162 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004163 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004164 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004165 }
Petr Kraus4d718682017-05-18 03:38:41 +02004166 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004167 }
Petr Kraus4d718682017-05-18 03:38:41 +02004168
Mark Lobodzinski602de982017-02-09 11:01:33 -07004169 return skip;
4170}
4171
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004172bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004173 const VkImageSubresourceRange &subresourceRange) {
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004174 bool is_khr_maintenance1 = device_extensions.vk_khr_maintenance1;
Petr Krausffa94af2017-08-08 21:46:02 +02004175 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4176 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4177 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4178
4179 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4180 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4181
4182 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004183 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4184 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
Shannon McPherson5a0de262019-06-05 10:43:56 -06004185 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-02724"
Dave Houltond8ed0212018-05-16 17:18:24 -06004186 : "VUID-VkImageViewCreateInfo-image-01482")
4187 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4188 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
Shannon McPherson5a0de262019-06-05 10:43:56 -06004189 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
Dave Houltond8ed0212018-05-16 17:18:24 -06004190 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4191 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004192
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004193 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004194 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
4195 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4196}
4197
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004198bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004199 const VkImageSubresourceRange &subresourceRange,
4200 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004201 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004202 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4203 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4204 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4205 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004206
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004207 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4208 "vkCmdClearColorImage", param_name, "arrayLayers", HandleToUint64(image_state->image),
4209 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004210}
4211
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004212bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004213 const VkImageSubresourceRange &subresourceRange,
4214 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004215 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004216 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4217 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4218 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4219 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004220
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004221 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4222 "vkCmdClearDepthStencilImage", param_name, "arrayLayers",
Petr Krausffa94af2017-08-08 21:46:02 +02004223 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4224}
4225
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004226bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004227 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
4228 const char *param_name) {
Petr Krausffa94af2017-08-08 21:46:02 +02004229 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004230 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4231 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4232 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4233 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004234
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004235 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4236 cmd_name, param_name, "arrayLayers", HandleToUint64(image_state->image),
Petr Krausffa94af2017-08-08 21:46:02 +02004237 subresourceRangeErrorCodes);
4238}
4239
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004240bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
4241 const VkAllocationCallbacks *pAllocator, VkImageView *pView) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004242 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004243 IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004244 if (image_state) {
4245 skip |= ValidateImageUsageFlags(
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004246 image_state,
Mark Lobodzinski602de982017-02-09 11:01:33 -07004247 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
Dave Houlton142c4cb2018-10-17 15:04:41 -06004248 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4249 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV,
Dave Houlton8e9f6542018-05-18 12:18:22 -06004250 false, kVUIDUndefined, "vkCreateImageView()",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004251 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|SHADING_RATE_IMAGE]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004252 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004253 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004254 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004255 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004256 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004257 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004258
4259 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4260 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004261 VkImageUsageFlags image_usage = image_state->createInfo.usage;
4262 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004263 VkFormat view_format = pCreateInfo->format;
4264 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004265 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004266 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004267
Dave Houltonbd2e2622018-04-10 16:41:14 -06004268 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004269 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004270 if (chained_ivuci_struct) {
Dave Houltonbd2e2622018-04-10 16:41:14 -06004271 image_usage = chained_ivuci_struct->usage;
4272 }
4273
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004274 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4275 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004276 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01004277 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06004278 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01004279 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06004280 std::stringstream ss;
4281 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01004282 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06004283 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Young9d1ac312018-05-21 16:28:27 -06004284 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 -07004285 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01586", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004286 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004287 }
4288 } else {
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004289 if ((!device_extensions.vk_khr_maintenance2 ||
Dave Houltonc7988072018-04-16 11:46:56 -06004290 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
4291 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4292 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
4293 std::stringstream ss;
4294 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06004295 << " is not in the same format compatibility class as "
4296 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004297 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4298 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
Mark Young9d1ac312018-05-21 16:28:27 -06004299 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 -07004300 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01018", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004301 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004302 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004303 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004304 }
4305 } else {
4306 // Format MUST be IDENTICAL to the format the image was created with
4307 if (image_format != view_format) {
4308 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06004309 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07004310 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004311 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Young9d1ac312018-05-21 16:28:27 -06004312 skip |=
4313 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004314 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01019", "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004315 }
4316 }
4317
4318 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004319 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004320
4321 switch (image_type) {
4322 case VK_IMAGE_TYPE_1D:
4323 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004324 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 -07004325 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004326 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4327 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004328 }
4329 break;
4330 case VK_IMAGE_TYPE_2D:
4331 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4332 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4333 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Young9d1ac312018-05-21 16:28:27 -06004334 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 -07004335 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01003",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004336 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4337 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004338 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004339 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 -07004340 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004341 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4342 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004343 }
4344 }
4345 break;
4346 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004347 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06004348 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4349 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4350 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004351 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004352 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004353 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01005",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004354 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4355 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004356 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4357 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004358 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004359 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004360 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004361 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4362 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004363 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4364 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004365 }
4366 } else {
Mark Young9d1ac312018-05-21 16:28:27 -06004367 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 -07004368 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004369 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4370 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004371 }
4372 }
4373 } else {
4374 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Young9d1ac312018-05-21 16:28:27 -06004375 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 -07004376 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004377 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4378 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004379 }
4380 }
4381 break;
4382 default:
4383 break;
4384 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004385
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004386 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004387 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07004388 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004389 }
4390
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004391 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004392 VkFormatFeatureFlags tiling_features = (image_tiling & VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4393 : format_properties.optimalTilingFeatures;
4394
4395 if (tiling_features == 0) {
4396 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 -07004397 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-None-02273",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004398 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4399 "physical device.",
4400 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4401 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4402 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 -07004403 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02274",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004404 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4405 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4406 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4407 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4408 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 -07004409 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02275",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004410 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4411 "VK_IMAGE_USAGE_STORAGE_BIT.",
4412 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4413 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
4414 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4415 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 -07004416 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02276",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004417 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4418 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4419 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4420 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4421 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4422 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 -07004423 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02277",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004424 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4425 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4426 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004427 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004428
Jeff Bolz9af91c52018-09-01 21:53:57 -05004429 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4430 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4431 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 -07004432 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02086",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004433 "vkCreateImageView() If image was created with usage containing "
4434 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4435 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
4436 }
4437 if (view_format != VK_FORMAT_R8_UINT) {
4438 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 -07004439 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02087",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004440 "vkCreateImageView() If image was created with usage containing "
4441 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
4442 }
4443 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004444 }
4445 return skip;
4446}
4447
John Zulauf7eeb6f72019-06-17 11:56:36 -06004448void ValidationStateTracker::PostCallRecordCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
4449 const VkAllocationCallbacks *pAllocator, VkImageView *pView,
4450 VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07004451 if (result != VK_SUCCESS) return;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004452 auto image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski81b02a12019-04-19 13:58:43 -06004453 imageViewMap[*pView] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(image_state, *pView, pCreateInfo));
Mark Lobodzinski602de982017-02-09 11:01:33 -07004454}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004455
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004456bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
4457 uint32_t regionCount, const VkBufferCopy *pRegions) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004458 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004459 auto src_buffer_state = GetBufferState(srcBuffer);
4460 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004461
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004462 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004463 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
4464 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004465 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004466 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004467 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
4468 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06004469 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004470 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
4471 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004472 skip |=
4473 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4474 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004475 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
4476 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004477 return skip;
4478}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004479
John Zulauf1686f232019-07-09 16:27:11 -06004480void ValidationStateTracker::PreCallRecordCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
4481 uint32_t regionCount, const VkBufferCopy *pRegions) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004482 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004483 auto src_buffer_state = GetBufferState(srcBuffer);
4484 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004485
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004486 // Update bindings between buffers and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004487 AddCommandBufferBindingBuffer(cb_node, src_buffer_state);
4488 AddCommandBufferBindingBuffer(cb_node, dst_buffer_state);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004489}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004490
Mark Lobodzinskif933db92019-03-09 12:58:03 -07004491bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004492 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004493 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004494 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004495 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 -06004496 kVUID_Core_DrawState_DoubleDestroy, "Cannot free %s that has not been allocated.",
Lockee9aeebf2019-03-03 23:50:08 -07004497 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004498 } else {
4499 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004500 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 -06004501 HandleToUint64(buffer), "VUID-vkDestroyBuffer-buffer-00922",
locke-lunarg9edc2812019-06-17 23:18:52 -06004502 "Cannot free %s that is in use by a command buffer.", report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004503 }
4504 }
4505 return skip;
4506}
4507
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004508bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07004509 IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06004510 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004511
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004512 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004513 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004514 skip |=
4515 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004516 }
4517 return skip;
4518}
4519
John Zulauf7eeb6f72019-06-17 11:56:36 -06004520void ValidationStateTracker::PreCallRecordDestroyImageView(VkDevice device, VkImageView imageView,
4521 const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07004522 IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004523 if (!image_view_state) return;
John Zulauf4fea6622019-04-01 11:38:18 -06004524 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004525
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004526 // Any bound cmd buffers are now invalid
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004527 InvalidateCommandBuffers(image_view_state->cb_bindings, obj_struct);
Mark Lobodzinski81b02a12019-04-19 13:58:43 -06004528 imageViewMap.erase(imageView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004529}
4530
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004531bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004532 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004533
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004534 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004535 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07004536 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004537 }
4538 return skip;
4539}
4540
John Zulauf7eeb6f72019-06-17 11:56:36 -06004541void ValidationStateTracker::PreCallRecordDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004542 if (!buffer) return;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004543 auto buffer_state = GetBufferState(buffer);
John Zulauf4fea6622019-04-01 11:38:18 -06004544 const VulkanTypedHandle obj_struct(buffer, kVulkanObjectTypeBuffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004545
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004546 InvalidateCommandBuffers(buffer_state->cb_bindings, obj_struct);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004547 for (auto mem_binding : buffer_state->GetBoundMemory()) {
Mark Lobodzinski0a41e0e2019-04-25 12:12:40 -06004548 auto mem_info = GetDevMemState(mem_binding);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004549 if (mem_info) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004550 RemoveBufferMemoryRange(HandleToUint64(buffer), mem_info);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004551 }
4552 }
John Zulauf4fea6622019-04-01 11:38:18 -06004553 ClearMemoryObjectBindings(obj_struct);
Mark Lobodzinski3baa8172019-04-19 13:47:30 -06004554 bufferMap.erase(buffer_state->buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004555}
4556
John Zulauf7eeb6f72019-06-17 11:56:36 -06004557void CoreChecks::PreCallRecordDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
4558 if (!buffer) return;
4559
4560 // Clean up validation specific data
4561 EraseQFOReleaseBarriers<VkBufferMemoryBarrier>(buffer);
4562
4563 // Clean up generic buffer state
4564 StateTracker::PreCallRecordDestroyBuffer(device, buffer, pAllocator);
4565}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004566bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
4567 const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07004568 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06004569 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004570 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004571 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004572 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06004573 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004574 }
4575 return skip;
4576}
4577
John Zulauf7eeb6f72019-06-17 11:56:36 -06004578void ValidationStateTracker::PreCallRecordDestroyBufferView(VkDevice device, VkBufferView bufferView,
4579 const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004580 if (!bufferView) return;
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07004581 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06004582 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004583
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004584 // Any bound cmd buffers are now invalid
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004585 InvalidateCommandBuffers(buffer_view_state->cb_bindings, obj_struct);
Mark Lobodzinskie0befe42019-04-19 13:49:08 -06004586 bufferViewMap.erase(bufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004587}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004588
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004589bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
4590 VkDeviceSize size, uint32_t data) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004591 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004592 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004593 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004594 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004595 skip |=
4596 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4597 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004598 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004599 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004600 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
4601 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004602 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004603 return skip;
4604}
4605
John Zulauf1686f232019-07-09 16:27:11 -06004606void ValidationStateTracker::PreCallRecordCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
4607 VkDeviceSize size, uint32_t data) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004608 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004609 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004610 // Update bindings between buffer and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004611 AddCommandBufferBindingBuffer(cb_node, buffer_state);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004612}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004613
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004614bool CoreChecks::ValidateBufferImageCopyData(uint32_t regionCount, const VkBufferImageCopy *pRegions, IMAGE_STATE *image_state,
4615 const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004616 bool skip = false;
4617
4618 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004619 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
4620 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004621 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 -06004622 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00199",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004623 "%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 -06004624 "and 1, respectively.",
4625 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004626 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004627 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004628
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004629 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
4630 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004631 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 -06004632 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00201",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004633 "%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 -06004634 "must be 0 and 1, respectively.",
4635 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004636 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004637 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004638
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004639 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
4640 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004641 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 -06004642 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-baseArrayLayer-00213",
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004643 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
4644 "For 3D images these must be 0 and 1, respectively.",
4645 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004646 }
4647 }
4648
4649 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07004650 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
Locke497739c2019-03-08 11:50:47 -07004651 uint32_t element_size = FormatElementSize(image_state->createInfo.format, pRegions[i].imageSubresource.aspectMask);
4652
Dave Houltona585d132019-01-18 13:05:42 -07004653 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004654 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 -06004655 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00193",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004656 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07004657 " must be a multiple of this format's texel size (%" PRIu32 ").",
4658 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004659 }
4660
4661 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06004662 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004663 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 -06004664 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00194",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004665 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
4666 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004667 }
4668
4669 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
4670 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004671 skip |=
4672 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004673 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00195",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004674 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
4675 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004676 }
4677
4678 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
4679 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
4680 skip |= log_msg(
4681 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004682 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004683 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
4684 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004685 }
4686
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06004687 // Calculate adjusted image extent, accounting for multiplane image factors
4688 VkExtent3D adusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
4689 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
4690 if ((pRegions[i].imageOffset.x < 0) || (pRegions[i].imageOffset.x > static_cast<int32_t>(adusted_image_extent.width)) ||
4691 ((pRegions[i].imageOffset.x + pRegions[i].imageExtent.width) > static_cast<int32_t>(adusted_image_extent.width))) {
4692 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4693 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00197",
4694 "%s(): Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
4695 "zero or <= image subresource width (%d).",
4696 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
4697 adusted_image_extent.width);
4698 }
4699
4700 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
4701 if ((pRegions[i].imageOffset.y < 0) || (pRegions[i].imageOffset.y > static_cast<int32_t>(adusted_image_extent.height)) ||
4702 ((pRegions[i].imageOffset.y + pRegions[i].imageExtent.height) > static_cast<int32_t>(adusted_image_extent.height))) {
4703 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4704 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00198",
4705 "%s(): Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
4706 "zero or <= image subresource height (%d).",
4707 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
4708 adusted_image_extent.height);
4709 }
4710
4711 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
4712 if ((pRegions[i].imageOffset.z < 0) || (pRegions[i].imageOffset.z > static_cast<int32_t>(adusted_image_extent.depth)) ||
4713 ((pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth) > static_cast<int32_t>(adusted_image_extent.depth))) {
4714 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4715 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00200",
4716 "%s(): Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
4717 "zero or <= image subresource depth (%d).",
4718 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
4719 adusted_image_extent.depth);
4720 }
4721
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004722 // subresource aspectMask must have exactly 1 bit set
4723 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
4724 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
4725 if (aspect_mask_bits.count() != 1) {
4726 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 -06004727 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00212",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004728 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004729 }
4730
4731 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06004732 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004733 skip |= log_msg(
4734 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004735 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004736 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
4737 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004738 }
4739
4740 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04004741 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07004742 auto block_size = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004743
4744 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06004745 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004746 skip |= log_msg(
4747 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004748 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00203",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004749 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
4750 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004751 }
4752
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004753 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004754 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004755 skip |= log_msg(
4756 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004757 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00204",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004758 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
4759 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004760 }
4761
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004762 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06004763 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
4764 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
4765 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004766 skip |=
4767 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004768 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00205",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004769 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
4770 "width & height (%d, %d)..",
4771 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004772 }
4773
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004774 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houltona585d132019-01-18 13:05:42 -07004775 uint32_t block_size_in_bytes = FormatElementSize(image_state->createInfo.format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06004776 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004777 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 -06004778 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00206",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004779 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07004780 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004781 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004782 }
Dave Houlton67e9b532017-03-02 17:00:10 -07004783
4784 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07004785 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06004786 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004787 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
4788 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 -06004789 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00207",
Dave Houlton75967fc2017-03-06 17:21:16 -07004790 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004791 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004792 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004793 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07004794 }
4795
4796 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004797 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004798 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
4799 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 -06004800 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00208",
Dave Houlton75967fc2017-03-06 17:21:16 -07004801 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004802 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004803 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004804 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07004805 }
4806
4807 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06004808 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004809 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
4810 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 -06004811 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00209",
Dave Houlton75967fc2017-03-06 17:21:16 -07004812 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004813 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004814 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004815 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07004816 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004817 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004818 }
4819
4820 return skip;
4821}
4822
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004823static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06004824 const VkBufferImageCopy *pRegions, const char *func_name, const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004825 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004826 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004827
4828 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004829 VkExtent3D extent = pRegions[i].imageExtent;
4830 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004831
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004832 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
4833 {
Dave Houlton51653902018-06-22 17:32:13 -06004834 skip |=
4835 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4836 kVUID_Core_Image_ZeroAreaSubregion, "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area",
4837 func_name, i, extent.width, extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004838 }
4839
4840 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
4841
4842 // 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 -06004843 if (FormatIsCompressed(image_info->format)) {
Dave Houltona585d132019-01-18 13:05:42 -07004844 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004845 if (image_extent.width % block_extent.width) {
4846 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
4847 }
4848 if (image_extent.height % block_extent.height) {
4849 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
4850 }
4851 if (image_extent.depth % block_extent.depth) {
4852 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
4853 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004854 }
4855
Dave Houltonfc1a4052017-04-27 14:32:45 -06004856 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004857 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 -06004858 msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004859 }
4860 }
4861
4862 return skip;
4863}
4864
Chris Forbese8ba09a2017-06-01 17:39:02 -07004865static inline bool ValidateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
Dave Houlton33c2d252017-06-09 17:08:32 -06004866 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06004867 const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004868 bool skip = false;
4869
4870 VkDeviceSize buffer_size = buff_state->createInfo.size;
4871
4872 for (uint32_t i = 0; i < regionCount; i++) {
4873 VkExtent3D copy_extent = pRegions[i].imageExtent;
4874
4875 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
4876 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Locke497739c2019-03-08 11:50:47 -07004877 VkDeviceSize unit_size = FormatElementSize(image_state->createInfo.format,
4878 pRegions[i].imageSubresource.aspectMask); // size (bytes) of texel or block
Dave Houltonf3229d52017-02-21 15:59:08 -07004879
Tom Cooperb2550c72018-10-15 13:08:41 +01004880 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004881 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houltona585d132019-01-18 13:05:42 -07004882 auto block_dim = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004883 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
4884 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
4885
4886 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
4887 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
4888 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004889 }
4890
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004891 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
4892 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
4893 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07004894 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004895 } else {
4896 // Calculate buffer offset of final copied byte, + 1.
4897 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
4898 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
4899 max_buffer_offset *= unit_size; // convert to bytes
4900 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004901
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004902 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06004903 skip |=
4904 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4905 msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i, buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004906 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004907 }
4908 }
4909
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004910 return skip;
4911}
4912
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004913bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4914 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004915 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004916 auto src_image_state = GetImageState(srcImage);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004917 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004918
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004919 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004920
4921 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004922 skip |= ValidateCmd(cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004923
4924 // Command pool must support graphics, compute, or transfer operations
Mark Lobodzinskic2a15b02019-04-25 12:06:02 -06004925 auto pPool = GetCommandPoolState(cb_node->createInfo.commandPool);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004926
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004927 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07004928
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004929 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4930 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 -06004931 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004932 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004933 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004934 }
Dave Houlton0ef27492018-04-04 11:41:48 -06004935 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004936 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Chris Forbese8ba09a2017-06-01 17:39:02 -07004937 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004938 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004939
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004940 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06004941 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004942 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
4943 skip |=
4944 ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004945
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004946 // Validate that SRC image & DST buffer have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004947 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004948 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
4949 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004950 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004951 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
4952 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06004953 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004954 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImageToBuffer()",
4955 "VUID-vkCmdCopyImageToBuffer-srcImage-01998",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06004956 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04004957 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004958 skip |= InsideRenderPass(cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06004959 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004960 const char *src_invalid_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
4961 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
4962 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004963 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004964 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
Cort Strattond619a302018-05-17 19:46:32 -07004965 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004966 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07004967 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
4968 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004969 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
4970 cb_node, src_image_state, &pRegions[i], i, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
4971 skip |=
4972 ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyImageToBuffer()",
4973 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
4974 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07004975 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
4976 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004977 }
4978 return skip;
4979}
4980
John Zulauf1686f232019-07-09 16:27:11 -06004981void ValidationStateTracker::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage,
4982 VkImageLayout srcImageLayout, VkBuffer dstBuffer,
4983 uint32_t regionCount, const VkBufferImageCopy *pRegions) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004984 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004985 auto src_image_state = GetImageState(srcImage);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004986 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004987
John Zulauf1686f232019-07-09 16:27:11 -06004988 // Update bindings between buffer/image and cmd buffer
4989 AddCommandBufferBindingImage(cb_node, src_image_state);
4990 AddCommandBufferBindingBuffer(cb_node, dst_buffer_state);
4991}
4992void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4993 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
4994 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
4995
4996 auto cb_node = GetCBState(commandBuffer);
4997 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06004998 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004999 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005000 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005001 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005002}
5003
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005004bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5005 VkImageLayout dstImageLayout, uint32_t regionCount,
5006 const VkBufferImageCopy *pRegions) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06005007 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005008 auto src_buffer_state = GetBufferState(srcBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07005009 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005010
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005011 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005012
5013 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005014 skip |= ValidateCmd(cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005015
5016 // Command pool must support graphics, compute, or transfer operations
Mark Lobodzinskic2a15b02019-04-25 12:06:02 -06005017 auto pPool = GetCommandPoolState(cb_node->createInfo.commandPool);
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005018 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005019 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
5020 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 -06005021 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005022 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005023 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005024 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005025 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005026 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Chris Forbese8ba09a2017-06-01 17:39:02 -07005027 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005028 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005029 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005030 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005031 skip |=
5032 ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
5033 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005034 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005035 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
5036 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005037 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005038 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
5039 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06005040 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005041 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyBufferToImage()",
5042 "VUID-vkCmdCopyBufferToImage-dstImage-01997",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005043 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04005044 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005045 skip |= InsideRenderPass(cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005046 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005047 const char *dst_invalid_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5048 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
5049 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005050 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005051 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
Cort Strattond619a302018-05-17 19:46:32 -07005052 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005053 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005054 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
5055 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005056 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5057 cb_node, dst_image_state, &pRegions[i], i, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
5058 skip |=
5059 ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyBufferToImage()",
5060 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
5061 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005062 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
5063 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005064 }
5065 return skip;
5066}
5067
John Zulauf1686f232019-07-09 16:27:11 -06005068void ValidationStateTracker::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5069 VkImageLayout dstImageLayout, uint32_t regionCount,
5070 const VkBufferImageCopy *pRegions) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06005071 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005072 auto src_buffer_state = GetBufferState(srcBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07005073 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005074
John Zulauf1686f232019-07-09 16:27:11 -06005075 AddCommandBufferBindingBuffer(cb_node, src_buffer_state);
5076 AddCommandBufferBindingImage(cb_node, dst_image_state);
5077}
5078
5079void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5080 VkImageLayout dstImageLayout, uint32_t regionCount,
5081 const VkBufferImageCopy *pRegions) {
5082 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
5083
5084 auto cb_node = GetCBState(commandBuffer);
5085 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06005086 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005087 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005088 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005089 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005090}
Mike Weiblen672b58b2017-02-21 14:32:53 -07005091
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005092bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
5093 VkSubresourceLayout *pLayout) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005094 bool skip = false;
5095 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
5096
Dave Houlton1d960ff2018-01-19 12:17:05 -07005097 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07005098 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
5099 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
5100 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02005101 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 -06005102 "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005103 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005104 }
5105
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07005106 IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005107 if (!image_entry) {
5108 return skip;
5109 }
5110
Dave Houlton1d960ff2018-01-19 12:17:05 -07005111 // image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
Mike Weiblen672b58b2017-02-21 14:32:53 -07005112 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005113 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5114 "VUID-vkGetImageSubresourceLayout-image-00996",
5115 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005116 }
5117
Dave Houlton1d960ff2018-01-19 12:17:05 -07005118 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005119 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005120 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5121 "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
5122 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
5123 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005124 }
5125
Dave Houlton1d960ff2018-01-19 12:17:05 -07005126 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005127 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005128 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5129 "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
5130 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
5131 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005132 }
5133
Dave Houlton1d960ff2018-01-19 12:17:05 -07005134 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07005135 const VkFormat img_format = image_entry->createInfo.format;
Dave Houlton1d960ff2018-01-19 12:17:05 -07005136 if (FormatIsMultiplane(img_format)) {
5137 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06005138 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07005139 if (FormatPlaneCount(img_format) > 2u) {
5140 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
Dave Houltond8ed0212018-05-16 17:18:24 -06005141 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07005142 }
5143 if (sub_aspect != (sub_aspect & allowed_flags)) {
5144 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 -06005145 HandleToUint64(image), vuid,
Dave Houlton1d960ff2018-01-19 12:17:05 -07005146 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005147 ") must be a single-plane specifier flag.",
5148 sub_aspect);
Dave Houlton1d960ff2018-01-19 12:17:05 -07005149 }
5150 } else if (FormatIsColor(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005151 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Dave Houlton852287e2018-01-19 15:11:51 -07005152 skip |= log_msg(
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06005153 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-VkImageSubresource-aspectMask-parameter",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005155 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005156 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06005157 } else if (FormatIsDepthOrStencil(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005158 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06005159 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 -06005160 HandleToUint64(image), "VUID-VkImageSubresource-aspectMask-parameter",
Mike Weiblen672b58b2017-02-21 14:32:53 -07005161 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005162 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005163 }
5164 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005165
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005166 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005167 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005168 }
5169
Mike Weiblen672b58b2017-02-21 14:32:53 -07005170 return skip;
5171}