blob: 5ef45ab53cc975a178089a5290a5cdf97c427068 [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 Lobodzinski60e79032019-03-07 10:22:31 -0700148 if (GetDeviceExtensions()->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 Lobodzinski60e79032019-03-07 10:22:31 -0700202 if (GetDeviceExtensions()->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 Lobodzinski60e79032019-03-07 10:22:31 -0700258 if (GetDeviceExtensions()->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
John Zulauff660ad62019-03-23 07:16:05 -0600290void CoreChecks::SetImageLayout(GLOBAL_CB_NODE *cb_node, const IMAGE_STATE &image_state,
291 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
301void CoreChecks::SetImageViewInitialLayout(GLOBAL_CB_NODE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
302 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
310void CoreChecks::SetImageInitialLayout(GLOBAL_CB_NODE *cb_node, const IMAGE_STATE &image_state,
311 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
317void CoreChecks::SetImageInitialLayout(GLOBAL_CB_NODE *cb_node, VkImage image, const VkImageSubresourceRange &range,
318 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
324void CoreChecks::SetImageInitialLayout(GLOBAL_CB_NODE *cb_node, const IMAGE_STATE &image_state,
325 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
John Zulauff660ad62019-03-23 07:16:05 -0600330void CoreChecks::SetImageViewLayout(GLOBAL_CB_NODE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
331 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 Lobodzinski60e79032019-03-07 10:22:31 -0700412 if (GetDeviceExtensions()->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 Lobodzinskief4ab2e2019-03-07 13:23:36 -0700445bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, GLOBAL_CB_NODE *pCB,
446 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 }
John Zulauff660ad62019-03-23 07:16:05 -0600460 const auto *const_pCB = static_cast<const GLOBAL_CB_NODE *>(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
496 bool subres_skip = false;
497 auto subresource_cb = [this, i, attachment_initial_layout, &subres_skip](
498 const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
499 LayoutUseCheckAndMessage layout_check(attachment_initial_layout, layout, initial_layout);
500 if (layout_check.CheckFailed()) {
501 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 Lobodzinski8564e442019-03-07 12:49:41 -0700579void CoreChecks::TransitionAttachmentRefLayout(GLOBAL_CB_NODE *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 Lobodzinski8564e442019-03-07 12:49:41 -0700589void CoreChecks::TransitionSubpassLayouts(GLOBAL_CB_NODE *pCB, const RENDER_PASS_STATE *render_pass_state, const int subpass_index,
590 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 Lobodzinski8564e442019-03-07 12:49:41 -0700610void CoreChecks::TransitionBeginRenderPassLayouts(GLOBAL_CB_NODE *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 Lobodzinskief4ab2e2019-03-07 13:23:36 -0700710bool CoreChecks::ValidateBarriersToImages(GLOBAL_CB_NODE 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;
796 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier->subresourceRange);
797 auto subres_callback = [this, img_barrier, cb_state, &subres_skip](
798 const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
799 LayoutUseCheckAndMessage layout_check(img_barrier->oldLayout, layout, initial_layout);
800 if (layout_check.CheckFailed()) {
801 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 Lobodzinski8deebf12019-03-07 11:38:38 -0700820bool CoreChecks::IsReleaseOp(GLOBAL_CB_NODE *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 Lobodzinskidaea5912019-03-07 14:47:09 -0700828bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const char *func_name, GLOBAL_CB_NODE *cb_state, uint32_t barrier_count,
829 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 Lobodzinskidaea5912019-03-07 14:47:09 -0700869void CoreChecks::RecordQFOTransferBarriers(GLOBAL_CB_NODE *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 Lobodzinskidaea5912019-03-07 14:47:09 -0700884bool CoreChecks::ValidateBarriersQFOTransferUniqueness(const char *func_name, GLOBAL_CB_NODE *cb_state, uint32_t bufferBarrierCount,
885 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 Lobodzinskidaea5912019-03-07 14:47:09 -0700894void CoreChecks::RecordBarriersQFOTransfers(GLOBAL_CB_NODE *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 Lobodzinskib56bbb92019-02-18 11:49:59 -0700902bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const GLOBAL_CB_NODE *cb_state,
903 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 Lobodzinskidaea5912019-03-07 14:47:09 -0700921bool CoreChecks::ValidateQueuedQFOTransferBarriers(GLOBAL_CB_NODE *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 Lobodzinskidaea5912019-03-07 14:47:09 -0700969bool CoreChecks::ValidateQueuedQFOTransfers(GLOBAL_CB_NODE *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 Lobodzinskidaea5912019-03-07 14:47:09 -0700979void CoreChecks::RecordQueuedQFOTransferBarriers(GLOBAL_CB_NODE *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 Lobodzinskidaea5912019-03-07 14:47:09 -07001006void CoreChecks::RecordQueuedQFOTransfers(GLOBAL_CB_NODE *cb_state) {
1007 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 Lobodzinski8564e442019-03-07 12:49:41 -07001014void CoreChecks::TransitionImageLayouts(GLOBAL_CB_NODE *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
John Zulauff660ad62019-03-23 07:16:05 -06001049bool CoreChecks::VerifyImageLayout(GLOBAL_CB_NODE 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 Zulaufabcc8292019-04-08 18:07:44 -06001061 auto subresource_cb = [this, explicit_layout, cb_node, layout_mismatch_msg_code, caller, image, aspect_mask, &error,
1062 &subres_skip](const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
1063 LayoutUseCheckAndMessage layout_check(explicit_layout, layout, initial_layout, aspect_mask);
John Zulauff660ad62019-03-23 07:16:05 -06001064 if (layout_check.CheckFailed()) {
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 Lobodzinski60e79032019-03-07 10:22:31 -07001091 } else if (GetDeviceExtensions()->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}
John Zulauff660ad62019-03-23 07:16:05 -06001111bool CoreChecks::VerifyImageLayout(GLOBAL_CB_NODE const *cb_node, IMAGE_STATE *image_state,
1112 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 Lobodzinski8564e442019-03-07 12:49:41 -07001119void CoreChecks::TransitionFinalSubpassLayouts(GLOBAL_CB_NODE *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 Lobodzinskieb8654d2019-03-07 11:14:47 -07001178 auto ahb_formats = GetAHBExternalFormatsSet();
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001179 if ((0 != ext_fmt_android->externalFormat) && (0 == ahb_formats->count(ext_fmt_android->externalFormat))) {
1180 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1181 "VUID-VkExternalFormatANDROID-externalFormat-01894",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001182 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat which has "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001183 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().");
1184 }
1185 }
1186
Dave Houltond9611312018-11-19 17:03:36 -07001187 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001188 if (VK_FORMAT_UNDEFINED == create_info->format) {
1189 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1190 "VUID-VkImageCreateInfo-pNext-01975",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001191 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
Dave Houltond9611312018-11-19 17:03:36 -07001192 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
1193 }
1194 }
1195
1196 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1197 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1198 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001199 skip |=
1200 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1201 "VUID-VkImageCreateInfo-pNext-02393",
1202 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1203 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1204 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001205 }
1206
1207 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
1208 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1209 "VUID-VkImageCreateInfo-pNext-02394",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001210 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
Dave Houltond9611312018-11-19 17:03:36 -07001211 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1212 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1213 create_info->mipLevels, FullMipChainLevels(create_info->extent));
1214 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001215 }
1216
1217 return skip;
1218}
1219
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001220void CoreChecks::RecordCreateImageANDROID(const VkImageCreateInfo *create_info, IMAGE_STATE *is_node) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001221 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1222 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1223 is_node->imported_ahb = true;
1224 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001225 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
egdaniel1f4d2a42019-02-04 10:25:38 -05001226 if (ext_fmt_android && (0 != ext_fmt_android->externalFormat)) {
Dave Houltond3e046d2018-11-28 13:08:09 -07001227 is_node->has_ahb_format = true;
1228 is_node->ahb_format = ext_fmt_android->externalFormat;
1229 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001230}
1231
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001232bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001233 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001234 IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001235
1236 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001237 if (VK_FORMAT_UNDEFINED != create_info->format) {
1238 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1239 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02399",
1240 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1241 "format member is %s.",
1242 string_VkFormat(create_info->format));
1243 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001244
Dave Houltond9611312018-11-19 17:03:36 -07001245 // Chain must include a compatible ycbcr conversion
1246 bool conv_found = false;
1247 uint64_t external_format = 0;
1248 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1249 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001250 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskieb8654d2019-03-07 11:14:47 -07001251 auto fmap = GetYcbcrConversionFormatMap();
Dave Houltond9611312018-11-19 17:03:36 -07001252 if (fmap->find(conv_handle) != fmap->end()) {
1253 conv_found = true;
1254 external_format = fmap->at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001255 }
Dave Houltond9611312018-11-19 17:03:36 -07001256 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001257 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001258 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 -07001259 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02400",
1260 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1261 "without a chained VkSamplerYcbcrConversionInfo struct with the same external format.");
1262 }
1263
1264 // Errors in create_info swizzles
1265 if ((create_info->components.r != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1266 (create_info->components.g != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1267 (create_info->components.b != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1268 (create_info->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
1269 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1270 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02401",
1271 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1272 "includes one or more non-identity component swizzles.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001273 }
1274 }
Dave Houltond9611312018-11-19 17:03:36 -07001275
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001276 return skip;
1277}
1278
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001279bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001280 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001281
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001282 IMAGE_STATE *image_state = GetImageState(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001283 if (image_state->imported_ahb && (0 == image_state->GetBoundMemory().size())) {
1284 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
1285 "VUID-vkGetImageSubresourceLayout-image-01895",
Graeme Leese79b60cb2018-11-28 11:51:20 +00001286 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001287 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1288 "bound to memory.");
1289 }
1290 return skip;
1291}
1292
1293#else
1294
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001295bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001296 return false;
1297}
1298
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001299void CoreChecks::RecordCreateImageANDROID(const VkImageCreateInfo *create_info, IMAGE_STATE *is_node) {}
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001300
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001301bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001302
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001303bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001304
1305#endif // VK_USE_PLATFORM_ANDROID_KHR
1306
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001307bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1308 const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001309 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001310
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001311 if (GetDeviceExtensions()->vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001312 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001313 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1314 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
1315 return log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1316 "VUID-VkImageCreateInfo-format-00943",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001317 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001318 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001319 }
1320
Dave Houlton130c0212018-01-29 13:39:56 -07001321 if ((pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) && (VK_IMAGE_TYPE_2D != pCreateInfo->imageType)) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001322 skip |= log_msg(
1323 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1324 "VUID-VkImageCreateInfo-flags-00949",
1325 "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 -07001326 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001327
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001328 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001329 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1330 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1331 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001332 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 +00001333 "VUID-VkImageCreateInfo-usage-00964",
1334 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1335 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001336 }
1337
1338 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001339 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 +00001340 "VUID-VkImageCreateInfo-usage-00965",
1341 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1342 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001343 }
1344
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001345 VkImageFormatProperties format_limits = {};
Mark Lobodzinski5c048802019-03-07 10:47:31 -07001346 VkResult res = GetPDImageFormatProperties(pCreateInfo, &format_limits);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001347 if (res == VK_ERROR_FORMAT_NOT_SUPPORTED) {
1348 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1349 "vkCreateImage(): Format %s is not supported for this combination of parameters.",
1350 string_VkFormat(pCreateInfo->format));
1351 } else {
1352 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1353 const char *format_string = string_VkFormat(pCreateInfo->format);
1354 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1355 "VUID-VkImageCreateInfo-mipLevels-02255",
1356 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1357 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
1358 }
Dave Houlton130c0212018-01-29 13:39:56 -07001359
Dave Houltona585d132019-01-18 13:05:42 -07001360 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1361 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1362 (uint64_t)pCreateInfo->samples;
1363 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * texel_count);
Dave Houlton130c0212018-01-29 13:39:56 -07001364
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001365 // Round up to imageGranularity boundary
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001366 VkDeviceSize imageGranularity = phys_dev_props.limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001367 uint64_t ig_mask = imageGranularity - 1;
1368 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001369
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001370 if (total_size > format_limits.maxResourceSize) {
1371 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1372 kVUID_Core_Image_InvalidFormatLimitsViolation,
1373 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1374 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1375 total_size, format_limits.maxResourceSize);
1376 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001377
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001378 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
1379 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1380 "VUID-VkImageCreateInfo-arrayLayers-02256",
1381 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1382 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
1383 }
1384
Piers Daniell10a5c762019-03-11 12:44:50 -06001385 if (GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion && FormatRequiresYcbcrConversion(pCreateInfo->format) &&
1386 !GetDeviceExtensions()->vk_ext_ycbcr_image_arrays && pCreateInfo->arrayLayers > 1) {
1387 skip |= log_msg(
1388 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1389 "VUID-VkImageCreateInfo-format-02653",
1390 "vkCreateImage(): arrayLayers=%d exceeds the maximum allowed of 1 for formats requiring sampler ycbcr conversion",
1391 pCreateInfo->arrayLayers);
1392 }
1393
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001394 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
1395 skip |=
1396 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1397 "VUID-VkImageCreateInfo-samples-02258", "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001398 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001399 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001400 }
1401
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001402 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures()->core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001403 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 -06001404 "VUID-VkImageCreateInfo-flags-01924",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001405 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
1406 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06001407 }
1408
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001409 if (GetDeviceExtensions()->vk_khr_maintenance2) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06001410 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
1411 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
1412 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
1413 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001414 skip |=
1415 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1416 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1417 "format must be block, ETC or ASTC compressed, but is %s",
1418 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001419 }
1420 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
1421 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001422 skip |=
1423 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1424 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1425 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001426 }
1427 }
1428 }
1429
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001430 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001431 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateImage",
1432 "pCreateInfo->pQueueFamilyIndices", "VUID-VkImageCreateInfo-sharingMode-01420",
1433 "VUID-VkImageCreateInfo-sharingMode-01420", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001434 }
1435
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001436 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001437}
1438
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001439void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1440 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07001441 if (VK_SUCCESS != result) return;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001442 IMAGE_LAYOUT_NODE image_state;
1443 image_state.layout = pCreateInfo->initialLayout;
1444 image_state.format = pCreateInfo->format;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001445 IMAGE_STATE *is_node = new IMAGE_STATE(*pImage, pCreateInfo);
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001446 if (GetDeviceExtensions()->vk_android_external_memory_android_hardware_buffer) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001447 RecordCreateImageANDROID(pCreateInfo, is_node);
1448 }
Mark Lobodzinski34e04bf2019-04-19 13:31:53 -06001449 imageMap.insert(std::make_pair(*pImage, std::unique_ptr<IMAGE_STATE>(is_node)));
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001450 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001451 imageSubresourceMap[*pImage].push_back(subpair);
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -06001452 imageLayoutMap[subpair] = image_state;
1453 imageLayoutMap[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001454}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001455
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001456bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001457 IMAGE_STATE *image_state = GetImageState(image);
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001458 const VK_OBJECT obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001459 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001460 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001461 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001462 }
1463 return skip;
1464}
1465
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001466void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidfa64112019-03-04 12:17:24 -07001467 if (!image) return;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001468 IMAGE_STATE *image_state = GetImageState(image);
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001469 VK_OBJECT obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001470 InvalidateCommandBuffers(image_state->cb_bindings, obj_struct);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001471 // Clean up memory mapping, bindings and range references for image
1472 for (auto mem_binding : image_state->GetBoundMemory()) {
Mark Lobodzinski97f83f72019-03-07 10:01:52 -07001473 auto mem_info = GetMemObjInfo(mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001474 if (mem_info) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001475 RemoveImageMemoryRange(obj_struct.handle, mem_info);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001476 }
1477 }
Mark Lobodzinski97f83f72019-03-07 10:01:52 -07001478 ClearMemoryObjectBindings(obj_struct.handle, kVulkanObjectTypeImage);
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001479 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001480 // Remove image from imageMap
Mark Lobodzinski34e04bf2019-04-19 13:31:53 -06001481 imageMap.erase(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001482
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001483 const auto &sub_entry = imageSubresourceMap.find(image);
1484 if (sub_entry != imageSubresourceMap.end()) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001485 for (const auto &pair : sub_entry->second) {
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -06001486 imageLayoutMap.erase(pair);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001487 }
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001488 imageSubresourceMap.erase(sub_entry);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001489 }
1490}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001491
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001492bool CoreChecks::ValidateImageAttributes(IMAGE_STATE *image_state, VkImageSubresourceRange range) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001493 bool skip = false;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001494
1495 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
1496 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
1497 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 -06001498 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001499 }
1500
Dave Houlton1d2022c2017-03-29 11:43:58 -06001501 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001502 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
1503 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 -06001504 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -06001505 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001506 char const str[] = "vkCmdClearColorImage called with compressed image.";
1507 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 -06001508 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001509 }
1510
1511 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
1512 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
1513 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 -06001514 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00002", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001515 }
1516 return skip;
1517}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001518
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001519uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1520 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1521 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001522 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001523 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001524 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001525 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001526}
1527
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001528uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1529 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1530 uint32_t array_layer_count = range->layerCount;
1531 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1532 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001533 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001534 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001535}
1536
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001537bool CoreChecks::VerifyClearImageLayout(GLOBAL_CB_NODE *cb_node, IMAGE_STATE *image_state, VkImageSubresourceRange range,
1538 VkImageLayout dest_image_layout, const char *func_name) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001539 bool skip = false;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001540
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001541 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
1542 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001543 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1544 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001545 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 -06001546 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001547 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
1548 }
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001549 } else if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR == dest_image_layout) {
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001550 if (!GetDeviceExtensions()->vk_khr_shared_presentable_image) {
Tobin Ehlisfb0661c2017-05-11 08:52:51 -06001551 // TODO: Add unique error id when available.
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001552 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 -06001553 HandleToUint64(image_state->image), 0,
Dave Houlton33c2d252017-06-09 17:08:32 -06001554 "Must enable VK_KHR_shared_presentable_image extension before creating images with a layout type "
1555 "of VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.");
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001556
1557 } else {
1558 if (image_state->shared_presentable) {
1559 skip |= log_msg(
1560 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001561 HandleToUint64(image_state->image), 0,
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001562 "Layout for shared presentable cleared image is %s but can only be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1563 string_VkImageLayout(dest_image_layout));
1564 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001565 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001566 } else {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06001567 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00005";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001568 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001569 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00012";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001570 } else {
1571 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1572 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001573 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 -06001574 HandleToUint64(image_state->image), error_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001575 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1576 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001577 }
1578 }
1579
John Zulauff660ad62019-03-23 07:16:05 -06001580 // Cast to const to prevent creation at validate time.
1581 const auto *subresource_map = GetImageSubresourceLayoutMap(static_cast<const GLOBAL_CB_NODE *>(cb_node), image_state->image);
1582 if (subresource_map) {
1583 bool subres_skip = false;
1584 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
1585 auto subres_callback = [this, cb_node, dest_image_layout, func_name, &subres_skip](
1586 const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
1587 LayoutUseCheckAndMessage layout_check(dest_image_layout, layout, initial_layout);
1588 if (layout_check.CheckFailed()) {
1589 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
1590 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1591 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
1592 } else {
1593 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001594 }
John Zulauff660ad62019-03-23 07:16:05 -06001595 subres_skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1596 HandleToUint64(cb_node->commandBuffer), error_code,
1597 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
1598 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
1599 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001600 }
John Zulauff660ad62019-03-23 07:16:05 -06001601 return !subres_skip;
1602 };
1603 subresource_map->ForRange(normalized_isr, subres_callback);
1604 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001605 }
1606
1607 return skip;
1608}
1609
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001610bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1611 const VkClearColorValue *pColor, uint32_t rangeCount,
1612 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001613 bool skip = false;
1614 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07001615 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001616 auto image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001617 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001618 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001619 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001620 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001621 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski96d5c6e2019-03-07 11:28:21 -07001622 if (GetApiVersion() >= VK_API_VERSION_1_1 || GetDeviceExtensions()->vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001623 skip |=
1624 ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
1625 "VUID-vkCmdClearColorImage-image-01993", "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001626 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001627 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001628 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001629 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001630 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001631 skip |= ValidateImageAttributes(image_state, pRanges[i]);
1632 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001633 }
1634 }
1635 return skip;
1636}
1637
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001638void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1639 const VkClearColorValue *pColor, uint32_t rangeCount,
1640 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07001641 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001642 auto image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001643 if (cb_node && image_state) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001644 AddCommandBufferBindingImage(cb_node, image_state);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001645 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001646 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001647 }
1648 }
1649}
1650
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001651bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1652 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1653 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001654 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001655
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001656 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07001657 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001658 auto image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001659 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001660 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06001661 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001662 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001663 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001664 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski96d5c6e2019-03-07 11:28:21 -07001665 if (GetApiVersion() >= VK_API_VERSION_1_1 || GetDeviceExtensions()->vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001666 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
1667 "VUID-vkCmdClearDepthStencilImage-image-01994",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001668 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001669 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001670 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001671 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001672 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001673 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001674 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001675 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001676 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1677 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001678 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001679 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1680 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001681 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 -06001682 HandleToUint64(commandBuffer), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001683 }
1684 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001685 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001686 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001687 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 -06001688 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00014", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001689 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001690 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1691 char const str[] =
1692 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1693 "set.";
1694 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 -06001695 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00009", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001696 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001697 }
1698 return skip;
1699}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001700
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001701void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1702 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1703 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07001704 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001705 auto image_state = GetImageState(image);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001706 if (cb_node && image_state) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001707 AddCommandBufferBindingImage(cb_node, image_state);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001708 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001709 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001710 }
1711 }
1712}
1713
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001714// Returns true if [x, xoffset] and [y, yoffset] overlap
1715static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1716 bool result = false;
1717 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1718 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1719
1720 if (intersection_max > intersection_min) {
1721 result = true;
1722 }
1723 return result;
1724}
1725
Dave Houltonc991cc92018-03-06 11:08:51 -07001726// Returns true if source area of first copy region intersects dest area of second region
1727// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1728static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001729 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001730
Dave Houltonc991cc92018-03-06 11:08:51 -07001731 // Separate planes within a multiplane image cannot intersect
1732 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07001733 return result;
1734 }
1735
Dave Houltonc991cc92018-03-06 11:08:51 -07001736 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
1737 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
1738 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001739 result = true;
1740 switch (type) {
1741 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001742 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001743 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001744 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001745 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001746 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001747 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001748 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001749 break;
1750 default:
1751 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1752 assert(false);
1753 }
1754 }
1755 return result;
1756}
1757
Dave Houltonfc1a4052017-04-27 14:32:45 -06001758// Returns non-zero if offset and extent exceed image extents
1759static const uint32_t x_bit = 1;
1760static const uint32_t y_bit = 2;
1761static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001762static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001763 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001764 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001765 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1766 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001767 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001768 }
1769 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1770 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001771 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001772 }
1773 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1774 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001775 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001776 }
1777 return result;
1778}
1779
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001780// Test if two VkExtent3D structs are equivalent
1781static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1782 bool result = true;
1783 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1784 (extent->depth != other_extent->depth)) {
1785 result = false;
1786 }
1787 return result;
1788}
1789
Dave Houltonee281a52017-12-08 13:51:02 -07001790// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1791// Destination image texel extents must be adjusted by block size for the dest validation checks
1792VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1793 VkExtent3D adjusted_extent = extent;
1794 if ((FormatIsCompressed(src_format) && (!FormatIsCompressed(dst_format)))) {
Dave Houltona585d132019-01-18 13:05:42 -07001795 VkExtent3D block_size = FormatTexelBlockExtent(src_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001796 adjusted_extent.width /= block_size.width;
1797 adjusted_extent.height /= block_size.height;
1798 adjusted_extent.depth /= block_size.depth;
1799 } else if ((!FormatIsCompressed(src_format) && (FormatIsCompressed(dst_format)))) {
Dave Houltona585d132019-01-18 13:05:42 -07001800 VkExtent3D block_size = FormatTexelBlockExtent(dst_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001801 adjusted_extent.width *= block_size.width;
1802 adjusted_extent.height *= block_size.height;
1803 adjusted_extent.depth *= block_size.depth;
1804 }
1805 return adjusted_extent;
1806}
1807
Dave Houlton6f9059e2017-05-02 17:15:13 -06001808// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001809static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1810 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001811
1812 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06001813 if (mip >= img->createInfo.mipLevels) {
1814 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06001815 }
Dave Houlton1150cf52017-04-27 14:38:11 -06001816
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001817 // 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 -06001818 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05001819
Dave Houltone48cd112019-01-03 17:01:18 -07001820 // If multi-plane, adjust per-plane extent
1821 if (FormatIsMultiplane(img->createInfo.format)) {
1822 VkExtent2D divisors = FindMultiplaneExtentDivisors(img->createInfo.format, subresource->aspectMask);
1823 extent.width /= divisors.width;
1824 extent.height /= divisors.height;
1825 }
1826
Jeff Bolzef40fec2018-09-01 22:04:34 -05001827 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
1828 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
Dave Houlton142c4cb2018-10-17 15:04:41 -06001829 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1) >> mip)));
Jeff Bolzef40fec2018-09-01 22:04:34 -05001830 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
1831 } else {
1832 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1833 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1834 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
1835 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06001836
Dave Houlton6f9059e2017-05-02 17:15:13 -06001837 // Image arrays have an effective z extent that isn't diminished by mip level
1838 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001839 extent.depth = img->createInfo.arrayLayers;
1840 }
1841
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001842 return extent;
1843}
1844
1845// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001846static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001847 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1848}
1849
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001850// Test if the extent argument has any dimensions set to 0.
1851static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1852 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1853}
1854
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001855// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001856VkExtent3D CoreChecks::GetScaledItg(const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001857 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1858 VkExtent3D granularity = {0, 0, 0};
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -07001859 auto pPool = GetCommandPoolNode(cb_node->createInfo.commandPool);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001860 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001861 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001862 if (FormatIsCompressed(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07001863 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001864 granularity.width *= block_size.width;
1865 granularity.height *= block_size.height;
1866 }
1867 }
1868 return granularity;
1869}
1870
1871// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1872static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1873 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001874 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
1875 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001876 valid = false;
1877 }
1878 return valid;
1879}
1880
1881// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001882bool CoreChecks::CheckItgOffset(const GLOBAL_CB_NODE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
1883 const uint32_t i, const char *function, const char *member, const char *vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001884 bool skip = false;
1885 VkExtent3D offset_extent = {};
1886 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1887 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1888 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001889 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001890 // 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 -07001891 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001892 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 -04001893 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001894 "%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 "
1895 "image transfer granularity is (w=0, h=0, d=0).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001896 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001897 }
1898 } else {
1899 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1900 // integer multiples of the image transfer granularity.
1901 if (IsExtentAligned(&offset_extent, granularity) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001902 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 -04001903 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001904 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
1905 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001906 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
1907 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001908 }
1909 }
1910 return skip;
1911}
1912
1913// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001914bool CoreChecks::CheckItgExtent(const GLOBAL_CB_NODE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
1915 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
1916 const uint32_t i, const char *function, const char *member, const char *vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001917 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001918 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001919 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
1920 // subresource extent.
1921 if (IsExtentEqual(extent, subresource_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001922 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 -04001923 HandleToUint64(cb_node->commandBuffer), vuid,
Petr Krausbc7f5442017-05-14 23:43:38 +02001924 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
1925 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1926 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
1927 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001928 }
1929 } else {
1930 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
1931 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
1932 // subresource extent dimensions.
1933 VkExtent3D offset_extent_sum = {};
1934 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
1935 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
1936 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001937 bool x_ok = true;
1938 bool y_ok = true;
1939 bool z_ok = true;
1940 switch (image_type) {
1941 case VK_IMAGE_TYPE_3D:
1942 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
1943 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001944 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001945 case VK_IMAGE_TYPE_2D:
1946 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
1947 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001948 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001949 case VK_IMAGE_TYPE_1D:
1950 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
1951 (subresource_extent->width == offset_extent_sum.width));
1952 break;
1953 default:
1954 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1955 assert(false);
1956 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06001957 if (!(x_ok && y_ok && z_ok)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001958 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 -04001959 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001960 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
1961 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
1962 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
1963 function, i, member, extent->width, extent->height, extent->depth, granularity->width,
1964 granularity->height, granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height,
1965 extent->depth, subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001966 }
1967 }
1968 return skip;
1969}
1970
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001971bool CoreChecks::ValidateImageMipLevel(const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img, uint32_t mip_level, const uint32_t i,
1972 const char *function, const char *member, const char *vuid) {
Cort Strattonff1542a2018-05-27 10:49:28 -07001973 bool skip = false;
1974 if (mip_level >= img->createInfo.mipLevels) {
1975 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1976 HandleToUint64(cb_node->commandBuffer), vuid,
Lockee9aeebf2019-03-03 23:50:08 -07001977 "In %s, pRegions[%u].%s.mipLevel is %u, but provided image %s has %u mip levels.", function, i, member,
1978 mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07001979 }
1980 return skip;
1981}
1982
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001983bool CoreChecks::ValidateImageArrayLayerRange(const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
1984 const uint32_t layer_count, const uint32_t i, const char *function,
1985 const char *member, const char *vuid) {
Cort Strattonff1542a2018-05-27 10:49:28 -07001986 bool skip = false;
1987 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
1988 (base_layer + layer_count) > img->createInfo.arrayLayers) {
1989 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1990 HandleToUint64(cb_node->commandBuffer), vuid,
1991 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
Lockee9aeebf2019-03-03 23:50:08 -07001992 "%u, but provided image %s has %u array layers.",
1993 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
1994 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07001995 }
1996 return skip;
1997}
1998
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07001999// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002000bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img,
2001 const VkBufferImageCopy *region, const uint32_t i,
2002 const char *function, const char *vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002003 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002004 VkExtent3D granularity = GetScaledItg(cb_node, img);
2005 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002006 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002007 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002008 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002009 return skip;
2010}
2011
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002012// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002013bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *src_img,
2014 const IMAGE_STATE *dst_img, const VkImageCopy *region,
2015 const uint32_t i, const char *function) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002016 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002017 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002018 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
2019 skip |=
2020 CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002021 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002022 const VkExtent3D extent = region->extent;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002023 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
2024 i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002025
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002026 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002027 granularity = GetScaledItg(cb_node, dst_img);
2028 skip |=
2029 CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002030 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002031 const VkExtent3D dest_effective_extent =
2032 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002033 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002034 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002035 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002036 return skip;
2037}
2038
Dave Houlton6f9059e2017-05-02 17:15:13 -06002039// Validate contents of a VkImageCopy struct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002040bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const VkImageCopy *ic_regions, const IMAGE_STATE *src_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002041 const IMAGE_STATE *dst_state) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002042 bool skip = false;
2043
2044 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002045 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002046
2047 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002048 const VkExtent3D src_copy_extent = region.extent;
2049 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002050 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2051
Dave Houlton6f9059e2017-05-02 17:15:13 -06002052 bool slice_override = false;
2053 uint32_t depth_slices = 0;
2054
2055 // Special case for copying between a 1D/2D array and a 3D image
2056 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2057 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002058 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002059 slice_override = (depth_slices != 1);
2060 } 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 -07002061 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002062 slice_override = (depth_slices != 1);
2063 }
2064
2065 // Do all checks on source image
2066 //
2067 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002068 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
2069 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 -06002070 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00146",
Dave Houltonee281a52017-12-08 13:51:02 -07002071 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002072 "be 0 and 1, respectively.",
2073 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002074 }
2075 }
2076
Dave Houlton533be9f2018-03-26 17:08:30 -06002077 // VUID-VkImageCopy-srcImage-01785
2078 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
2079 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 -06002080 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01785",
Dave Houlton533be9f2018-03-26 17:08:30 -06002081 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002082 "these must be 0 and 1, respectively.",
2083 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002084 }
2085
Dave Houlton533be9f2018-03-26 17:08:30 -06002086 // VUID-VkImageCopy-srcImage-01787
2087 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
2088 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 -06002089 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01787",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002090 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2091 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002092 }
2093
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002094 if (GetDeviceExtensions()->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002095 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002096 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002097 skip |=
2098 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002099 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002100 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002101 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2102 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002103 }
2104 }
2105 } else { // Pre maint 1
2106 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002107 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002108 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 -06002109 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002110 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2111 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002112 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2113 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002114 }
2115 }
2116 }
2117
Dave Houltonc991cc92018-03-06 11:08:51 -07002118 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002119 bool ext_ycbcr = GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion;
Dave Houltonc991cc92018-03-06 11:08:51 -07002120 if (FormatIsCompressed(src_state->createInfo.format) ||
2121 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002122 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002123 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002124 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2125 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2126 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002127 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002128 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 -07002129 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002130 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002131 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002132 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002133 }
2134
Dave Houlton94a00372017-12-14 15:08:47 -07002135 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002136 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2137 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002138 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002139 skip |=
2140 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002141 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002142 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002143 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002144 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002145 }
2146
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002147 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002148 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2149 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002150 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002151 skip |=
2152 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002153 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002154 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002155 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002156 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002157 }
2158
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002159 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002160 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2161 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002162 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002163 skip |=
2164 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002165 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002166 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002167 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002168 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002169 }
2170 } // Compressed
2171
2172 // Do all checks on dest image
2173 //
2174 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002175 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002176 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 -06002177 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-00152",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002178 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002179 "these must be 0 and 1, respectively.",
2180 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002181 }
2182 }
2183
Dave Houlton533be9f2018-03-26 17:08:30 -06002184 // VUID-VkImageCopy-dstImage-01786
2185 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
2186 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 -06002187 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01786",
Dave Houlton533be9f2018-03-26 17:08:30 -06002188 "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 -06002189 "and 1, respectively.",
2190 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002191 }
2192
2193 // VUID-VkImageCopy-dstImage-01788
2194 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
2195 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 -06002196 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01788",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002197 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2198 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002199 }
2200
2201 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002202 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002203 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 -06002204 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002205 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002206 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2207 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002208 }
2209 }
2210 // VU01199 changed with mnt1
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002211 if (GetDeviceExtensions()->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002212 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002213 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002214 skip |=
2215 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002216 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002217 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002218 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2219 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002220 }
2221 }
2222 } else { // Pre maint 1
2223 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002224 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002225 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 -06002226 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002227 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2228 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002229 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2230 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002231 }
2232 }
2233 }
2234
Dave Houltonc991cc92018-03-06 11:08:51 -07002235 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2236 if (FormatIsCompressed(dst_state->createInfo.format) ||
2237 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002238 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002239
2240 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002241 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2242 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2243 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002244 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002245 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 -07002246 HandleToUint64(dst_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002247 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002248 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002249 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002250 }
2251
Dave Houlton94a00372017-12-14 15:08:47 -07002252 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002253 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2254 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002255 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002256 skip |=
2257 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002258 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002259 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002260 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002261 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002262 }
2263
Dave Houltonee281a52017-12-08 13:51:02 -07002264 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2265 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2266 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002267 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002268 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 -07002269 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002270 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2271 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
Dave Houltonc991cc92018-03-06 11:08:51 -07002272 "height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002273 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002274 }
2275
Dave Houltonee281a52017-12-08 13:51:02 -07002276 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2277 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2278 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002279 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002280 skip |=
2281 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002282 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002283 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002284 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002285 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002286 }
2287 } // Compressed
2288 }
2289 return skip;
2290}
2291
Dave Houltonc991cc92018-03-06 11:08:51 -07002292// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002293bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
2294 const IMAGE_STATE *dst_image_state, const VkImageCopy region) {
Dave Houltonc991cc92018-03-06 11:08:51 -07002295 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002296
2297 // Neither image is multiplane
2298 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2299 // If neither image is multi-plane the aspectMask member of src and dst must match
2300 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2301 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002302 ss << "vkCmdCopyImage(): Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002303 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
2304 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 -06002305 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002306 }
2307 } else {
2308 // Source image multiplane checks
2309 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2310 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2311 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2312 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002313 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002314 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 -06002315 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002316 }
2317 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2318 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2319 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002320 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002321 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 -06002322 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002323 }
2324 // Single-plane to multi-plane
2325 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2326 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2327 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002328 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002329 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 -06002330 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002331 }
2332
2333 // Dest image multiplane checks
2334 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2335 aspect = region.dstSubresource.aspectMask;
2336 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2337 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002338 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002339 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 -06002340 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002341 }
2342 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2343 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2344 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002345 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002346 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 -06002347 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002348 }
2349 // Multi-plane to single-plane
2350 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2351 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2352 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002353 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002354 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 -06002355 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002356 }
2357 }
2358
2359 return skip;
2360}
2361
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002362bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2363 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2364 const VkImageCopy *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002365 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002366 auto src_image_state = GetImageState(srcImage);
2367 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002368 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002369
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002370 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002371
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002372 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2373
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002374 for (uint32_t i = 0; i < regionCount; i++) {
2375 const VkImageCopy region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002376
2377 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2378 VkExtent3D src_copy_extent = region.extent;
2379 VkExtent3D dst_copy_extent =
2380 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
2381
Dave Houlton6f9059e2017-05-02 17:15:13 -06002382 bool slice_override = false;
2383 uint32_t depth_slices = 0;
2384
2385 // Special case for copying between a 1D/2D array and a 3D image
2386 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2387 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2388 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002389 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002390 slice_override = (depth_slices != 1);
2391 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2392 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002393 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002394 slice_override = (depth_slices != 1);
2395 }
2396
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002397 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2398 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
2399 skip |= ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002400 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002401 skip |= ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002402 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002403 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002404 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2405 "VUID-vkCmdCopyImage-srcSubresource-01698");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002406 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002407 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2408 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002409
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002410 if (GetDeviceExtensions()->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002411 // No chance of mismatch if we're overriding depth slice count
2412 if (!slice_override) {
2413 // The number of depth slices in srcSubresource and dstSubresource must match
2414 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2415 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002416 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2417 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002418 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002419 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2420 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002421 if (src_slices != dst_slices) {
2422 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002423 ss << "vkCmdCopyImage(): number of depth slices in source and destination subresources for pRegions[" << i
Dave Houlton6f9059e2017-05-02 17:15:13 -06002424 << "] do not match";
2425 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002426 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06002427 }
2428 }
2429 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002430 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002431 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002432 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002433 ss << "vkCmdCopyImage(): number of layers in source and destination subresources for pRegions[" << i
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002434 << "] do not match";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002435 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 -06002436 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002437 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002438 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002439
Dave Houltonc991cc92018-03-06 11:08:51 -07002440 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002441 if (GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002442 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region);
Dave Houltonc991cc92018-03-06 11:08:51 -07002443 }
2444
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002445 if (!GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002446 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2447 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002448 char const str[] = "vkCmdCopyImage(): Src and dest aspectMasks for each region must match";
Dave Houltonf5217612018-02-02 16:18:52 -07002449 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 -06002450 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002451 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002452 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002453
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002454 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07002455 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002456 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002457 ss << "vkCmdCopyImage(): pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002458 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
2459 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 -06002460 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002461 }
2462
2463 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07002464 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002465 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002466 ss << "vkCmdCopyImage(): pRegion[" << i
2467 << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002468 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 -06002469 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002470 }
2471
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002472 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
2473 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
2474 // 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 -07002475 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2476 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002477 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002478 ss << "vkCmdCopyImage(): Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002479 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
2480 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
2481 << " ] exceeds the source image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002482 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 -06002483 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00122", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002484 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002485
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002486 // 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 -07002487 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2488 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002489 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002490 ss << "vkCmdCopyImage(): Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002491 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
2492 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
2493 << " ] exceeds the destination image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002494 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 -06002495 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00123", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002496 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002497 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002498
Dave Houltonfc1a4052017-04-27 14:32:45 -06002499 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002500 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2501 if (slice_override) src_copy_extent.depth = depth_slices;
2502 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002503 if (extent_check & x_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002504 skip |=
2505 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2506 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00144",
2507 "vkCmdCopyImage(): Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2508 "width [%1d].",
2509 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002510 }
2511
2512 if (extent_check & y_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002513 skip |=
2514 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2515 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00145",
2516 "vkCmdCopyImage(): Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2517 "height [%1d].",
2518 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002519 }
2520 if (extent_check & z_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002521 skip |=
2522 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2523 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00147",
2524 "vkCmdCopyImage(): Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2525 "depth [%1d].",
2526 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002527 }
2528
Dave Houltonee281a52017-12-08 13:51:02 -07002529 // Adjust dest extent if necessary
2530 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2531 if (slice_override) dst_copy_extent.depth = depth_slices;
2532
2533 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002534 if (extent_check & x_bit) {
2535 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002536 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00150",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002537 "vkCmdCopyImage(): Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002538 "width [%1d].",
2539 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002540 }
2541 if (extent_check & y_bit) {
2542 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 -06002543 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00151",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002544 "vkCmdCopyImage(): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002545 "height [%1d].",
2546 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002547 }
2548 if (extent_check & z_bit) {
2549 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 -06002550 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00153",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002551 "vkCmdCopyImage(): Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002552 "depth [%1d].",
2553 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002554 }
2555
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002556 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2557 // must not overlap in memory
2558 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002559 for (uint32_t j = 0; j < regionCount; j++) {
2560 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
Dave Houltonf5217612018-02-02 16:18:52 -07002561 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002562 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002563 ss << "vkCmdCopyImage(): pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002564 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 -06002565 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002566 }
2567 }
2568 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002569 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002570
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002571 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2572 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2573 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002574 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002575 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2576 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02002577 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 -06002578 HandleToUint64(command_buffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002579 }
2580 } else {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002581 if (!FormatSizesAreEqual(src_image_state->createInfo.format, dst_image_state->createInfo.format, regionCount, pRegions)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002582 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
2583 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 -06002584 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00135", "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002585 }
2586 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002587
Dave Houlton33c22b72017-02-28 13:16:02 -07002588 // Source and dest image sample counts must match
2589 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2590 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
2591 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002592 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002593 }
2594
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002595 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2596 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002597 // Validate that SRC & DST images have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002598 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyImage-srcImage-00126",
2599 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2600 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyImage-dstImage-00131",
2601 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski96d5c6e2019-03-07 11:28:21 -07002602 if (GetApiVersion() >= VK_API_VERSION_1_1 || GetDeviceExtensions()->vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002603 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
2604 "VUID-vkCmdCopyImage-srcImage-01995", "VUID-vkCmdCopyImage-srcImage-01995");
2605 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
2606 "VUID-vkCmdCopyImage-dstImage-01996", "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002607 }
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002608 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyImage()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002609 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002610 skip |= ValidateCmd(cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
2611 skip |= InsideRenderPass(cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002612 bool hit_error = false;
Jeff Bolzfdd0d852019-02-03 21:55:12 -06002613 const char *invalid_src_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002614 (src_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Cort Stratton7df30962018-05-17 19:45:57 -07002615 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2616 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
Jeff Bolzfdd0d852019-02-03 21:55:12 -06002617 const char *invalid_dst_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002618 (dst_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Cort Stratton7df30962018-05-17 19:45:57 -07002619 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2620 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002621 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002622 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002623 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2624 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002625 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002626 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2627 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002628 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
2629 "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002630 }
2631
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002632 return skip;
2633}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002634
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002635void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2636 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2637 const VkImageCopy *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002638 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002639 auto src_image_state = GetImageState(srcImage);
2640 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002641
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002642 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002643 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002644 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
2645 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002646 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002647 // Update bindings between images and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002648 AddCommandBufferBindingImage(cb_node, src_image_state);
2649 AddCommandBufferBindingImage(cb_node, dst_image_state);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002650}
2651
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002652// Returns true if sub_rect is entirely contained within rect
2653static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2654 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2655 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2656 return false;
2657 return true;
2658}
2659
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002660bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002661 FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment, const VkRect2D &render_area,
2662 uint32_t rect_count, const VkClearRect *clear_rects) {
John Zulauf3a548ef2019-02-01 16:14:07 -07002663 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07002664 const IMAGE_VIEW_STATE *image_view_state = nullptr;
2665 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07002666 image_view_state = GetImageViewState(framebuffer->createInfo.pAttachments[fb_attachment]);
John Zulauff2582972019-02-09 14:53:30 -07002667 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002668
2669 for (uint32_t j = 0; j < rect_count; j++) {
2670 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002671 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 -07002672 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00016",
2673 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2674 "the current render pass instance.",
2675 j);
2676 }
2677
2678 if (image_view_state) {
2679 // The layers specified by a given element of pRects must be contained within every attachment that
2680 // pAttachments refers to
2681 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
2682 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
2683 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002684 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2685 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00017",
2686 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
2687 "of pAttachment[%d].",
2688 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07002689 }
2690 }
2691 }
2692 return skip;
2693}
2694
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002695bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2696 const VkClearAttachment *pAttachments, uint32_t rectCount,
2697 const VkClearRect *pRects) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002698 GLOBAL_CB_NODE *cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002699
2700 bool skip = false;
2701 if (cb_node) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002702 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002703 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002704 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002705 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
Chris Forbes05375e72017-04-21 13:15:15 -07002706 if (!cb_node->hasDrawCmd && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002707 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
2708 // 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 -07002709 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
2710 // CmdClearAttachments.
Lockee9aeebf2019-03-03 23:50:08 -07002711 skip |=
2712 log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2713 HandleToUint64(commandBuffer), kVUID_Core_DrawState_ClearCmdBeforeDraw,
2714 "vkCmdClearAttachments() issued on command buffer object %s prior to any Draw Cmds. It is recommended you "
2715 "use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
2716 report_data->FormatHandle(commandBuffer).c_str());
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002717 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002718 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002719 }
2720
2721 // Validate that attachment is in reference list of active subpass
2722 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002723 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07002724 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01002725 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
Mark Lobodzinski74772ca2019-03-06 16:15:06 -07002726 auto framebuffer = GetFramebufferState(cb_node->activeFramebuffer);
John Zulauf3a548ef2019-02-01 16:14:07 -07002727 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
2728 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002729
John Zulauf3a548ef2019-02-01 16:14:07 -07002730 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2731 auto clear_desc = &pAttachments[attachment_index];
2732 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002733
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002734 if (0 == clear_desc->aspectMask) {
2735 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 -06002736 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002737 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2738 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002739 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002740 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07002741 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
2742 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
2743 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2744 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Lockee9aeebf2019-03-03 23:50:08 -07002745 skip |= log_msg(
2746 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2747 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
2748 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
2749 "and not a valid attachment for render pass %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
2750 attachment_index, clear_desc->colorAttachment,
2751 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
2752 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
2753
John Zulauff2582972019-02-09 14:53:30 -07002754 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
2755 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002756 } else {
Lockee9aeebf2019-03-03 23:50:08 -07002757 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2758 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
2759 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for render pass %s"
2760 " subpass %u. colorAttachmentCount=%u",
2761 attachment_index, clear_desc->colorAttachment,
2762 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
2763 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002764 }
John Zulauff2582972019-02-09 14:53:30 -07002765 fb_attachment = color_attachment;
2766
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002767 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2768 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2769 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002770 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
John Zulauf3a548ef2019-02-01 16:14:07 -07002771 skip |=
2772 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2773 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002774 }
2775 } else { // Must be depth and/or stencil
2776 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2777 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002778 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002779 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 -07002780 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-parameter", str,
2781 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002782 }
2783 if (!subpass_desc->pDepthStencilAttachment ||
2784 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
2785 skip |= log_msg(
2786 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002787 HandleToUint64(commandBuffer), kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002788 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002789 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07002790 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002791 }
2792 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002793 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002794 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
2795 rectCount, pRects);
John Zulauf3a548ef2019-02-01 16:14:07 -07002796 } else {
2797 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
2798 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
2799 if (!clear_rect_copy) {
2800 // We need a copy of the clear rectangles that will persist until the last lambda executes
2801 // but we want to create it as lazily as possible
2802 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002803 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002804
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002805 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
John Zulauf3a548ef2019-02-01 16:14:07 -07002806 GLOBAL_CB_NODE *prim_cb, VkFramebuffer fb) {
2807 assert(rectCount == clear_rect_copy->size());
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002808 FRAMEBUFFER_STATE *framebuffer = GetFramebufferState(fb);
John Zulauf3a548ef2019-02-01 16:14:07 -07002809 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
2810 bool skip = false;
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002811 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
2812 rectCount, clear_rect_copy->data());
John Zulauf3a548ef2019-02-01 16:14:07 -07002813 return skip;
2814 };
2815 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002816 }
2817 }
2818 }
2819 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002820}
2821
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002822bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2823 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2824 const VkImageResolve *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002825 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002826 auto src_image_state = GetImageState(srcImage);
2827 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002828
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002829 bool skip = false;
2830 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002831 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-srcImage-00256");
2832 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-00258");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002833 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002834 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002835 skip |= ValidateCmd(cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
2836 skip |= InsideRenderPass(cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002837 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, "vkCmdResolveImage()",
2838 "VUID-vkCmdResolveImage-dstImage-02003", "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002839
Cort Stratton7df30962018-05-17 19:45:57 -07002840 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002841 const char *invalid_src_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002842 (src_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002843 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
2844 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
2845 const char *invalid_dst_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002846 (dst_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002847 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
2848 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002849 // For each region, the number of layers in the image subresource should not be zero
2850 // For each region, src and dest image aspect must be color only
2851 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002852 skip |=
2853 ValidateImageSubresourceLayers(cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()", "srcSubresource", i);
2854 skip |=
2855 ValidateImageSubresourceLayers(cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()", "dstSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002856 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002857 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
2858 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002859 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002860 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
2861 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002862 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i, "vkCmdResolveImage()",
2863 "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
2864 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i, "vkCmdResolveImage()",
2865 "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
2866 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002867 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2868 "VUID-vkCmdResolveImage-srcSubresource-01711");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002869 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002870 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2871 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07002872
2873 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002874 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
2875 skip |= log_msg(
2876 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002877 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-layerCount-00267",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002878 "vkCmdResolveImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002879 }
Cort Stratton7df30962018-05-17 19:45:57 -07002880 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002881 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
2882 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
2883 char const str[] =
Graeme Leese79b60cb2018-11-28 11:51:20 +00002884 "vkCmdResolveImage(): src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002885 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 -06002886 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002887 }
2888 }
2889
2890 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2891 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002892 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 -06002893 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002894 }
2895 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
2896 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002897 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 -06002898 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageType, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002899 }
2900 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
2901 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
2902 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 -06002903 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-srcImage-00257", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002904 }
2905 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
2906 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
2907 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 -06002908 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-dstImage-00259", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002909 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002910 } else {
2911 assert(0);
2912 }
2913 return skip;
2914}
2915
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002916void CoreChecks::PreCallRecordCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2917 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2918 const VkImageResolve *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002919 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002920 auto src_image_state = GetImageState(srcImage);
2921 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002922
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002923 // Update bindings between images and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002924 AddCommandBufferBindingImage(cb_node, src_image_state);
2925 AddCommandBufferBindingImage(cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002926}
2927
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002928bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2929 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2930 const VkImageBlit *pRegions, VkFilter filter) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002931 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002932 auto src_image_state = GetImageState(srcImage);
2933 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002934
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002935 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07002936 if (cb_node) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002937 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
John Zulauf5c2750c2018-01-30 15:04:56 -07002938 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002939 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002940 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06002941 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002942 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06002943 "VUID-vkCmdBlitImage-dstImage-00234");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002944 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
2945 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
Dave Houltond8ed0212018-05-16 17:18:24 -06002946 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002947 ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdBlitImage-srcImage-00219",
2948 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06002949 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002950 ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdBlitImage-dstImage-00224",
2951 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002952 skip |=
2953 ValidateCmdQueueFlags(cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002954 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
2955 skip |= InsideRenderPass(cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002956 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002957 "VUID-vkCmdBlitImage-srcImage-01999", "VUID-vkCmdBlitImage-srcImage-01999");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002958 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002959 "VUID-vkCmdBlitImage-dstImage-02000", "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04002960
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002961 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002962
Dave Houlton33c2d252017-06-09 17:08:32 -06002963 VkFormat src_format = src_image_state->createInfo.format;
2964 VkFormat dst_format = dst_image_state->createInfo.format;
2965 VkImageType src_type = src_image_state->createInfo.imageType;
2966 VkImageType dst_type = dst_image_state->createInfo.imageType;
2967
Cort Stratton186b1a22018-05-01 20:18:06 -04002968 if (VK_FILTER_LINEAR == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002969 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002970 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001",
2971 "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04002972 } else if (VK_FILTER_CUBIC_IMG == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002973 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
2974 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02002",
2975 "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06002976 }
2977
2978 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
2979 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 -06002980 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-filter-00237",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002981 "vkCmdBlitImage(): source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06002982 }
2983
Dave Houlton33c2d252017-06-09 17:08:32 -06002984 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
2985 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
2986 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 -06002987 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00228",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002988 "vkCmdBlitImage(): source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT.");
Dave Houlton33c2d252017-06-09 17:08:32 -06002989 }
2990
2991 // Validate consistency for unsigned formats
2992 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
2993 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002994 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06002995 << "the other one must also have unsigned integer format. "
2996 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
2997 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 -06002998 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06002999 }
3000
3001 // Validate consistency for signed formats
3002 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3003 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003004 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003005 << "the other one must also have signed integer format. "
3006 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3007 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 -06003008 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003009 }
3010
3011 // Validate filter for Depth/Stencil formats
3012 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3013 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003014 ss << "vkCmdBlitImage(): If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003015 << "then filter must be VK_FILTER_NEAREST.";
3016 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 -06003017 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003018 }
3019
3020 // Validate aspect bits and formats for depth/stencil images
3021 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3022 if (src_format != dst_format) {
3023 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003024 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003025 << "stencil, the other one must have exactly the same format. "
3026 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3027 << string_VkFormat(dst_format);
Dave Houltond8ed0212018-05-16 17:18:24 -06003028 skip |=
3029 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3030 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003031 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003032 } // Depth or Stencil
3033
3034 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003035 const char *invalid_src_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003036 (src_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003037 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3038 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3039 const char *invalid_dst_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003040 (dst_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003041 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3042 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003043 for (uint32_t i = 0; i < regionCount; i++) {
3044 const VkImageBlit rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003045 bool hit_error = false;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003046 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003047 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3048 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003049 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003050 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3051 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003052 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3053 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
3054 skip |= ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003055 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003056 skip |= ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003057 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003058 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003059 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3060 "VUID-vkCmdBlitImage-srcSubresource-01707");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003061 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003062 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3063 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003064 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003065 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3066 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003067 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003068 ss << "vkCmdBlitImage(): pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003069 skip |=
3070 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3071 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003072 }
Dave Houlton48989f32017-05-26 15:01:46 -06003073 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3074 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003075 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003076 ss << "vkCmdBlitImage(): pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003077 skip |=
3078 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3079 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003080 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003081
3082 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003083 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003084 skip |= log_msg(
3085 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3086 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-layerCount-00239",
3087 "vkCmdBlitImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003088 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003089
Dave Houlton48989f32017-05-26 15:01:46 -06003090 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003091 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 -06003092 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00238",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003093 "vkCmdBlitImage(): aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003094 }
Dave Houlton48989f32017-05-26 15:01:46 -06003095
Dave Houlton33c2d252017-06-09 17:08:32 -06003096 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
3097 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 -06003098 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00241",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003099 "vkCmdBlitImage(): region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003100 "image format %s.",
3101 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003102 }
3103
3104 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
3105 skip |= log_msg(
3106 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003107 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00242",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003108 "vkCmdBlitImage(): region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3109 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003110 }
3111
Dave Houlton48989f32017-05-26 15:01:46 -06003112 // Validate source image offsets
3113 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003114 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003115 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003116 skip |=
3117 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3118 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00245",
3119 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3120 "of (%1d, %1d). These must be (0, 1).",
3121 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003122 }
3123 }
3124
Dave Houlton33c2d252017-06-09 17:08:32 -06003125 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003126 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
3127 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 -06003128 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00247",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003129 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003130 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3131 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003132 }
3133 }
3134
Dave Houlton33c2d252017-06-09 17:08:32 -06003135 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003136 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3137 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003138 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003139 skip |= log_msg(
3140 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3141 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00243",
3142 "vkCmdBlitImage(): region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).", i,
3143 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003144 }
3145 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3146 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003147 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003148 skip |= log_msg(
3149 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003150 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00244",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003151 "vkCmdBlitImage(): region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003152 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003153 }
3154 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3155 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003156 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003157 skip |= log_msg(
3158 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3159 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00246",
3160 "vkCmdBlitImage(): region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).", i,
3161 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003162 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003163 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003164 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 -06003165 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00215",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003166 "vkCmdBlitImage(): region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003167 }
Dave Houlton48989f32017-05-26 15:01:46 -06003168
3169 // Validate dest image offsets
3170 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003171 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003172 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003173 skip |=
3174 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3175 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00250",
3176 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3177 "(%1d, %1d). These must be (0, 1).",
3178 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003179 }
3180 }
3181
Dave Houlton33c2d252017-06-09 17:08:32 -06003182 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003183 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
3184 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 -06003185 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00252",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003186 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003187 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3188 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003189 }
3190 }
3191
Dave Houlton33c2d252017-06-09 17:08:32 -06003192 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003193 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3194 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003195 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003196 skip |= log_msg(
3197 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3198 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00248",
3199 "vkCmdBlitImage(): region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).", i,
3200 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003201 }
3202 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3203 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003204 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003205 skip |= log_msg(
3206 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003207 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00249",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003208 "vkCmdBlitImage(): region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003209 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003210 }
3211 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3212 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003213 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003214 skip |= log_msg(
3215 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3216 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00251",
3217 "vkCmdBlitImage(): region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).", i,
3218 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003219 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003220 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003221 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 -06003222 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00216",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003223 "vkCmdBlitImage(): region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003224 }
3225
Dave Houlton33c2d252017-06-09 17:08:32 -06003226 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3227 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3228 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003229 skip |=
3230 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3231 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00240",
3232 "vkCmdBlitImage(): region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3233 "layerCount other than 1.",
3234 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003235 }
3236 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003237 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003238 } else {
3239 assert(0);
3240 }
3241 return skip;
3242}
3243
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003244void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3245 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3246 const VkImageBlit *pRegions, VkFilter filter) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07003247 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003248 auto src_image_state = GetImageState(srcImage);
3249 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003250
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003251 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003252 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003253 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3254 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003255 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003256 // Update bindings between images and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003257 AddCommandBufferBindingImage(cb_node, src_image_state);
3258 AddCommandBufferBindingImage(cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003259}
3260
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003261// This validates that the initial layout specified in the command buffer for the IMAGE is the same as the global IMAGE layout
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003262bool CoreChecks::ValidateCmdBufImageLayouts(GLOBAL_CB_NODE *pCB,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003263 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> const &globalImageLayoutMap,
3264 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &overlayLayoutMap) {
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003265 bool skip = false;
John Zulauff660ad62019-03-23 07:16:05 -06003266 // Iterate over the layout maps for each referenced image
3267 for (const auto &layout_map_entry : pCB->image_layout_map) {
3268 const auto image = layout_map_entry.first;
3269 const auto *image_state = GetImageState(image);
3270 if (!image_state) continue; // Can't check layouts of a dead image
3271 const auto &subres_map = layout_map_entry.second;
3272 ImageSubresourcePair isr_pair;
3273 isr_pair.image = image;
3274 isr_pair.hasSubresource = true;
Tony Barbourdf013b92017-01-25 12:53:48 -07003275
John Zulauff660ad62019-03-23 07:16:05 -06003276 // Validate the initial_uses for each subresource referenced
3277 for (auto it_init = subres_map->BeginInitialUse(); !it_init.AtEnd(); ++it_init) {
3278 isr_pair.subresource = (*it_init).subresource;
3279 VkImageLayout initial_layout = (*it_init).layout;
3280 VkImageLayout image_layout;
3281 if (FindLayout(overlayLayoutMap, isr_pair, image_layout) || FindLayout(globalImageLayoutMap, isr_pair, image_layout)) {
3282 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
3283 // TODO: Set memory invalid which is in mem_tracker currently
3284 } else if (image_layout != initial_layout) {
John Zulaufb61ed972019-04-09 16:12:35 -06003285 // Need to look up the inital layout *state* to get a bit more information
3286 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(isr_pair.subresource);
3287 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
3288 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
3289 if (!matches) {
3290 std::string formatted_label = FormatDebugLabel(" ", pCB->debug_label);
3291 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3292 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
3293 "Submitted command buffer expects image %s (subresource: aspectMask 0x%X array layer %u, "
3294 "mip level %u) "
3295 "to be in layout %s--instead, current layout is %s.%s",
3296 report_data->FormatHandle(image).c_str(), isr_pair.subresource.aspectMask,
3297 isr_pair.subresource.arrayLayer, isr_pair.subresource.mipLevel,
3298 string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout),
3299 formatted_label.c_str());
3300 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003301 }
3302 }
John Zulauff660ad62019-03-23 07:16:05 -06003303 }
3304
3305 // Update all layout set operations (which will be a subset of the initial_layouts
3306 for (auto it_set = subres_map->BeginSetLayout(); !it_set.AtEnd(); ++it_set) {
3307 VkImageLayout layout = (*it_set).layout;
3308 isr_pair.subresource = (*it_set).subresource;
3309 SetLayout(overlayLayoutMap, isr_pair, layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003310 }
3311 }
John Zulauff660ad62019-03-23 07:16:05 -06003312
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003313 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003314}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003315
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003316void CoreChecks::UpdateCmdBufImageLayouts(GLOBAL_CB_NODE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06003317 for (const auto &layout_map_entry : pCB->image_layout_map) {
3318 const auto image = layout_map_entry.first;
3319 const auto *image_state = GetImageState(image);
3320 if (!image_state) continue; // Can't set layouts of a dead image
3321 const auto &subres_map = layout_map_entry.second;
3322 ImageSubresourcePair isr_pair;
3323 isr_pair.image = image;
3324 isr_pair.hasSubresource = true;
3325
3326 // Update all layout set operations (which will be a subset of the initial_layouts
3327 for (auto it_set = subres_map->BeginSetLayout(); !it_set.AtEnd(); ++it_set) {
3328 VkImageLayout layout = (*it_set).layout;
3329 isr_pair.subresource = (*it_set).subresource;
3330 SetGlobalLayout(isr_pair, layout);
3331 }
Tony Barbourdf013b92017-01-25 12:53:48 -07003332 }
3333}
3334
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003335// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003336// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3337// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003338bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3339 const VkImageLayout first_layout, const uint32_t attachment,
3340 const VkAttachmentDescription2KHR &attachment_description) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003341 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003342 const char *vuid;
3343 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3344
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003345 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
3346 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003347 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3348 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3349 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003350 skip |=
Shannon McPherson3ea65132018-12-05 10:37:39 -07003351 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3352 "VUID-VkRenderPassCreateInfo2KHR-pAttachments-02522",
3353 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
3354 } else if (!use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3355 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
3356 skip |=
3357 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3358 "VUID-VkRenderPassCreateInfo-pAttachments-00836",
Dave Houltond8ed0212018-05-16 17:18:24 -06003359 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003360 }
3361 }
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003362 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3363 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003364 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01566";
Dave Houltond8ed0212018-05-16 17:18:24 -06003365 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003366 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 -06003367 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003368 }
3369 }
3370
3371 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3372 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003373 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01567";
Dave Houltond8ed0212018-05-16 17:18:24 -06003374 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003375 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 -06003376 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003377 }
3378 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003379 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003380}
3381
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003382bool CoreChecks::ValidateLayouts(RenderPassCreateVersion rp_version, VkDevice device,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003383 const VkRenderPassCreateInfo2KHR *pCreateInfo) {
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003384 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003385 const char *vuid;
3386 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3387 const char *const function_name = use_rp2 ? "vkCreateRenderPass2KHR()" : "vkCreateRenderPass()";
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003388
Jason Ekstranda1906302017-12-03 20:16:32 -08003389 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3390 VkFormat format = pCreateInfo->pAttachments[i].format;
3391 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3392 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3393 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003394 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 -06003395 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003396 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
3397 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3398 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3399 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003400 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003401 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003402 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 -06003403 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003404 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3405 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3406 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3407 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003408 }
3409 }
3410 }
3411
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003412 // Track when we're observing the first use of an attachment
3413 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3414 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003415 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003416
3417 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3418 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3419 auto attach_index = subpass.pInputAttachments[j].attachment;
3420 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003421 switch (subpass.pInputAttachments[j].layout) {
3422 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3423 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3424 // These are ideal.
3425 break;
3426
3427 case VK_IMAGE_LAYOUT_GENERAL:
3428 // May not be optimal. TODO: reconsider this warning based on other constraints.
3429 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003430 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003431 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
3432 break;
3433
Tobias Hectorbbb12282018-10-22 15:17:59 +01003434 case VK_IMAGE_LAYOUT_UNDEFINED:
3435 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3436 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3437 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3438 "Layout for input attachment reference %u in subpass %u is %s but must be "
3439 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
3440 j, i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3441 break;
3442
Graeme Leese668a9862018-10-08 10:40:02 +01003443 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3444 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003445 if (GetDeviceExtensions()->vk_khr_maintenance2) {
Graeme Leese668a9862018-10-08 10:40:02 +01003446 break;
3447 } else {
3448 // Intentionally fall through to generic error message
3449 }
3450 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003451
Cort Stratton7547f772017-05-04 15:18:52 -07003452 default:
3453 // No other layouts are acceptable
3454 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 -06003455 kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003456 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3457 string_VkImageLayout(subpass.pInputAttachments[j].layout));
3458 }
3459
Cort Stratton7547f772017-05-04 15:18:52 -07003460 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003461 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3462 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003463
3464 bool used_as_depth =
3465 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3466 bool used_as_color = false;
3467 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3468 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3469 }
3470 if (!used_as_depth && !used_as_color &&
3471 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003472 vuid = use_rp2 ? "VUID-VkSubpassDescription2KHR-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
3473 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3474 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
3475 function_name, attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07003476 }
3477 }
3478 attach_first_use[attach_index] = false;
3479 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003480
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003481 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3482 auto attach_index = subpass.pColorAttachments[j].attachment;
3483 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3484
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003485 // TODO: Need a way to validate shared presentable images here, currently just allowing
3486 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3487 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003488 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003489 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003490 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003491 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3492 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003493 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003494
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003495 case VK_IMAGE_LAYOUT_GENERAL:
3496 // May not be optimal; TODO: reconsider this warning based on other constraints?
3497 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003498 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003499 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
3500 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003501
Tobias Hectorbbb12282018-10-22 15:17:59 +01003502 case VK_IMAGE_LAYOUT_UNDEFINED:
3503 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3504 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3505 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3506 "Layout for color attachment reference %u in subpass %u is %s but should be "
3507 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3508 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3509 break;
3510
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003511 default:
3512 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 -06003513 kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003514 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3515 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003516 }
3517
John Zulauf4eee2692019-02-09 16:14:25 -07003518 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].attachment != VK_ATTACHMENT_UNUSED) &&
3519 (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
3520 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003521 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3522 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 -07003523 "Layout for resolve attachment reference %u in subpass %u is %s but should be "
Tobias Hectorbbb12282018-10-22 15:17:59 +01003524 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
John Zulauff0f8c2b2019-02-14 12:13:44 -07003525 j, i, string_VkImageLayout(subpass.pResolveAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003526 }
3527
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003528 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003529 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
3530 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003531 }
3532 attach_first_use[attach_index] = false;
3533 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003534
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003535 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3536 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003537 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3538 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3539 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003540 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003541
Dave Houltona9df0ce2018-02-07 10:51:23 -07003542 case VK_IMAGE_LAYOUT_GENERAL:
3543 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3544 // doing a bunch of transitions.
3545 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003546 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003547 "GENERAL layout for depth attachment may not give optimal performance.");
3548 break;
3549
Tobias Hectorbbb12282018-10-22 15:17:59 +01003550 case VK_IMAGE_LAYOUT_UNDEFINED:
3551 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3552 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3553 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3554 "Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
3555 "layout or GENERAL.",
3556 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3557 break;
3558
Dave Houltona9df0ce2018-02-07 10:51:23 -07003559 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3560 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003561 if (GetDeviceExtensions()->vk_khr_maintenance2) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003562 break;
3563 } else {
3564 // Intentionally fall through to generic error message
3565 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06003566 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003567
Dave Houltona9df0ce2018-02-07 10:51:23 -07003568 default:
3569 // No other layouts are acceptable
3570 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 -06003571 kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003572 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3573 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
3574 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003575 }
3576
3577 auto attach_index = subpass.pDepthStencilAttachment->attachment;
3578 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003579 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
3580 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003581 }
3582 attach_first_use[attach_index] = false;
3583 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003584 }
3585 return skip;
3586}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003587
3588// For any image objects that overlap mapped memory, verify that their layouts are PREINIT or GENERAL
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003589bool CoreChecks::ValidateMapImageLayouts(VkDevice device, DEVICE_MEM_INFO const *mem_info, VkDeviceSize offset,
3590 VkDeviceSize end_offset) {
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003591 bool skip = false;
3592 // Iterate over all bound image ranges and verify that for any that overlap the map ranges, the layouts are
3593 // VK_IMAGE_LAYOUT_PREINITIALIZED or VK_IMAGE_LAYOUT_GENERAL
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003594 // TODO : This can be optimized if we store ranges based on starting address and early exit when we pass our range
3595 for (auto image_handle : mem_info->bound_images) {
3596 auto img_it = mem_info->bound_ranges.find(image_handle);
3597 if (img_it != mem_info->bound_ranges.end()) {
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003598 if (RangesIntersect(&img_it->second, offset, end_offset)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003599 std::vector<VkImageLayout> layouts;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003600 if (FindLayouts(VkImage(image_handle), layouts)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003601 for (auto layout : layouts) {
3602 if (layout != VK_IMAGE_LAYOUT_PREINITIALIZED && layout != VK_IMAGE_LAYOUT_GENERAL) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003603 skip |=
3604 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 -06003605 HandleToUint64(mem_info->mem), kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003606 "Mapping an image with layout %s can result in undefined behavior if this memory is used "
3607 "by the device. Only GENERAL or PREINITIALIZED should be used.",
Petr Krausbc7f5442017-05-14 23:43:38 +02003608 string_VkImageLayout(layout));
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003609 }
3610 }
3611 }
3612 }
3613 }
3614 }
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003615 return skip;
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003616}
Mark Lobodzinski96210742017-02-09 10:33:46 -07003617
3618// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
3619// is true, verify that (actual & desired) flags == desired
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003620bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, uint64_t obj_handle,
3621 VulkanObjectType obj_type, const char *msgCode, char const *func_name, char const *usage_str) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003622 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003623 bool skip = false;
Mark Lobodzinski33826372017-04-13 11:10:11 -06003624 const char *type_str = object_string[obj_type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003625 if (strict) {
3626 correct_usage = ((actual & desired) == desired);
3627 } else {
3628 correct_usage = ((actual & desired) != 0);
3629 }
3630 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06003631 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06003632 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
Lockee9aeebf2019-03-03 23:50:08 -07003633 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[obj_type], obj_handle,
3634 kVUID_Core_MemTrack_InvalidUsageFlag,
3635 "Invalid usage flag for %s %s used by %s. In this case, %s should have %s set during creation.",
3636 type_str, report_data->FormatHandle(obj_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003637 } else {
Lockee9aeebf2019-03-03 23:50:08 -07003638 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[obj_type], obj_handle, msgCode,
3639 "Invalid usage flag for %s %s used by %s. In this case, %s should have %s set during creation.",
3640 type_str, report_data->FormatHandle(obj_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003641 }
3642 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003643 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003644}
3645
3646// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3647// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003648bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
3649 char const *func_name, char const *usage_string) {
3650 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, HandleToUint64(image_state->image),
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003651 kVulkanObjectTypeImage, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003652}
3653
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003654bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003655 char const *func_name, const char *linear_vuid, const char *optimal_vuid) {
Mark Lobodzinski5c048802019-03-07 10:47:31 -07003656 VkFormatProperties format_properties = GetPDFormatProperties(image_state->createInfo.format);
Cort Stratton186b1a22018-05-01 20:18:06 -04003657 bool skip = false;
3658 if (image_state->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
3659 if ((format_properties.linearTilingFeatures & desired) != desired) {
Lockee9aeebf2019-03-03 23:50:08 -07003660 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3661 HandleToUint64(image_state->image), linear_vuid,
3662 "In %s, invalid linearTilingFeatures (0x%08X) for format %u used by image %s.", func_name,
3663 format_properties.linearTilingFeatures, image_state->createInfo.format,
3664 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04003665 }
3666 } else if (image_state->createInfo.tiling == VK_IMAGE_TILING_OPTIMAL) {
3667 if ((format_properties.optimalTilingFeatures & desired) != desired) {
3668 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3669 HandleToUint64(image_state->image), optimal_vuid,
Lockee9aeebf2019-03-03 23:50:08 -07003670 "In %s, invalid optimalTilingFeatures (0x%08X) for format %u used by image %s.", func_name,
Cort Stratton186b1a22018-05-01 20:18:06 -04003671 format_properties.optimalTilingFeatures, image_state->createInfo.format,
Lockee9aeebf2019-03-03 23:50:08 -07003672 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04003673 }
3674 }
3675 return skip;
3676}
3677
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003678bool CoreChecks::ValidateImageSubresourceLayers(const GLOBAL_CB_NODE *cb_node, const VkImageSubresourceLayers *subresource_layers,
3679 char const *func_name, char const *member, uint32_t i) {
Cort Strattond619a302018-05-17 19:46:32 -07003680 bool skip = false;
Cort Strattond619a302018-05-17 19:46:32 -07003681 // layerCount must not be zero
3682 if (subresource_layers->layerCount == 0) {
3683 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3684 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-layerCount-01700",
3685 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
3686 }
3687 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
3688 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
3689 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3690 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00168",
3691 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
3692 }
3693 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
3694 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3695 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
3696 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3697 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00167",
3698 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
3699 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3700 func_name, i, member);
3701 }
3702 return skip;
3703}
3704
Mark Lobodzinski96210742017-02-09 10:33:46 -07003705// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3706// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003707bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
3708 char const *func_name, char const *usage_string) {
3709 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, HandleToUint64(buffer_state->buffer),
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003710 kVulkanObjectTypeBuffer, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003711}
3712
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003713bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
3714 const VkPhysicalDeviceLimits *device_limits) {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003715 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003716
3717 const VkDeviceSize &range = pCreateInfo->range;
3718 if (range != VK_WHOLE_SIZE) {
3719 // Range must be greater than 0
3720 if (range <= 0) {
3721 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3722 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00928",
3723 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3724 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
3725 range);
3726 }
3727 // Range must be a multiple of the element size of format
Dave Houltona585d132019-01-18 13:05:42 -07003728 const size_t format_size = FormatElementSize(pCreateInfo->format);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003729 if (range % format_size != 0) {
3730 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3731 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00929",
3732 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3733 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
3734 "(" PRINTF_SIZE_T_SPECIFIER ").",
3735 range, format_size);
3736 }
3737 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
3738 if (range / format_size > device_limits->maxTexelBufferElements) {
3739 skip |=
3740 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3741 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00930",
3742 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3743 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (" PRINTF_SIZE_T_SPECIFIER
3744 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
3745 range, format_size, device_limits->maxTexelBufferElements);
3746 }
3747 // The sum of range and offset must be less than or equal to the size of buffer
3748 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
3749 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3750 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00931",
3751 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3752 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
3753 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
3754 range, pCreateInfo->offset, buffer_state->createInfo.size);
3755 }
3756 }
3757 return skip;
3758}
3759
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003760bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) {
Shannon McPherson265383a2018-06-21 15:37:52 -06003761 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07003762 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06003763 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
3764 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
3765 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3766 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00933",
3767 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
3768 "be supported for uniform texel buffers");
3769 }
3770 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
3771 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
3772 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3773 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00934",
3774 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
3775 "be supported for storage texel buffers");
3776 }
3777 return skip;
3778}
3779
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003780bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
3781 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003782 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003783
Dave Houltond8ed0212018-05-16 17:18:24 -06003784 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003785
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003786 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures()->core.sparseBinding)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003787 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 -06003788 "VUID-VkBufferCreateInfo-flags-00915",
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003789 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003790 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003791 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003792
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003793 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!GetEnabledFeatures()->core.sparseResidencyBuffer)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003794 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 -06003795 "VUID-VkBufferCreateInfo-flags-00916",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003796 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003797 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003798 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003799
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003800 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures()->core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003801 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 -06003802 "VUID-VkBufferCreateInfo-flags-00917",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003803 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003804 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003805 }
Jeff Bolz87697532019-01-11 22:54:00 -06003806
3807 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
3808 if (chained_devaddr_struct) {
3809 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
3810 chained_devaddr_struct->deviceAddress != 0) {
3811 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3812 "VUID-VkBufferCreateInfo-deviceAddress-02604",
3813 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
3814 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
3815 }
3816 }
3817
3818 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003819 !GetEnabledFeatures()->buffer_address.bufferDeviceAddressCaptureReplay) {
Jeff Bolz87697532019-01-11 22:54:00 -06003820 skip |= log_msg(
3821 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3822 "VUID-VkBufferCreateInfo-flags-02605",
3823 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
3824 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
3825 }
3826
3827 if ((pCreateInfo->usage & VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_EXT) &&
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003828 !GetEnabledFeatures()->buffer_address.bufferDeviceAddress) {
Jeff Bolz87697532019-01-11 22:54:00 -06003829 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3830 "VUID-VkBufferCreateInfo-usage-02606",
3831 "vkCreateBuffer(): the bufferDeviceAddress device feature is disabled: Buffers cannot be created with "
3832 "the VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_EXT set.");
3833 }
3834
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07003835 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003836 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateBuffer",
3837 "pCreateInfo->pQueueFamilyIndices", "VUID-VkBufferCreateInfo-sharingMode-01419",
3838 "VUID-VkBufferCreateInfo-sharingMode-01419", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07003839 }
3840
Mark Lobodzinski96210742017-02-09 10:33:46 -07003841 return skip;
3842}
3843
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003844void CoreChecks::PostCallRecordCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
3845 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer, VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07003846 if (result != VK_SUCCESS) return;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003847 // 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 -06003848 bufferMap.insert(std::make_pair(*pBuffer, std::unique_ptr<BUFFER_STATE>(new BUFFER_STATE(*pBuffer, pCreateInfo))));
Mark Lobodzinski96210742017-02-09 10:33:46 -07003849}
3850
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003851bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
3852 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003853 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07003854 BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003855 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
3856 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003857 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07003858 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
3859 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003860 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06003861 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
3862 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
3863 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06003864
Shannon McPherson0eb84f62018-06-18 16:32:40 -06003865 // Buffer view offset must be less than the size of buffer
3866 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
3867 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3868 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00925",
3869 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3870 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
3871 pCreateInfo->offset, buffer_state->createInfo.size);
3872 }
3873
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06003874 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Shannon McPherson883f6092018-06-14 13:15:25 -06003875 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
3876 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0) {
3877 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3878 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00926",
3879 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3880 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
3881 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
3882 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003883
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003884 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06003885
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003886 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003887 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003888 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003889}
3890
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003891void CoreChecks::PostCallRecordCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
3892 const VkAllocationCallbacks *pAllocator, VkBufferView *pView, VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07003893 if (result != VK_SUCCESS) return;
Mark Lobodzinski1170cf22019-03-07 11:08:21 -07003894 (*GetBufferViewMap())[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
Mark Lobodzinski96210742017-02-09 10:33:46 -07003895}
Mark Lobodzinski602de982017-02-09 11:01:33 -07003896
3897// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07003898bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
3899 const char *vuid) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003900 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003901 VkDebugReportObjectTypeEXT objectType = VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT;
3902 if (image != VK_NULL_HANDLE) {
3903 objectType = VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT;
3904 }
3905
Dave Houlton1d2022c2017-03-29 11:43:58 -06003906 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003907 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003908 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003909 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003910 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003911 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003912 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003913 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003914 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003915 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003916 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003917 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003918 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3919 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003920 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003921 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski602de982017-02-09 11:01:33 -07003922 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003923 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3924 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003925 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003926 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003927 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003928 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003929 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003930 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003931 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003932 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003933 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003934 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003935 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003936 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003937 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003938 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003939 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003940 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003941 }
Dave Houlton501b15b2018-03-30 15:07:41 -06003942 } else if (FormatIsMultiplane(format)) {
3943 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
3944 if (3 == FormatPlaneCount(format)) {
3945 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
3946 }
3947 if ((aspect_mask & valid_flags) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003948 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houlton501b15b2018-03-30 15:07:41 -06003949 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
3950 "set, where n = [0, 1, 2].",
3951 func_name);
3952 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003953 }
3954 return skip;
3955}
3956
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07003957bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
3958 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
3959 const char *param_name, const char *image_layer_count_var_name,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003960 const uint64_t image_handle, SubresourceRangeErrorCodes errorCodes) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003961 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02003962
3963 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02003964 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003965 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 -06003966 errorCodes.base_mip_err,
Petr Krausffa94af2017-08-08 21:46:02 +02003967 "%s: %s.baseMipLevel (= %" PRIu32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003968 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
3969 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003970 }
Petr Kraus4d718682017-05-18 03:38:41 +02003971
Petr Krausffa94af2017-08-08 21:46:02 +02003972 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
3973 if (subresourceRange.levelCount == 0) {
3974 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 -06003975 errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02003976 } else {
3977 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02003978
Petr Krausffa94af2017-08-08 21:46:02 +02003979 if (necessary_mip_count > image_mip_count) {
3980 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 -06003981 errorCodes.mip_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02003982 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003983 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02003984 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003985 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003986 }
Petr Kraus4d718682017-05-18 03:38:41 +02003987 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003988 }
Petr Kraus4d718682017-05-18 03:38:41 +02003989
3990 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02003991 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003992 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 -06003993 errorCodes.base_layer_err,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003994 "%s: %s.baseArrayLayer (= %" PRIu32
3995 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
3996 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003997 }
Petr Kraus4d718682017-05-18 03:38:41 +02003998
Petr Krausffa94af2017-08-08 21:46:02 +02003999 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4000 if (subresourceRange.layerCount == 0) {
4001 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 -06004002 errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004003 } else {
4004 const uint64_t necessary_layer_count =
4005 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004006
Petr Krausffa94af2017-08-08 21:46:02 +02004007 if (necessary_layer_count > image_layer_count) {
4008 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 -06004009 errorCodes.layer_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004010 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004011 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004012 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004013 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004014 }
Petr Kraus4d718682017-05-18 03:38:41 +02004015 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004016 }
Petr Kraus4d718682017-05-18 03:38:41 +02004017
Mark Lobodzinski602de982017-02-09 11:01:33 -07004018 return skip;
4019}
4020
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004021bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004022 const VkImageSubresourceRange &subresourceRange) {
Mark Lobodzinski60e79032019-03-07 10:22:31 -07004023 bool is_khr_maintenance1 = GetDeviceExtensions()->vk_khr_maintenance1;
Petr Krausffa94af2017-08-08 21:46:02 +02004024 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4025 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4026 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4027
4028 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4029 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4030
4031 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004032 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4033 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
4034 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-01484"
4035 : "VUID-VkImageViewCreateInfo-image-01482")
4036 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4037 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
4038 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-01485"
4039 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4040 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004041
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004042 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004043 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
4044 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4045}
4046
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004047bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004048 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
Petr Krausffa94af2017-08-08 21:46:02 +02004049 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004050 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4051 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4052 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4053 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004054
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004055 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4056 "vkCmdClearColorImage", param_name, "arrayLayers", HandleToUint64(image_state->image),
4057 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004058}
4059
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004060bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004061 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
Petr Krausffa94af2017-08-08 21:46:02 +02004062 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004063 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4064 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4065 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4066 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004067
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004068 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4069 "vkCmdClearDepthStencilImage", param_name, "arrayLayers",
Petr Krausffa94af2017-08-08 21:46:02 +02004070 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4071}
4072
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004073bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004074 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
4075 const char *param_name) {
Petr Krausffa94af2017-08-08 21:46:02 +02004076 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004077 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4078 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4079 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4080 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004081
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004082 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4083 cmd_name, param_name, "arrayLayers", HandleToUint64(image_state->image),
Petr Krausffa94af2017-08-08 21:46:02 +02004084 subresourceRangeErrorCodes);
4085}
4086
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004087bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
4088 const VkAllocationCallbacks *pAllocator, VkImageView *pView) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004089 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004090 IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004091 if (image_state) {
4092 skip |= ValidateImageUsageFlags(
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004093 image_state,
Mark Lobodzinski602de982017-02-09 11:01:33 -07004094 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
Dave Houlton142c4cb2018-10-17 15:04:41 -06004095 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4096 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV,
Dave Houlton8e9f6542018-05-18 12:18:22 -06004097 false, kVUIDUndefined, "vkCreateImageView()",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004098 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|SHADING_RATE_IMAGE]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004099 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004100 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004101 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004102 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004103 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004104 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004105
4106 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4107 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004108 VkImageUsageFlags image_usage = image_state->createInfo.usage;
4109 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004110 VkFormat view_format = pCreateInfo->format;
4111 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004112 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004113 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004114
Dave Houltonbd2e2622018-04-10 16:41:14 -06004115 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004116 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004117 if (chained_ivuci_struct) {
Dave Houltonbd2e2622018-04-10 16:41:14 -06004118 image_usage = chained_ivuci_struct->usage;
4119 }
4120
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004121 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4122 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004123 if (FormatIsMultiplane(image_format)) {
4124 // View format must match the multiplane compatible format
4125 uint32_t plane = 3; // invalid
4126 switch (aspect_mask) {
4127 case VK_IMAGE_ASPECT_PLANE_0_BIT:
4128 plane = 0;
4129 break;
4130 case VK_IMAGE_ASPECT_PLANE_1_BIT:
4131 plane = 1;
4132 break;
4133 case VK_IMAGE_ASPECT_PLANE_2_BIT:
4134 plane = 2;
4135 break;
4136 default:
4137 break;
4138 }
4139
4140 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, plane);
4141 if (view_format != compat_format) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06004142 std::stringstream ss;
4143 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004144 << " is not compatible with plane " << plane << " of underlying image format "
4145 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Young9d1ac312018-05-21 16:28:27 -06004146 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 -07004147 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01586", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004148 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004149 }
4150 } else {
Mark Lobodzinski60e79032019-03-07 10:22:31 -07004151 if ((!GetDeviceExtensions()->vk_khr_maintenance2 ||
Dave Houltonc7988072018-04-16 11:46:56 -06004152 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
4153 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4154 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
4155 std::stringstream ss;
4156 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Lockee9aeebf2019-03-03 23:50:08 -07004157 << " is not in the same format compatibility class as image ("
4158 << report_data->FormatHandle(pCreateInfo->image).c_str() << ") format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004159 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4160 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
Mark Young9d1ac312018-05-21 16:28:27 -06004161 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 -07004162 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01018", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004163 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004164 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004165 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004166 }
4167 } else {
4168 // Format MUST be IDENTICAL to the format the image was created with
4169 if (image_format != view_format) {
4170 std::stringstream ss;
4171 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from image "
Lockee9aeebf2019-03-03 23:50:08 -07004172 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004173 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Young9d1ac312018-05-21 16:28:27 -06004174 skip |=
4175 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004176 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01019", "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004177 }
4178 }
4179
4180 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004181 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004182
4183 switch (image_type) {
4184 case VK_IMAGE_TYPE_1D:
4185 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004186 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 -07004187 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004188 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4189 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004190 }
4191 break;
4192 case VK_IMAGE_TYPE_2D:
4193 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4194 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4195 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Young9d1ac312018-05-21 16:28:27 -06004196 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 -07004197 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01003",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004198 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4199 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004200 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004201 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 -07004202 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004203 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4204 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004205 }
4206 }
4207 break;
4208 case VK_IMAGE_TYPE_3D:
Mark Lobodzinski60e79032019-03-07 10:22:31 -07004209 if (GetDeviceExtensions()->vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06004210 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4211 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4212 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004213 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004214 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004215 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01005",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004216 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4217 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004218 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4219 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004220 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004221 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004222 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004223 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4224 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004225 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4226 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004227 }
4228 } else {
Mark Young9d1ac312018-05-21 16:28:27 -06004229 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 -07004230 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004231 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4232 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004233 }
4234 }
4235 } else {
4236 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Young9d1ac312018-05-21 16:28:27 -06004237 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 -07004238 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004239 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4240 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004241 }
4242 }
4243 break;
4244 default:
4245 break;
4246 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004247
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004248 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinski60e79032019-03-07 10:22:31 -07004249 if (GetDeviceExtensions()->vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07004250 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004251 }
4252
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004253 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004254 VkFormatFeatureFlags tiling_features = (image_tiling & VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4255 : format_properties.optimalTilingFeatures;
4256
4257 if (tiling_features == 0) {
4258 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 -07004259 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-None-02273",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004260 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4261 "physical device.",
4262 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4263 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4264 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 -07004265 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02274",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004266 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4267 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4268 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4269 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4270 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 -07004271 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02275",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004272 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4273 "VK_IMAGE_USAGE_STORAGE_BIT.",
4274 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4275 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
4276 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4277 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 -07004278 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02276",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004279 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4280 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4281 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4282 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4283 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4284 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004285 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02277",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004286 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4287 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4288 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004289 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004290
Jeff Bolz9af91c52018-09-01 21:53:57 -05004291 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4292 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4293 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 -07004294 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02086",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004295 "vkCreateImageView() If image was created with usage containing "
4296 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4297 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
4298 }
4299 if (view_format != VK_FORMAT_R8_UINT) {
4300 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 -07004301 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02087",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004302 "vkCreateImageView() If image was created with usage containing "
4303 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
4304 }
4305 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004306 }
4307 return skip;
4308}
4309
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004310void CoreChecks::PostCallRecordCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
4311 const VkAllocationCallbacks *pAllocator, VkImageView *pView, VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07004312 if (result != VK_SUCCESS) return;
Mark Lobodzinski1170cf22019-03-07 11:08:21 -07004313 auto image_view_map = GetImageViewMap();
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004314 auto image_state = GetImageState(pCreateInfo->image);
John Zulauff660ad62019-03-23 07:16:05 -06004315 (*image_view_map)[*pView] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(image_state, *pView, pCreateInfo));
Mark Lobodzinski602de982017-02-09 11:01:33 -07004316}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004317
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004318bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
4319 uint32_t regionCount, const VkBufferCopy *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004320 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004321 auto src_buffer_state = GetBufferState(srcBuffer);
4322 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004323
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004324 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004325 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
4326 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004327 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004328 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004329 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
4330 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06004331 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004332 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
4333 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004334 skip |=
4335 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4336 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004337 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
4338 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004339 return skip;
4340}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004341
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004342void CoreChecks::PreCallRecordCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
4343 uint32_t regionCount, const VkBufferCopy *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004344 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004345 auto src_buffer_state = GetBufferState(srcBuffer);
4346 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004347
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004348 // Update bindings between buffers and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004349 AddCommandBufferBindingBuffer(cb_node, src_buffer_state);
4350 AddCommandBufferBindingBuffer(cb_node, dst_buffer_state);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004351}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004352
Mark Lobodzinskif933db92019-03-09 12:58:03 -07004353bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004354 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004355 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004356 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004357 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 -07004358 kVUID_Core_DrawState_DoubleDestroy, "Cannot free buffer %s that has not been allocated.",
4359 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004360 } else {
4361 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004362 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 -06004363 HandleToUint64(buffer), "VUID-vkDestroyBuffer-buffer-00922",
Lockee9aeebf2019-03-03 23:50:08 -07004364 "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 -07004365 }
4366 }
4367 return skip;
4368}
4369
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004370bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07004371 IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004372 VK_OBJECT obj_struct = {HandleToUint64(imageView), kVulkanObjectTypeImageView};
4373
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004374 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004375 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004376 skip |=
4377 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004378 }
4379 return skip;
4380}
4381
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004382void CoreChecks::PreCallRecordDestroyImageView(VkDevice device, VkImageView imageView, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07004383 IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004384 if (!image_view_state) return;
4385 VK_OBJECT obj_struct = {HandleToUint64(imageView), kVulkanObjectTypeImageView};
4386
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004387 // Any bound cmd buffers are now invalid
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004388 InvalidateCommandBuffers(image_view_state->cb_bindings, obj_struct);
Mark Lobodzinski1170cf22019-03-07 11:08:21 -07004389 (*GetImageViewMap()).erase(imageView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004390}
4391
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004392bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004393 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004394
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004395 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004396 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07004397 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004398 }
4399 return skip;
4400}
4401
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004402void CoreChecks::PreCallRecordDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004403 if (!buffer) return;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004404 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004405 VK_OBJECT obj_struct = {HandleToUint64(buffer), kVulkanObjectTypeBuffer};
4406
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004407 InvalidateCommandBuffers(buffer_state->cb_bindings, obj_struct);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004408 for (auto mem_binding : buffer_state->GetBoundMemory()) {
Mark Lobodzinski97f83f72019-03-07 10:01:52 -07004409 auto mem_info = GetMemObjInfo(mem_binding);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004410 if (mem_info) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004411 RemoveBufferMemoryRange(HandleToUint64(buffer), mem_info);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004412 }
4413 }
Mark Lobodzinski97f83f72019-03-07 10:01:52 -07004414 ClearMemoryObjectBindings(HandleToUint64(buffer), kVulkanObjectTypeBuffer);
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004415 EraseQFOReleaseBarriers<VkBufferMemoryBarrier>(buffer);
Mark Lobodzinski3baa8172019-04-19 13:47:30 -06004416 bufferMap.erase(buffer_state->buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004417}
4418
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004419bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
4420 const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07004421 auto buffer_view_state = GetBufferViewState(bufferView);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004422 VK_OBJECT obj_struct = {HandleToUint64(bufferView), kVulkanObjectTypeBufferView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004423 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004424 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004425 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06004426 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004427 }
4428 return skip;
4429}
4430
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004431void CoreChecks::PreCallRecordDestroyBufferView(VkDevice device, VkBufferView bufferView, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004432 if (!bufferView) return;
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07004433 auto buffer_view_state = GetBufferViewState(bufferView);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004434 VK_OBJECT obj_struct = {HandleToUint64(bufferView), kVulkanObjectTypeBufferView};
4435
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004436 // Any bound cmd buffers are now invalid
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004437 InvalidateCommandBuffers(buffer_view_state->cb_bindings, obj_struct);
Mark Lobodzinski1170cf22019-03-07 11:08:21 -07004438 GetBufferViewMap()->erase(bufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004439}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004440
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004441bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
4442 VkDeviceSize size, uint32_t data) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004443 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004444 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004445 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004446 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004447 skip |=
4448 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4449 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004450 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004451 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004452 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
4453 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004454 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004455 return skip;
4456}
4457
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004458void CoreChecks::PreCallRecordCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
4459 VkDeviceSize size, uint32_t data) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004460 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004461 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004462 // Update bindings between buffer and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004463 AddCommandBufferBindingBuffer(cb_node, buffer_state);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004464}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004465
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004466bool CoreChecks::ValidateBufferImageCopyData(uint32_t regionCount, const VkBufferImageCopy *pRegions, IMAGE_STATE *image_state,
4467 const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004468 bool skip = false;
4469
4470 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004471 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
4472 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004473 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 -06004474 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00199",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004475 "%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 -06004476 "and 1, respectively.",
4477 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004478 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004479 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004480
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004481 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
4482 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004483 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 -06004484 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00201",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004485 "%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 -06004486 "must be 0 and 1, respectively.",
4487 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004488 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004489 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004490
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004491 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
4492 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004493 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 -06004494 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-baseArrayLayer-00213",
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004495 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
4496 "For 3D images these must be 0 and 1, respectively.",
4497 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004498 }
4499 }
4500
4501 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07004502 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
Locke497739c2019-03-08 11:50:47 -07004503 uint32_t element_size = FormatElementSize(image_state->createInfo.format, pRegions[i].imageSubresource.aspectMask);
4504
Dave Houltona585d132019-01-18 13:05:42 -07004505 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004506 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 -06004507 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00193",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004508 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07004509 " must be a multiple of this format's texel size (%" PRIu32 ").",
4510 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004511 }
4512
4513 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06004514 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004515 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 -06004516 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00194",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004517 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
4518 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004519 }
4520
4521 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
4522 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004523 skip |=
4524 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004525 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00195",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004526 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
4527 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004528 }
4529
4530 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
4531 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
4532 skip |= log_msg(
4533 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004534 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004535 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
4536 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004537 }
4538
4539 // subresource aspectMask must have exactly 1 bit set
4540 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
4541 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
4542 if (aspect_mask_bits.count() != 1) {
4543 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 -06004544 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00212",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004545 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004546 }
4547
4548 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06004549 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004550 skip |= log_msg(
4551 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004552 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004553 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
4554 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004555 }
4556
4557 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04004558 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07004559 auto block_size = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004560
4561 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06004562 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004563 skip |= log_msg(
4564 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004565 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00203",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004566 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
4567 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004568 }
4569
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004570 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004571 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004572 skip |= log_msg(
4573 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004574 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00204",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004575 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
4576 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004577 }
4578
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004579 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06004580 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
4581 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
4582 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004583 skip |=
4584 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004585 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00205",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004586 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
4587 "width & height (%d, %d)..",
4588 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004589 }
4590
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004591 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houltona585d132019-01-18 13:05:42 -07004592 uint32_t block_size_in_bytes = FormatElementSize(image_state->createInfo.format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06004593 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004594 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 -06004595 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00206",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004596 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07004597 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004598 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004599 }
Dave Houlton67e9b532017-03-02 17:00:10 -07004600
4601 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07004602 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06004603 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004604 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
4605 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 -06004606 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00207",
Dave Houlton75967fc2017-03-06 17:21:16 -07004607 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004608 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004609 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004610 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07004611 }
4612
4613 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004614 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004615 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
4616 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 -06004617 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00208",
Dave Houlton75967fc2017-03-06 17:21:16 -07004618 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004619 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004620 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004621 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07004622 }
4623
4624 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06004625 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004626 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
4627 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 -06004628 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00209",
Dave Houlton75967fc2017-03-06 17:21:16 -07004629 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004630 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004631 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004632 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07004633 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004634 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004635 }
4636
4637 return skip;
4638}
4639
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004640static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06004641 const VkBufferImageCopy *pRegions, const char *func_name, const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004642 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004643 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004644
4645 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004646 VkExtent3D extent = pRegions[i].imageExtent;
4647 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004648
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004649 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
4650 {
Dave Houlton51653902018-06-22 17:32:13 -06004651 skip |=
4652 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4653 kVUID_Core_Image_ZeroAreaSubregion, "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area",
4654 func_name, i, extent.width, extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004655 }
4656
4657 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
4658
4659 // 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 -06004660 if (FormatIsCompressed(image_info->format)) {
Dave Houltona585d132019-01-18 13:05:42 -07004661 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004662 if (image_extent.width % block_extent.width) {
4663 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
4664 }
4665 if (image_extent.height % block_extent.height) {
4666 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
4667 }
4668 if (image_extent.depth % block_extent.depth) {
4669 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
4670 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004671 }
4672
Dave Houltonfc1a4052017-04-27 14:32:45 -06004673 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004674 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 -06004675 msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004676 }
4677 }
4678
4679 return skip;
4680}
4681
Chris Forbese8ba09a2017-06-01 17:39:02 -07004682static inline bool ValidateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
Dave Houlton33c2d252017-06-09 17:08:32 -06004683 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06004684 const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004685 bool skip = false;
4686
4687 VkDeviceSize buffer_size = buff_state->createInfo.size;
4688
4689 for (uint32_t i = 0; i < regionCount; i++) {
4690 VkExtent3D copy_extent = pRegions[i].imageExtent;
4691
4692 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
4693 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Locke497739c2019-03-08 11:50:47 -07004694 VkDeviceSize unit_size = FormatElementSize(image_state->createInfo.format,
4695 pRegions[i].imageSubresource.aspectMask); // size (bytes) of texel or block
Dave Houltonf3229d52017-02-21 15:59:08 -07004696
Tom Cooperb2550c72018-10-15 13:08:41 +01004697 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004698 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houltona585d132019-01-18 13:05:42 -07004699 auto block_dim = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004700 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
4701 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
4702
4703 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
4704 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
4705 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004706 }
4707
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004708 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
4709 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
4710 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07004711 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004712 } else {
4713 // Calculate buffer offset of final copied byte, + 1.
4714 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
4715 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
4716 max_buffer_offset *= unit_size; // convert to bytes
4717 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004718
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004719 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06004720 skip |=
4721 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4722 msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i, buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004723 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004724 }
4725 }
4726
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004727 return skip;
4728}
4729
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004730bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4731 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004732 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004733 auto src_image_state = GetImageState(srcImage);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004734 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004735
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004736 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004737
4738 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004739 skip |= ValidateCmd(cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004740
4741 // Command pool must support graphics, compute, or transfer operations
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -07004742 auto pPool = GetCommandPoolNode(cb_node->createInfo.commandPool);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004743
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004744 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07004745
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004746 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4747 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 -06004748 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004749 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004750 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004751 }
Dave Houlton0ef27492018-04-04 11:41:48 -06004752 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004753 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Chris Forbese8ba09a2017-06-01 17:39:02 -07004754 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004755 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004756
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004757 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06004758 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004759 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
4760 skip |=
4761 ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004762
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004763 // Validate that SRC image & DST buffer have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004764 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004765 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
4766 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004767 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004768 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
4769 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski96d5c6e2019-03-07 11:28:21 -07004770 if (GetApiVersion() >= VK_API_VERSION_1_1 || GetDeviceExtensions()->vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004771 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImageToBuffer()",
4772 "VUID-vkCmdCopyImageToBuffer-srcImage-01998",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06004773 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04004774 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004775 skip |= InsideRenderPass(cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06004776 bool hit_error = false;
Jeff Bolzfdd0d852019-02-03 21:55:12 -06004777 const char *src_invalid_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07004778 (src_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Cort Stratton7df30962018-05-17 19:45:57 -07004779 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
4780 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004781 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004782 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
Cort Strattond619a302018-05-17 19:46:32 -07004783 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004784 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07004785 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
4786 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004787 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
4788 cb_node, src_image_state, &pRegions[i], i, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
4789 skip |=
4790 ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyImageToBuffer()",
4791 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
4792 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07004793 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
4794 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004795 }
4796 return skip;
4797}
4798
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004799void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4800 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004801 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004802 auto src_image_state = GetImageState(srcImage);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004803 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004804
John Zulauff660ad62019-03-23 07:16:05 -06004805 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004806 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06004807 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004808 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004809 // Update bindings between buffer/image and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004810 AddCommandBufferBindingImage(cb_node, src_image_state);
4811 AddCommandBufferBindingBuffer(cb_node, dst_buffer_state);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004812}
4813
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004814bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
4815 VkImageLayout dstImageLayout, uint32_t regionCount,
4816 const VkBufferImageCopy *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004817 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004818 auto src_buffer_state = GetBufferState(srcBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004819 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004820
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004821 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004822
4823 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004824 skip |= ValidateCmd(cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004825
4826 // Command pool must support graphics, compute, or transfer operations
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -07004827 auto pPool = GetCommandPoolNode(cb_node->createInfo.commandPool);
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004828 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004829 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4830 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 -06004831 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004832 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004833 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004834 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004835 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004836 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Chris Forbese8ba09a2017-06-01 17:39:02 -07004837 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004838 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004839 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06004840 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004841 skip |=
4842 ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
4843 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004844 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004845 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
4846 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004847 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004848 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
4849 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski96d5c6e2019-03-07 11:28:21 -07004850 if (GetApiVersion() >= VK_API_VERSION_1_1 || GetDeviceExtensions()->vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004851 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyBufferToImage()",
4852 "VUID-vkCmdCopyBufferToImage-dstImage-01997",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06004853 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04004854 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004855 skip |= InsideRenderPass(cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06004856 bool hit_error = false;
Jeff Bolzfdd0d852019-02-03 21:55:12 -06004857 const char *dst_invalid_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07004858 (dst_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Cort Stratton7df30962018-05-17 19:45:57 -07004859 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
4860 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004861 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004862 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
Cort Strattond619a302018-05-17 19:46:32 -07004863 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004864 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07004865 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
4866 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004867 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
4868 cb_node, dst_image_state, &pRegions[i], i, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
4869 skip |=
4870 ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyBufferToImage()",
4871 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
4872 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07004873 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
4874 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004875 }
4876 return skip;
4877}
4878
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004879void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
4880 VkImageLayout dstImageLayout, uint32_t regionCount,
4881 const VkBufferImageCopy *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004882 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004883 auto src_buffer_state = GetBufferState(srcBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004884 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004885
John Zulauff660ad62019-03-23 07:16:05 -06004886 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004887 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06004888 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004889 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004890 AddCommandBufferBindingBuffer(cb_node, src_buffer_state);
4891 AddCommandBufferBindingImage(cb_node, dst_image_state);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004892}
Mike Weiblen672b58b2017-02-21 14:32:53 -07004893
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004894bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
4895 VkSubresourceLayout *pLayout) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004896 bool skip = false;
4897 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
4898
Dave Houlton1d960ff2018-01-19 12:17:05 -07004899 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07004900 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
4901 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
4902 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004903 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 -06004904 "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004905 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004906 }
4907
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004908 IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004909 if (!image_entry) {
4910 return skip;
4911 }
4912
Dave Houlton1d960ff2018-01-19 12:17:05 -07004913 // image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
Mike Weiblen672b58b2017-02-21 14:32:53 -07004914 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004915 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4916 "VUID-vkGetImageSubresourceLayout-image-00996",
4917 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004918 }
4919
Dave Houlton1d960ff2018-01-19 12:17:05 -07004920 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004921 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004922 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4923 "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
4924 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
4925 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004926 }
4927
Dave Houlton1d960ff2018-01-19 12:17:05 -07004928 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004929 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004930 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4931 "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
4932 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
4933 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004934 }
4935
Dave Houlton1d960ff2018-01-19 12:17:05 -07004936 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07004937 const VkFormat img_format = image_entry->createInfo.format;
Dave Houlton1d960ff2018-01-19 12:17:05 -07004938 if (FormatIsMultiplane(img_format)) {
4939 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06004940 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07004941 if (FormatPlaneCount(img_format) > 2u) {
4942 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
Dave Houltond8ed0212018-05-16 17:18:24 -06004943 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07004944 }
4945 if (sub_aspect != (sub_aspect & allowed_flags)) {
4946 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 -06004947 HandleToUint64(image), vuid,
Dave Houlton1d960ff2018-01-19 12:17:05 -07004948 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004949 ") must be a single-plane specifier flag.",
4950 sub_aspect);
Dave Houlton1d960ff2018-01-19 12:17:05 -07004951 }
4952 } else if (FormatIsColor(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004953 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Dave Houlton852287e2018-01-19 15:11:51 -07004954 skip |= log_msg(
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004955 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
Dave Houltond8ed0212018-05-16 17:18:24 -06004956 "VUID-VkImageSubresource-aspectMask-parameter",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004957 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004958 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004959 } else if (FormatIsDepthOrStencil(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004960 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06004961 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 -06004962 HandleToUint64(image), "VUID-VkImageSubresource-aspectMask-parameter",
Mike Weiblen672b58b2017-02-21 14:32:53 -07004963 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004964 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004965 }
4966 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004967
Mark Lobodzinski60e79032019-03-07 10:22:31 -07004968 if (GetDeviceExtensions()->vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07004969 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004970 }
4971
Mike Weiblen672b58b2017-02-21 14:32:53 -07004972 return skip;
4973}