blob: f682a9d9be73496da5b6e503d425749502843826 [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{},
68 sparse_requirements{} {
69 if ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) && (createInfo.queueFamilyIndexCount > 0)) {
70 uint32_t *pQueueFamilyIndices = new uint32_t[createInfo.queueFamilyIndexCount];
71 for (uint32_t i = 0; i < createInfo.queueFamilyIndexCount; i++) {
72 pQueueFamilyIndices[i] = pCreateInfo->pQueueFamilyIndices[i];
73 }
74 createInfo.pQueueFamilyIndices = pQueueFamilyIndices;
75 }
76
77 if (createInfo.flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) {
78 sparse = true;
79 }
80 const auto format = createInfo.format;
81 VkImageSubresourceRange init_range{0, 0, VK_REMAINING_MIP_LEVELS, 0, VK_REMAINING_ARRAY_LAYERS};
82 if (FormatIsColor(format) || FormatIsMultiplane(format)) {
83 init_range.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT; // Normalization will expand this for multiplane
84 } else {
85 init_range.aspectMask =
86 (FormatHasDepth(format) ? VK_IMAGE_ASPECT_DEPTH_BIT : 0) | (FormatHasStencil(format) ? VK_IMAGE_ASPECT_STENCIL_BIT : 0);
87 }
88 full_range = NormalizeSubresourceRange(*this, init_range);
89}
90
91IMAGE_VIEW_STATE::IMAGE_VIEW_STATE(const IMAGE_STATE *image_state, VkImageView iv, const VkImageViewCreateInfo *ci)
92 : image_view(iv), create_info(*ci), normalized_subresource_range(ci->subresourceRange), samplerConversion(VK_NULL_HANDLE) {
93 auto *conversionInfo = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info.pNext);
94 if (conversionInfo) samplerConversion = conversionInfo->conversion;
95 if (image_state) {
96 // A light normalization of the createInfo range
97 auto &sub_res_range = create_info.subresourceRange;
98 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
99 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
100
101 // Cache a full normalization (for "full image/whole image" comparisons)
102 normalized_subresource_range = NormalizeSubresourceRange(*image_state, ci->subresourceRange);
103 }
104}
105
Dave Houltond9611312018-11-19 17:03:36 -0700106uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
107 // uint cast applies floor()
108 return 1u + (uint32_t)log2(std::max({height, width, depth}));
109}
110
111uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
112
113uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
114
John Zulauff660ad62019-03-23 07:16:05 -0600115VkImageSubresourceRange NormalizeSubresourceRange(const IMAGE_STATE &image_state, const VkImageSubresourceRange &range) {
116 const VkImageCreateInfo &image_create_info = image_state.createInfo;
117 VkImageSubresourceRange norm = range;
118 norm.levelCount = ResolveRemainingLevels(&range, image_create_info.mipLevels);
119
120 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
121 // <arrayLayers> can potentially alias.
122 uint32_t layer_limit = (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR))
123 ? image_create_info.extent.depth
124 : image_create_info.arrayLayers;
125 norm.layerCount = ResolveRemainingLayers(&range, layer_limit);
126
127 // For multiplanar formats, IMAGE_ASPECT_COLOR is equivalent to adding the aspect of the individual planes
128 VkImageAspectFlags &aspect_mask = norm.aspectMask;
129 if (FormatIsMultiplane(image_create_info.format)) {
130 if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
131 aspect_mask &= ~VK_IMAGE_ASPECT_COLOR_BIT;
132 aspect_mask |= (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
133 if (FormatPlaneCount(image_create_info.format) > 2) {
134 aspect_mask |= VK_IMAGE_ASPECT_PLANE_2_BIT;
135 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700136 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700137 }
John Zulauff660ad62019-03-23 07:16:05 -0600138 return norm;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700139}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700140
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700141template <class OBJECT, class LAYOUT>
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700142void CoreChecks::SetLayout(OBJECT *pObject, VkImage image, VkImageSubresource range, const LAYOUT &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700143 ImageSubresourcePair imgpair = {image, true, range};
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700144 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
145 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
146 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
147 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600148 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700149 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
150 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
151 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700152 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700153}
154
155template <class OBJECT, class LAYOUT>
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700156void CoreChecks::SetLayout(OBJECT *pObject, ImageSubresourcePair imgpair, const LAYOUT &layout, VkImageAspectFlags aspectMask) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700157 if (imgpair.subresource.aspectMask & aspectMask) {
158 imgpair.subresource.aspectMask = aspectMask;
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700159 SetLayout(pObject, imgpair, layout);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700160 }
161}
162
Tony Barbourdf013b92017-01-25 12:53:48 -0700163// Set the layout in supplied map
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700164void CoreChecks::SetLayout(std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap,
165 ImageSubresourcePair imgpair, VkImageLayout layout) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700166 auto it = imageLayoutMap.find(imgpair);
167 if (it != imageLayoutMap.end()) {
168 it->second.layout = layout; // Update
169 } else {
170 imageLayoutMap[imgpair].layout = layout; // Insert
171 }
Tony Barbourdf013b92017-01-25 12:53:48 -0700172}
173
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700174bool CoreChecks::FindLayoutVerifyLayout(ImageSubresourcePair imgpair, VkImageLayout &layout, const VkImageAspectFlags aspectMask) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700175 if (!(imgpair.subresource.aspectMask & aspectMask)) {
176 return false;
177 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700178 VkImageAspectFlags oldAspectMask = imgpair.subresource.aspectMask;
179 imgpair.subresource.aspectMask = aspectMask;
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600180 auto imgsubIt = imageLayoutMap.find(imgpair);
181 if (imgsubIt == imageLayoutMap.end()) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700182 return false;
183 }
184 if (layout != VK_IMAGE_LAYOUT_MAX_ENUM && layout != imgsubIt->second.layout) {
Petr Krausbc7f5442017-05-14 23:43:38 +0200185 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 -0600186 kVUID_Core_DrawState_InvalidLayout,
Lockee9aeebf2019-03-03 23:50:08 -0700187 "Cannot query for VkImage %s layout when combined aspect mask %d has multiple layout types: %s and %s",
188 report_data->FormatHandle(imgpair.image).c_str(), oldAspectMask, string_VkImageLayout(layout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700189 string_VkImageLayout(imgsubIt->second.layout));
190 }
191 layout = imgsubIt->second.layout;
192 return true;
193}
194
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700195// Find layout(s) on the global level
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700196bool CoreChecks::FindGlobalLayout(ImageSubresourcePair imgpair, VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700197 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700198 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
199 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
200 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
201 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600202 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700203 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
204 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
205 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700206 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700207 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
208 imgpair = {imgpair.image, false, VkImageSubresource()};
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600209 auto imgsubIt = imageLayoutMap.find(imgpair);
210 if (imgsubIt == imageLayoutMap.end()) return false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700211 layout = imgsubIt->second.layout;
212 }
213 return true;
214}
215
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700216bool CoreChecks::FindLayouts(VkImage image, std::vector<VkImageLayout> &layouts) {
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -0600217 auto sub_data = imageSubresourceMap.find(image);
218 if (sub_data == imageSubresourceMap.end()) return false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700219 auto image_state = GetImageState(image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700220 if (!image_state) return false;
221 bool ignoreGlobal = false;
222 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
223 if (sub_data->second.size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
224 ignoreGlobal = true;
225 }
226 for (auto imgsubpair : sub_data->second) {
227 if (ignoreGlobal && !imgsubpair.hasSubresource) continue;
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600228 auto img_data = imageLayoutMap.find(imgsubpair);
229 if (img_data != imageLayoutMap.end()) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700230 layouts.push_back(img_data->second.layout);
231 }
232 }
233 return true;
234}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700235
236bool CoreChecks::FindLayout(const std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap,
237 ImageSubresourcePair imgpair, VkImageLayout &layout, const VkImageAspectFlags aspectMask) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700238 if (!(imgpair.subresource.aspectMask & aspectMask)) {
239 return false;
240 }
241 imgpair.subresource.aspectMask = aspectMask;
242 auto imgsubIt = imageLayoutMap.find(imgpair);
243 if (imgsubIt == imageLayoutMap.end()) {
244 return false;
245 }
246 layout = imgsubIt->second.layout;
247 return true;
Tony Barboure0c5cc92017-02-08 13:53:39 -0700248}
Tony Barbourdf013b92017-01-25 12:53:48 -0700249
250// find layout in supplied map
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700251bool CoreChecks::FindLayout(const std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700252 ImageSubresourcePair imgpair, VkImageLayout &layout) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700253 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
254 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
255 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
256 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
257 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600258 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700259 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
260 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
261 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
262 }
263 // Image+subresource not found, look for image handle w/o subresource
Tony Barbourdf013b92017-01-25 12:53:48 -0700264 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
265 imgpair = {imgpair.image, false, VkImageSubresource()};
266 auto imgsubIt = imageLayoutMap.find(imgpair);
267 if (imgsubIt == imageLayoutMap.end()) return false;
268 layout = imgsubIt->second.layout;
269 }
270 return true;
271}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700272
273// Set the layout on the global level
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700274void CoreChecks::SetGlobalLayout(ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700275 VkImage &image = imgpair.image;
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600276 auto data = imageLayoutMap.find(imgpair);
277 if (data != imageLayoutMap.end()) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700278 data->second.layout = layout; // Update
279 } else {
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600280 imageLayoutMap[imgpair].layout = layout; // Insert
Dave Houltonb3f4b282018-02-22 16:25:16 -0700281 }
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -0600282 auto &image_subresources = imageSubresourceMap[image];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700283 auto subresource = std::find(image_subresources.begin(), image_subresources.end(), imgpair);
284 if (subresource == image_subresources.end()) {
285 image_subresources.push_back(imgpair);
286 }
287}
288
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600289// Set image layout for given VkImageSubresourceRange struct
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600290void CoreChecks::SetImageLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600291 const VkImageSubresourceRange &image_subresource_range, VkImageLayout layout,
292 VkImageLayout expected_layout) {
293 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
294 assert(subresource_map); // the non-const getter must return a valid pointer
295 if (subresource_map->SetSubresourceRangeLayout(image_subresource_range, layout, expected_layout)) {
296 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700297 }
298}
John Zulauff660ad62019-03-23 07:16:05 -0600299
300// Set the initial image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600301void CoreChecks::SetImageViewInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
John Zulauff660ad62019-03-23 07:16:05 -0600302 IMAGE_STATE *image_state = GetImageState(view_state.create_info.image);
303 if (image_state) {
304 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
John Zulaufb61ed972019-04-09 16:12:35 -0600305 subresource_map->SetSubresourceRangeInitialLayout(view_state.normalized_subresource_range, layout, *cb_node, &view_state);
John Zulauff660ad62019-03-23 07:16:05 -0600306 }
307}
308
309// Set the initial image layout for a passed non-normalized subresource range
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600310void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600311 const VkImageSubresourceRange &range, VkImageLayout layout) {
312 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
313 assert(subresource_map);
John Zulaufb61ed972019-04-09 16:12:35 -0600314 subresource_map->SetSubresourceRangeInitialLayout(NormalizeSubresourceRange(image_state, range), layout, *cb_node);
John Zulauff660ad62019-03-23 07:16:05 -0600315}
316
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600317void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, VkImage image, const VkImageSubresourceRange &range,
John Zulauff660ad62019-03-23 07:16:05 -0600318 VkImageLayout layout) {
319 const IMAGE_STATE *image_state = GetImageState(image);
320 if (!image_state) return;
321 SetImageInitialLayout(cb_node, *image_state, range, layout);
322};
323
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600324void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600325 const VkImageSubresourceLayers &layers, VkImageLayout layout) {
326 SetImageInitialLayout(cb_node, image_state, RangeFromLayers(layers), layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600327}
Dave Houltonddd65c52018-05-08 14:58:01 -0600328
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600329// Set image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600330void CoreChecks::SetImageViewLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
John Zulauff660ad62019-03-23 07:16:05 -0600331 IMAGE_STATE *image_state = GetImageState(view_state.create_info.image);
332 if (!image_state) return; // TODO: track/report stale image references
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600333
John Zulauff660ad62019-03-23 07:16:05 -0600334 VkImageSubresourceRange sub_range = view_state.normalized_subresource_range;
Dave Houltonddd65c52018-05-08 14:58:01 -0600335 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
336 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
John Zulauff660ad62019-03-23 07:16:05 -0600337 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 -0600338 sub_range.baseArrayLayer = 0;
339 sub_range.layerCount = image_state->createInfo.extent.depth;
340 }
341
John Zulauff660ad62019-03-23 07:16:05 -0600342 SetImageLayout(cb_node, *image_state, sub_range, layout);
John Zulauf4ccf5c02018-09-21 11:46:18 -0600343}
344
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700345bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
346 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700347 VkFramebuffer framebuffer, VkRenderPass renderpass,
348 uint32_t attachment_index, const char *variable_name) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100349 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700350 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100351 const char *vuid;
352 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
353
354 if (!image_state) {
355 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
356 "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Lockee9aeebf2019-03-03 23:50:08 -0700357 "Render Pass begin with renderpass %s uses framebuffer %s where pAttachments[%" PRIu32
358 "] = image view %s, which refers to an invalid image",
359 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
360 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100361 return skip;
362 }
363
364 auto image_usage = image_state->createInfo.usage;
365
366 // Check for layouts that mismatch image usages in the framebuffer
367 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
368 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
369 skip |=
370 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
Lockee9aeebf2019-03-03 23:50:08 -0700371 "Layout/usage mismatch for attachment %u in render pass %s"
372 " - the %s is %s but the image attached to framebuffer %s via image view %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100373 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600374 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
375 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100376 }
377
378 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
379 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
380 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
381 skip |=
382 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
Lockee9aeebf2019-03-03 23:50:08 -0700383 "Layout/usage mismatch for attachment %u in render pass %s"
384 " - the %s is %s but the image attached to framebuffer %s via image view %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100385 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600386 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
387 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100388 }
389
390 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
391 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
392 skip |=
393 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
Lockee9aeebf2019-03-03 23:50:08 -0700394 "Layout/usage mismatch for attachment %u in render pass %s"
395 " - the %s is %s but the image attached to framebuffer %s via image view %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100396 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600397 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
398 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100399 }
400
401 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
402 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
403 skip |=
404 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
Lockee9aeebf2019-03-03 23:50:08 -0700405 "Layout/usage mismatch for attachment %u in render pass %s"
406 " - the %s is %s but the image attached to framebuffer %s via image view %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100407 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600408 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
409 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100410 }
411
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600412 if (device_extensions.vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100413 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
414 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
415 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
416 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
417 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
418 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Lockee9aeebf2019-03-03 23:50:08 -0700419 skip |= log_msg(
420 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
421 "Layout/usage mismatch for attachment %u in render pass %s"
422 " - the %s is %s but the image attached to framebuffer %s via image view %s"
423 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600424 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
425 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100426 }
427 } else {
428 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
429 if ((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 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
433 HandleToUint64(image), "VUID-vkCmdBeginRenderPass-initialLayout-00896",
Lockee9aeebf2019-03-03 23:50:08 -0700434 "Layout/usage mismatch for attachment %u in render pass %s"
435 " - the %s is %s but the image attached to framebuffer %s via image view %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100436 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600437 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
438 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
Lockee9aeebf2019-03-03 23:50:08 -0700439 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100440 }
441 }
442 return skip;
443}
444
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600445bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700446 const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700447 const FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600448 bool skip = false;
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700449 auto const pRenderPassInfo = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700450 auto const &framebufferInfo = framebuffer_state->createInfo;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100451
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700452 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100453 auto framebuffer = framebuffer_state->framebuffer;
454
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700455 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600456 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 -0600457 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700458 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700459 }
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600460 const auto *const_pCB = static_cast<const CMD_BUFFER_STATE *>(pCB);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700461 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
462 const VkImageView &image_view = framebufferInfo.pAttachments[i];
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700463 auto view_state = GetImageViewState(image_view);
John Zulauf8e308292018-09-21 11:34:37 -0600464
465 if (!view_state) {
Lockee9aeebf2019-03-03 23:50:08 -0700466 skip |=
467 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_RENDER_PASS_EXT,
468 HandleToUint64(pRenderPassBegin->renderPass), "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
469 "vkCmdBeginRenderPass(): framebuffer %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
470 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
471 report_data->FormatHandle(image_view).c_str());
John Zulauf8e308292018-09-21 11:34:37 -0600472 continue;
473 }
474
John Zulauff660ad62019-03-23 07:16:05 -0600475 const VkImage image = view_state->create_info.image;
476 const IMAGE_STATE *image_state = GetImageState(image);
477
478 if (!image_state) {
479 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_RENDER_PASS_EXT,
480 HandleToUint64(pRenderPassBegin->renderPass), "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
481 "vkCmdBeginRenderPass(): framebuffer %s pAttachments[%" PRIu32
482 "] = VkImageView %s references non-extant VkImage %s.",
483 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
484 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
485 continue;
486 }
487 auto attachment_initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100488 auto final_layout = pRenderPassInfo->pAttachments[i].finalLayout;
489
John Zulauff660ad62019-03-23 07:16:05 -0600490 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
491 // in common with the non-const version.)
492 const ImageSubresourceLayoutMap *subresource_map =
493 (attachment_initial_layout != VK_IMAGE_LAYOUT_UNDEFINED) ? GetImageSubresourceLayoutMap(const_pCB, image) : nullptr;
494
495 if (subresource_map) { // If no layout information for image yet, will be checked at QueueSubmit time
John Zulauf02a204c2019-04-23 18:52:11 -0600496 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -0600497 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -0600498 auto subresource_cb = [this, i, attachment_initial_layout, &layout_check, &subres_skip](
John Zulauff660ad62019-03-23 07:16:05 -0600499 const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
John Zulauf02a204c2019-04-23 18:52:11 -0600500 if (!layout_check.Check(subres, attachment_initial_layout, layout, initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600501 subres_skip |=
502 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
503 kVUID_Core_DrawState_InvalidRenderpass,
504 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
505 "and the %s layout of the attachment is %s. The layouts must match, or the render "
506 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
507 i, string_VkImageLayout(attachment_initial_layout), layout_check.message,
508 string_VkImageLayout(layout_check.layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700509 }
John Zulauff660ad62019-03-23 07:16:05 -0600510 return !subres_skip; // quit checking subresources once we fail once
511 };
512
513 subresource_map->ForRange(view_state->normalized_subresource_range, subresource_cb);
514 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700515 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100516
John Zulauff660ad62019-03-23 07:16:05 -0600517 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view, framebuffer,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700518 render_pass, i, "initial layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100519
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700520 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer, render_pass,
521 i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100522 }
523
524 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
525 auto &subpass = pRenderPassInfo->pSubpasses[j];
526 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
527 auto &attachment_ref = subpass.pInputAttachments[k];
528 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
529 auto image_view = framebufferInfo.pAttachments[attachment_ref.attachment];
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700530 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100531
532 if (view_state) {
533 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700534 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
535 framebuffer, render_pass, attachment_ref.attachment,
536 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100537 }
538 }
539 }
540
541 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
542 auto &attachment_ref = subpass.pColorAttachments[k];
543 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
544 auto image_view = framebufferInfo.pAttachments[attachment_ref.attachment];
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700545 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100546
547 if (view_state) {
548 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700549 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
550 framebuffer, render_pass, attachment_ref.attachment,
551 "color attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100552 if (subpass.pResolveAttachments) {
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700553 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
554 framebuffer, render_pass, attachment_ref.attachment,
555 "resolve attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100556 }
557 }
558 }
559 }
560
561 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
562 auto &attachment_ref = *subpass.pDepthStencilAttachment;
563 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
564 auto image_view = framebufferInfo.pAttachments[attachment_ref.attachment];
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700565 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100566
567 if (view_state) {
568 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700569 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
570 framebuffer, render_pass, attachment_ref.attachment,
571 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100572 }
573 }
574 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700575 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600576 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700577}
578
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600579void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700580 const safe_VkAttachmentReference2KHR &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700581 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700582 auto image_view = GetAttachmentImageViewState(pFramebuffer, ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600583 if (image_view) {
John Zulauff660ad62019-03-23 07:16:05 -0600584 SetImageViewLayout(pCB, *image_view, ref.layout);
John Zulauf8e308292018-09-21 11:34:37 -0600585 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700586 }
587}
588
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600589void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
590 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700591 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700592
593 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700594 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700595 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700596 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700597 }
598 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700599 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700600 }
601 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700602 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700603 }
604 }
605}
606
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700607// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
608// 1. Transition into initialLayout state
609// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600610void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700611 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700612 // First transition into initialLayout
613 auto const rpci = render_pass_state->createInfo.ptr();
614 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700615 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -0600616 if (view_state) {
John Zulauff660ad62019-03-23 07:16:05 -0600617 SetImageViewLayout(cb_state, *view_state, rpci->pAttachments[i].initialLayout);
John Zulauf8e308292018-09-21 11:34:37 -0600618 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700619 }
620 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700621 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700622}
623
Dave Houlton10b39482017-03-16 13:18:15 -0600624bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600625 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600626 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600627 }
628 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600629 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600630 }
631 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600632 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600633 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700634 if (0 !=
635 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
636 if (FormatPlaneCount(format) == 1) return false;
637 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600638 return true;
639}
640
Mike Weiblen62d08a32017-03-07 22:18:27 -0700641// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700642bool CoreChecks::ValidateBarrierLayoutToImageUsage(const VkImageMemoryBarrier *img_barrier, bool new_not_old,
643 VkImageUsageFlags usage_flags, const char *func_name) {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700644 bool skip = false;
645 const VkImageLayout layout = (new_not_old) ? img_barrier->newLayout : img_barrier->oldLayout;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600646 const char *msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700647
648 switch (layout) {
649 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
650 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600651 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700652 }
653 break;
654 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
655 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600656 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700657 }
658 break;
659 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
660 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600661 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700662 }
663 break;
664 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
665 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600666 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700667 }
668 break;
669 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
670 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600671 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700672 }
673 break;
674 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
675 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600676 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700677 }
678 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600679 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500680 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
681 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
682 }
683 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700684 default:
685 // Other VkImageLayout values do not have VUs defined in this context.
686 break;
687 }
688
Dave Houlton8e9f6542018-05-18 12:18:22 -0600689 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600690 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 -0600691 HandleToUint64(img_barrier->image), msg_code,
John Zulauff660ad62019-03-23 07:16:05 -0600692 "%s: Image barrier 0x%p %s Layout=%s is not compatible with image %s usage flags 0x%" PRIx32 ".", func_name,
Lockee9aeebf2019-03-03 23:50:08 -0700693 static_cast<const void *>(img_barrier), ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
694 report_data->FormatHandle(img_barrier->image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700695 }
696 return skip;
697}
698
John Zulauf463c51e2018-05-31 13:29:20 -0600699// Scoreboard for checking for duplicate and inconsistent barriers to images
700struct ImageBarrierScoreboardEntry {
701 uint32_t index;
702 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
703 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
704 const VkImageMemoryBarrier *barrier;
705};
706using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
707using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
708
Mike Weiblen62d08a32017-03-07 22:18:27 -0700709// Verify image barriers are compatible with the images they reference.
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600710bool CoreChecks::ValidateBarriersToImages(CMD_BUFFER_STATE const *cb_state, uint32_t imageMemoryBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700711 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700712 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700713
John Zulauf463c51e2018-05-31 13:29:20 -0600714 // Scoreboard for duplicate layout transition barriers within the list
715 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
716 ImageBarrierScoreboardImageMap layout_transitions;
717
Mike Weiblen62d08a32017-03-07 22:18:27 -0700718 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
719 auto img_barrier = &pImageMemoryBarriers[i];
720 if (!img_barrier) continue;
721
John Zulauf463c51e2018-05-31 13:29:20 -0600722 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
723 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
724 // at a per sub-resource level
725 if (img_barrier->oldLayout != img_barrier->newLayout) {
726 ImageBarrierScoreboardEntry new_entry{i, img_barrier};
727 auto image_it = layout_transitions.find(img_barrier->image);
728 if (image_it != layout_transitions.end()) {
729 auto &subres_map = image_it->second;
730 auto subres_it = subres_map.find(img_barrier->subresourceRange);
731 if (subres_it != subres_map.end()) {
732 auto &entry = subres_it->second;
733 if ((entry.barrier->newLayout != img_barrier->oldLayout) &&
734 (img_barrier->oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
735 const VkImageSubresourceRange &range = img_barrier->subresourceRange;
736 skip = log_msg(
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700737 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
738 HandleToUint64(cb_state->commandBuffer), "VUID-VkImageMemoryBarrier-oldLayout-01197",
Lockee9aeebf2019-03-03 23:50:08 -0700739 "%s: pImageMemoryBarrier[%u] conflicts with earlier entry pImageMemoryBarrier[%u]. Image %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600740 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
741 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700742 func_name, i, entry.index, report_data->FormatHandle(img_barrier->image).c_str(), range.aspectMask,
Lockee9aeebf2019-03-03 23:50:08 -0700743 range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
744 string_VkImageLayout(img_barrier->oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600745 }
746 entry = new_entry;
747 } else {
748 subres_map[img_barrier->subresourceRange] = new_entry;
749 }
750 } else {
751 layout_transitions[img_barrier->image][img_barrier->subresourceRange] = new_entry;
752 }
753 }
754
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700755 auto image_state = GetImageState(img_barrier->image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600756 if (image_state) {
757 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700758 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, false, usage_flags, func_name);
759 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, true, usage_flags, func_name);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600760
761 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
762 if (image_state->layout_locked) {
763 // TODO: Add unique id for error when available
Dave Houlton33c2d252017-06-09 17:08:32 -0600764 skip |= log_msg(
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700765 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
766 HandleToUint64(img_barrier->image), 0,
Lockee9aeebf2019-03-03 23:50:08 -0700767 "Attempting to transition shared presentable image %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600768 " from layout %s to layout %s, but image has already been presented and cannot have its layout transitioned.",
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700769 report_data->FormatHandle(img_barrier->image).c_str(), string_VkImageLayout(img_barrier->oldLayout),
770 string_VkImageLayout(img_barrier->newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600771 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600772
John Zulauff660ad62019-03-23 07:16:05 -0600773 VkImageCreateInfo *image_create_info = &image_state->createInfo;
774 // For a Depth/Stencil image both aspects MUST be set
775 if (FormatIsDepthAndStencil(image_create_info->format)) {
776 auto const aspect_mask = img_barrier->subresourceRange.aspectMask;
777 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
778 if ((aspect_mask & ds_mask) != (ds_mask)) {
779 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
780 HandleToUint64(img_barrier->image), "VUID-VkImageMemoryBarrier-image-01207",
781 "%s: Image barrier 0x%p references image %s of format %s that must have the depth and stencil "
782 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
783 func_name, static_cast<const void *>(img_barrier),
784 report_data->FormatHandle(img_barrier->image).c_str(),
785 string_VkFormat(image_create_info->format), aspect_mask);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700786 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700787 }
John Zulauff660ad62019-03-23 07:16:05 -0600788
789 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier->image);
790 if (img_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
791 // TODO: Set memory invalid which is in mem_tracker currently
792 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
793 // subresource.
794 } else if (subresource_map) {
795 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -0600796 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -0600797 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier->subresourceRange);
John Zulauf02a204c2019-04-23 18:52:11 -0600798 auto subres_callback = [this, img_barrier, cb_state, &layout_check, &subres_skip](
John Zulauff660ad62019-03-23 07:16:05 -0600799 const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
John Zulauf02a204c2019-04-23 18:52:11 -0600800 if (!layout_check.Check(subres, img_barrier->oldLayout, layout, initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600801 subres_skip =
802 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
803 HandleToUint64(cb_state->commandBuffer), "VUID-VkImageMemoryBarrier-oldLayout-01197",
804 "For image %s you cannot transition the layout of aspect=%d level=%d layer=%d from %s when the "
805 "%s layout is %s.",
806 report_data->FormatHandle(img_barrier->image).c_str(), subres.aspectMask, subres.mipLevel,
807 subres.arrayLayer, string_VkImageLayout(img_barrier->oldLayout), layout_check.message,
808 string_VkImageLayout(layout_check.layout));
809 }
810 return !subres_skip;
811 };
812 subresource_map->ForRange(normalized_isr, subres_callback);
813 skip |= subres_skip;
814 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700815 }
816 }
817 return skip;
818}
819
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600820bool CoreChecks::IsReleaseOp(CMD_BUFFER_STATE *cb_state, VkImageMemoryBarrier const *barrier) {
John Zulauf1b33d5a2018-03-24 19:52:19 -0600821 if (!IsTransferOp(barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700822
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -0700823 auto pool = GetCommandPoolNode(cb_state->createInfo.commandPool);
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700824 return pool && TempIsReleaseOp<VkImageMemoryBarrier, true>(pool, barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700825}
826
John Zulauf6b4aae82018-05-09 13:03:36 -0600827template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600828bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700829 const Barrier *barriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600830 using BarrierRecord = QFOTransferBarrier<Barrier>;
831 bool skip = false;
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -0700832 auto pool = GetCommandPoolNode(cb_state->createInfo.commandPool);
John Zulauf6b4aae82018-05-09 13:03:36 -0600833 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
834 const char *barrier_name = BarrierRecord::BarrierName();
835 const char *handle_name = BarrierRecord::HandleName();
836 const char *transfer_type = nullptr;
837 for (uint32_t b = 0; b < barrier_count; b++) {
838 if (!IsTransferOp(&barriers[b])) continue;
839 const BarrierRecord *barrier_record = nullptr;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700840 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) &&
841 !IsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600842 const auto found = barrier_sets.release.find(barriers[b]);
843 if (found != barrier_sets.release.cend()) {
844 barrier_record = &(*found);
845 transfer_type = "releasing";
846 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600847 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
848 !IsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600849 const auto found = barrier_sets.acquire.find(barriers[b]);
850 if (found != barrier_sets.acquire.cend()) {
851 barrier_record = &(*found);
852 transfer_type = "acquiring";
853 }
854 }
855 if (barrier_record != nullptr) {
Lockee9aeebf2019-03-03 23:50:08 -0700856 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
857 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInCB(),
858 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
859 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
860 func_name, barrier_name, b, transfer_type, handle_name,
861 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
862 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -0600863 }
864 }
865 return skip;
866}
867
868template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600869void CoreChecks::RecordQFOTransferBarriers(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count, const Barrier *barriers) {
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -0700870 auto pool = GetCommandPoolNode(cb_state->createInfo.commandPool);
John Zulauf6b4aae82018-05-09 13:03:36 -0600871 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
872 for (uint32_t b = 0; b < barrier_count; b++) {
873 if (!IsTransferOp(&barriers[b])) continue;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700874 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barriers[b]) &&
875 !IsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600876 barrier_sets.release.emplace(barriers[b]);
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600877 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
878 !IsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600879 barrier_sets.acquire.emplace(barriers[b]);
880 }
881 }
882}
883
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600884bool CoreChecks::ValidateBarriersQFOTransferUniqueness(const char *func_name, CMD_BUFFER_STATE *cb_state,
885 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700886 uint32_t imageMemBarrierCount,
887 const VkImageMemoryBarrier *pImageMemBarriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600888 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700889 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
890 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -0600891 return skip;
892}
893
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600894void CoreChecks::RecordBarriersQFOTransfers(CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700895 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
896 const VkImageMemoryBarrier *pImageMemBarriers) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700897 RecordQFOTransferBarriers(cb_state, bufferBarrierCount, pBufferMemBarriers);
898 RecordQFOTransferBarriers(cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -0600899}
900
901template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600902bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700903 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600904 // Record to the scoreboard or report that we have a duplication
905 bool skip = false;
906 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
907 if (!inserted.second && inserted.first->second != cb_state) {
908 // 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 -0700909 skip = log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
910 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
911 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
912 " duplicates existing barrier submitted in this batch from command buffer %s.",
913 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
914 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex, barrier.dstQueueFamilyIndex,
John Zulauf7eb94822019-04-05 09:38:46 -0600915 report_data->FormatHandle(inserted.first->second->commandBuffer).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -0600916 }
917 return skip;
918}
919
920template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600921bool CoreChecks::ValidateQueuedQFOTransferBarriers(CMD_BUFFER_STATE *cb_state, QFOTransferCBScoreboards<Barrier> *scoreboards) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600922 using BarrierRecord = QFOTransferBarrier<Barrier>;
923 using TypeTag = typename BarrierRecord::Tag;
924 bool skip = false;
John Zulauf6b4aae82018-05-09 13:03:36 -0600925 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -0700926 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -0600927 const char *barrier_name = BarrierRecord::BarrierName();
928 const char *handle_name = BarrierRecord::HandleName();
929 // No release should have an extant duplicate (WARNING)
930 for (const auto &release : cb_barriers.release) {
931 // Check the global pending release barriers
932 const auto set_it = global_release_barriers.find(release.handle);
933 if (set_it != global_release_barriers.cend()) {
934 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
935 const auto found = set_for_handle.find(release);
936 if (found != set_for_handle.cend()) {
937 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
938 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
Lockee9aeebf2019-03-03 23:50:08 -0700939 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
John Zulauf6b4aae82018-05-09 13:03:36 -0600940 " to dstQueueFamilyIndex %" PRIu32
941 " duplicates existing barrier queued for execution, without intervening acquire operation.",
Lockee9aeebf2019-03-03 23:50:08 -0700942 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
John Zulauf6b4aae82018-05-09 13:03:36 -0600943 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
944 }
945 }
946 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
947 }
948 // Each acquire must have a matching release (ERROR)
949 for (const auto &acquire : cb_barriers.acquire) {
950 const auto set_it = global_release_barriers.find(acquire.handle);
951 bool matching_release_found = false;
952 if (set_it != global_release_barriers.cend()) {
953 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
954 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
955 }
956 if (!matching_release_found) {
957 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
958 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
Lockee9aeebf2019-03-03 23:50:08 -0700959 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
960 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
961 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
John Zulauf6b4aae82018-05-09 13:03:36 -0600962 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
963 }
964 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
965 }
966 return skip;
967}
968
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600969bool CoreChecks::ValidateQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700970 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
971 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600972 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700973 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state, qfo_image_scoreboards);
974 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state, qfo_buffer_scoreboards);
John Zulauf6b4aae82018-05-09 13:03:36 -0600975 return skip;
976}
977
978template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600979void CoreChecks::RecordQueuedQFOTransferBarriers(CMD_BUFFER_STATE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600980 using BarrierRecord = QFOTransferBarrier<Barrier>;
981 using TypeTag = typename BarrierRecord::Tag;
982 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -0700983 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -0600984
985 // Add release barriers from this submit to the global map
986 for (const auto &release : cb_barriers.release) {
987 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
988 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
989 global_release_barriers[release.handle].insert(release);
990 }
991
992 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
993 for (const auto &acquire : cb_barriers.acquire) {
994 // NOTE: We're not using [] because we don't want to create entries for missing releases
995 auto set_it = global_release_barriers.find(acquire.handle);
996 if (set_it != global_release_barriers.end()) {
997 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
998 set_for_handle.erase(acquire);
999 if (set_for_handle.size() == 0) { // Clean up empty sets
1000 global_release_barriers.erase(set_it);
1001 }
1002 }
1003 }
1004}
1005
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001006void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001007 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state);
1008 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001009}
1010
John Zulauf6b4aae82018-05-09 13:03:36 -06001011// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001012void CoreChecks::EraseQFOImageRelaseBarriers(const VkImage &image) { EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image); }
John Zulauf6b4aae82018-05-09 13:03:36 -06001013
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001014void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001015 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001016 for (uint32_t i = 0; i < memBarrierCount; ++i) {
1017 auto mem_barrier = &pImgMemBarriers[i];
1018 if (!mem_barrier) continue;
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001019
Chris Forbes4de4b132017-08-21 11:27:08 -07001020 // For ownership transfers, the barrier is specified twice; as a release
1021 // operation on the yielding queue family, and as an acquire operation
1022 // on the acquiring queue family. This barrier may also include a layout
1023 // transition, which occurs 'between' the two operations. For validation
1024 // purposes it doesn't seem important which side performs the layout
1025 // transition, but it must not be performed twice. We'll arbitrarily
1026 // choose to perform it as part of the acquire operation.
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001027 if (IsReleaseOp(cb_state, mem_barrier)) {
Chris Forbes4de4b132017-08-21 11:27:08 -07001028 continue;
1029 }
1030
John Zulauff660ad62019-03-23 07:16:05 -06001031 auto *image_state = GetImageState(mem_barrier->image);
1032 if (!image_state) continue;
1033
1034 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier->subresourceRange);
1035 const auto &image_create_info = image_state->createInfo;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001036
Dave Houltonb3f4b282018-02-22 16:25:16 -07001037 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1038 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1039 // for all (potential) layer sub_resources.
John Zulauff660ad62019-03-23 07:16:05 -06001040 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
1041 normalized_isr.baseArrayLayer = 0;
1042 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
Dave Houltonb3f4b282018-02-22 16:25:16 -07001043 }
1044
John Zulauff660ad62019-03-23 07:16:05 -06001045 SetImageLayout(cb_state, *image_state, normalized_isr, mem_barrier->newLayout, mem_barrier->oldLayout);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001046 }
1047}
1048
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001049bool CoreChecks::VerifyImageLayout(CMD_BUFFER_STATE const *cb_node, IMAGE_STATE *image_state, const VkImageSubresourceRange &range,
John Zulaufabcc8292019-04-08 18:07:44 -06001050 VkImageAspectFlags aspect_mask, VkImageLayout explicit_layout, VkImageLayout optimal_layout,
1051 const char *caller, const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code,
1052 bool *error) {
John Zulauff660ad62019-03-23 07:16:05 -06001053 assert(cb_node);
1054 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001055 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001056 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001057
John Zulauff660ad62019-03-23 07:16:05 -06001058 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1059 if (subresource_map) {
1060 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001061 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
1062 auto subresource_cb = [this, explicit_layout, cb_node, layout_mismatch_msg_code, caller, image, &layout_check, &error,
John Zulaufabcc8292019-04-08 18:07:44 -06001063 &subres_skip](const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
John Zulauf02a204c2019-04-23 18:52:11 -06001064 if (!layout_check.Check(subres, explicit_layout, layout, initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001065 *error = true;
John Zulauff660ad62019-03-23 07:16:05 -06001066 subres_skip |=
1067 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1068 HandleToUint64(cb_node->commandBuffer), layout_mismatch_msg_code,
1069 "%s: Cannot use image %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1070 "%s layout %s.",
1071 caller, report_data->FormatHandle(image).c_str(), subres.arrayLayer, subres.mipLevel,
1072 string_VkImageLayout(explicit_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001073 }
John Zulauff660ad62019-03-23 07:16:05 -06001074 return !subres_skip;
1075 };
1076 subresource_map->ForRange(range, subresource_cb);
1077 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001078 }
John Zulauff660ad62019-03-23 07:16:05 -06001079
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001080 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1081 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1082 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001083 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1084 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001085 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001086 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_node->commandBuffer),
Dave Houlton51653902018-06-22 17:32:13 -06001087 kVUID_Core_DrawState_InvalidImageLayout,
Lockee9aeebf2019-03-03 23:50:08 -07001088 "%s: For optimal performance image %s layout should be %s instead of GENERAL.", caller,
1089 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001090 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001091 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001092 if (image_state->shared_presentable) {
1093 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
Cort Stratton7df30962018-05-17 19:45:57 -07001094 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1095 layout_invalid_msg_code,
1096 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1097 string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001098 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001099 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001100 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001101 *error = true;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001102 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 -07001103 HandleToUint64(cb_node->commandBuffer), layout_invalid_msg_code,
Lockee9aeebf2019-03-03 23:50:08 -07001104 "%s: Layout for image %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1105 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1106 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001107 }
1108 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001109 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001110}
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001111bool CoreChecks::VerifyImageLayout(CMD_BUFFER_STATE const *cb_node, IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001112 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1113 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
1114 const char *layout_mismatch_msg_code, bool *error) {
1115 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1116 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1117}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001118
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001119void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001120 FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinski2e495882019-03-06 16:11:56 -07001121 auto renderPass = GetRenderPassState(pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001122 if (!renderPass) return;
1123
Tobias Hectorbbb12282018-10-22 15:17:59 +01001124 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001125 if (framebuffer_state) {
1126 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07001127 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -06001128 if (view_state) {
John Zulauff660ad62019-03-23 07:16:05 -06001129 SetImageViewLayout(pCB, *view_state, pRenderPassInfo->pAttachments[i].finalLayout);
John Zulauf8e308292018-09-21 11:34:37 -06001130 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001131 }
1132 }
1133}
Dave Houltone19e20d2018-02-02 16:32:41 -07001134
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001135#ifdef VK_USE_PLATFORM_ANDROID_KHR
1136// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1137// This could also move into a seperate core_validation_android.cpp file... ?
1138
1139//
1140// AHB-specific validation within non-AHB APIs
1141//
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001142bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001143 bool skip = false;
1144
1145 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1146 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001147 if (0 != ext_fmt_android->externalFormat) {
1148 if (VK_FORMAT_UNDEFINED != create_info->format) {
1149 skip |=
1150 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1151 "VUID-VkImageCreateInfo-pNext-01974",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001152 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
Dave Houltond9611312018-11-19 17:03:36 -07001153 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
1154 }
1155
1156 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
1157 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1158 "VUID-VkImageCreateInfo-pNext-02396",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001159 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001160 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
1161 }
1162
1163 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
1164 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1165 "VUID-VkImageCreateInfo-pNext-02397",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001166 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001167 "non-zero externalFormat, but usage includes bits other than VK_IMAGE_USAGE_SAMPLED_BIT.");
1168 }
1169
1170 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
1171 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1172 "VUID-VkImageCreateInfo-pNext-02398",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001173 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001174 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
1175 }
1176 }
1177
Mark Lobodzinski1ee06e92019-04-19 14:03:53 -06001178 if ((0 != ext_fmt_android->externalFormat) && (0 == ahb_ext_formats_set.count(ext_fmt_android->externalFormat))) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001179 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1180 "VUID-VkExternalFormatANDROID-externalFormat-01894",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001181 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat which has "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001182 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().");
1183 }
1184 }
1185
Dave Houltond9611312018-11-19 17:03:36 -07001186 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001187 if (VK_FORMAT_UNDEFINED == create_info->format) {
1188 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1189 "VUID-VkImageCreateInfo-pNext-01975",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001190 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
Dave Houltond9611312018-11-19 17:03:36 -07001191 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
1192 }
1193 }
1194
1195 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1196 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1197 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001198 skip |=
1199 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1200 "VUID-VkImageCreateInfo-pNext-02393",
1201 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1202 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1203 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001204 }
1205
1206 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
1207 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1208 "VUID-VkImageCreateInfo-pNext-02394",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001209 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
Dave Houltond9611312018-11-19 17:03:36 -07001210 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1211 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1212 create_info->mipLevels, FullMipChainLevels(create_info->extent));
1213 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001214 }
1215
1216 return skip;
1217}
1218
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001219void CoreChecks::RecordCreateImageANDROID(const VkImageCreateInfo *create_info, IMAGE_STATE *is_node) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001220 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1221 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1222 is_node->imported_ahb = true;
1223 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001224 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
egdaniel1f4d2a42019-02-04 10:25:38 -05001225 if (ext_fmt_android && (0 != ext_fmt_android->externalFormat)) {
Dave Houltond3e046d2018-11-28 13:08:09 -07001226 is_node->has_ahb_format = true;
1227 is_node->ahb_format = ext_fmt_android->externalFormat;
1228 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001229}
1230
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001231bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001232 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001233 IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001234
1235 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001236 if (VK_FORMAT_UNDEFINED != create_info->format) {
1237 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1238 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02399",
1239 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1240 "format member is %s.",
1241 string_VkFormat(create_info->format));
1242 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001243
Dave Houltond9611312018-11-19 17:03:36 -07001244 // Chain must include a compatible ycbcr conversion
1245 bool conv_found = false;
1246 uint64_t external_format = 0;
1247 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1248 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001249 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001250 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001251 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001252 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001253 }
Dave Houltond9611312018-11-19 17:03:36 -07001254 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001255 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001256 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 -07001257 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02400",
1258 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1259 "without a chained VkSamplerYcbcrConversionInfo struct with the same external format.");
1260 }
1261
1262 // Errors in create_info swizzles
1263 if ((create_info->components.r != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1264 (create_info->components.g != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1265 (create_info->components.b != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1266 (create_info->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
1267 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1268 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02401",
1269 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1270 "includes one or more non-identity component swizzles.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001271 }
1272 }
Dave Houltond9611312018-11-19 17:03:36 -07001273
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001274 return skip;
1275}
1276
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001277bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001278 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001279
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001280 IMAGE_STATE *image_state = GetImageState(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001281 if (image_state->imported_ahb && (0 == image_state->GetBoundMemory().size())) {
1282 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
1283 "VUID-vkGetImageSubresourceLayout-image-01895",
Graeme Leese79b60cb2018-11-28 11:51:20 +00001284 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001285 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1286 "bound to memory.");
1287 }
1288 return skip;
1289}
1290
1291#else
1292
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001293bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001294 return false;
1295}
1296
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001297void CoreChecks::RecordCreateImageANDROID(const VkImageCreateInfo *create_info, IMAGE_STATE *is_node) {}
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001298
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001299bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001300
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001301bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001302
1303#endif // VK_USE_PLATFORM_ANDROID_KHR
1304
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001305bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1306 const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001307 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001308
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001309 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001310 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001311 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1312 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
1313 return log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1314 "VUID-VkImageCreateInfo-format-00943",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001315 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001316 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001317 }
1318
Dave Houlton130c0212018-01-29 13:39:56 -07001319 if ((pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) && (VK_IMAGE_TYPE_2D != pCreateInfo->imageType)) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001320 skip |= log_msg(
1321 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1322 "VUID-VkImageCreateInfo-flags-00949",
1323 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set");
Dave Houlton130c0212018-01-29 13:39:56 -07001324 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001325
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001326 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001327 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1328 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1329 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001330 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 +00001331 "VUID-VkImageCreateInfo-usage-00964",
1332 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1333 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001334 }
1335
1336 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001337 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 +00001338 "VUID-VkImageCreateInfo-usage-00965",
1339 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1340 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001341 }
1342
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001343 VkImageFormatProperties format_limits = {};
Mark Lobodzinski5c048802019-03-07 10:47:31 -07001344 VkResult res = GetPDImageFormatProperties(pCreateInfo, &format_limits);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001345 if (res == VK_ERROR_FORMAT_NOT_SUPPORTED) {
Lockee87f87c2019-04-23 17:53:10 -06001346#ifdef VK_USE_PLATFORM_ANDROID_KHR
1347 if (!lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext))
1348#endif // VK_USE_PLATFORM_ANDROID_KHR
1349 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1350 "vkCreateImage(): Format %s is not supported for this combination of parameters.",
1351 string_VkFormat(pCreateInfo->format));
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001352 } else {
1353 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1354 const char *format_string = string_VkFormat(pCreateInfo->format);
1355 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1356 "VUID-VkImageCreateInfo-mipLevels-02255",
1357 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1358 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
1359 }
Dave Houlton130c0212018-01-29 13:39:56 -07001360
Dave Houltona585d132019-01-18 13:05:42 -07001361 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1362 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1363 (uint64_t)pCreateInfo->samples;
1364 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * texel_count);
Dave Houlton130c0212018-01-29 13:39:56 -07001365
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001366 // Round up to imageGranularity boundary
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001367 VkDeviceSize imageGranularity = phys_dev_props.limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001368 uint64_t ig_mask = imageGranularity - 1;
1369 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001370
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001371 if (total_size > format_limits.maxResourceSize) {
1372 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1373 kVUID_Core_Image_InvalidFormatLimitsViolation,
1374 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1375 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1376 total_size, format_limits.maxResourceSize);
1377 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001378
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001379 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
1380 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1381 "VUID-VkImageCreateInfo-arrayLayers-02256",
1382 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1383 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
1384 }
1385
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001386 if (device_extensions.vk_khr_sampler_ycbcr_conversion && FormatRequiresYcbcrConversion(pCreateInfo->format) &&
1387 !device_extensions.vk_ext_ycbcr_image_arrays && pCreateInfo->arrayLayers > 1) {
Piers Daniell10a5c762019-03-11 12:44:50 -06001388 skip |= log_msg(
1389 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1390 "VUID-VkImageCreateInfo-format-02653",
1391 "vkCreateImage(): arrayLayers=%d exceeds the maximum allowed of 1 for formats requiring sampler ycbcr conversion",
1392 pCreateInfo->arrayLayers);
1393 }
1394
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001395 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
1396 skip |=
1397 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1398 "VUID-VkImageCreateInfo-samples-02258", "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001399 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001400 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001401 }
1402
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06001403 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001404 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 -06001405 "VUID-VkImageCreateInfo-flags-01924",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001406 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
1407 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06001408 }
1409
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001410 if (device_extensions.vk_khr_maintenance2) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06001411 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
1412 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
1413 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
1414 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001415 skip |=
1416 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1417 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1418 "format must be block, ETC or ASTC compressed, but is %s",
1419 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001420 }
1421 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
1422 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001423 skip |=
1424 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1425 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1426 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001427 }
1428 }
1429 }
1430
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001431 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001432 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateImage",
1433 "pCreateInfo->pQueueFamilyIndices", "VUID-VkImageCreateInfo-sharingMode-01420",
1434 "VUID-VkImageCreateInfo-sharingMode-01420", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001435 }
1436
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001437 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001438}
1439
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001440void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1441 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07001442 if (VK_SUCCESS != result) return;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001443 IMAGE_LAYOUT_NODE image_state;
1444 image_state.layout = pCreateInfo->initialLayout;
1445 image_state.format = pCreateInfo->format;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001446 IMAGE_STATE *is_node = new IMAGE_STATE(*pImage, pCreateInfo);
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001447 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001448 RecordCreateImageANDROID(pCreateInfo, is_node);
1449 }
Mark Lobodzinski34e04bf2019-04-19 13:31:53 -06001450 imageMap.insert(std::make_pair(*pImage, std::unique_ptr<IMAGE_STATE>(is_node)));
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001451 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001452 imageSubresourceMap[*pImage].push_back(subpair);
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -06001453 imageLayoutMap[subpair] = image_state;
1454 imageLayoutMap[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001455}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001456
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001457bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001458 IMAGE_STATE *image_state = GetImageState(image);
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001459 const VK_OBJECT obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001460 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001461 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001462 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001463 }
1464 return skip;
1465}
1466
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001467void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidfa64112019-03-04 12:17:24 -07001468 if (!image) return;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001469 IMAGE_STATE *image_state = GetImageState(image);
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001470 VK_OBJECT obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001471 InvalidateCommandBuffers(image_state->cb_bindings, obj_struct);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001472 // Clean up memory mapping, bindings and range references for image
1473 for (auto mem_binding : image_state->GetBoundMemory()) {
Mark Lobodzinski97f83f72019-03-07 10:01:52 -07001474 auto mem_info = GetMemObjInfo(mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001475 if (mem_info) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001476 RemoveImageMemoryRange(obj_struct.handle, mem_info);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001477 }
1478 }
Mark Lobodzinski97f83f72019-03-07 10:01:52 -07001479 ClearMemoryObjectBindings(obj_struct.handle, kVulkanObjectTypeImage);
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001480 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001481 // Remove image from imageMap
Mark Lobodzinski34e04bf2019-04-19 13:31:53 -06001482 imageMap.erase(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001483
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001484 const auto &sub_entry = imageSubresourceMap.find(image);
1485 if (sub_entry != imageSubresourceMap.end()) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001486 for (const auto &pair : sub_entry->second) {
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -06001487 imageLayoutMap.erase(pair);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001488 }
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001489 imageSubresourceMap.erase(sub_entry);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001490 }
1491}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001492
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001493bool CoreChecks::ValidateImageAttributes(IMAGE_STATE *image_state, VkImageSubresourceRange range) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001494 bool skip = false;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001495
1496 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
1497 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
1498 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 -06001499 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001500 }
1501
Dave Houlton1d2022c2017-03-29 11:43:58 -06001502 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001503 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
1504 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 -06001505 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -06001506 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001507 char const str[] = "vkCmdClearColorImage called with compressed image.";
1508 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 -06001509 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001510 }
1511
1512 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
1513 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
1514 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 -06001515 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00002", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001516 }
1517 return skip;
1518}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001519
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001520uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1521 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1522 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001523 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001524 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001525 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001526 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001527}
1528
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001529uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1530 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1531 uint32_t array_layer_count = range->layerCount;
1532 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1533 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001534 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001535 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001536}
1537
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001538bool CoreChecks::VerifyClearImageLayout(CMD_BUFFER_STATE *cb_node, IMAGE_STATE *image_state, VkImageSubresourceRange range,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001539 VkImageLayout dest_image_layout, const char *func_name) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001540 bool skip = false;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001541
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001542 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
1543 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001544 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1545 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001546 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 -06001547 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001548 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
1549 }
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001550 } else if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR == dest_image_layout) {
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001551 if (!device_extensions.vk_khr_shared_presentable_image) {
Tobin Ehlisfb0661c2017-05-11 08:52:51 -06001552 // TODO: Add unique error id when available.
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001553 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 -06001554 HandleToUint64(image_state->image), 0,
Dave Houlton33c2d252017-06-09 17:08:32 -06001555 "Must enable VK_KHR_shared_presentable_image extension before creating images with a layout type "
1556 "of VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.");
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001557
1558 } else {
1559 if (image_state->shared_presentable) {
1560 skip |= log_msg(
1561 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001562 HandleToUint64(image_state->image), 0,
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001563 "Layout for shared presentable cleared image is %s but can only be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1564 string_VkImageLayout(dest_image_layout));
1565 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001566 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001567 } else {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06001568 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00005";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001569 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001570 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00012";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001571 } else {
1572 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1573 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001574 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 -06001575 HandleToUint64(image_state->image), error_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001576 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1577 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001578 }
1579 }
1580
John Zulauff660ad62019-03-23 07:16:05 -06001581 // Cast to const to prevent creation at validate time.
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001582 const auto *subresource_map = GetImageSubresourceLayoutMap(static_cast<const CMD_BUFFER_STATE *>(cb_node), image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06001583 if (subresource_map) {
1584 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001585 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06001586 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
John Zulauf02a204c2019-04-23 18:52:11 -06001587 auto subres_callback = [this, cb_node, dest_image_layout, func_name, &layout_check, &subres_skip](
John Zulauff660ad62019-03-23 07:16:05 -06001588 const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
John Zulauf02a204c2019-04-23 18:52:11 -06001589 if (!layout_check.Check(subres, dest_image_layout, layout, initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06001590 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
1591 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1592 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
1593 } else {
1594 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001595 }
John Zulauff660ad62019-03-23 07:16:05 -06001596 subres_skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1597 HandleToUint64(cb_node->commandBuffer), error_code,
1598 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
1599 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
1600 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001601 }
John Zulauff660ad62019-03-23 07:16:05 -06001602 return !subres_skip;
1603 };
1604 subresource_map->ForRange(normalized_isr, subres_callback);
1605 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001606 }
1607
1608 return skip;
1609}
1610
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001611bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1612 const VkClearColorValue *pColor, uint32_t rangeCount,
1613 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001614 bool skip = false;
1615 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07001616 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001617 auto image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001618 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001619 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001620 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001621 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001622 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski544def72019-04-19 14:25:59 -06001623 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001624 skip |=
1625 ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
1626 "VUID-vkCmdClearColorImage-image-01993", "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001627 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001628 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001629 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001630 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001631 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001632 skip |= ValidateImageAttributes(image_state, pRanges[i]);
1633 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001634 }
1635 }
1636 return skip;
1637}
1638
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001639void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1640 const VkClearColorValue *pColor, uint32_t rangeCount,
1641 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07001642 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001643 auto image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001644 if (cb_node && image_state) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001645 AddCommandBufferBindingImage(cb_node, image_state);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001646 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001647 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001648 }
1649 }
1650}
1651
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001652bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1653 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1654 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001655 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001656
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001657 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07001658 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001659 auto image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001660 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001661 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06001662 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001663 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001664 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001665 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski544def72019-04-19 14:25:59 -06001666 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001667 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
1668 "VUID-vkCmdClearDepthStencilImage-image-01994",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001669 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001670 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001671 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001672 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001673 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001674 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001675 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001676 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001677 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1678 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001679 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001680 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1681 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001682 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 -06001683 HandleToUint64(commandBuffer), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001684 }
1685 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001686 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001687 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001688 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 -06001689 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00014", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001690 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001691 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1692 char const str[] =
1693 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1694 "set.";
1695 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 -06001696 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00009", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001697 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001698 }
1699 return skip;
1700}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001701
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001702void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1703 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1704 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07001705 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001706 auto image_state = GetImageState(image);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001707 if (cb_node && image_state) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001708 AddCommandBufferBindingImage(cb_node, image_state);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001709 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001710 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001711 }
1712 }
1713}
1714
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001715// Returns true if [x, xoffset] and [y, yoffset] overlap
1716static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1717 bool result = false;
1718 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1719 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1720
1721 if (intersection_max > intersection_min) {
1722 result = true;
1723 }
1724 return result;
1725}
1726
Dave Houltonc991cc92018-03-06 11:08:51 -07001727// Returns true if source area of first copy region intersects dest area of second region
1728// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1729static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001730 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001731
Dave Houltonc991cc92018-03-06 11:08:51 -07001732 // Separate planes within a multiplane image cannot intersect
1733 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07001734 return result;
1735 }
1736
Dave Houltonc991cc92018-03-06 11:08:51 -07001737 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
1738 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
1739 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001740 result = true;
1741 switch (type) {
1742 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001743 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001744 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001745 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001746 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001747 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001748 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001749 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001750 break;
1751 default:
1752 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1753 assert(false);
1754 }
1755 }
1756 return result;
1757}
1758
Dave Houltonfc1a4052017-04-27 14:32:45 -06001759// Returns non-zero if offset and extent exceed image extents
1760static const uint32_t x_bit = 1;
1761static const uint32_t y_bit = 2;
1762static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001763static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001764 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001765 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001766 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1767 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001768 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001769 }
1770 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1771 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001772 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001773 }
1774 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1775 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001776 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001777 }
1778 return result;
1779}
1780
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001781// Test if two VkExtent3D structs are equivalent
1782static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1783 bool result = true;
1784 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1785 (extent->depth != other_extent->depth)) {
1786 result = false;
1787 }
1788 return result;
1789}
1790
Dave Houltonee281a52017-12-08 13:51:02 -07001791// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1792// Destination image texel extents must be adjusted by block size for the dest validation checks
1793VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1794 VkExtent3D adjusted_extent = extent;
1795 if ((FormatIsCompressed(src_format) && (!FormatIsCompressed(dst_format)))) {
Dave Houltona585d132019-01-18 13:05:42 -07001796 VkExtent3D block_size = FormatTexelBlockExtent(src_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001797 adjusted_extent.width /= block_size.width;
1798 adjusted_extent.height /= block_size.height;
1799 adjusted_extent.depth /= block_size.depth;
1800 } else if ((!FormatIsCompressed(src_format) && (FormatIsCompressed(dst_format)))) {
Dave Houltona585d132019-01-18 13:05:42 -07001801 VkExtent3D block_size = FormatTexelBlockExtent(dst_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001802 adjusted_extent.width *= block_size.width;
1803 adjusted_extent.height *= block_size.height;
1804 adjusted_extent.depth *= block_size.depth;
1805 }
1806 return adjusted_extent;
1807}
1808
Dave Houlton6f9059e2017-05-02 17:15:13 -06001809// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001810static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1811 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001812
1813 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06001814 if (mip >= img->createInfo.mipLevels) {
1815 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06001816 }
Dave Houlton1150cf52017-04-27 14:38:11 -06001817
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001818 // 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 -06001819 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05001820
Dave Houltone48cd112019-01-03 17:01:18 -07001821 // If multi-plane, adjust per-plane extent
1822 if (FormatIsMultiplane(img->createInfo.format)) {
1823 VkExtent2D divisors = FindMultiplaneExtentDivisors(img->createInfo.format, subresource->aspectMask);
1824 extent.width /= divisors.width;
1825 extent.height /= divisors.height;
1826 }
1827
Jeff Bolzef40fec2018-09-01 22:04:34 -05001828 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
1829 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
Dave Houlton142c4cb2018-10-17 15:04:41 -06001830 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1) >> mip)));
Jeff Bolzef40fec2018-09-01 22:04:34 -05001831 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
1832 } else {
1833 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1834 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1835 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
1836 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06001837
Dave Houlton6f9059e2017-05-02 17:15:13 -06001838 // Image arrays have an effective z extent that isn't diminished by mip level
1839 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001840 extent.depth = img->createInfo.arrayLayers;
1841 }
1842
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001843 return extent;
1844}
1845
1846// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001847static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001848 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1849}
1850
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001851// Test if the extent argument has any dimensions set to 0.
1852static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1853 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1854}
1855
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001856// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001857VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001858 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1859 VkExtent3D granularity = {0, 0, 0};
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -07001860 auto pPool = GetCommandPoolNode(cb_node->createInfo.commandPool);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001861 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001862 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001863 if (FormatIsCompressed(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07001864 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001865 granularity.width *= block_size.width;
1866 granularity.height *= block_size.height;
1867 }
1868 }
1869 return granularity;
1870}
1871
1872// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1873static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1874 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001875 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
1876 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001877 valid = false;
1878 }
1879 return valid;
1880}
1881
1882// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001883bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001884 const uint32_t i, const char *function, const char *member, const char *vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001885 bool skip = false;
1886 VkExtent3D offset_extent = {};
1887 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1888 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1889 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001890 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001891 // 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 -07001892 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001893 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 -04001894 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001895 "%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 "
1896 "image transfer granularity is (w=0, h=0, d=0).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001897 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001898 }
1899 } else {
1900 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1901 // integer multiples of the image transfer granularity.
1902 if (IsExtentAligned(&offset_extent, granularity) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001903 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 -04001904 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001905 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
1906 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001907 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
1908 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001909 }
1910 }
1911 return skip;
1912}
1913
1914// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001915bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001916 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
1917 const uint32_t i, const char *function, const char *member, const char *vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001918 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001919 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001920 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
1921 // subresource extent.
1922 if (IsExtentEqual(extent, subresource_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001923 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 -04001924 HandleToUint64(cb_node->commandBuffer), vuid,
Petr Krausbc7f5442017-05-14 23:43:38 +02001925 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
1926 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1927 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
1928 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001929 }
1930 } else {
1931 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
1932 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
1933 // subresource extent dimensions.
1934 VkExtent3D offset_extent_sum = {};
1935 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
1936 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
1937 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001938 bool x_ok = true;
1939 bool y_ok = true;
1940 bool z_ok = true;
1941 switch (image_type) {
1942 case VK_IMAGE_TYPE_3D:
1943 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
1944 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001945 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001946 case VK_IMAGE_TYPE_2D:
1947 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
1948 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001949 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001950 case VK_IMAGE_TYPE_1D:
1951 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
1952 (subresource_extent->width == offset_extent_sum.width));
1953 break;
1954 default:
1955 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1956 assert(false);
1957 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06001958 if (!(x_ok && y_ok && z_ok)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001959 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 -04001960 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001961 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
1962 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
1963 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
1964 function, i, member, extent->width, extent->height, extent->depth, granularity->width,
1965 granularity->height, granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height,
1966 extent->depth, subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001967 }
1968 }
1969 return skip;
1970}
1971
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001972bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
1973 const uint32_t i, const char *function, const char *member, const char *vuid) {
Cort Strattonff1542a2018-05-27 10:49:28 -07001974 bool skip = false;
1975 if (mip_level >= img->createInfo.mipLevels) {
1976 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1977 HandleToUint64(cb_node->commandBuffer), vuid,
Lockee9aeebf2019-03-03 23:50:08 -07001978 "In %s, pRegions[%u].%s.mipLevel is %u, but provided image %s has %u mip levels.", function, i, member,
1979 mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07001980 }
1981 return skip;
1982}
1983
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001984bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001985 const uint32_t layer_count, const uint32_t i, const char *function,
1986 const char *member, const char *vuid) {
Cort Strattonff1542a2018-05-27 10:49:28 -07001987 bool skip = false;
1988 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
1989 (base_layer + layer_count) > img->createInfo.arrayLayers) {
1990 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1991 HandleToUint64(cb_node->commandBuffer), vuid,
1992 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
Lockee9aeebf2019-03-03 23:50:08 -07001993 "%u, but provided image %s has %u array layers.",
1994 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
1995 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07001996 }
1997 return skip;
1998}
1999
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002000// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002001bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002002 const VkBufferImageCopy *region, const uint32_t i,
2003 const char *function, const char *vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002004 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002005 VkExtent3D granularity = GetScaledItg(cb_node, img);
2006 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002007 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002008 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002009 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002010 return skip;
2011}
2012
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002013// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002014bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002015 const IMAGE_STATE *dst_img, const VkImageCopy *region,
2016 const uint32_t i, const char *function) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002017 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002018 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002019 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
2020 skip |=
2021 CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002022 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002023 const VkExtent3D extent = region->extent;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002024 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
2025 i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002026
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002027 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002028 granularity = GetScaledItg(cb_node, dst_img);
2029 skip |=
2030 CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002031 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002032 const VkExtent3D dest_effective_extent =
2033 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002034 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002035 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002036 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002037 return skip;
2038}
2039
Dave Houlton6f9059e2017-05-02 17:15:13 -06002040// Validate contents of a VkImageCopy struct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002041bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const VkImageCopy *ic_regions, const IMAGE_STATE *src_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002042 const IMAGE_STATE *dst_state) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002043 bool skip = false;
2044
2045 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002046 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002047
2048 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002049 const VkExtent3D src_copy_extent = region.extent;
2050 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002051 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2052
Dave Houlton6f9059e2017-05-02 17:15:13 -06002053 bool slice_override = false;
2054 uint32_t depth_slices = 0;
2055
2056 // Special case for copying between a 1D/2D array and a 3D image
2057 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2058 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002059 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002060 slice_override = (depth_slices != 1);
2061 } 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 -07002062 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002063 slice_override = (depth_slices != 1);
2064 }
2065
2066 // Do all checks on source image
2067 //
2068 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002069 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
2070 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 -06002071 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00146",
Dave Houltonee281a52017-12-08 13:51:02 -07002072 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002073 "be 0 and 1, respectively.",
2074 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002075 }
2076 }
2077
Dave Houlton533be9f2018-03-26 17:08:30 -06002078 // VUID-VkImageCopy-srcImage-01785
2079 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
2080 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 -06002081 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01785",
Dave Houlton533be9f2018-03-26 17:08:30 -06002082 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002083 "these must be 0 and 1, respectively.",
2084 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002085 }
2086
Dave Houlton533be9f2018-03-26 17:08:30 -06002087 // VUID-VkImageCopy-srcImage-01787
2088 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
2089 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 -06002090 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01787",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002091 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2092 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002093 }
2094
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002095 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002096 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002097 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002098 skip |=
2099 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002100 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002101 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002102 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2103 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002104 }
2105 }
2106 } else { // Pre maint 1
2107 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002108 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002109 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 -06002110 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002111 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2112 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002113 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2114 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002115 }
2116 }
2117 }
2118
Dave Houltonc991cc92018-03-06 11:08:51 -07002119 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002120 bool ext_ycbcr = device_extensions.vk_khr_sampler_ycbcr_conversion;
Dave Houltonc991cc92018-03-06 11:08:51 -07002121 if (FormatIsCompressed(src_state->createInfo.format) ||
2122 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002123 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002124 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002125 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2126 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2127 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002128 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002129 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 -07002130 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002131 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002132 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002133 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002134 }
2135
Dave Houlton94a00372017-12-14 15:08:47 -07002136 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002137 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2138 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002139 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002140 skip |=
2141 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002142 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002143 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002144 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002145 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002146 }
2147
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002148 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002149 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2150 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002151 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002152 skip |=
2153 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002154 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002155 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002156 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002157 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002158 }
2159
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002160 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002161 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2162 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002163 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002164 skip |=
2165 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002166 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002167 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002168 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002169 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002170 }
2171 } // Compressed
2172
2173 // Do all checks on dest image
2174 //
2175 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002176 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002177 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 -06002178 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-00152",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002179 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002180 "these must be 0 and 1, respectively.",
2181 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002182 }
2183 }
2184
Dave Houlton533be9f2018-03-26 17:08:30 -06002185 // VUID-VkImageCopy-dstImage-01786
2186 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
2187 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 -06002188 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01786",
Dave Houlton533be9f2018-03-26 17:08:30 -06002189 "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 -06002190 "and 1, respectively.",
2191 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002192 }
2193
2194 // VUID-VkImageCopy-dstImage-01788
2195 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
2196 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 -06002197 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01788",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002198 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2199 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002200 }
2201
2202 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002203 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002204 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 -06002205 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002206 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002207 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2208 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002209 }
2210 }
2211 // VU01199 changed with mnt1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002212 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002213 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002214 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002215 skip |=
2216 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002217 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002218 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002219 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2220 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002221 }
2222 }
2223 } else { // Pre maint 1
2224 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002225 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002226 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 -06002227 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002228 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2229 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002230 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2231 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002232 }
2233 }
2234 }
2235
Dave Houltonc991cc92018-03-06 11:08:51 -07002236 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2237 if (FormatIsCompressed(dst_state->createInfo.format) ||
2238 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002239 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002240
2241 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002242 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2243 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2244 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002245 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002246 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 -07002247 HandleToUint64(dst_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002248 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002249 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002250 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002251 }
2252
Dave Houlton94a00372017-12-14 15:08:47 -07002253 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002254 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2255 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002256 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002257 skip |=
2258 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002259 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002260 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002261 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002262 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002263 }
2264
Dave Houltonee281a52017-12-08 13:51:02 -07002265 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2266 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2267 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002268 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002269 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 -07002270 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002271 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2272 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
Dave Houltonc991cc92018-03-06 11:08:51 -07002273 "height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002274 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002275 }
2276
Dave Houltonee281a52017-12-08 13:51:02 -07002277 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2278 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2279 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002280 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002281 skip |=
2282 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002283 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002284 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002285 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002286 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002287 }
2288 } // Compressed
2289 }
2290 return skip;
2291}
2292
Dave Houltonc991cc92018-03-06 11:08:51 -07002293// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002294bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
2295 const IMAGE_STATE *dst_image_state, const VkImageCopy region) {
Dave Houltonc991cc92018-03-06 11:08:51 -07002296 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002297
2298 // Neither image is multiplane
2299 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2300 // If neither image is multi-plane the aspectMask member of src and dst must match
2301 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2302 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002303 ss << "vkCmdCopyImage(): Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002304 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
2305 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 -06002306 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002307 }
2308 } else {
2309 // Source image multiplane checks
2310 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2311 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2312 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2313 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002314 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002315 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 -06002316 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002317 }
2318 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2319 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2320 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002321 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002322 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 -06002323 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002324 }
2325 // Single-plane to multi-plane
2326 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2327 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2328 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002329 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002330 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 -06002331 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002332 }
2333
2334 // Dest image multiplane checks
2335 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2336 aspect = region.dstSubresource.aspectMask;
2337 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2338 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002339 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002340 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 -06002341 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002342 }
2343 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2344 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2345 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002346 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002347 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 -06002348 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002349 }
2350 // Multi-plane to single-plane
2351 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2352 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2353 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002354 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002355 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 -06002356 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002357 }
2358 }
2359
2360 return skip;
2361}
2362
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002363bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2364 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2365 const VkImageCopy *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002366 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002367 auto src_image_state = GetImageState(srcImage);
2368 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002369 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002370
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002371 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002372
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002373 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2374
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002375 for (uint32_t i = 0; i < regionCount; i++) {
2376 const VkImageCopy region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002377
2378 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2379 VkExtent3D src_copy_extent = region.extent;
2380 VkExtent3D dst_copy_extent =
2381 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
2382
Dave Houlton6f9059e2017-05-02 17:15:13 -06002383 bool slice_override = false;
2384 uint32_t depth_slices = 0;
2385
2386 // Special case for copying between a 1D/2D array and a 3D image
2387 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2388 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2389 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002390 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002391 slice_override = (depth_slices != 1);
2392 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2393 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002394 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002395 slice_override = (depth_slices != 1);
2396 }
2397
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002398 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2399 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
2400 skip |= ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002401 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002402 skip |= ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002403 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002404 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002405 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2406 "VUID-vkCmdCopyImage-srcSubresource-01698");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002407 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002408 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2409 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002410
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002411 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002412 // No chance of mismatch if we're overriding depth slice count
2413 if (!slice_override) {
2414 // The number of depth slices in srcSubresource and dstSubresource must match
2415 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2416 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002417 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2418 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002419 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002420 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2421 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002422 if (src_slices != dst_slices) {
2423 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002424 ss << "vkCmdCopyImage(): number of depth slices in source and destination subresources for pRegions[" << i
Dave Houlton6f9059e2017-05-02 17:15:13 -06002425 << "] do not match";
2426 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 -06002427 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06002428 }
2429 }
2430 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002431 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002432 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002433 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002434 ss << "vkCmdCopyImage(): number of layers in source and destination subresources for pRegions[" << i
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002435 << "] do not match";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002436 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 -06002437 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002438 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002439 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002440
Dave Houltonc991cc92018-03-06 11:08:51 -07002441 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002442 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002443 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region);
Dave Houltonc991cc92018-03-06 11:08:51 -07002444 }
2445
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002446 if (!device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002447 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2448 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002449 char const str[] = "vkCmdCopyImage(): Src and dest aspectMasks for each region must match";
Dave Houltonf5217612018-02-02 16:18:52 -07002450 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 -06002451 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002452 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002453 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002454
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002455 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07002456 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002457 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002458 ss << "vkCmdCopyImage(): pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002459 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
2460 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 -06002461 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002462 }
2463
2464 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07002465 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002466 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002467 ss << "vkCmdCopyImage(): pRegion[" << i
2468 << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002469 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 -06002470 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002471 }
2472
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002473 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
2474 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
2475 // 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 -07002476 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2477 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002478 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002479 ss << "vkCmdCopyImage(): Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002480 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
2481 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
2482 << " ] exceeds the source image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002483 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 -06002484 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00122", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002485 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002486
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002487 // 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 -07002488 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2489 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002490 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002491 ss << "vkCmdCopyImage(): Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002492 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
2493 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
2494 << " ] exceeds the destination image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002495 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 -06002496 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00123", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002497 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002498 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002499
Dave Houltonfc1a4052017-04-27 14:32:45 -06002500 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002501 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2502 if (slice_override) src_copy_extent.depth = depth_slices;
2503 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002504 if (extent_check & x_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002505 skip |=
2506 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2507 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00144",
2508 "vkCmdCopyImage(): Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2509 "width [%1d].",
2510 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002511 }
2512
2513 if (extent_check & y_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002514 skip |=
2515 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2516 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00145",
2517 "vkCmdCopyImage(): Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2518 "height [%1d].",
2519 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002520 }
2521 if (extent_check & z_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002522 skip |=
2523 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2524 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00147",
2525 "vkCmdCopyImage(): Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2526 "depth [%1d].",
2527 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002528 }
2529
Dave Houltonee281a52017-12-08 13:51:02 -07002530 // Adjust dest extent if necessary
2531 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2532 if (slice_override) dst_copy_extent.depth = depth_slices;
2533
2534 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002535 if (extent_check & x_bit) {
2536 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 -06002537 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00150",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002538 "vkCmdCopyImage(): Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002539 "width [%1d].",
2540 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002541 }
2542 if (extent_check & y_bit) {
2543 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 -06002544 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00151",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002545 "vkCmdCopyImage(): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002546 "height [%1d].",
2547 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002548 }
2549 if (extent_check & z_bit) {
2550 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 -06002551 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00153",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002552 "vkCmdCopyImage(): Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002553 "depth [%1d].",
2554 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002555 }
2556
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002557 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2558 // must not overlap in memory
2559 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002560 for (uint32_t j = 0; j < regionCount; j++) {
2561 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
Dave Houltonf5217612018-02-02 16:18:52 -07002562 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002563 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002564 ss << "vkCmdCopyImage(): pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002565 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 -06002566 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002567 }
2568 }
2569 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002570 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002571
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002572 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2573 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2574 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002575 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002576 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2577 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02002578 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 -06002579 HandleToUint64(command_buffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002580 }
2581 } else {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002582 if (!FormatSizesAreEqual(src_image_state->createInfo.format, dst_image_state->createInfo.format, regionCount, pRegions)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002583 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
2584 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002585 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00135", "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002586 }
2587 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002588
Dave Houlton33c22b72017-02-28 13:16:02 -07002589 // Source and dest image sample counts must match
2590 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2591 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
2592 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 -06002593 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002594 }
2595
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002596 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2597 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002598 // Validate that SRC & DST images have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002599 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyImage-srcImage-00126",
2600 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2601 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyImage-dstImage-00131",
2602 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06002603 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002604 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
2605 "VUID-vkCmdCopyImage-srcImage-01995", "VUID-vkCmdCopyImage-srcImage-01995");
2606 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
2607 "VUID-vkCmdCopyImage-dstImage-01996", "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002608 }
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002609 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyImage()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002610 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002611 skip |= ValidateCmd(cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
2612 skip |= InsideRenderPass(cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002613 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002614 const char *invalid_src_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2615 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2616 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
2617 const char *invalid_dst_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2618 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2619 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002620 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002621 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002622 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2623 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002624 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002625 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2626 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002627 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
2628 "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002629 }
2630
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002631 return skip;
2632}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002633
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002634void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2635 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2636 const VkImageCopy *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002637 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002638 auto src_image_state = GetImageState(srcImage);
2639 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002640
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002641 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002642 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002643 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
2644 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002645 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002646 // Update bindings between images and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002647 AddCommandBufferBindingImage(cb_node, src_image_state);
2648 AddCommandBufferBindingImage(cb_node, dst_image_state);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002649}
2650
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002651// Returns true if sub_rect is entirely contained within rect
2652static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2653 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2654 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2655 return false;
2656 return true;
2657}
2658
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002659bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002660 FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment, const VkRect2D &render_area,
2661 uint32_t rect_count, const VkClearRect *clear_rects) {
John Zulauf3a548ef2019-02-01 16:14:07 -07002662 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07002663 const IMAGE_VIEW_STATE *image_view_state = nullptr;
2664 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07002665 image_view_state = GetImageViewState(framebuffer->createInfo.pAttachments[fb_attachment]);
John Zulauff2582972019-02-09 14:53:30 -07002666 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002667
2668 for (uint32_t j = 0; j < rect_count; j++) {
2669 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002670 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 -07002671 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00016",
2672 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2673 "the current render pass instance.",
2674 j);
2675 }
2676
2677 if (image_view_state) {
2678 // The layers specified by a given element of pRects must be contained within every attachment that
2679 // pAttachments refers to
2680 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
2681 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
2682 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002683 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2684 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00017",
2685 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
2686 "of pAttachment[%d].",
2687 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07002688 }
2689 }
2690 }
2691 return skip;
2692}
2693
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002694bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2695 const VkClearAttachment *pAttachments, uint32_t rectCount,
2696 const VkClearRect *pRects) {
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002697 CMD_BUFFER_STATE *cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002698
2699 bool skip = false;
2700 if (cb_node) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002701 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002702 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002703 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002704 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
Chris Forbes05375e72017-04-21 13:15:15 -07002705 if (!cb_node->hasDrawCmd && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002706 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
2707 // 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 -07002708 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
2709 // CmdClearAttachments.
Lockee9aeebf2019-03-03 23:50:08 -07002710 skip |=
2711 log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2712 HandleToUint64(commandBuffer), kVUID_Core_DrawState_ClearCmdBeforeDraw,
2713 "vkCmdClearAttachments() issued on command buffer object %s prior to any Draw Cmds. It is recommended you "
2714 "use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
2715 report_data->FormatHandle(commandBuffer).c_str());
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002716 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002717 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002718 }
2719
2720 // Validate that attachment is in reference list of active subpass
2721 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002722 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07002723 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01002724 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
Mark Lobodzinski74772ca2019-03-06 16:15:06 -07002725 auto framebuffer = GetFramebufferState(cb_node->activeFramebuffer);
John Zulauf3a548ef2019-02-01 16:14:07 -07002726 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
2727 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002728
John Zulauf3a548ef2019-02-01 16:14:07 -07002729 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2730 auto clear_desc = &pAttachments[attachment_index];
2731 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002732
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002733 if (0 == clear_desc->aspectMask) {
2734 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 -06002735 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002736 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2737 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 -06002738 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002739 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07002740 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
2741 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
2742 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2743 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Lockee9aeebf2019-03-03 23:50:08 -07002744 skip |= log_msg(
2745 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2746 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
2747 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
2748 "and not a valid attachment for render pass %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
2749 attachment_index, clear_desc->colorAttachment,
2750 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
2751 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
2752
John Zulauff2582972019-02-09 14:53:30 -07002753 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
2754 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002755 } else {
Lockee9aeebf2019-03-03 23:50:08 -07002756 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2757 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
2758 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for render pass %s"
2759 " subpass %u. colorAttachmentCount=%u",
2760 attachment_index, clear_desc->colorAttachment,
2761 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
2762 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002763 }
John Zulauff2582972019-02-09 14:53:30 -07002764 fb_attachment = color_attachment;
2765
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002766 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2767 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2768 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002769 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
John Zulauf3a548ef2019-02-01 16:14:07 -07002770 skip |=
2771 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2772 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002773 }
2774 } else { // Must be depth and/or stencil
2775 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2776 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002777 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002778 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 -07002779 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-parameter", str,
2780 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002781 }
2782 if (!subpass_desc->pDepthStencilAttachment ||
2783 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
2784 skip |= log_msg(
2785 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002786 HandleToUint64(commandBuffer), kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002787 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002788 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07002789 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002790 }
2791 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002792 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002793 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
2794 rectCount, pRects);
John Zulauf3a548ef2019-02-01 16:14:07 -07002795 } else {
2796 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
2797 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
2798 if (!clear_rect_copy) {
2799 // We need a copy of the clear rectangles that will persist until the last lambda executes
2800 // but we want to create it as lazily as possible
2801 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002802 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002803
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002804 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002805 CMD_BUFFER_STATE *prim_cb, VkFramebuffer fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07002806 assert(rectCount == clear_rect_copy->size());
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002807 FRAMEBUFFER_STATE *framebuffer = GetFramebufferState(fb);
John Zulauf3a548ef2019-02-01 16:14:07 -07002808 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
2809 bool skip = false;
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002810 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
2811 rectCount, clear_rect_copy->data());
John Zulauf3a548ef2019-02-01 16:14:07 -07002812 return skip;
2813 };
2814 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002815 }
2816 }
2817 }
2818 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002819}
2820
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002821bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2822 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2823 const VkImageResolve *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002824 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002825 auto src_image_state = GetImageState(srcImage);
2826 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002827
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002828 bool skip = false;
2829 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002830 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-srcImage-00256");
2831 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-00258");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002832 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002833 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002834 skip |= ValidateCmd(cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
2835 skip |= InsideRenderPass(cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002836 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, "vkCmdResolveImage()",
2837 "VUID-vkCmdResolveImage-dstImage-02003", "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002838
Cort Stratton7df30962018-05-17 19:45:57 -07002839 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002840 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002841 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002842 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
2843 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
2844 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002845 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002846 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
2847 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002848 // For each region, the number of layers in the image subresource should not be zero
2849 // For each region, src and dest image aspect must be color only
2850 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002851 skip |=
2852 ValidateImageSubresourceLayers(cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()", "srcSubresource", i);
2853 skip |=
2854 ValidateImageSubresourceLayers(cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()", "dstSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002855 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002856 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
2857 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002858 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002859 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
2860 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002861 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i, "vkCmdResolveImage()",
2862 "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
2863 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i, "vkCmdResolveImage()",
2864 "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
2865 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002866 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2867 "VUID-vkCmdResolveImage-srcSubresource-01711");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002868 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002869 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2870 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07002871
2872 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002873 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
2874 skip |= log_msg(
2875 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002876 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-layerCount-00267",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002877 "vkCmdResolveImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002878 }
Cort Stratton7df30962018-05-17 19:45:57 -07002879 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002880 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
2881 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
2882 char const str[] =
Graeme Leese79b60cb2018-11-28 11:51:20 +00002883 "vkCmdResolveImage(): src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002884 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 -06002885 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002886 }
2887 }
2888
2889 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2890 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002891 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 -06002892 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002893 }
2894 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
2895 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002896 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 -06002897 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageType, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002898 }
2899 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
2900 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
2901 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 -06002902 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-srcImage-00257", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002903 }
2904 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
2905 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
2906 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 -06002907 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-dstImage-00259", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002908 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002909 } else {
2910 assert(0);
2911 }
2912 return skip;
2913}
2914
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002915void CoreChecks::PreCallRecordCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2916 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2917 const VkImageResolve *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002918 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002919 auto src_image_state = GetImageState(srcImage);
2920 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002921
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002922 // Update bindings between images and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002923 AddCommandBufferBindingImage(cb_node, src_image_state);
2924 AddCommandBufferBindingImage(cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002925}
2926
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002927bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2928 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2929 const VkImageBlit *pRegions, VkFilter filter) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002930 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002931 auto src_image_state = GetImageState(srcImage);
2932 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002933
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002934 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07002935 if (cb_node) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002936 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
John Zulauf5c2750c2018-01-30 15:04:56 -07002937 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002938 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002939 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06002940 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002941 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06002942 "VUID-vkCmdBlitImage-dstImage-00234");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002943 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
2944 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
Dave Houltond8ed0212018-05-16 17:18:24 -06002945 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002946 ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdBlitImage-srcImage-00219",
2947 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06002948 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002949 ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdBlitImage-dstImage-00224",
2950 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002951 skip |=
2952 ValidateCmdQueueFlags(cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002953 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
2954 skip |= InsideRenderPass(cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002955 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002956 "VUID-vkCmdBlitImage-srcImage-01999", "VUID-vkCmdBlitImage-srcImage-01999");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002957 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002958 "VUID-vkCmdBlitImage-dstImage-02000", "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04002959
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002960 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002961
Dave Houlton33c2d252017-06-09 17:08:32 -06002962 VkFormat src_format = src_image_state->createInfo.format;
2963 VkFormat dst_format = dst_image_state->createInfo.format;
2964 VkImageType src_type = src_image_state->createInfo.imageType;
2965 VkImageType dst_type = dst_image_state->createInfo.imageType;
2966
Cort Stratton186b1a22018-05-01 20:18:06 -04002967 if (VK_FILTER_LINEAR == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002968 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002969 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001",
2970 "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04002971 } else if (VK_FILTER_CUBIC_IMG == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002972 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
2973 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02002",
2974 "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06002975 }
2976
2977 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
2978 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 -06002979 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-filter-00237",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002980 "vkCmdBlitImage(): source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06002981 }
2982
Dave Houlton33c2d252017-06-09 17:08:32 -06002983 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
2984 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
2985 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 -06002986 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00228",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002987 "vkCmdBlitImage(): source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT.");
Dave Houlton33c2d252017-06-09 17:08:32 -06002988 }
2989
2990 // Validate consistency for unsigned formats
2991 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
2992 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002993 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06002994 << "the other one must also have unsigned integer format. "
2995 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
2996 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 -06002997 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06002998 }
2999
3000 // Validate consistency for signed formats
3001 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3002 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003003 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003004 << "the other one must also have signed integer format. "
3005 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3006 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 -06003007 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003008 }
3009
3010 // Validate filter for Depth/Stencil formats
3011 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3012 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003013 ss << "vkCmdBlitImage(): If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003014 << "then filter must be VK_FILTER_NEAREST.";
3015 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 -06003016 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003017 }
3018
3019 // Validate aspect bits and formats for depth/stencil images
3020 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3021 if (src_format != dst_format) {
3022 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003023 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003024 << "stencil, the other one must have exactly the same format. "
3025 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3026 << string_VkFormat(dst_format);
Dave Houltond8ed0212018-05-16 17:18:24 -06003027 skip |=
3028 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3029 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003030 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003031 } // Depth or Stencil
3032
3033 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003034 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003035 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003036 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3037 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3038 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003039 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003040 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3041 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003042 for (uint32_t i = 0; i < regionCount; i++) {
3043 const VkImageBlit rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003044 bool hit_error = false;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003045 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003046 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3047 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003048 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003049 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3050 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003051 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3052 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
3053 skip |= ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003054 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003055 skip |= ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003056 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003057 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003058 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3059 "VUID-vkCmdBlitImage-srcSubresource-01707");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003060 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003061 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3062 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003063 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003064 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3065 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003066 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003067 ss << "vkCmdBlitImage(): pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003068 skip |=
3069 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3070 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003071 }
Dave Houlton48989f32017-05-26 15:01:46 -06003072 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3073 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003074 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003075 ss << "vkCmdBlitImage(): pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003076 skip |=
3077 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3078 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003079 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003080
3081 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003082 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003083 skip |= log_msg(
3084 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3085 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-layerCount-00239",
3086 "vkCmdBlitImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003087 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003088
Dave Houlton48989f32017-05-26 15:01:46 -06003089 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003090 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 -06003091 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00238",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003092 "vkCmdBlitImage(): aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003093 }
Dave Houlton48989f32017-05-26 15:01:46 -06003094
Dave Houlton33c2d252017-06-09 17:08:32 -06003095 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
3096 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 -06003097 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00241",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003098 "vkCmdBlitImage(): region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003099 "image format %s.",
3100 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003101 }
3102
3103 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
3104 skip |= log_msg(
3105 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003106 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00242",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003107 "vkCmdBlitImage(): region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3108 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003109 }
3110
Dave Houlton48989f32017-05-26 15:01:46 -06003111 // Validate source image offsets
3112 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003113 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003114 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003115 skip |=
3116 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3117 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00245",
3118 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3119 "of (%1d, %1d). These must be (0, 1).",
3120 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003121 }
3122 }
3123
Dave Houlton33c2d252017-06-09 17:08:32 -06003124 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003125 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
3126 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 -06003127 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00247",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003128 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003129 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3130 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003131 }
3132 }
3133
Dave Houlton33c2d252017-06-09 17:08:32 -06003134 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003135 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3136 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003137 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003138 skip |= log_msg(
3139 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3140 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00243",
3141 "vkCmdBlitImage(): region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).", i,
3142 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003143 }
3144 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3145 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003146 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003147 skip |= log_msg(
3148 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003149 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00244",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003150 "vkCmdBlitImage(): region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003151 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003152 }
3153 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3154 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003155 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003156 skip |= log_msg(
3157 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3158 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00246",
3159 "vkCmdBlitImage(): region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).", i,
3160 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003161 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003162 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003163 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 -06003164 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00215",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003165 "vkCmdBlitImage(): region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003166 }
Dave Houlton48989f32017-05-26 15:01:46 -06003167
3168 // Validate dest image offsets
3169 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003170 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003171 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003172 skip |=
3173 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3174 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00250",
3175 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3176 "(%1d, %1d). These must be (0, 1).",
3177 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003178 }
3179 }
3180
Dave Houlton33c2d252017-06-09 17:08:32 -06003181 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003182 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
3183 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 -06003184 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00252",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003185 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003186 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3187 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003188 }
3189 }
3190
Dave Houlton33c2d252017-06-09 17:08:32 -06003191 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003192 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3193 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003194 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003195 skip |= log_msg(
3196 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3197 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00248",
3198 "vkCmdBlitImage(): region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).", i,
3199 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003200 }
3201 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3202 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003203 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003204 skip |= log_msg(
3205 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003206 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00249",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003207 "vkCmdBlitImage(): region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003208 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003209 }
3210 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3211 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003212 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003213 skip |= log_msg(
3214 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3215 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00251",
3216 "vkCmdBlitImage(): region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).", i,
3217 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003218 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003219 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003220 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 -06003221 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00216",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003222 "vkCmdBlitImage(): region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003223 }
3224
Dave Houlton33c2d252017-06-09 17:08:32 -06003225 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3226 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3227 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003228 skip |=
3229 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3230 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00240",
3231 "vkCmdBlitImage(): region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3232 "layerCount other than 1.",
3233 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003234 }
3235 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003236 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003237 } else {
3238 assert(0);
3239 }
3240 return skip;
3241}
3242
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003243void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3244 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3245 const VkImageBlit *pRegions, VkFilter filter) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07003246 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003247 auto src_image_state = GetImageState(srcImage);
3248 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003249
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003250 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003251 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003252 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3253 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003254 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003255 // Update bindings between images and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003256 AddCommandBufferBindingImage(cb_node, src_image_state);
3257 AddCommandBufferBindingImage(cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003258}
3259
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003260// This validates that the initial layout specified in the command buffer for the IMAGE is the same as the global IMAGE layout
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003261bool CoreChecks::ValidateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003262 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> const &globalImageLayoutMap,
3263 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &overlayLayoutMap) {
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003264 bool skip = false;
John Zulauff660ad62019-03-23 07:16:05 -06003265 // Iterate over the layout maps for each referenced image
3266 for (const auto &layout_map_entry : pCB->image_layout_map) {
3267 const auto image = layout_map_entry.first;
3268 const auto *image_state = GetImageState(image);
3269 if (!image_state) continue; // Can't check layouts of a dead image
3270 const auto &subres_map = layout_map_entry.second;
3271 ImageSubresourcePair isr_pair;
3272 isr_pair.image = image;
3273 isr_pair.hasSubresource = true;
Tony Barbourdf013b92017-01-25 12:53:48 -07003274
John Zulauff660ad62019-03-23 07:16:05 -06003275 // Validate the initial_uses for each subresource referenced
3276 for (auto it_init = subres_map->BeginInitialUse(); !it_init.AtEnd(); ++it_init) {
3277 isr_pair.subresource = (*it_init).subresource;
3278 VkImageLayout initial_layout = (*it_init).layout;
3279 VkImageLayout image_layout;
3280 if (FindLayout(overlayLayoutMap, isr_pair, image_layout) || FindLayout(globalImageLayoutMap, isr_pair, image_layout)) {
3281 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
3282 // TODO: Set memory invalid which is in mem_tracker currently
3283 } else if (image_layout != initial_layout) {
John Zulaufb61ed972019-04-09 16:12:35 -06003284 // Need to look up the inital layout *state* to get a bit more information
3285 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(isr_pair.subresource);
3286 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
3287 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
3288 if (!matches) {
3289 std::string formatted_label = FormatDebugLabel(" ", pCB->debug_label);
3290 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3291 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
3292 "Submitted command buffer expects image %s (subresource: aspectMask 0x%X array layer %u, "
3293 "mip level %u) "
3294 "to be in layout %s--instead, current layout is %s.%s",
3295 report_data->FormatHandle(image).c_str(), isr_pair.subresource.aspectMask,
3296 isr_pair.subresource.arrayLayer, isr_pair.subresource.mipLevel,
3297 string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout),
3298 formatted_label.c_str());
3299 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003300 }
3301 }
John Zulauff660ad62019-03-23 07:16:05 -06003302 }
3303
3304 // Update all layout set operations (which will be a subset of the initial_layouts
3305 for (auto it_set = subres_map->BeginSetLayout(); !it_set.AtEnd(); ++it_set) {
3306 VkImageLayout layout = (*it_set).layout;
3307 isr_pair.subresource = (*it_set).subresource;
3308 SetLayout(overlayLayoutMap, isr_pair, layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003309 }
3310 }
John Zulauff660ad62019-03-23 07:16:05 -06003311
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003312 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003313}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003314
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003315void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06003316 for (const auto &layout_map_entry : pCB->image_layout_map) {
3317 const auto image = layout_map_entry.first;
3318 const auto *image_state = GetImageState(image);
3319 if (!image_state) continue; // Can't set layouts of a dead image
3320 const auto &subres_map = layout_map_entry.second;
3321 ImageSubresourcePair isr_pair;
3322 isr_pair.image = image;
3323 isr_pair.hasSubresource = true;
3324
3325 // Update all layout set operations (which will be a subset of the initial_layouts
3326 for (auto it_set = subres_map->BeginSetLayout(); !it_set.AtEnd(); ++it_set) {
3327 VkImageLayout layout = (*it_set).layout;
3328 isr_pair.subresource = (*it_set).subresource;
3329 SetGlobalLayout(isr_pair, layout);
3330 }
Tony Barbourdf013b92017-01-25 12:53:48 -07003331 }
3332}
3333
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003334// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003335// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3336// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003337bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3338 const VkImageLayout first_layout, const uint32_t attachment,
3339 const VkAttachmentDescription2KHR &attachment_description) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003340 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003341 const char *vuid;
3342 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3343
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003344 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
3345 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003346 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3347 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3348 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003349 skip |=
Shannon McPherson3ea65132018-12-05 10:37:39 -07003350 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3351 "VUID-VkRenderPassCreateInfo2KHR-pAttachments-02522",
3352 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
3353 } else if (!use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3354 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
3355 skip |=
3356 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3357 "VUID-VkRenderPassCreateInfo-pAttachments-00836",
Dave Houltond8ed0212018-05-16 17:18:24 -06003358 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003359 }
3360 }
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003361 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3362 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003363 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01566";
Dave Houltond8ed0212018-05-16 17:18:24 -06003364 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003365 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 -06003366 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003367 }
3368 }
3369
3370 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3371 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003372 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01567";
Dave Houltond8ed0212018-05-16 17:18:24 -06003373 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003374 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 -06003375 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003376 }
3377 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003378 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003379}
3380
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003381bool CoreChecks::ValidateLayouts(RenderPassCreateVersion rp_version, VkDevice device,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003382 const VkRenderPassCreateInfo2KHR *pCreateInfo) {
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003383 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003384 const char *vuid;
3385 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3386 const char *const function_name = use_rp2 ? "vkCreateRenderPass2KHR()" : "vkCreateRenderPass()";
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003387
Jason Ekstranda1906302017-12-03 20:16:32 -08003388 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3389 VkFormat format = pCreateInfo->pAttachments[i].format;
3390 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3391 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3392 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003393 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 -06003394 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003395 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
3396 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3397 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3398 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003399 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003400 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003401 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 -06003402 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003403 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3404 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3405 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3406 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003407 }
3408 }
3409 }
3410
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003411 // Track when we're observing the first use of an attachment
3412 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3413 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003414 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003415
3416 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3417 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3418 auto attach_index = subpass.pInputAttachments[j].attachment;
3419 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003420 switch (subpass.pInputAttachments[j].layout) {
3421 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3422 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3423 // These are ideal.
3424 break;
3425
3426 case VK_IMAGE_LAYOUT_GENERAL:
3427 // May not be optimal. TODO: reconsider this warning based on other constraints.
3428 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003429 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003430 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
3431 break;
3432
Tobias Hectorbbb12282018-10-22 15:17:59 +01003433 case VK_IMAGE_LAYOUT_UNDEFINED:
3434 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3435 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3436 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3437 "Layout for input attachment reference %u in subpass %u is %s but must be "
3438 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
3439 j, i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3440 break;
3441
Graeme Leese668a9862018-10-08 10:40:02 +01003442 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3443 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003444 if (device_extensions.vk_khr_maintenance2) {
Graeme Leese668a9862018-10-08 10:40:02 +01003445 break;
3446 } else {
3447 // Intentionally fall through to generic error message
3448 }
3449 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003450
Cort Stratton7547f772017-05-04 15:18:52 -07003451 default:
3452 // No other layouts are acceptable
3453 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 -06003454 kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003455 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3456 string_VkImageLayout(subpass.pInputAttachments[j].layout));
3457 }
3458
Cort Stratton7547f772017-05-04 15:18:52 -07003459 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003460 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3461 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003462
3463 bool used_as_depth =
3464 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3465 bool used_as_color = false;
3466 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3467 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3468 }
3469 if (!used_as_depth && !used_as_color &&
3470 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003471 vuid = use_rp2 ? "VUID-VkSubpassDescription2KHR-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
3472 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3473 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
3474 function_name, attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07003475 }
3476 }
3477 attach_first_use[attach_index] = false;
3478 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003479
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003480 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3481 auto attach_index = subpass.pColorAttachments[j].attachment;
3482 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3483
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003484 // TODO: Need a way to validate shared presentable images here, currently just allowing
3485 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3486 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003487 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003488 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003489 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003490 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3491 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003492 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003493
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003494 case VK_IMAGE_LAYOUT_GENERAL:
3495 // May not be optimal; TODO: reconsider this warning based on other constraints?
3496 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003497 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003498 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
3499 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003500
Tobias Hectorbbb12282018-10-22 15:17:59 +01003501 case VK_IMAGE_LAYOUT_UNDEFINED:
3502 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3503 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3504 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3505 "Layout for color attachment reference %u in subpass %u is %s but should be "
3506 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3507 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3508 break;
3509
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003510 default:
3511 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 -06003512 kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003513 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3514 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003515 }
3516
John Zulauf4eee2692019-02-09 16:14:25 -07003517 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].attachment != VK_ATTACHMENT_UNUSED) &&
3518 (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
3519 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003520 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3521 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 -07003522 "Layout for resolve attachment reference %u in subpass %u is %s but should be "
Tobias Hectorbbb12282018-10-22 15:17:59 +01003523 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
John Zulauff0f8c2b2019-02-14 12:13:44 -07003524 j, i, string_VkImageLayout(subpass.pResolveAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003525 }
3526
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003527 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003528 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
3529 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003530 }
3531 attach_first_use[attach_index] = false;
3532 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003533
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003534 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3535 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003536 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3537 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3538 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003539 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003540
Dave Houltona9df0ce2018-02-07 10:51:23 -07003541 case VK_IMAGE_LAYOUT_GENERAL:
3542 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3543 // doing a bunch of transitions.
3544 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003545 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003546 "GENERAL layout for depth attachment may not give optimal performance.");
3547 break;
3548
Tobias Hectorbbb12282018-10-22 15:17:59 +01003549 case VK_IMAGE_LAYOUT_UNDEFINED:
3550 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3551 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3552 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3553 "Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
3554 "layout or GENERAL.",
3555 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3556 break;
3557
Dave Houltona9df0ce2018-02-07 10:51:23 -07003558 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3559 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003560 if (device_extensions.vk_khr_maintenance2) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003561 break;
3562 } else {
3563 // Intentionally fall through to generic error message
3564 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06003565 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003566
Dave Houltona9df0ce2018-02-07 10:51:23 -07003567 default:
3568 // No other layouts are acceptable
3569 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 -06003570 kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003571 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3572 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
3573 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003574 }
3575
3576 auto attach_index = subpass.pDepthStencilAttachment->attachment;
3577 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003578 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
3579 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003580 }
3581 attach_first_use[attach_index] = false;
3582 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003583 }
3584 return skip;
3585}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003586
3587// For any image objects that overlap mapped memory, verify that their layouts are PREINIT or GENERAL
Mark Lobodzinskidb315cc2019-04-25 10:45:28 -06003588bool CoreChecks::ValidateMapImageLayouts(VkDevice device, DEVICE_MEMORY_STATE const *mem_info, VkDeviceSize offset,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003589 VkDeviceSize end_offset) {
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003590 bool skip = false;
3591 // Iterate over all bound image ranges and verify that for any that overlap the map ranges, the layouts are
3592 // VK_IMAGE_LAYOUT_PREINITIALIZED or VK_IMAGE_LAYOUT_GENERAL
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003593 // TODO : This can be optimized if we store ranges based on starting address and early exit when we pass our range
3594 for (auto image_handle : mem_info->bound_images) {
3595 auto img_it = mem_info->bound_ranges.find(image_handle);
3596 if (img_it != mem_info->bound_ranges.end()) {
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003597 if (RangesIntersect(&img_it->second, offset, end_offset)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003598 std::vector<VkImageLayout> layouts;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003599 if (FindLayouts(VkImage(image_handle), layouts)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003600 for (auto layout : layouts) {
3601 if (layout != VK_IMAGE_LAYOUT_PREINITIALIZED && layout != VK_IMAGE_LAYOUT_GENERAL) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003602 skip |=
3603 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DEVICE_MEMORY_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003604 HandleToUint64(mem_info->mem), kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003605 "Mapping an image with layout %s can result in undefined behavior if this memory is used "
3606 "by the device. Only GENERAL or PREINITIALIZED should be used.",
Petr Krausbc7f5442017-05-14 23:43:38 +02003607 string_VkImageLayout(layout));
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003608 }
3609 }
3610 }
3611 }
3612 }
3613 }
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003614 return skip;
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003615}
Mark Lobodzinski96210742017-02-09 10:33:46 -07003616
3617// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
3618// is true, verify that (actual & desired) flags == desired
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003619bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, uint64_t obj_handle,
3620 VulkanObjectType obj_type, const char *msgCode, char const *func_name, char const *usage_str) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003621 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003622 bool skip = false;
Mark Lobodzinski33826372017-04-13 11:10:11 -06003623 const char *type_str = object_string[obj_type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003624 if (strict) {
3625 correct_usage = ((actual & desired) == desired);
3626 } else {
3627 correct_usage = ((actual & desired) != 0);
3628 }
3629 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06003630 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06003631 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
Lockee9aeebf2019-03-03 23:50:08 -07003632 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[obj_type], obj_handle,
3633 kVUID_Core_MemTrack_InvalidUsageFlag,
3634 "Invalid usage flag for %s %s used by %s. In this case, %s should have %s set during creation.",
3635 type_str, report_data->FormatHandle(obj_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003636 } else {
Lockee9aeebf2019-03-03 23:50:08 -07003637 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[obj_type], obj_handle, msgCode,
3638 "Invalid usage flag for %s %s used by %s. In this case, %s should have %s set during creation.",
3639 type_str, report_data->FormatHandle(obj_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003640 }
3641 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003642 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003643}
3644
3645// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3646// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003647bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
3648 char const *func_name, char const *usage_string) {
3649 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, HandleToUint64(image_state->image),
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003650 kVulkanObjectTypeImage, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003651}
3652
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003653bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003654 char const *func_name, const char *linear_vuid, const char *optimal_vuid) {
Mark Lobodzinski5c048802019-03-07 10:47:31 -07003655 VkFormatProperties format_properties = GetPDFormatProperties(image_state->createInfo.format);
Cort Stratton186b1a22018-05-01 20:18:06 -04003656 bool skip = false;
3657 if (image_state->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
3658 if ((format_properties.linearTilingFeatures & desired) != desired) {
Lockee9aeebf2019-03-03 23:50:08 -07003659 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3660 HandleToUint64(image_state->image), linear_vuid,
3661 "In %s, invalid linearTilingFeatures (0x%08X) for format %u used by image %s.", func_name,
3662 format_properties.linearTilingFeatures, image_state->createInfo.format,
3663 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04003664 }
3665 } else if (image_state->createInfo.tiling == VK_IMAGE_TILING_OPTIMAL) {
3666 if ((format_properties.optimalTilingFeatures & desired) != desired) {
3667 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3668 HandleToUint64(image_state->image), optimal_vuid,
Lockee9aeebf2019-03-03 23:50:08 -07003669 "In %s, invalid optimalTilingFeatures (0x%08X) for format %u used by image %s.", func_name,
Cort Stratton186b1a22018-05-01 20:18:06 -04003670 format_properties.optimalTilingFeatures, image_state->createInfo.format,
Lockee9aeebf2019-03-03 23:50:08 -07003671 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04003672 }
3673 }
3674 return skip;
3675}
3676
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003677bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003678 char const *func_name, char const *member, uint32_t i) {
Cort Strattond619a302018-05-17 19:46:32 -07003679 bool skip = false;
Cort Strattond619a302018-05-17 19:46:32 -07003680 // layerCount must not be zero
3681 if (subresource_layers->layerCount == 0) {
3682 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3683 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-layerCount-01700",
3684 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
3685 }
3686 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
3687 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
3688 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3689 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00168",
3690 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
3691 }
3692 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
3693 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3694 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
3695 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3696 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00167",
3697 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
3698 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3699 func_name, i, member);
3700 }
3701 return skip;
3702}
3703
Mark Lobodzinski96210742017-02-09 10:33:46 -07003704// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3705// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003706bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
3707 char const *func_name, char const *usage_string) {
3708 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, HandleToUint64(buffer_state->buffer),
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003709 kVulkanObjectTypeBuffer, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003710}
3711
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003712bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
3713 const VkPhysicalDeviceLimits *device_limits) {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003714 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003715
3716 const VkDeviceSize &range = pCreateInfo->range;
3717 if (range != VK_WHOLE_SIZE) {
3718 // Range must be greater than 0
3719 if (range <= 0) {
3720 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3721 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00928",
3722 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3723 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
3724 range);
3725 }
3726 // Range must be a multiple of the element size of format
Dave Houltona585d132019-01-18 13:05:42 -07003727 const size_t format_size = FormatElementSize(pCreateInfo->format);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003728 if (range % format_size != 0) {
3729 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3730 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00929",
3731 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3732 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
3733 "(" PRINTF_SIZE_T_SPECIFIER ").",
3734 range, format_size);
3735 }
3736 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
3737 if (range / format_size > device_limits->maxTexelBufferElements) {
3738 skip |=
3739 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3740 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00930",
3741 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3742 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (" PRINTF_SIZE_T_SPECIFIER
3743 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
3744 range, format_size, device_limits->maxTexelBufferElements);
3745 }
3746 // The sum of range and offset must be less than or equal to the size of buffer
3747 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
3748 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3749 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00931",
3750 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3751 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
3752 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
3753 range, pCreateInfo->offset, buffer_state->createInfo.size);
3754 }
3755 }
3756 return skip;
3757}
3758
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003759bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) {
Shannon McPherson265383a2018-06-21 15:37:52 -06003760 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07003761 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06003762 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
3763 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
3764 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3765 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00933",
3766 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
3767 "be supported for uniform texel buffers");
3768 }
3769 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
3770 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
3771 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3772 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00934",
3773 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
3774 "be supported for storage texel buffers");
3775 }
3776 return skip;
3777}
3778
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003779bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
3780 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003781 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003782
Dave Houltond8ed0212018-05-16 17:18:24 -06003783 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003784
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06003785 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!enabled_features.core.sparseBinding)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003786 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 -06003787 "VUID-VkBufferCreateInfo-flags-00915",
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003788 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003789 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003790 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003791
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06003792 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!enabled_features.core.sparseResidencyBuffer)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003793 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 -06003794 "VUID-VkBufferCreateInfo-flags-00916",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003795 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003796 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003797 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003798
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06003799 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003800 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 -06003801 "VUID-VkBufferCreateInfo-flags-00917",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003802 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003803 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003804 }
Jeff Bolz87697532019-01-11 22:54:00 -06003805
3806 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
3807 if (chained_devaddr_struct) {
3808 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
3809 chained_devaddr_struct->deviceAddress != 0) {
3810 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3811 "VUID-VkBufferCreateInfo-deviceAddress-02604",
3812 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
3813 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
3814 }
3815 }
3816
3817 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06003818 !enabled_features.buffer_address.bufferDeviceAddressCaptureReplay) {
Jeff Bolz87697532019-01-11 22:54:00 -06003819 skip |= log_msg(
3820 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3821 "VUID-VkBufferCreateInfo-flags-02605",
3822 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
3823 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
3824 }
3825
3826 if ((pCreateInfo->usage & VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_EXT) &&
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06003827 !enabled_features.buffer_address.bufferDeviceAddress) {
Jeff Bolz87697532019-01-11 22:54:00 -06003828 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3829 "VUID-VkBufferCreateInfo-usage-02606",
3830 "vkCreateBuffer(): the bufferDeviceAddress device feature is disabled: Buffers cannot be created with "
3831 "the VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_EXT set.");
3832 }
3833
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07003834 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003835 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateBuffer",
3836 "pCreateInfo->pQueueFamilyIndices", "VUID-VkBufferCreateInfo-sharingMode-01419",
3837 "VUID-VkBufferCreateInfo-sharingMode-01419", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07003838 }
3839
Mark Lobodzinski96210742017-02-09 10:33:46 -07003840 return skip;
3841}
3842
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003843void CoreChecks::PostCallRecordCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
3844 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer, VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07003845 if (result != VK_SUCCESS) return;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003846 // TODO : This doesn't create deep copy of pQueueFamilyIndices so need to fix that if/when we want that data to be valid
Mark Lobodzinski3baa8172019-04-19 13:47:30 -06003847 bufferMap.insert(std::make_pair(*pBuffer, std::unique_ptr<BUFFER_STATE>(new BUFFER_STATE(*pBuffer, pCreateInfo))));
Mark Lobodzinski96210742017-02-09 10:33:46 -07003848}
3849
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003850bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
3851 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003852 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07003853 BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003854 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
3855 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003856 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07003857 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
3858 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003859 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06003860 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
3861 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
3862 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06003863
Shannon McPherson0eb84f62018-06-18 16:32:40 -06003864 // Buffer view offset must be less than the size of buffer
3865 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
3866 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3867 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00925",
3868 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3869 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
3870 pCreateInfo->offset, buffer_state->createInfo.size);
3871 }
3872
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06003873 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Shannon McPherson883f6092018-06-14 13:15:25 -06003874 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
3875 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0) {
3876 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3877 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00926",
3878 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3879 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
3880 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
3881 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003882
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003883 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06003884
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003885 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003886 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003887 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003888}
3889
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003890void CoreChecks::PostCallRecordCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
3891 const VkAllocationCallbacks *pAllocator, VkBufferView *pView, VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07003892 if (result != VK_SUCCESS) return;
Mark Lobodzinskie0befe42019-04-19 13:49:08 -06003893 bufferViewMap[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
Mark Lobodzinski96210742017-02-09 10:33:46 -07003894}
Mark Lobodzinski602de982017-02-09 11:01:33 -07003895
3896// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07003897bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
3898 const char *vuid) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003899 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003900 VkDebugReportObjectTypeEXT objectType = VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT;
3901 if (image != VK_NULL_HANDLE) {
3902 objectType = VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT;
3903 }
3904
Dave Houlton1d2022c2017-03-29 11:43:58 -06003905 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003906 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003907 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003908 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003909 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003910 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003911 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003912 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003913 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003914 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003915 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003916 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003917 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3918 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003919 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003920 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski602de982017-02-09 11:01:33 -07003921 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003922 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3923 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003924 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003925 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003926 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003927 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003928 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003929 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003930 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003931 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003932 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003933 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003934 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003935 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003936 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003937 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003938 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003939 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003940 }
Dave Houlton501b15b2018-03-30 15:07:41 -06003941 } else if (FormatIsMultiplane(format)) {
3942 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
3943 if (3 == FormatPlaneCount(format)) {
3944 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
3945 }
3946 if ((aspect_mask & valid_flags) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003947 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houlton501b15b2018-03-30 15:07:41 -06003948 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
3949 "set, where n = [0, 1, 2].",
3950 func_name);
3951 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003952 }
3953 return skip;
3954}
3955
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07003956bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
3957 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
3958 const char *param_name, const char *image_layer_count_var_name,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003959 const uint64_t image_handle, SubresourceRangeErrorCodes errorCodes) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003960 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02003961
3962 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02003963 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003964 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 -06003965 errorCodes.base_mip_err,
Petr Krausffa94af2017-08-08 21:46:02 +02003966 "%s: %s.baseMipLevel (= %" PRIu32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003967 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
3968 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003969 }
Petr Kraus4d718682017-05-18 03:38:41 +02003970
Petr Krausffa94af2017-08-08 21:46:02 +02003971 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
3972 if (subresourceRange.levelCount == 0) {
3973 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 -06003974 errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02003975 } else {
3976 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02003977
Petr Krausffa94af2017-08-08 21:46:02 +02003978 if (necessary_mip_count > image_mip_count) {
3979 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 -06003980 errorCodes.mip_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02003981 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003982 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02003983 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003984 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003985 }
Petr Kraus4d718682017-05-18 03:38:41 +02003986 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003987 }
Petr Kraus4d718682017-05-18 03:38:41 +02003988
3989 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02003990 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003991 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 -06003992 errorCodes.base_layer_err,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003993 "%s: %s.baseArrayLayer (= %" PRIu32
3994 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
3995 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003996 }
Petr Kraus4d718682017-05-18 03:38:41 +02003997
Petr Krausffa94af2017-08-08 21:46:02 +02003998 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
3999 if (subresourceRange.layerCount == 0) {
4000 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 -06004001 errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004002 } else {
4003 const uint64_t necessary_layer_count =
4004 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004005
Petr Krausffa94af2017-08-08 21:46:02 +02004006 if (necessary_layer_count > image_layer_count) {
4007 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 -06004008 errorCodes.layer_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004009 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004010 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004011 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004012 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004013 }
Petr Kraus4d718682017-05-18 03:38:41 +02004014 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004015 }
Petr Kraus4d718682017-05-18 03:38:41 +02004016
Mark Lobodzinski602de982017-02-09 11:01:33 -07004017 return skip;
4018}
4019
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004020bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004021 const VkImageSubresourceRange &subresourceRange) {
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004022 bool is_khr_maintenance1 = device_extensions.vk_khr_maintenance1;
Petr Krausffa94af2017-08-08 21:46:02 +02004023 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4024 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4025 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4026
4027 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4028 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4029
4030 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004031 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4032 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
4033 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-01484"
4034 : "VUID-VkImageViewCreateInfo-image-01482")
4035 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4036 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
4037 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-01485"
4038 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4039 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004040
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004041 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004042 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
4043 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4044}
4045
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004046bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004047 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
Petr Krausffa94af2017-08-08 21:46:02 +02004048 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004049 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4050 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4051 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4052 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004053
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004054 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4055 "vkCmdClearColorImage", param_name, "arrayLayers", HandleToUint64(image_state->image),
4056 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004057}
4058
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004059bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004060 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
Petr Krausffa94af2017-08-08 21:46:02 +02004061 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004062 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4063 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4064 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4065 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004066
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004067 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4068 "vkCmdClearDepthStencilImage", param_name, "arrayLayers",
Petr Krausffa94af2017-08-08 21:46:02 +02004069 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4070}
4071
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004072bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004073 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
4074 const char *param_name) {
Petr Krausffa94af2017-08-08 21:46:02 +02004075 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004076 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4077 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4078 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4079 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004080
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004081 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4082 cmd_name, param_name, "arrayLayers", HandleToUint64(image_state->image),
Petr Krausffa94af2017-08-08 21:46:02 +02004083 subresourceRangeErrorCodes);
4084}
4085
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004086bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
4087 const VkAllocationCallbacks *pAllocator, VkImageView *pView) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004088 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004089 IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004090 if (image_state) {
4091 skip |= ValidateImageUsageFlags(
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004092 image_state,
Mark Lobodzinski602de982017-02-09 11:01:33 -07004093 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
Dave Houlton142c4cb2018-10-17 15:04:41 -06004094 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4095 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV,
Dave Houlton8e9f6542018-05-18 12:18:22 -06004096 false, kVUIDUndefined, "vkCreateImageView()",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004097 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|SHADING_RATE_IMAGE]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004098 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004099 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004100 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004101 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004102 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004103 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004104
4105 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4106 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004107 VkImageUsageFlags image_usage = image_state->createInfo.usage;
4108 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004109 VkFormat view_format = pCreateInfo->format;
4110 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004111 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004112 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004113
Dave Houltonbd2e2622018-04-10 16:41:14 -06004114 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004115 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004116 if (chained_ivuci_struct) {
Dave Houltonbd2e2622018-04-10 16:41:14 -06004117 image_usage = chained_ivuci_struct->usage;
4118 }
4119
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004120 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4121 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004122 if (FormatIsMultiplane(image_format)) {
4123 // View format must match the multiplane compatible format
4124 uint32_t plane = 3; // invalid
4125 switch (aspect_mask) {
4126 case VK_IMAGE_ASPECT_PLANE_0_BIT:
4127 plane = 0;
4128 break;
4129 case VK_IMAGE_ASPECT_PLANE_1_BIT:
4130 plane = 1;
4131 break;
4132 case VK_IMAGE_ASPECT_PLANE_2_BIT:
4133 plane = 2;
4134 break;
4135 default:
4136 break;
4137 }
4138
4139 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, plane);
4140 if (view_format != compat_format) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06004141 std::stringstream ss;
4142 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004143 << " is not compatible with plane " << plane << " of underlying image format "
4144 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Young9d1ac312018-05-21 16:28:27 -06004145 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 -07004146 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01586", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004147 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004148 }
4149 } else {
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004150 if ((!device_extensions.vk_khr_maintenance2 ||
Dave Houltonc7988072018-04-16 11:46:56 -06004151 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
4152 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4153 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
4154 std::stringstream ss;
4155 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Lockee9aeebf2019-03-03 23:50:08 -07004156 << " is not in the same format compatibility class as image ("
4157 << report_data->FormatHandle(pCreateInfo->image).c_str() << ") format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004158 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4159 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
Mark Young9d1ac312018-05-21 16:28:27 -06004160 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 -07004161 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01018", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004162 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004163 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004164 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004165 }
4166 } else {
4167 // Format MUST be IDENTICAL to the format the image was created with
4168 if (image_format != view_format) {
4169 std::stringstream ss;
4170 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from image "
Lockee9aeebf2019-03-03 23:50:08 -07004171 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004172 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Young9d1ac312018-05-21 16:28:27 -06004173 skip |=
4174 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004175 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01019", "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004176 }
4177 }
4178
4179 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004180 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004181
4182 switch (image_type) {
4183 case VK_IMAGE_TYPE_1D:
4184 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004185 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 -07004186 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004187 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4188 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004189 }
4190 break;
4191 case VK_IMAGE_TYPE_2D:
4192 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4193 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4194 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Young9d1ac312018-05-21 16:28:27 -06004195 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 -07004196 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01003",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004197 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4198 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004199 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004200 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 -07004201 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004202 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4203 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004204 }
4205 }
4206 break;
4207 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004208 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06004209 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4210 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4211 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004212 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004213 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004214 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01005",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004215 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4216 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004217 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4218 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004219 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004220 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004221 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004222 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4223 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004224 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4225 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004226 }
4227 } else {
Mark Young9d1ac312018-05-21 16:28:27 -06004228 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 -07004229 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004230 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4231 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004232 }
4233 }
4234 } else {
4235 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Young9d1ac312018-05-21 16:28:27 -06004236 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 -07004237 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004238 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4239 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004240 }
4241 }
4242 break;
4243 default:
4244 break;
4245 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004246
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004247 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004248 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07004249 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004250 }
4251
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004252 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004253 VkFormatFeatureFlags tiling_features = (image_tiling & VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4254 : format_properties.optimalTilingFeatures;
4255
4256 if (tiling_features == 0) {
4257 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 -07004258 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-None-02273",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004259 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4260 "physical device.",
4261 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4262 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4263 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 -07004264 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02274",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004265 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4266 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4267 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4268 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4269 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 -07004270 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02275",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004271 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4272 "VK_IMAGE_USAGE_STORAGE_BIT.",
4273 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4274 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
4275 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4276 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 -07004277 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02276",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004278 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4279 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4280 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4281 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4282 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4283 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 -07004284 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02277",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004285 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4286 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4287 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004288 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004289
Jeff Bolz9af91c52018-09-01 21:53:57 -05004290 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4291 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4292 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 -07004293 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02086",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004294 "vkCreateImageView() If image was created with usage containing "
4295 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4296 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
4297 }
4298 if (view_format != VK_FORMAT_R8_UINT) {
4299 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-02087",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004301 "vkCreateImageView() If image was created with usage containing "
4302 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
4303 }
4304 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004305 }
4306 return skip;
4307}
4308
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004309void CoreChecks::PostCallRecordCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
4310 const VkAllocationCallbacks *pAllocator, VkImageView *pView, VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07004311 if (result != VK_SUCCESS) return;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004312 auto image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski81b02a12019-04-19 13:58:43 -06004313 imageViewMap[*pView] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(image_state, *pView, pCreateInfo));
Mark Lobodzinski602de982017-02-09 11:01:33 -07004314}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004315
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004316bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
4317 uint32_t regionCount, const VkBufferCopy *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004318 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004319 auto src_buffer_state = GetBufferState(srcBuffer);
4320 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004321
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004322 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004323 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
4324 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004325 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004326 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004327 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
4328 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06004329 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004330 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
4331 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004332 skip |=
4333 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4334 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004335 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
4336 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004337 return skip;
4338}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004339
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004340void CoreChecks::PreCallRecordCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
4341 uint32_t regionCount, const VkBufferCopy *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004342 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004343 auto src_buffer_state = GetBufferState(srcBuffer);
4344 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004345
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004346 // Update bindings between buffers and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004347 AddCommandBufferBindingBuffer(cb_node, src_buffer_state);
4348 AddCommandBufferBindingBuffer(cb_node, dst_buffer_state);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004349}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004350
Mark Lobodzinskif933db92019-03-09 12:58:03 -07004351bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004352 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004353 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004354 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004355 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT, HandleToUint64(buffer),
Lockee9aeebf2019-03-03 23:50:08 -07004356 kVUID_Core_DrawState_DoubleDestroy, "Cannot free buffer %s that has not been allocated.",
4357 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004358 } else {
4359 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004360 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 -06004361 HandleToUint64(buffer), "VUID-vkDestroyBuffer-buffer-00922",
Lockee9aeebf2019-03-03 23:50:08 -07004362 "Cannot free buffer %s that is in use by a command buffer.", report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004363 }
4364 }
4365 return skip;
4366}
4367
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004368bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07004369 IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004370 VK_OBJECT obj_struct = {HandleToUint64(imageView), kVulkanObjectTypeImageView};
4371
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004372 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004373 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004374 skip |=
4375 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004376 }
4377 return skip;
4378}
4379
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004380void CoreChecks::PreCallRecordDestroyImageView(VkDevice device, VkImageView imageView, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07004381 IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004382 if (!image_view_state) return;
4383 VK_OBJECT obj_struct = {HandleToUint64(imageView), kVulkanObjectTypeImageView};
4384
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004385 // Any bound cmd buffers are now invalid
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004386 InvalidateCommandBuffers(image_view_state->cb_bindings, obj_struct);
Mark Lobodzinski81b02a12019-04-19 13:58:43 -06004387 imageViewMap.erase(imageView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004388}
4389
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004390bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004391 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004392
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004393 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004394 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07004395 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004396 }
4397 return skip;
4398}
4399
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004400void CoreChecks::PreCallRecordDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004401 if (!buffer) return;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004402 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004403 VK_OBJECT obj_struct = {HandleToUint64(buffer), kVulkanObjectTypeBuffer};
4404
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004405 InvalidateCommandBuffers(buffer_state->cb_bindings, obj_struct);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004406 for (auto mem_binding : buffer_state->GetBoundMemory()) {
Mark Lobodzinski97f83f72019-03-07 10:01:52 -07004407 auto mem_info = GetMemObjInfo(mem_binding);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004408 if (mem_info) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004409 RemoveBufferMemoryRange(HandleToUint64(buffer), mem_info);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004410 }
4411 }
Mark Lobodzinski97f83f72019-03-07 10:01:52 -07004412 ClearMemoryObjectBindings(HandleToUint64(buffer), kVulkanObjectTypeBuffer);
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004413 EraseQFOReleaseBarriers<VkBufferMemoryBarrier>(buffer);
Mark Lobodzinski3baa8172019-04-19 13:47:30 -06004414 bufferMap.erase(buffer_state->buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004415}
4416
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004417bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
4418 const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07004419 auto buffer_view_state = GetBufferViewState(bufferView);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004420 VK_OBJECT obj_struct = {HandleToUint64(bufferView), kVulkanObjectTypeBufferView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004421 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004422 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004423 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06004424 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004425 }
4426 return skip;
4427}
4428
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004429void CoreChecks::PreCallRecordDestroyBufferView(VkDevice device, VkBufferView bufferView, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004430 if (!bufferView) return;
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07004431 auto buffer_view_state = GetBufferViewState(bufferView);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004432 VK_OBJECT obj_struct = {HandleToUint64(bufferView), kVulkanObjectTypeBufferView};
4433
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004434 // Any bound cmd buffers are now invalid
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004435 InvalidateCommandBuffers(buffer_view_state->cb_bindings, obj_struct);
Mark Lobodzinskie0befe42019-04-19 13:49:08 -06004436 bufferViewMap.erase(bufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004437}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004438
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004439bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
4440 VkDeviceSize size, uint32_t data) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004441 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004442 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004443 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004444 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004445 skip |=
4446 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4447 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004448 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004449 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004450 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
4451 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004452 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004453 return skip;
4454}
4455
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004456void CoreChecks::PreCallRecordCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
4457 VkDeviceSize size, uint32_t data) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004458 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004459 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004460 // Update bindings between buffer and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004461 AddCommandBufferBindingBuffer(cb_node, buffer_state);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004462}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004463
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004464bool CoreChecks::ValidateBufferImageCopyData(uint32_t regionCount, const VkBufferImageCopy *pRegions, IMAGE_STATE *image_state,
4465 const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004466 bool skip = false;
4467
4468 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004469 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
4470 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004471 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 -06004472 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00199",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004473 "%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 -06004474 "and 1, respectively.",
4475 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004476 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004477 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004478
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004479 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
4480 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004481 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 -06004482 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00201",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004483 "%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 -06004484 "must be 0 and 1, respectively.",
4485 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004486 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004487 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004488
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004489 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
4490 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004491 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 -06004492 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-baseArrayLayer-00213",
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004493 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
4494 "For 3D images these must be 0 and 1, respectively.",
4495 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004496 }
4497 }
4498
4499 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07004500 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
Locke497739c2019-03-08 11:50:47 -07004501 uint32_t element_size = FormatElementSize(image_state->createInfo.format, pRegions[i].imageSubresource.aspectMask);
4502
Dave Houltona585d132019-01-18 13:05:42 -07004503 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004504 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 -06004505 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00193",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004506 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07004507 " must be a multiple of this format's texel size (%" PRIu32 ").",
4508 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004509 }
4510
4511 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06004512 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004513 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 -06004514 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00194",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004515 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
4516 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004517 }
4518
4519 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
4520 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004521 skip |=
4522 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004523 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00195",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004524 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
4525 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004526 }
4527
4528 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
4529 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
4530 skip |= log_msg(
4531 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004532 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004533 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
4534 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004535 }
4536
4537 // subresource aspectMask must have exactly 1 bit set
4538 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
4539 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
4540 if (aspect_mask_bits.count() != 1) {
4541 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 -06004542 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00212",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004543 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004544 }
4545
4546 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06004547 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004548 skip |= log_msg(
4549 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004550 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004551 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
4552 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004553 }
4554
4555 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04004556 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07004557 auto block_size = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004558
4559 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06004560 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004561 skip |= log_msg(
4562 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004563 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00203",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004564 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
4565 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004566 }
4567
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004568 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004569 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004570 skip |= log_msg(
4571 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004572 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00204",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004573 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
4574 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004575 }
4576
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004577 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06004578 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
4579 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
4580 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004581 skip |=
4582 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004583 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00205",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004584 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
4585 "width & height (%d, %d)..",
4586 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004587 }
4588
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004589 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houltona585d132019-01-18 13:05:42 -07004590 uint32_t block_size_in_bytes = FormatElementSize(image_state->createInfo.format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06004591 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004592 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 -06004593 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00206",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004594 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07004595 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004596 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004597 }
Dave Houlton67e9b532017-03-02 17:00:10 -07004598
4599 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07004600 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06004601 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004602 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
4603 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 -06004604 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00207",
Dave Houlton75967fc2017-03-06 17:21:16 -07004605 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004606 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004607 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004608 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07004609 }
4610
4611 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004612 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004613 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
4614 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 -06004615 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00208",
Dave Houlton75967fc2017-03-06 17:21:16 -07004616 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004617 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004618 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004619 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07004620 }
4621
4622 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06004623 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004624 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
4625 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 -06004626 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00209",
Dave Houlton75967fc2017-03-06 17:21:16 -07004627 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004628 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004629 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004630 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07004631 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004632 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004633 }
4634
4635 return skip;
4636}
4637
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004638static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06004639 const VkBufferImageCopy *pRegions, const char *func_name, const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004640 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004641 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004642
4643 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004644 VkExtent3D extent = pRegions[i].imageExtent;
4645 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004646
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004647 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
4648 {
Dave Houlton51653902018-06-22 17:32:13 -06004649 skip |=
4650 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4651 kVUID_Core_Image_ZeroAreaSubregion, "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area",
4652 func_name, i, extent.width, extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004653 }
4654
4655 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
4656
4657 // 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 -06004658 if (FormatIsCompressed(image_info->format)) {
Dave Houltona585d132019-01-18 13:05:42 -07004659 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004660 if (image_extent.width % block_extent.width) {
4661 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
4662 }
4663 if (image_extent.height % block_extent.height) {
4664 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
4665 }
4666 if (image_extent.depth % block_extent.depth) {
4667 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
4668 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004669 }
4670
Dave Houltonfc1a4052017-04-27 14:32:45 -06004671 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004672 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 -06004673 msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004674 }
4675 }
4676
4677 return skip;
4678}
4679
Chris Forbese8ba09a2017-06-01 17:39:02 -07004680static inline bool ValidateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
Dave Houlton33c2d252017-06-09 17:08:32 -06004681 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06004682 const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004683 bool skip = false;
4684
4685 VkDeviceSize buffer_size = buff_state->createInfo.size;
4686
4687 for (uint32_t i = 0; i < regionCount; i++) {
4688 VkExtent3D copy_extent = pRegions[i].imageExtent;
4689
4690 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
4691 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Locke497739c2019-03-08 11:50:47 -07004692 VkDeviceSize unit_size = FormatElementSize(image_state->createInfo.format,
4693 pRegions[i].imageSubresource.aspectMask); // size (bytes) of texel or block
Dave Houltonf3229d52017-02-21 15:59:08 -07004694
Tom Cooperb2550c72018-10-15 13:08:41 +01004695 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004696 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houltona585d132019-01-18 13:05:42 -07004697 auto block_dim = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004698 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
4699 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
4700
4701 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
4702 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
4703 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004704 }
4705
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004706 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
4707 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
4708 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07004709 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004710 } else {
4711 // Calculate buffer offset of final copied byte, + 1.
4712 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
4713 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
4714 max_buffer_offset *= unit_size; // convert to bytes
4715 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004716
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004717 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06004718 skip |=
4719 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4720 msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i, buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004721 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004722 }
4723 }
4724
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004725 return skip;
4726}
4727
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004728bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4729 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004730 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004731 auto src_image_state = GetImageState(srcImage);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004732 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004733
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004734 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004735
4736 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004737 skip |= ValidateCmd(cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004738
4739 // Command pool must support graphics, compute, or transfer operations
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -07004740 auto pPool = GetCommandPoolNode(cb_node->createInfo.commandPool);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004741
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004742 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07004743
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004744 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4745 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 -06004746 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004747 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004748 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004749 }
Dave Houlton0ef27492018-04-04 11:41:48 -06004750 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004751 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Chris Forbese8ba09a2017-06-01 17:39:02 -07004752 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004753 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004754
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004755 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06004756 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004757 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
4758 skip |=
4759 ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004760
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004761 // Validate that SRC image & DST buffer have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004762 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004763 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
4764 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004765 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004766 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
4767 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06004768 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004769 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImageToBuffer()",
4770 "VUID-vkCmdCopyImageToBuffer-srcImage-01998",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06004771 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04004772 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004773 skip |= InsideRenderPass(cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06004774 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004775 const char *src_invalid_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
4776 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
4777 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004778 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004779 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
Cort Strattond619a302018-05-17 19:46:32 -07004780 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004781 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07004782 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
4783 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004784 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
4785 cb_node, src_image_state, &pRegions[i], i, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
4786 skip |=
4787 ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyImageToBuffer()",
4788 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
4789 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07004790 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
4791 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004792 }
4793 return skip;
4794}
4795
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004796void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4797 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004798 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004799 auto src_image_state = GetImageState(srcImage);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004800 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004801
John Zulauff660ad62019-03-23 07:16:05 -06004802 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004803 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06004804 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004805 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004806 // Update bindings between buffer/image and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004807 AddCommandBufferBindingImage(cb_node, src_image_state);
4808 AddCommandBufferBindingBuffer(cb_node, dst_buffer_state);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004809}
4810
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004811bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
4812 VkImageLayout dstImageLayout, uint32_t regionCount,
4813 const VkBufferImageCopy *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004814 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004815 auto src_buffer_state = GetBufferState(srcBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004816 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004817
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004818 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004819
4820 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004821 skip |= ValidateCmd(cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004822
4823 // Command pool must support graphics, compute, or transfer operations
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -07004824 auto pPool = GetCommandPoolNode(cb_node->createInfo.commandPool);
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004825 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004826 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4827 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 -06004828 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004829 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004830 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004831 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004832 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004833 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Chris Forbese8ba09a2017-06-01 17:39:02 -07004834 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004835 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004836 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06004837 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004838 skip |=
4839 ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
4840 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004841 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004842 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
4843 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004844 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004845 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
4846 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06004847 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004848 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyBufferToImage()",
4849 "VUID-vkCmdCopyBufferToImage-dstImage-01997",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06004850 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04004851 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004852 skip |= InsideRenderPass(cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06004853 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004854 const char *dst_invalid_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
4855 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
4856 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004857 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004858 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
Cort Strattond619a302018-05-17 19:46:32 -07004859 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004860 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07004861 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
4862 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004863 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
4864 cb_node, dst_image_state, &pRegions[i], i, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
4865 skip |=
4866 ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyBufferToImage()",
4867 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
4868 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07004869 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
4870 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004871 }
4872 return skip;
4873}
4874
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004875void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
4876 VkImageLayout dstImageLayout, uint32_t regionCount,
4877 const VkBufferImageCopy *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004878 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004879 auto src_buffer_state = GetBufferState(srcBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004880 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004881
John Zulauff660ad62019-03-23 07:16:05 -06004882 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004883 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06004884 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004885 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004886 AddCommandBufferBindingBuffer(cb_node, src_buffer_state);
4887 AddCommandBufferBindingImage(cb_node, dst_image_state);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004888}
Mike Weiblen672b58b2017-02-21 14:32:53 -07004889
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004890bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
4891 VkSubresourceLayout *pLayout) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004892 bool skip = false;
4893 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
4894
Dave Houlton1d960ff2018-01-19 12:17:05 -07004895 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07004896 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
4897 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
4898 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004899 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 -06004900 "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004901 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004902 }
4903
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004904 IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004905 if (!image_entry) {
4906 return skip;
4907 }
4908
Dave Houlton1d960ff2018-01-19 12:17:05 -07004909 // image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
Mike Weiblen672b58b2017-02-21 14:32:53 -07004910 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004911 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4912 "VUID-vkGetImageSubresourceLayout-image-00996",
4913 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004914 }
4915
Dave Houlton1d960ff2018-01-19 12:17:05 -07004916 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004917 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004918 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4919 "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
4920 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
4921 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004922 }
4923
Dave Houlton1d960ff2018-01-19 12:17:05 -07004924 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004925 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004926 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4927 "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
4928 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
4929 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004930 }
4931
Dave Houlton1d960ff2018-01-19 12:17:05 -07004932 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07004933 const VkFormat img_format = image_entry->createInfo.format;
Dave Houlton1d960ff2018-01-19 12:17:05 -07004934 if (FormatIsMultiplane(img_format)) {
4935 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06004936 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07004937 if (FormatPlaneCount(img_format) > 2u) {
4938 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
Dave Houltond8ed0212018-05-16 17:18:24 -06004939 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07004940 }
4941 if (sub_aspect != (sub_aspect & allowed_flags)) {
4942 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 -06004943 HandleToUint64(image), vuid,
Dave Houlton1d960ff2018-01-19 12:17:05 -07004944 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004945 ") must be a single-plane specifier flag.",
4946 sub_aspect);
Dave Houlton1d960ff2018-01-19 12:17:05 -07004947 }
4948 } else if (FormatIsColor(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004949 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Dave Houlton852287e2018-01-19 15:11:51 -07004950 skip |= log_msg(
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004951 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
Dave Houltond8ed0212018-05-16 17:18:24 -06004952 "VUID-VkImageSubresource-aspectMask-parameter",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004953 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004954 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004955 } else if (FormatIsDepthOrStencil(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004956 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06004957 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 -06004958 HandleToUint64(image), "VUID-VkImageSubresource-aspectMask-parameter",
Mike Weiblen672b58b2017-02-21 14:32:53 -07004959 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004960 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004961 }
4962 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004963
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004964 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07004965 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004966 }
4967
Mike Weiblen672b58b2017-02-21 14:32:53 -07004968 return skip;
4969}