blob: addda7c8ae8cad8d3cb9c706180e28237af7f959 [file] [log] [blame]
sfricke-samsung552d5e12020-01-07 22:00:20 -08001/* Copyright (c) 2015-2020 The Khronos Group Inc.
2 * Copyright (c) 2015-2020 Valve Corporation
3 * Copyright (c) 2015-2020 LunarG, Inc.
4 * Copyright (C) 2015-2020 Google Inc.
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -07005 *
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 *
18 * Author: Mark Lobodzinski <mark@lunarg.com>
Dave Houlton4eaaf3a2017-03-14 11:31:20 -060019 * Author: Dave Houlton <daveh@lunarg.com>
Shannon McPherson3ea65132018-12-05 10:37:39 -070020 * Shannon McPherson <shannon@lunarg.com>
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070021 */
22
Dave Houlton0d4ad6f2018-09-05 14:53:34 -060023#include <cmath>
24#include <set>
Mark Lobodzinski90224de2017-01-26 15:23:11 -070025#include <sstream>
Petr Kraus4d718682017-05-18 03:38:41 +020026#include <string>
Mark Lobodzinski90224de2017-01-26 15:23:11 -070027
28#include "vk_enum_string_helper.h"
Petr Kraus5a01b472019-08-10 01:40:28 +020029#include "vk_format_utils.h"
Mark Lobodzinski90224de2017-01-26 15:23:11 -070030#include "vk_layer_data.h"
31#include "vk_layer_utils.h"
32#include "vk_layer_logging.h"
Dave Houltonbd2e2622018-04-10 16:41:14 -060033#include "vk_typemap_helper.h"
Mark Lobodzinski90224de2017-01-26 15:23:11 -070034
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -070035#include "chassis.h"
Mark Lobodzinski76d76662019-02-14 14:38:21 -070036#include "core_validation.h"
37#include "shader_validation.h"
38#include "descriptor_sets.h"
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070039#include "buffer_validation.h"
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -070040
John Zulauff660ad62019-03-23 07:16:05 -060041// Transfer VkImageSubresourceLayers into VkImageSubresourceRange struct
42static VkImageSubresourceRange RangeFromLayers(const VkImageSubresourceLayers &subresource_layers) {
43 VkImageSubresourceRange subresource_range;
44 subresource_range.aspectMask = subresource_layers.aspectMask;
45 subresource_range.baseArrayLayer = subresource_layers.baseArrayLayer;
46 subresource_range.layerCount = subresource_layers.layerCount;
47 subresource_range.baseMipLevel = subresource_layers.mipLevel;
48 subresource_range.levelCount = 1;
49 return subresource_range;
50}
51
John Zulaufb58415b2019-12-09 15:02:32 -070052static VkImageSubresourceRange NormalizeSubresourceRange(const VkImageCreateInfo &image_create_info,
53 const VkImageSubresourceRange &range);
54static VkImageSubresourceRange MakeImageFullRange(const VkImageCreateInfo &create_info) {
55 const auto format = create_info.format;
56 VkImageSubresourceRange init_range{0, 0, VK_REMAINING_MIP_LEVELS, 0, VK_REMAINING_ARRAY_LAYERS};
57 if (FormatIsColor(format) || FormatIsMultiplane(format)) {
58 init_range.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT; // Normalization will expand this for multiplane
59 } else {
60 init_range.aspectMask =
61 (FormatHasDepth(format) ? VK_IMAGE_ASPECT_DEPTH_BIT : 0) | (FormatHasStencil(format) ? VK_IMAGE_ASPECT_STENCIL_BIT : 0);
62 }
63 return NormalizeSubresourceRange(create_info, init_range);
64}
65
John Zulauff660ad62019-03-23 07:16:05 -060066IMAGE_STATE::IMAGE_STATE(VkImage img, const VkImageCreateInfo *pCreateInfo)
67 : image(img),
Tony-LunarGf3278f52020-01-31 09:58:26 -070068 safe_create_info(pCreateInfo),
69 createInfo(*safe_create_info.ptr()),
John Zulauff660ad62019-03-23 07:16:05 -060070 valid(false),
71 acquired(false),
72 shared_presentable(false),
73 layout_locked(false),
74 get_sparse_reqs_called(false),
75 sparse_metadata_required(false),
76 sparse_metadata_bound(false),
77 imported_ahb(false),
78 has_ahb_format(false),
Tony-LunarGe64e4fe2020-02-17 16:21:55 -070079 is_swapchain_image(false),
John Zulauff660ad62019-03-23 07:16:05 -060080 ahb_format(0),
John Zulaufb58415b2019-12-09 15:02:32 -070081 full_range{MakeImageFullRange(createInfo)},
unknown09edc722019-06-21 15:49:38 -060082 create_from_swapchain(VK_NULL_HANDLE),
83 bind_swapchain(VK_NULL_HANDLE),
unknown08c57af2019-06-21 16:33:35 -060084 bind_swapchain_imageIndex(0),
John Zulaufb58415b2019-12-09 15:02:32 -070085 range_encoder(full_range),
unknown08c57af2019-06-21 16:33:35 -060086 sparse_requirements{} {
John Zulauff660ad62019-03-23 07:16:05 -060087 if ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) && (createInfo.queueFamilyIndexCount > 0)) {
88 uint32_t *pQueueFamilyIndices = new uint32_t[createInfo.queueFamilyIndexCount];
89 for (uint32_t i = 0; i < createInfo.queueFamilyIndexCount; i++) {
90 pQueueFamilyIndices[i] = pCreateInfo->pQueueFamilyIndices[i];
91 }
92 createInfo.pQueueFamilyIndices = pQueueFamilyIndices;
93 }
94
95 if (createInfo.flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) {
96 sparse = true;
97 }
Locked8af3732019-05-10 09:47:56 -060098
sfricke-samsunge2441192019-11-06 14:07:57 -080099 auto *externalMemoryInfo = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(pCreateInfo->pNext);
100 if (externalMemoryInfo) {
101 external_memory_handle = externalMemoryInfo->handleTypes;
102 }
103
Locked8af3732019-05-10 09:47:56 -0600104#ifdef VK_USE_PLATFORM_ANDROID_KHR
105 auto external_format = lvl_find_in_chain<VkExternalFormatANDROID>(createInfo.pNext);
106 if (external_format) {
107 external_format_android = external_format->externalFormat;
108 } else {
109 // If externalFormat is zero, the effect is as if the VkExternalFormatANDROID structure was not present.
110 external_format_android = 0;
111 }
112#endif // VK_USE_PLATFORM_ANDROID_KHR
John Zulauff660ad62019-03-23 07:16:05 -0600113}
114
unknown2c877272019-07-11 12:56:50 -0600115bool IMAGE_STATE::IsCreateInfoEqual(const VkImageCreateInfo &other_createInfo) const {
116 bool is_equal = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
117 is_equal = is_equal && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
118 is_equal = is_equal && IsMipLevelsEqual(other_createInfo) && IsArrayLayersEqual(other_createInfo);
119 is_equal = is_equal && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
120 is_equal = is_equal && IsExtentEqual(other_createInfo) && IsTilingEqual(other_createInfo);
121 is_equal = is_equal && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
122 return is_equal && IsQueueFamilyIndicesEqual(other_createInfo);
123}
124
Jeff Bolz82f854d2019-09-17 14:56:47 -0500125// Check image compatibility rules for VK_NV_dedicated_allocation_image_aliasing
126bool IMAGE_STATE::IsCreateInfoDedicatedAllocationImageAliasingCompatible(const VkImageCreateInfo &other_createInfo) const {
127 bool is_compatible = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
128 is_compatible = is_compatible && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
129 is_compatible = is_compatible && IsMipLevelsEqual(other_createInfo);
130 is_compatible = is_compatible && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
131 is_compatible = is_compatible && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
132 is_compatible = is_compatible && IsQueueFamilyIndicesEqual(other_createInfo) && IsTilingEqual(other_createInfo);
133
134 is_compatible = is_compatible && createInfo.extent.width <= other_createInfo.extent.width &&
135 createInfo.extent.height <= other_createInfo.extent.height &&
136 createInfo.extent.depth <= other_createInfo.extent.depth &&
137 createInfo.arrayLayers <= other_createInfo.arrayLayers;
138 return is_compatible;
139}
140
unknown2c877272019-07-11 12:56:50 -0600141bool IMAGE_STATE::IsCompatibleAliasing(IMAGE_STATE *other_image_state) {
Tony-LunarGe64e4fe2020-02-17 16:21:55 -0700142 if (!is_swapchain_image && !other_image_state->is_swapchain_image &&
143 !(createInfo.flags & other_image_state->createInfo.flags & VK_IMAGE_CREATE_ALIAS_BIT))
144 return false;
locke-lunarg5f59e782019-12-19 10:32:23 -0700145 if ((create_from_swapchain == VK_NULL_HANDLE) && binding.mem_state &&
146 (binding.mem_state == other_image_state->binding.mem_state) && (binding.offset == other_image_state->binding.offset) &&
unknown2c877272019-07-11 12:56:50 -0600147 IsCreateInfoEqual(other_image_state->createInfo)) {
148 return true;
149 }
unknowne1661522019-07-11 13:04:18 -0600150 if ((bind_swapchain == other_image_state->bind_swapchain) && (bind_swapchain != VK_NULL_HANDLE)) {
151 return true;
152 }
unknown2c877272019-07-11 12:56:50 -0600153 return false;
154}
155
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500156IMAGE_VIEW_STATE::IMAGE_VIEW_STATE(const std::shared_ptr<IMAGE_STATE> &im, VkImageView iv, const VkImageViewCreateInfo *ci)
157 : image_view(iv),
158 create_info(*ci),
John Zulaufb58415b2019-12-09 15:02:32 -0700159 normalized_subresource_range(NormalizeSubresourceRange(*im, ci->subresourceRange)),
160 range_generator(im->range_encoder, normalized_subresource_range),
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500161 samplerConversion(VK_NULL_HANDLE),
162 image_state(im) {
John Zulauff660ad62019-03-23 07:16:05 -0600163 auto *conversionInfo = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info.pNext);
164 if (conversionInfo) samplerConversion = conversionInfo->conversion;
165 if (image_state) {
166 // A light normalization of the createInfo range
167 auto &sub_res_range = create_info.subresourceRange;
168 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
169 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
170
171 // Cache a full normalization (for "full image/whole image" comparisons)
John Zulaufb58415b2019-12-09 15:02:32 -0700172 // normalized_subresource_range = NormalizeSubresourceRange(*image_state, ci->subresourceRange);
Jeff Bolz6cede832019-08-09 23:30:39 -0500173 samples = image_state->createInfo.samples;
174 descriptor_format_bits = DescriptorRequirementsBitsFromFormat(create_info.format);
John Zulauff660ad62019-03-23 07:16:05 -0600175 }
176}
177
Dave Houltond9611312018-11-19 17:03:36 -0700178uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
179 // uint cast applies floor()
180 return 1u + (uint32_t)log2(std::max({height, width, depth}));
181}
182
183uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
184
185uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
186
John Zulaufb58415b2019-12-09 15:02:32 -0700187static VkImageSubresourceRange NormalizeSubresourceRange(const VkImageCreateInfo &image_create_info,
188 const VkImageSubresourceRange &range) {
John Zulauff660ad62019-03-23 07:16:05 -0600189 VkImageSubresourceRange norm = range;
190 norm.levelCount = ResolveRemainingLevels(&range, image_create_info.mipLevels);
191
192 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
193 // <arrayLayers> can potentially alias.
194 uint32_t layer_limit = (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR))
195 ? image_create_info.extent.depth
196 : image_create_info.arrayLayers;
197 norm.layerCount = ResolveRemainingLayers(&range, layer_limit);
198
199 // For multiplanar formats, IMAGE_ASPECT_COLOR is equivalent to adding the aspect of the individual planes
200 VkImageAspectFlags &aspect_mask = norm.aspectMask;
201 if (FormatIsMultiplane(image_create_info.format)) {
202 if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
203 aspect_mask &= ~VK_IMAGE_ASPECT_COLOR_BIT;
204 aspect_mask |= (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
205 if (FormatPlaneCount(image_create_info.format) > 2) {
206 aspect_mask |= VK_IMAGE_ASPECT_PLANE_2_BIT;
207 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700208 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700209 }
John Zulauff660ad62019-03-23 07:16:05 -0600210 return norm;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700211}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700212
John Zulaufb58415b2019-12-09 15:02:32 -0700213VkImageSubresourceRange NormalizeSubresourceRange(const IMAGE_STATE &image_state, const VkImageSubresourceRange &range) {
214 const VkImageCreateInfo &image_create_info = image_state.createInfo;
215 return NormalizeSubresourceRange(image_create_info, range);
216}
217
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500218bool CoreChecks::FindLayouts(VkImage image, std::vector<VkImageLayout> &layouts) const {
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;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700221
John Zulauf2076e812020-01-08 14:55:54 -0700222 const auto *layout_range_map = GetLayoutRangeMap(imageLayoutMap, image);
223 if (!layout_range_map) return false;
locke-lunargf155ccf2020-02-18 11:34:15 -0700224 // TODO: FindLayouts function should mutate into a ValidatePresentableLayout with the loop wrapping the LogError
225 // from the caller. You can then use decode to add the subresource of the range::begin to the error message.
226
John Zulauf2076e812020-01-08 14:55:54 -0700227 // TODO: what is this test and what is it supposed to do?! -- the logic doesn't match the comment below?!
228
229 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
230 if (layout_range_map->size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700231 return false;
232 }
locke-lunargcba7d5f2019-12-30 16:59:11 -0700233
John Zulauf2076e812020-01-08 14:55:54 -0700234 for (auto entry : *layout_range_map) {
235 layouts.push_back(entry.second);
Tony Barbourdf013b92017-01-25 12:53:48 -0700236 }
237 return true;
238}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700239
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600240// Set image layout for given VkImageSubresourceRange struct
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600241void CoreChecks::SetImageLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600242 const VkImageSubresourceRange &image_subresource_range, VkImageLayout layout,
243 VkImageLayout expected_layout) {
244 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
245 assert(subresource_map); // the non-const getter must return a valid pointer
John Zulauf4ec24ec2019-05-02 17:22:59 -0600246 if (subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600247 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700248 }
249}
John Zulauff660ad62019-03-23 07:16:05 -0600250
251// Set the initial image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600252void CoreChecks::SetImageViewInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
Jeff Bolz3e333222019-08-10 23:00:38 -0500253 if (disabled.image_layout_validation) {
254 return;
255 }
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500256 IMAGE_STATE *image_state = view_state.image_state.get();
257 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
John Zulaufb58415b2019-12-09 15:02:32 -0700258 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
John Zulauff660ad62019-03-23 07:16:05 -0600259}
260
261// Set the initial image layout for a passed non-normalized subresource range
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600262void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600263 const VkImageSubresourceRange &range, VkImageLayout layout) {
264 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
265 assert(subresource_map);
John Zulauf4ec24ec2019-05-02 17:22:59 -0600266 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(image_state, range), layout);
John Zulauff660ad62019-03-23 07:16:05 -0600267}
268
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600269void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, VkImage image, const VkImageSubresourceRange &range,
John Zulauff660ad62019-03-23 07:16:05 -0600270 VkImageLayout layout) {
271 const IMAGE_STATE *image_state = GetImageState(image);
272 if (!image_state) return;
273 SetImageInitialLayout(cb_node, *image_state, range, layout);
274};
275
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600276void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600277 const VkImageSubresourceLayers &layers, VkImageLayout layout) {
278 SetImageInitialLayout(cb_node, image_state, RangeFromLayers(layers), layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600279}
Dave Houltonddd65c52018-05-08 14:58:01 -0600280
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600281// Set image layout for all slices of an image view
Piers Daniell4fde9b72019-11-27 16:19:46 -0700282void CoreChecks::SetImageViewLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout,
283 VkImageLayout layoutStencil) {
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500284 IMAGE_STATE *image_state = view_state.image_state.get();
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600285
John Zulauff660ad62019-03-23 07:16:05 -0600286 VkImageSubresourceRange sub_range = view_state.normalized_subresource_range;
Dave Houltonddd65c52018-05-08 14:58:01 -0600287 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
288 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
John Zulauff660ad62019-03-23 07:16:05 -0600289 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 -0600290 sub_range.baseArrayLayer = 0;
291 sub_range.layerCount = image_state->createInfo.extent.depth;
292 }
293
Piers Daniell4fde9b72019-11-27 16:19:46 -0700294 if (sub_range.aspectMask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT) && layoutStencil != kInvalidLayout) {
295 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
296 SetImageLayout(cb_node, *image_state, sub_range, layout);
297 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
298 SetImageLayout(cb_node, *image_state, sub_range, layoutStencil);
299 } else {
300 SetImageLayout(cb_node, *image_state, sub_range, layout);
301 }
John Zulauf4ccf5c02018-09-21 11:46:18 -0600302}
303
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700304bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
305 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700306 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600307 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100308 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700309 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100310 const char *vuid;
311 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
312
313 if (!image_state) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700314 skip |= LogError(image, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
315 "Render Pass begin with %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
316 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
317 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100318 return skip;
319 }
320
321 auto image_usage = image_state->createInfo.usage;
322
323 // Check for layouts that mismatch image usages in the framebuffer
324 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800325 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100326 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700327 LogError(image, vuid,
328 "Layout/usage mismatch for attachment %u in %s"
329 " - the %s is %s but the image attached to %s via %s"
330 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
331 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
332 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100333 }
334
335 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
336 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800337 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100338 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700339 LogError(image, vuid,
340 "Layout/usage mismatch for attachment %u in %s"
341 " - the %s is %s but the image attached to %s via %s"
342 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
343 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
344 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100345 }
346
347 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800348 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100349 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700350 LogError(image, vuid,
351 "Layout/usage mismatch for attachment %u in %s"
352 " - the %s is %s but the image attached to %s via %s"
353 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
354 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
355 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100356 }
357
358 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800359 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100360 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700361 LogError(image, vuid,
362 "Layout/usage mismatch for attachment %u in %s"
363 " - the %s is %s but the image attached to %s via %s"
364 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
365 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
366 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100367 }
368
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600369 if (device_extensions.vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100370 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
371 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
372 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
373 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
374 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800375 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700376 skip |= LogError(image, vuid,
377 "Layout/usage mismatch for attachment %u in %s"
378 " - the %s is %s but the image attached to %s via %s"
379 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
380 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
381 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
382 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100383 }
384 } else {
385 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
386 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
387 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
388 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700389 skip |= LogError(image, "VUID-vkCmdBeginRenderPass-initialLayout-00896",
390 "Layout/usage mismatch for attachment %u in %s"
391 " - the %s is %s but the image attached to %s via %s"
392 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
393 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
394 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
395 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100396 }
397 }
398 return skip;
399}
400
John Zulauf17a01bb2019-08-09 16:41:19 -0600401bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700402 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600403 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600404 bool skip = false;
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700405 auto const pRenderPassInfo = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700406 auto const &framebufferInfo = framebuffer_state->createInfo;
Tobias Hectorc9057422019-07-23 12:15:52 +0100407 const VkImageView *attachments = framebufferInfo.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100408
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700409 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100410 auto framebuffer = framebuffer_state->framebuffer;
411
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700412 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700413 skip |= LogError(pCB->commandBuffer, kVUID_Core_DrawState_InvalidRenderpass,
414 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700415 }
John Zulauf8e308292018-09-21 11:34:37 -0600416
Tobias Hectorc9057422019-07-23 12:15:52 +0100417 const auto *attachmentInfo = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
418 if (((framebufferInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) != 0) && attachmentInfo != nullptr) {
419 attachments = attachmentInfo->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100420 }
421
Tobias Hectorc9057422019-07-23 12:15:52 +0100422 if (attachments != nullptr) {
423 const auto *const_pCB = static_cast<const CMD_BUFFER_STATE *>(pCB);
424 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
425 auto image_view = attachments[i];
426 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100427
Tobias Hectorc9057422019-07-23 12:15:52 +0100428 if (!view_state) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700429 skip |= LogError(pRenderPassBegin->renderPass, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
430 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
431 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
432 report_data->FormatHandle(image_view).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100433 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100434 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100435
436 const VkImage image = view_state->create_info.image;
437 const IMAGE_STATE *image_state = GetImageState(image);
438
439 if (!image_state) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700440 skip |= LogError(pRenderPassBegin->renderPass, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
441 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
442 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
443 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100444 continue;
445 }
446 auto attachment_initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
447 auto final_layout = pRenderPassInfo->pAttachments[i].finalLayout;
448
Piers Daniell7f894f62020-01-09 16:33:48 -0700449 // Default to expecting stencil in the same layout.
450 auto attachment_stencil_initial_layout = attachment_initial_layout;
451
452 // If a separate layout is specified, look for that.
453 const auto *attachment_description_stencil_layout =
454 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
455 if (attachment_description_stencil_layout) {
456 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
457 }
458
Tobias Hectorc9057422019-07-23 12:15:52 +0100459 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
460 // in common with the non-const version.)
461 const ImageSubresourceLayoutMap *subresource_map =
462 (attachment_initial_layout != VK_IMAGE_LAYOUT_UNDEFINED) ? GetImageSubresourceLayoutMap(const_pCB, image) : nullptr;
463
464 if (subresource_map) { // If no layout information for image yet, will be checked at QueueSubmit time
465 LayoutUseCheckAndMessage layout_check(subresource_map);
466 bool subres_skip = false;
John Zulauf5e617452019-11-19 14:44:16 -0700467 auto pos = subresource_map->Find(view_state->normalized_subresource_range);
468 for (; pos != subresource_map->End() && !subres_skip; ++pos) {
469 const VkImageSubresource &subres = pos->subresource;
Piers Daniell7f894f62020-01-09 16:33:48 -0700470
John Zulauf5e617452019-11-19 14:44:16 -0700471 // Allow for differing depth and stencil layouts
472 VkImageLayout check_layout = attachment_initial_layout;
473 if (subres.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) check_layout = attachment_stencil_initial_layout;
474
475 if (!layout_check.Check(subres, check_layout, pos->current_layout, pos->initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700476 subres_skip |= LogError(
477 device, kVUID_Core_DrawState_InvalidRenderpass,
Piers Daniell7f894f62020-01-09 16:33:48 -0700478 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
479 "and the %s layout of the attachment is %s. The layouts must match, or the render "
480 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
John Zulauf5e617452019-11-19 14:44:16 -0700481 i, string_VkImageLayout(check_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobias Hectorc9057422019-07-23 12:15:52 +0100482 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700483 }
John Zulauf5e617452019-11-19 14:44:16 -0700484
Tobias Hectorc9057422019-07-23 12:15:52 +0100485 skip |= subres_skip;
486 }
487
488 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view,
489 framebuffer, render_pass, i, "initial layout");
490
491 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer,
492 render_pass, i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100493 }
494
Tobias Hectorc9057422019-07-23 12:15:52 +0100495 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
496 auto &subpass = pRenderPassInfo->pSubpasses[j];
497 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
498 auto &attachment_ref = subpass.pInputAttachments[k];
499 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
500 auto image_view = attachments[attachment_ref.attachment];
501 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100502
Tobias Hectorc9057422019-07-23 12:15:52 +0100503 if (view_state) {
504 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700505 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
506 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100507 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100508 }
509 }
510 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100511
Tobias Hectorc9057422019-07-23 12:15:52 +0100512 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
513 auto &attachment_ref = subpass.pColorAttachments[k];
514 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
515 auto image_view = attachments[attachment_ref.attachment];
516 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100517
Tobias Hectorc9057422019-07-23 12:15:52 +0100518 if (view_state) {
519 auto image = view_state->create_info.image;
520 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
521 framebuffer, render_pass, attachment_ref.attachment,
522 "color attachment layout");
523 if (subpass.pResolveAttachments) {
524 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
525 rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
526 attachment_ref.attachment, "resolve attachment layout");
527 }
528 }
529 }
530 }
531
532 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
533 auto &attachment_ref = *subpass.pDepthStencilAttachment;
534 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
535 auto image_view = attachments[attachment_ref.attachment];
536 auto view_state = GetImageViewState(image_view);
537
538 if (view_state) {
539 auto image = view_state->create_info.image;
540 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
541 framebuffer, render_pass, attachment_ref.attachment,
542 "input attachment layout");
543 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100544 }
545 }
546 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700547 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600548 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700549}
550
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600551void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700552 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700553 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700554 auto image_view = GetAttachmentImageViewState(pFramebuffer, ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600555 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700556 VkImageLayout stencil_layout = kInvalidLayout;
557 const auto *attachment_reference_stencil_layout = lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(ref.pNext);
558 if (attachment_reference_stencil_layout) {
559 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
560 }
561
562 SetImageViewLayout(pCB, *image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600563 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700564 }
565}
566
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600567void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
568 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700569 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700570
571 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700572 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700573 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700574 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700575 }
576 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700577 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700578 }
579 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700580 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700581 }
582 }
583}
584
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700585// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
586// 1. Transition into initialLayout state
587// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600588void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700589 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700590 // First transition into initialLayout
591 auto const rpci = render_pass_state->createInfo.ptr();
592 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700593 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -0600594 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700595 VkImageLayout stencil_layout = kInvalidLayout;
596 const auto *attachment_description_stencil_layout =
597 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(rpci->pAttachments[i].pNext);
598 if (attachment_description_stencil_layout) {
599 stencil_layout = attachment_description_stencil_layout->stencilInitialLayout;
600 }
601
602 SetImageViewLayout(cb_state, *view_state, rpci->pAttachments[i].initialLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600603 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700604 }
605 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700606 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700607}
608
Dave Houlton10b39482017-03-16 13:18:15 -0600609bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600610 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600611 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600612 }
613 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600614 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600615 }
616 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600617 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600618 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700619 if (0 !=
620 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
621 if (FormatPlaneCount(format) == 1) return false;
622 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600623 return true;
624}
625
Mike Weiblen62d08a32017-03-07 22:18:27 -0700626// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Petr Krausad0096a2019-08-09 18:35:04 +0200627bool CoreChecks::ValidateBarrierLayoutToImageUsage(const VkImageMemoryBarrier &img_barrier, bool new_not_old,
628 VkImageUsageFlags usage_flags, const char *func_name,
John Zulaufa4472282019-08-22 14:44:34 -0600629 const char *barrier_pname) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700630 bool skip = false;
Petr Krausad0096a2019-08-09 18:35:04 +0200631 const VkImageLayout layout = (new_not_old) ? img_barrier.newLayout : img_barrier.oldLayout;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600632 const char *msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700633
634 switch (layout) {
635 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
636 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600637 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700638 }
639 break;
640 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
641 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600642 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700643 }
644 break;
645 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
646 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600647 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700648 }
649 break;
650 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
651 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600652 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700653 }
654 break;
655 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
656 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600657 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700658 }
659 break;
660 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
661 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600662 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700663 }
664 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600665 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500666 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
667 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
668 }
669 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700670 default:
671 // Other VkImageLayout values do not have VUs defined in this context.
672 break;
673 }
674
Dave Houlton8e9f6542018-05-18 12:18:22 -0600675 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700676 skip |= LogError(img_barrier.image, msg_code,
677 "%s: Image barrier %s %s Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".", func_name,
678 barrier_pname, ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
679 report_data->FormatHandle(img_barrier.image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700680 }
681 return skip;
682}
683
684// Verify image barriers are compatible with the images they reference.
John Zulaufa4472282019-08-22 14:44:34 -0600685bool CoreChecks::ValidateBarriersToImages(const CMD_BUFFER_STATE *cb_state, uint32_t imageMemoryBarrierCount,
686 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700687 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700688
Petr Krausad0096a2019-08-09 18:35:04 +0200689 // Scoreboard for checking for duplicate and inconsistent barriers to images
690 struct ImageBarrierScoreboardEntry {
691 uint32_t index;
692 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
693 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
694 const VkImageMemoryBarrier *barrier;
695 };
696 using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
697 using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
698
John Zulauf463c51e2018-05-31 13:29:20 -0600699 // Scoreboard for duplicate layout transition barriers within the list
700 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
701 ImageBarrierScoreboardImageMap layout_transitions;
702
Mike Weiblen62d08a32017-03-07 22:18:27 -0700703 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +0200704 const auto &img_barrier = pImageMemoryBarriers[i];
705 const std::string barrier_pname = "pImageMemoryBarrier[" + std::to_string(i) + "]";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700706
John Zulauf463c51e2018-05-31 13:29:20 -0600707 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
708 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
709 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +0200710 if (img_barrier.oldLayout != img_barrier.newLayout) {
711 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
712 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -0600713 if (image_it != layout_transitions.end()) {
714 auto &subres_map = image_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200715 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -0600716 if (subres_it != subres_map.end()) {
717 auto &entry = subres_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200718 if ((entry.barrier->newLayout != img_barrier.oldLayout) &&
719 (img_barrier.oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
720 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700721 skip = LogError(
722 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
Petr Krausad0096a2019-08-09 18:35:04 +0200723 "%s: %s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600724 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
725 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Petr Krausad0096a2019-08-09 18:35:04 +0200726 func_name, barrier_pname.c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
727 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
728 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600729 }
730 entry = new_entry;
731 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200732 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600733 }
734 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200735 layout_transitions[img_barrier.image][img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600736 }
737 }
738
Petr Krausad0096a2019-08-09 18:35:04 +0200739 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600740 if (image_state) {
741 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Petr Krausad0096a2019-08-09 18:35:04 +0200742 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, false, usage_flags, func_name, barrier_pname.c_str());
743 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, true, usage_flags, func_name, barrier_pname.c_str());
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600744
745 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
746 if (image_state->layout_locked) {
747 // TODO: Add unique id for error when available
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700748 skip |= LogError(
749 img_barrier.image, 0,
locke-lunarg9edc2812019-06-17 23:18:52 -0600750 "Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600751 " from layout %s to layout %s, but image has already been presented and cannot have its layout transitioned.",
Petr Krausad0096a2019-08-09 18:35:04 +0200752 report_data->FormatHandle(img_barrier.image).c_str(), string_VkImageLayout(img_barrier.oldLayout),
753 string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600754 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600755
John Zulaufa4472282019-08-22 14:44:34 -0600756 const VkImageCreateInfo &image_create_info = image_state->createInfo;
John Zulauff660ad62019-03-23 07:16:05 -0600757 // For a Depth/Stencil image both aspects MUST be set
John Zulaufa4472282019-08-22 14:44:34 -0600758 if (FormatIsDepthAndStencil(image_create_info.format)) {
Petr Krausad0096a2019-08-09 18:35:04 +0200759 auto const aspect_mask = img_barrier.subresourceRange.aspectMask;
Piers Daniell41b8c5d2020-01-10 15:42:00 -0700760 if (enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -0600761 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
762 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700763 LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-03319",
764 "%s: Image barrier %s references %s of format %s that must have either the depth or stencil "
765 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
766 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
767 string_VkFormat(image_create_info.format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600768 }
769 } else {
770 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
771 if ((aspect_mask & ds_mask) != (ds_mask)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700772 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-03320",
773 "%s: Image barrier %s references %s of format %s that must have the depth and stencil "
774 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
775 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
776 string_VkFormat(image_create_info.format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600777 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700778 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700779 }
John Zulauff660ad62019-03-23 07:16:05 -0600780
Petr Krausad0096a2019-08-09 18:35:04 +0200781 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier.image);
782 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -0600783 // TODO: Set memory invalid which is in mem_tracker currently
784 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
785 // subresource.
786 } else if (subresource_map) {
787 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -0600788 LayoutUseCheckAndMessage layout_check(subresource_map);
Petr Krausad0096a2019-08-09 18:35:04 +0200789 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier.subresourceRange);
John Zulauf5e617452019-11-19 14:44:16 -0700790 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
791 const auto &value = *pos;
792 if (!layout_check.Check(value.subresource, img_barrier.oldLayout, value.current_layout, value.initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700793 subres_skip = LogError(
794 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
John Zulauf5e617452019-11-19 14:44:16 -0700795 "For %s you cannot transition the layout of aspect=%d level=%d layer=%d from %s when the "
796 "%s layout is %s.",
797 report_data->FormatHandle(img_barrier.image).c_str(), value.subresource.aspectMask,
798 value.subresource.mipLevel, value.subresource.arrayLayer, string_VkImageLayout(img_barrier.oldLayout),
799 layout_check.message, string_VkImageLayout(layout_check.layout));
John Zulauff660ad62019-03-23 07:16:05 -0600800 }
John Zulauf5e617452019-11-19 14:44:16 -0700801 }
John Zulauff660ad62019-03-23 07:16:05 -0600802 skip |= subres_skip;
803 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700804 }
805 }
806 return skip;
807}
808
John Zulaufe3d1c8a2019-08-12 14:34:58 -0600809bool CoreChecks::IsReleaseOp(CMD_BUFFER_STATE *cb_state, const VkImageMemoryBarrier &barrier) const {
Petr Krausad0096a2019-08-09 18:35:04 +0200810 if (!IsTransferOp(&barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700811
Jeff Bolz6835fda2019-10-06 00:15:34 -0500812 auto pool = cb_state->command_pool.get();
Petr Krausad0096a2019-08-09 18:35:04 +0200813 return pool && TempIsReleaseOp<VkImageMemoryBarrier, true>(pool, &barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700814}
815
John Zulauf6b4aae82018-05-09 13:03:36 -0600816template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -0600817bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
818 uint32_t barrier_count, const Barrier *barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600819 using BarrierRecord = QFOTransferBarrier<Barrier>;
820 bool skip = false;
Jeff Bolz6835fda2019-10-06 00:15:34 -0500821 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -0600822 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
823 const char *barrier_name = BarrierRecord::BarrierName();
824 const char *handle_name = BarrierRecord::HandleName();
825 const char *transfer_type = nullptr;
826 for (uint32_t b = 0; b < barrier_count; b++) {
827 if (!IsTransferOp(&barriers[b])) continue;
828 const BarrierRecord *barrier_record = nullptr;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700829 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufa4472282019-08-22 14:44:34 -0600830 !QueueFamilyIsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600831 const auto found = barrier_sets.release.find(barriers[b]);
832 if (found != barrier_sets.release.cend()) {
833 barrier_record = &(*found);
834 transfer_type = "releasing";
835 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600836 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufa4472282019-08-22 14:44:34 -0600837 !QueueFamilyIsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600838 const auto found = barrier_sets.acquire.find(barriers[b]);
839 if (found != barrier_sets.acquire.cend()) {
840 barrier_record = &(*found);
841 transfer_type = "acquiring";
842 }
843 }
844 if (barrier_record != nullptr) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700845 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOInCB(),
846 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
847 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
848 func_name, barrier_name, b, transfer_type, handle_name,
849 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
850 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -0600851 }
852 }
853 return skip;
854}
855
John Zulaufa4472282019-08-22 14:44:34 -0600856VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
857 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
858}
859
860const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
861 return device_state.GetImageState(barrier.image);
862}
863
864VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
865 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
866}
867
868const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
869 return device_state.GetBufferState(barrier.buffer);
870}
871
872VkBuffer BarrierHandle(const VkBufferMemoryBarrier &barrier) { return barrier.buffer; }
873
John Zulauf6b4aae82018-05-09 13:03:36 -0600874template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -0600875void CoreChecks::RecordBarrierArrayValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
876 const Barrier *barriers) {
Jeff Bolz6835fda2019-10-06 00:15:34 -0500877 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -0600878 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
879 for (uint32_t b = 0; b < barrier_count; b++) {
John Zulaufa4472282019-08-22 14:44:34 -0600880 auto &barrier = barriers[b];
881 if (IsTransferOp(&barrier)) {
882 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barrier) &&
883 !QueueFamilyIsSpecial(barrier.dstQueueFamilyIndex)) {
884 barrier_sets.release.emplace(barrier);
885 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barrier) &&
886 !QueueFamilyIsSpecial(barrier.srcQueueFamilyIndex)) {
887 barrier_sets.acquire.emplace(barrier);
888 }
889 }
890
891 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
892 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
893 if (!QueueFamilyIsIgnored(src_queue_family) && !QueueFamilyIsIgnored(dst_queue_family)) {
894 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
895 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
896 auto handle_state = BarrierHandleState(*this, barrier);
897 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
898 if (!mode_concurrent) {
899 const auto typed_handle = BarrierTypedHandle(barrier);
Jeff Bolz310775c2019-10-09 00:46:33 -0500900 cb_state->queue_submit_functions.emplace_back(
901 [func_name, cb_state, typed_handle, src_queue_family, dst_queue_family](
902 const ValidationStateTracker *device_data, const QUEUE_STATE *queue_state) {
903 return ValidateConcurrentBarrierAtSubmit(device_data, queue_state, func_name, cb_state, typed_handle,
904 src_queue_family, dst_queue_family);
John Zulaufa4472282019-08-22 14:44:34 -0600905 });
906 }
John Zulauf6b4aae82018-05-09 13:03:36 -0600907 }
908 }
909}
910
John Zulaufa4472282019-08-22 14:44:34 -0600911bool CoreChecks::ValidateBarriersQFOTransferUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600912 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700913 uint32_t imageMemBarrierCount,
John Zulaufa4472282019-08-22 14:44:34 -0600914 const VkImageMemoryBarrier *pImageMemBarriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600915 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700916 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
917 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -0600918 return skip;
919}
920
John Zulaufa4472282019-08-22 14:44:34 -0600921void CoreChecks::RecordBarrierValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
922 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
923 const VkImageMemoryBarrier *pImageMemBarriers) {
924 RecordBarrierArrayValidationInfo(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
925 RecordBarrierArrayValidationInfo(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -0600926}
927
928template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600929bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
John Zulauf3b04ebd2019-07-18 14:08:11 -0600930 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600931 // Record to the scoreboard or report that we have a duplication
932 bool skip = false;
933 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
934 if (!inserted.second && inserted.first->second != cb_state) {
935 // This is a duplication (but don't report duplicates from the same CB, as we do that at record time
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700936 skip = LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
937 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
938 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
939 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
940 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
941 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -0600942 }
943 return skip;
944}
945
946template <typename Barrier>
John Zulauf3b04ebd2019-07-18 14:08:11 -0600947bool CoreChecks::ValidateQueuedQFOTransferBarriers(const CMD_BUFFER_STATE *cb_state,
948 QFOTransferCBScoreboards<Barrier> *scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600949 using BarrierRecord = QFOTransferBarrier<Barrier>;
950 using TypeTag = typename BarrierRecord::Tag;
951 bool skip = false;
John Zulauf6b4aae82018-05-09 13:03:36 -0600952 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -0700953 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -0600954 const char *barrier_name = BarrierRecord::BarrierName();
955 const char *handle_name = BarrierRecord::HandleName();
956 // No release should have an extant duplicate (WARNING)
957 for (const auto &release : cb_barriers.release) {
958 // Check the global pending release barriers
959 const auto set_it = global_release_barriers.find(release.handle);
960 if (set_it != global_release_barriers.cend()) {
961 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
962 const auto found = set_for_handle.find(release);
963 if (found != set_for_handle.cend()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700964 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
965 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
966 " to dstQueueFamilyIndex %" PRIu32
967 " duplicates existing barrier queued for execution, without intervening acquire operation.",
968 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
969 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -0600970 }
971 }
972 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
973 }
974 // Each acquire must have a matching release (ERROR)
975 for (const auto &acquire : cb_barriers.acquire) {
976 const auto set_it = global_release_barriers.find(acquire.handle);
977 bool matching_release_found = false;
978 if (set_it != global_release_barriers.cend()) {
979 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
980 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
981 }
982 if (!matching_release_found) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700983 skip |= LogError(cb_state->commandBuffer, BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
984 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
985 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
986 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
987 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -0600988 }
989 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
990 }
991 return skip;
992}
993
John Zulauf3b04ebd2019-07-18 14:08:11 -0600994bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700995 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
John Zulauf3b04ebd2019-07-18 14:08:11 -0600996 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600997 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700998 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state, qfo_image_scoreboards);
999 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state, qfo_buffer_scoreboards);
John Zulauf6b4aae82018-05-09 13:03:36 -06001000 return skip;
1001}
1002
1003template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001004void CoreChecks::RecordQueuedQFOTransferBarriers(CMD_BUFFER_STATE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001005 using BarrierRecord = QFOTransferBarrier<Barrier>;
1006 using TypeTag = typename BarrierRecord::Tag;
1007 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001008 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001009
1010 // Add release barriers from this submit to the global map
1011 for (const auto &release : cb_barriers.release) {
1012 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1013 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1014 global_release_barriers[release.handle].insert(release);
1015 }
1016
1017 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1018 for (const auto &acquire : cb_barriers.acquire) {
1019 // NOTE: We're not using [] because we don't want to create entries for missing releases
1020 auto set_it = global_release_barriers.find(acquire.handle);
1021 if (set_it != global_release_barriers.end()) {
1022 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1023 set_for_handle.erase(acquire);
1024 if (set_for_handle.size() == 0) { // Clean up empty sets
1025 global_release_barriers.erase(set_it);
1026 }
1027 }
1028 }
1029}
1030
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001031void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001032 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state);
1033 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001034}
1035
John Zulauf6b4aae82018-05-09 13:03:36 -06001036// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001037void CoreChecks::EraseQFOImageRelaseBarriers(const VkImage &image) { EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image); }
John Zulauf6b4aae82018-05-09 13:03:36 -06001038
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001039void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001040 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001041 for (uint32_t i = 0; i < memBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +02001042 const auto &mem_barrier = pImgMemBarriers[i];
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001043
Chris Forbes4de4b132017-08-21 11:27:08 -07001044 // For ownership transfers, the barrier is specified twice; as a release
1045 // operation on the yielding queue family, and as an acquire operation
1046 // on the acquiring queue family. This barrier may also include a layout
1047 // transition, which occurs 'between' the two operations. For validation
1048 // purposes it doesn't seem important which side performs the layout
1049 // transition, but it must not be performed twice. We'll arbitrarily
1050 // choose to perform it as part of the acquire operation.
John Zulauf2be3fe02019-12-30 09:48:02 -07001051 //
1052 // However, we still need to record initial layout for the "initial layout" validation
1053 const bool is_release_op = IsReleaseOp(cb_state, mem_barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -07001054
Petr Krausad0096a2019-08-09 18:35:04 +02001055 auto *image_state = GetImageState(mem_barrier.image);
John Zulauff660ad62019-03-23 07:16:05 -06001056 if (!image_state) continue;
John Zulauf2be3fe02019-12-30 09:48:02 -07001057 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
unknown86bcb3a2019-07-11 13:05:36 -06001058 for (const auto &image : image_state->aliasing_images) {
1059 image_state = GetImageState(image);
John Zulauf2be3fe02019-12-30 09:48:02 -07001060 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
Dave Houltonb3f4b282018-02-22 16:25:16 -07001061 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001062 }
1063}
1064
unknown86bcb3a2019-07-11 13:05:36 -06001065void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
John Zulauf2be3fe02019-12-30 09:48:02 -07001066 const VkImageMemoryBarrier &mem_barrier, bool is_release_op) {
unknown86bcb3a2019-07-11 13:05:36 -06001067 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier.subresourceRange);
1068 const auto &image_create_info = image_state->createInfo;
1069
1070 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1071 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1072 // for all (potential) layer sub_resources.
1073 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
1074 normalized_isr.baseArrayLayer = 0;
1075 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
1076 }
1077
John Zulauf2be3fe02019-12-30 09:48:02 -07001078 if (is_release_op) {
1079 SetImageInitialLayout(cb_state, *image_state, normalized_isr, mem_barrier.oldLayout);
1080 } else {
1081 SetImageLayout(cb_state, *image_state, normalized_isr, mem_barrier.newLayout, mem_barrier.oldLayout);
1082 }
unknown86bcb3a2019-07-11 13:05:36 -06001083}
1084
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001085bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1086 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1087 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1088 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Matthew Ruschd7ef5482019-07-16 22:01:54 -07001089 if (disabled.image_layout_validation) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001090 assert(cb_node);
1091 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001092 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001093 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001094
John Zulauff660ad62019-03-23 07:16:05 -06001095 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1096 if (subresource_map) {
1097 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001098 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
John Zulauf5e617452019-11-19 14:44:16 -07001099 for (auto pos = subresource_map->Find(range); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1100 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001101 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001102 subres_skip |= LogError(cb_node->commandBuffer, layout_mismatch_msg_code,
1103 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1104 "%s layout %s.",
1105 caller, report_data->FormatHandle(image).c_str(), pos->subresource.arrayLayer,
1106 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1107 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001108 }
John Zulauf5e617452019-11-19 14:44:16 -07001109 }
John Zulauff660ad62019-03-23 07:16:05 -06001110 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001111 }
John Zulauff660ad62019-03-23 07:16:05 -06001112
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001113 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1114 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1115 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001116 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1117 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001118 skip |= LogPerformanceWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
1119 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
1120 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001121 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001122 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001123 if (image_state->shared_presentable) {
1124 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001125 skip |= LogError(device, layout_invalid_msg_code,
1126 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1127 string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001128 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001129 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001130 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001131 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001132 skip |= LogError(cb_node->commandBuffer, layout_invalid_msg_code,
1133 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1134 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1135 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001136 }
1137 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001138 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001139}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001140bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001141 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1142 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001143 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001144 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1145 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1146}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001147
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001148void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001149 FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinski2e495882019-03-06 16:11:56 -07001150 auto renderPass = GetRenderPassState(pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001151 if (!renderPass) return;
1152
Tobias Hectorbbb12282018-10-22 15:17:59 +01001153 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001154 if (framebuffer_state) {
1155 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07001156 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -06001157 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001158 VkImageLayout stencil_layout = kInvalidLayout;
1159 const auto *attachment_description_stencil_layout =
1160 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
1161 if (attachment_description_stencil_layout) {
1162 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1163 }
1164
1165 SetImageViewLayout(pCB, *view_state, pRenderPassInfo->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001166 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001167 }
1168 }
1169}
Dave Houltone19e20d2018-02-02 16:32:41 -07001170
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001171#ifdef VK_USE_PLATFORM_ANDROID_KHR
1172// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1173// This could also move into a seperate core_validation_android.cpp file... ?
1174
1175//
1176// AHB-specific validation within non-AHB APIs
1177//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001178bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001179 bool skip = false;
1180
1181 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1182 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001183 if (0 != ext_fmt_android->externalFormat) {
1184 if (VK_FORMAT_UNDEFINED != create_info->format) {
1185 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001186 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1187 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1188 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001189 }
1190
1191 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001192 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1193 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1194 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001195 }
1196
1197 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001198 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1199 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1200 "non-zero externalFormat, but usage includes bits other than VK_IMAGE_USAGE_SAMPLED_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001201 }
1202
1203 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001204 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1205 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1206 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001207 }
1208 }
1209
Mark Lobodzinski1ee06e92019-04-19 14:03:53 -06001210 if ((0 != ext_fmt_android->externalFormat) && (0 == ahb_ext_formats_set.count(ext_fmt_android->externalFormat))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001211 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
1212 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat which has "
1213 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001214 }
1215 }
1216
Dave Houltond9611312018-11-19 17:03:36 -07001217 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001218 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001219 skip |=
1220 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1221 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1222 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001223 }
1224 }
1225
1226 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1227 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1228 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001229 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001230 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1231 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1232 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1233 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001234 }
1235
1236 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001237 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1238 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1239 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1240 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1241 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001242 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001243 }
1244
1245 return skip;
1246}
1247
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001248bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001249 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001250 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001251
1252 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001253 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001254 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1255 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1256 "format member is %s.",
1257 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001258 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001259
Dave Houltond9611312018-11-19 17:03:36 -07001260 // Chain must include a compatible ycbcr conversion
1261 bool conv_found = false;
1262 uint64_t external_format = 0;
1263 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1264 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001265 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001266 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001267 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001268 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001269 }
Dave Houltond9611312018-11-19 17:03:36 -07001270 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001271 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001272 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
1273 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1274 "without a chained VkSamplerYcbcrConversionInfo struct with the same external format.");
Dave Houltond9611312018-11-19 17:03:36 -07001275 }
1276
1277 // Errors in create_info swizzles
1278 if ((create_info->components.r != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1279 (create_info->components.g != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1280 (create_info->components.b != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1281 (create_info->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001282 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1283 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1284 "includes one or more non-identity component swizzles.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001285 }
1286 }
Dave Houltond9611312018-11-19 17:03:36 -07001287
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001288 return skip;
1289}
1290
John Zulaufa26d3c82019-08-14 16:09:08 -06001291bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001292 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001293
John Zulaufa26d3c82019-08-14 16:09:08 -06001294 const IMAGE_STATE *image_state = GetImageState(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001295 if (image_state->imported_ahb && (0 == image_state->GetBoundMemory().size())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001296 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1297 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1298 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1299 "bound to memory.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001300 }
1301 return skip;
1302}
1303
1304#else
1305
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001306bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001307 return false;
1308}
1309
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001310bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001311
John Zulaufa26d3c82019-08-14 16:09:08 -06001312bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001313
1314#endif // VK_USE_PLATFORM_ANDROID_KHR
1315
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001316bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001317 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001318 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001319
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001320 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001321 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001322 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1323 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001324 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1325 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001326 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001327 }
1328
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001329 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1330 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001331 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1332 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1333 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001334 }
1335
1336 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001337 skip |= LogError(device, "VUID-VkImageCreateInfo-imageType-00954",
1338 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1339 "height (%d) and arrayLayers (%d) must be >= 6.",
1340 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001341 }
Dave Houlton130c0212018-01-29 13:39:56 -07001342 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001343
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001344 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001345 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1346 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1347 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001348 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
1349 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1350 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001351 }
1352
1353 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001354 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
1355 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1356 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001357 }
1358
ByumjinConffx991b6062019-08-14 15:17:53 -07001359 if (device_extensions.vk_ext_fragment_density_map) {
1360 uint32_t ceiling_width =
1361 (uint32_t)ceil((float)device_limits->maxFramebufferWidth /
1362 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, 1.0f));
1363 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1364 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001365 LogError(device, "VUID-VkImageCreateInfo-usage-02559",
1366 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1367 "ceiling of device "
1368 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1369 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1370 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001371 }
1372
1373 uint32_t ceiling_height =
1374 (uint32_t)ceil((float)device_limits->maxFramebufferHeight /
1375 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, 1.0f));
1376 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1377 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001378 LogError(device, "VUID-VkImageCreateInfo-usage-02560",
1379 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1380 "ceiling of device "
1381 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1382 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1383 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001384 }
1385 }
1386
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001387 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001388 VkResult result = VK_SUCCESS;
1389 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1390 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1391 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1392 &format_limits);
1393 } else {
1394 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>();
1395 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1396 image_format_info.type = pCreateInfo->imageType;
1397 image_format_info.tiling = pCreateInfo->tiling;
1398 image_format_info.usage = pCreateInfo->usage;
1399 image_format_info.flags = pCreateInfo->flags;
1400 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1401 format_limits = image_format_properties.imageFormatProperties;
1402 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001403
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001404 if (result == VK_ERROR_FORMAT_NOT_SUPPORTED) {
Lockee87f87c2019-04-23 17:53:10 -06001405#ifdef VK_USE_PLATFORM_ANDROID_KHR
1406 if (!lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext))
1407#endif // VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001408 skip |=
1409 LogError(device, kVUIDUndefined, "vkCreateImage(): Format %s is not supported for this combination of parameters.",
1410 string_VkFormat(pCreateInfo->format));
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001411 } else {
1412 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1413 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001414 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1415 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1416 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001417 }
Dave Houlton130c0212018-01-29 13:39:56 -07001418
Dave Houltona585d132019-01-18 13:05:42 -07001419 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1420 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1421 (uint64_t)pCreateInfo->samples;
1422 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * texel_count);
Dave Houlton130c0212018-01-29 13:39:56 -07001423
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001424 // Round up to imageGranularity boundary
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001425 VkDeviceSize imageGranularity = phys_dev_props.limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001426 uint64_t ig_mask = imageGranularity - 1;
1427 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001428
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001429 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001430 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
1431 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1432 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1433 total_size, format_limits.maxResourceSize);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001434 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001435
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001436 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001437 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
1438 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1439 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001440 }
1441
1442 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001443 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
1444 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
1445 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001446 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001447 }
1448
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001449 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsungcead0802020-01-30 22:20:10 -08001450 if (FormatRequiresYcbcrConversion(pCreateInfo->format)) {
1451 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
1452 const char *error_vuid = (device_extensions.vk_ext_ycbcr_image_arrays) ? "VUID-VkImageCreateInfo-format-02653"
1453 : "VUID-VkImageCreateInfo-format-02564";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001454 skip |= LogError(device, error_vuid,
1455 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
1456 "YCbCr Conversion format, arrayLayers must be 1",
1457 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001458 }
1459
1460 if (pCreateInfo->mipLevels != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001461 skip |= LogError(device, "VUID-VkImageCreateInfo-format-02561",
1462 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
1463 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001464 }
1465
1466 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001467 skip |= LogError(
1468 device, "VUID-VkImageCreateInfo-format-02562",
sfricke-samsungcead0802020-01-30 22:20:10 -08001469 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
1470 string_VkSampleCountFlagBits(pCreateInfo->samples));
1471 }
1472
1473 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001474 skip |= LogError(
1475 device, "VUID-VkImageCreateInfo-format-02563",
sfricke-samsungcead0802020-01-30 22:20:10 -08001476 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
1477 string_VkImageType(pCreateInfo->imageType));
1478 }
1479 }
1480
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06001481 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001482 skip |=
1483 LogError(device, "VUID-VkImageCreateInfo-flags-01924",
1484 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
1485 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06001486 }
1487
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001488 if (device_extensions.vk_khr_maintenance2) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06001489 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
1490 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
1491 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
1492 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001493 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001494 LogError(device, kVUIDUndefined,
1495 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1496 "format must be block, ETC or ASTC compressed, but is %s",
1497 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001498 }
1499 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
1500 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001501 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001502 LogError(device, kVUIDUndefined,
1503 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1504 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001505 }
1506 }
1507 }
1508
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001509 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001510 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateImage",
1511 "pCreateInfo->pQueueFamilyIndices", "VUID-VkImageCreateInfo-sharingMode-01420",
1512 "VUID-VkImageCreateInfo-sharingMode-01420", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001513 }
1514
unknown2c877272019-07-11 12:56:50 -06001515 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
1516 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
1517 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001518 LogError(device, "VUID-VkImageCreateInfo-format-01577",
1519 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
1520 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06001521 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001522 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001523}
1524
John Zulauf7eeb6f72019-06-17 11:56:36 -06001525void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1526 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
1527 if (VK_SUCCESS != result) return;
1528
1529 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
locke-lunarg20699892020-01-02 19:17:29 -07001530 auto image_state = Get<IMAGE_STATE>(*pImage);
1531 AddInitialLayoutintoImageLayoutMap(*image_state, imageLayoutMap);
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001532}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001533
Jeff Bolz5c801d12019-10-09 10:38:45 -05001534bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001535 const IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06001536 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001537 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001538 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001539 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001540 }
1541 return skip;
1542}
1543
John Zulauf7eeb6f72019-06-17 11:56:36 -06001544void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
1545 // Clean up validation specific data
1546 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001547
locke-lunargcba7d5f2019-12-30 16:59:11 -07001548 imageLayoutMap.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06001549
1550 // Clean up generic image state
1551 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001552}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001553
John Zulauf07288512019-07-05 11:09:50 -06001554bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001555 bool skip = false;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001556
1557 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
1558 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001559 skip |= LogError(image_state->image, kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001560 }
1561
Dave Houlton1d2022c2017-03-29 11:43:58 -06001562 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001563 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001564 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -06001565 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001566 char const str[] = "vkCmdClearColorImage called with compressed image.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001567 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001568 }
1569
1570 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
1571 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001572 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-image-00002", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001573 }
1574 return skip;
1575}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001576
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001577uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1578 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1579 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001580 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001581 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001582 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001583 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001584}
1585
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001586uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1587 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1588 uint32_t array_layer_count = range->layerCount;
1589 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1590 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001591 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001592 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001593}
1594
John Zulauf07288512019-07-05 11:09:50 -06001595bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1596 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
1597 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001598 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001599 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1600 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001601 skip |= LogError(image_state->image, "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
1602 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1603 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001604 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001605
1606 } else {
1607 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1608 if (!device_extensions.vk_khr_shared_presentable_image) {
1609 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001610 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-imageLayout-00005",
1611 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1612 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001613 }
1614 } else {
1615 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
1616 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001617 skip |= LogError(
1618 image_state->image, "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001619 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
1620 func_name, string_VkImageLayout(dest_image_layout));
1621 }
1622 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001623 }
1624
John Zulauff660ad62019-03-23 07:16:05 -06001625 // Cast to const to prevent creation at validate time.
John Zulauf07288512019-07-05 11:09:50 -06001626 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06001627 if (subresource_map) {
1628 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001629 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06001630 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
John Zulauf5e617452019-11-19 14:44:16 -07001631 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1632 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06001633 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
1634 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1635 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
1636 } else {
1637 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001638 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001639 subres_skip |= LogError(cb_node->commandBuffer, error_code,
1640 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
1641 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
1642 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001643 }
John Zulauf5e617452019-11-19 14:44:16 -07001644 }
John Zulauff660ad62019-03-23 07:16:05 -06001645 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001646 }
1647
1648 return skip;
1649}
1650
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001651bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1652 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001653 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001654 bool skip = false;
1655 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06001656 const auto *cb_node = GetCBState(commandBuffer);
1657 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001658 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001659 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001660 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001661 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001662 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07001663 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001664 skip |=
1665 ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
1666 "VUID-vkCmdClearColorImage-image-01993", "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001667 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001668 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001669 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001670 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001671 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001672 skip |= ValidateImageAttributes(image_state, pRanges[i]);
1673 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001674 }
sfricke-samsunge775d492020-02-28 09:02:25 -08001675 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
1676 if (FormatRequiresYcbcrConversion(image_state->createInfo.format)) {
1677 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
1678 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
1679 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
1680 string_VkFormat(image_state->createInfo.format));
1681 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001682 }
1683 return skip;
1684}
1685
John Zulaufeabb4462019-07-05 14:13:03 -06001686void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1687 const VkClearColorValue *pColor, uint32_t rangeCount,
1688 const VkImageSubresourceRange *pRanges) {
1689 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
1690
1691 auto cb_node = GetCBState(commandBuffer);
1692 auto image_state = GetImageState(image);
1693 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001694 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001695 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001696 }
1697 }
1698}
1699
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001700bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1701 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001702 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001703 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001704
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001705 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06001706 const auto *cb_node = GetCBState(commandBuffer);
1707 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001708 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001709 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06001710 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001711 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001712 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001713 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07001714 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001715 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
1716 "VUID-vkCmdClearDepthStencilImage-image-01994",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001717 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001718 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001719 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Andrew Fobel3abeb992020-01-20 16:33:22 -05001720
1721 bool any_include_aspect_depth_bit = false;
1722 bool any_include_aspect_stencil_bit = false;
1723
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001724 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001725 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001726 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001727 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001728 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001729 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1730 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001731 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001732 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1733 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001734 skip |= LogError(commandBuffer, kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001735 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05001736 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
1737 any_include_aspect_depth_bit = true;
1738 }
1739 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
1740 any_include_aspect_stencil_bit = true;
1741 }
1742 }
1743 if (any_include_aspect_stencil_bit) {
1744 const auto image_stencil_struct = lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
1745 if (image_stencil_struct != nullptr) {
1746 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
1747 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001748 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
1749 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
1750 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
1751 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05001752 }
1753 } else {
1754 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001755 skip |= LogError(
1756 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05001757 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
1758 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
1759 "in VkImageCreateInfo::usage used to create image");
1760 }
1761 }
1762 }
1763 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001764 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
1765 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
1766 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001767 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001768 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001769 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001770 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001771 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001772 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1773 char const str[] =
1774 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1775 "set.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001776 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001777 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001778 }
1779 return skip;
1780}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001781
John Zulaufeabb4462019-07-05 14:13:03 -06001782void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1783 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1784 const VkImageSubresourceRange *pRanges) {
1785 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
1786 auto cb_node = GetCBState(commandBuffer);
1787 auto image_state = GetImageState(image);
1788 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001789 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001790 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001791 }
1792 }
1793}
1794
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001795// Returns true if [x, xoffset] and [y, yoffset] overlap
1796static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1797 bool result = false;
1798 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1799 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1800
1801 if (intersection_max > intersection_min) {
1802 result = true;
1803 }
1804 return result;
1805}
1806
Dave Houltonc991cc92018-03-06 11:08:51 -07001807// Returns true if source area of first copy region intersects dest area of second region
1808// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1809static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001810 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001811
Dave Houltonc991cc92018-03-06 11:08:51 -07001812 // Separate planes within a multiplane image cannot intersect
1813 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07001814 return result;
1815 }
1816
Dave Houltonc991cc92018-03-06 11:08:51 -07001817 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
1818 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
1819 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001820 result = true;
1821 switch (type) {
1822 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001823 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001824 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001825 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001826 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001827 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001828 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001829 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001830 break;
1831 default:
1832 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1833 assert(false);
1834 }
1835 }
1836 return result;
1837}
1838
Dave Houltonfc1a4052017-04-27 14:32:45 -06001839// Returns non-zero if offset and extent exceed image extents
1840static const uint32_t x_bit = 1;
1841static const uint32_t y_bit = 2;
1842static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001843static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001844 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001845 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001846 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1847 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001848 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001849 }
1850 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1851 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001852 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001853 }
1854 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1855 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001856 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001857 }
1858 return result;
1859}
1860
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001861// Test if two VkExtent3D structs are equivalent
1862static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1863 bool result = true;
1864 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1865 (extent->depth != other_extent->depth)) {
1866 result = false;
1867 }
1868 return result;
1869}
1870
Dave Houltonee281a52017-12-08 13:51:02 -07001871// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1872// Destination image texel extents must be adjusted by block size for the dest validation checks
1873VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1874 VkExtent3D adjusted_extent = extent;
unknown948b6ba2019-09-19 17:32:54 -06001875 if ((FormatIsCompressed(src_format) || FormatIsSinglePlane_422(src_format)) &&
1876 !(FormatIsCompressed(dst_format) || FormatIsSinglePlane_422(dst_format))) {
Dave Houltona585d132019-01-18 13:05:42 -07001877 VkExtent3D block_size = FormatTexelBlockExtent(src_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001878 adjusted_extent.width /= block_size.width;
1879 adjusted_extent.height /= block_size.height;
1880 adjusted_extent.depth /= block_size.depth;
unknown948b6ba2019-09-19 17:32:54 -06001881 } else if (!(FormatIsCompressed(src_format) || FormatIsSinglePlane_422(src_format)) &&
1882 (FormatIsCompressed(dst_format) || FormatIsSinglePlane_422(dst_format))) {
Dave Houltona585d132019-01-18 13:05:42 -07001883 VkExtent3D block_size = FormatTexelBlockExtent(dst_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001884 adjusted_extent.width *= block_size.width;
1885 adjusted_extent.height *= block_size.height;
1886 adjusted_extent.depth *= block_size.depth;
1887 }
1888 return adjusted_extent;
1889}
1890
Dave Houlton6f9059e2017-05-02 17:15:13 -06001891// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001892static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1893 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001894
1895 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06001896 if (mip >= img->createInfo.mipLevels) {
1897 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06001898 }
Dave Houlton1150cf52017-04-27 14:38:11 -06001899
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001900 // 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 -06001901 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05001902
Dave Houltone48cd112019-01-03 17:01:18 -07001903 // If multi-plane, adjust per-plane extent
1904 if (FormatIsMultiplane(img->createInfo.format)) {
1905 VkExtent2D divisors = FindMultiplaneExtentDivisors(img->createInfo.format, subresource->aspectMask);
1906 extent.width /= divisors.width;
1907 extent.height /= divisors.height;
1908 }
1909
Jeff Bolzef40fec2018-09-01 22:04:34 -05001910 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
1911 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
Dave Houlton142c4cb2018-10-17 15:04:41 -06001912 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1) >> mip)));
Jeff Bolzef40fec2018-09-01 22:04:34 -05001913 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
1914 } else {
1915 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1916 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1917 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
1918 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06001919
Dave Houlton6f9059e2017-05-02 17:15:13 -06001920 // Image arrays have an effective z extent that isn't diminished by mip level
1921 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001922 extent.depth = img->createInfo.arrayLayers;
1923 }
1924
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001925 return extent;
1926}
1927
1928// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001929static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001930 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1931}
1932
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001933// Test if the extent argument has any dimensions set to 0.
1934static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1935 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1936}
1937
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001938// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001939VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001940 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1941 VkExtent3D granularity = {0, 0, 0};
Jeff Bolz6835fda2019-10-06 00:15:34 -05001942 auto pPool = cb_node->command_pool.get();
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001943 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001944 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06001945 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07001946 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001947 granularity.width *= block_size.width;
1948 granularity.height *= block_size.height;
1949 }
1950 }
1951 return granularity;
1952}
1953
1954// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1955static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1956 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001957 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
1958 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001959 valid = false;
1960 }
1961 return valid;
1962}
1963
1964// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001965bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001966 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001967 bool skip = false;
1968 VkExtent3D offset_extent = {};
1969 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1970 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1971 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001972 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001973 // 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 -07001974 if (IsExtentAllZeroes(&offset_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001975 skip |= LogError(cb_node->commandBuffer, vuid,
1976 "%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 "
1977 "image transfer granularity is (w=0, h=0, d=0).",
1978 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001979 }
1980 } else {
1981 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1982 // integer multiples of the image transfer granularity.
1983 if (IsExtentAligned(&offset_extent, granularity) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001984 skip |= LogError(cb_node->commandBuffer, vuid,
1985 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
1986 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
1987 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
1988 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001989 }
1990 }
1991 return skip;
1992}
1993
1994// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001995bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001996 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001997 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001998 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001999 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002000 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2001 // subresource extent.
2002 if (IsExtentEqual(extent, subresource_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002003 skip |= LogError(cb_node->commandBuffer, vuid,
2004 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2005 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2006 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2007 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002008 }
2009 } else {
2010 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2011 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2012 // subresource extent dimensions.
2013 VkExtent3D offset_extent_sum = {};
2014 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2015 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2016 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002017 bool x_ok = true;
2018 bool y_ok = true;
2019 bool z_ok = true;
2020 switch (image_type) {
2021 case VK_IMAGE_TYPE_3D:
2022 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2023 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002024 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002025 case VK_IMAGE_TYPE_2D:
2026 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2027 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002028 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002029 case VK_IMAGE_TYPE_1D:
2030 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2031 (subresource_extent->width == offset_extent_sum.width));
2032 break;
2033 default:
2034 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2035 assert(false);
2036 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002037 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002038 skip |=
2039 LogError(cb_node->commandBuffer, vuid,
2040 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2041 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2042 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2043 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2044 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2045 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002046 }
2047 }
2048 return skip;
2049}
2050
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002051bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002052 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002053 bool skip = false;
2054 if (mip_level >= img->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002055 skip |= LogError(cb_node->commandBuffer, vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2056 function, i, member, mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002057 }
2058 return skip;
2059}
2060
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002061bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002062 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002063 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002064 bool skip = false;
2065 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2066 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002067 skip |= LogError(cb_node->commandBuffer, vuid,
2068 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2069 "%u, but provided %s has %u array layers.",
2070 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2071 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002072 }
2073 return skip;
2074}
2075
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002076// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002077bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002078 const VkBufferImageCopy *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002079 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002080 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002081 VkExtent3D granularity = GetScaledItg(cb_node, img);
2082 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002083 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002084 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002085 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002086 return skip;
2087}
2088
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002089// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002090bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002091 const IMAGE_STATE *dst_img, const VkImageCopy *region,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002092 const uint32_t i, const char *function) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002093 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002094 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002095 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
2096 skip |=
2097 CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002098 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002099 const VkExtent3D extent = region->extent;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002100 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
2101 i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002102
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002103 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002104 granularity = GetScaledItg(cb_node, dst_img);
2105 skip |=
2106 CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002107 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002108 const VkExtent3D dest_effective_extent =
2109 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002110 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002111 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002112 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002113 return skip;
2114}
2115
Dave Houlton6f9059e2017-05-02 17:15:13 -06002116// Validate contents of a VkImageCopy struct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002117bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const VkImageCopy *ic_regions, const IMAGE_STATE *src_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002118 const IMAGE_STATE *dst_state) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002119 bool skip = false;
2120
2121 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002122 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002123
2124 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002125 const VkExtent3D src_copy_extent = region.extent;
2126 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002127 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2128
Dave Houlton6f9059e2017-05-02 17:15:13 -06002129 bool slice_override = false;
2130 uint32_t depth_slices = 0;
2131
2132 // Special case for copying between a 1D/2D array and a 3D image
2133 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2134 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002135 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002136 slice_override = (depth_slices != 1);
2137 } 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 -07002138 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002139 slice_override = (depth_slices != 1);
2140 }
2141
2142 // Do all checks on source image
2143 //
2144 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002145 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002146 skip |=
2147 LogError(src_state->image, "VUID-VkImageCopy-srcImage-00146",
2148 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2149 "be 0 and 1, respectively.",
2150 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002151 }
2152 }
2153
Dave Houlton533be9f2018-03-26 17:08:30 -06002154 // VUID-VkImageCopy-srcImage-01785
2155 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002156 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-01785",
2157 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
2158 "these must be 0 and 1, respectively.",
2159 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002160 }
2161
Dave Houlton533be9f2018-03-26 17:08:30 -06002162 // VUID-VkImageCopy-srcImage-01787
2163 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002164 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-01787",
2165 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2166 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002167 }
2168
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002169 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002170 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002171 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002172 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002173 LogError(src_state->image, "VUID-VkImageCopy-srcImage-00141",
2174 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2175 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2176 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002177 }
2178 }
2179 } else { // Pre maint 1
2180 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002181 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002182 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-00141",
2183 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2184 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2185 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2186 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002187 }
2188 }
2189 }
2190
Dave Houltonc991cc92018-03-06 11:08:51 -07002191 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002192 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002193 if (FormatIsCompressed(src_state->createInfo.format) ||
2194 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002195 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002196 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002197 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2198 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2199 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002200 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002201 skip |= LogError(src_state->image, vuid,
2202 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
2203 "texel width & height (%d, %d).",
2204 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002205 }
2206
Dave Houlton94a00372017-12-14 15:08:47 -07002207 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002208 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2209 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002210 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002211 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002212 LogError(src_state->image, vuid,
2213 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2214 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2215 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002216 }
2217
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002218 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002219 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2220 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002221 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002222 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002223 LogError(src_state->image, vuid,
2224 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2225 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2226 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002227 }
2228
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002229 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002230 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2231 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002232 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002233 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002234 LogError(src_state->image, vuid,
2235 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2236 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2237 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002238 }
2239 } // Compressed
2240
2241 // Do all checks on dest image
2242 //
2243 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002244 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002245 skip |= LogError(dst_state->image, "VUID-VkImageCopy-dstImage-00152",
2246 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
2247 "these must be 0 and 1, respectively.",
2248 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002249 }
2250 }
2251
Dave Houlton533be9f2018-03-26 17:08:30 -06002252 // VUID-VkImageCopy-dstImage-01786
2253 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002254 skip |=
2255 LogError(dst_state->image, "VUID-VkImageCopy-dstImage-01786",
2256 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2257 "and 1, respectively.",
2258 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002259 }
2260
2261 // VUID-VkImageCopy-dstImage-01788
2262 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002263 skip |= LogError(dst_state->image, "VUID-VkImageCopy-dstImage-01788",
2264 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2265 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002266 }
2267
2268 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002269 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002270 skip |= LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00141",
2271 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2272 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2273 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002274 }
2275 }
2276 // VU01199 changed with mnt1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002277 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002278 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002279 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002280 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002281 LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00141",
2282 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2283 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2284 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002285 }
2286 }
2287 } else { // Pre maint 1
2288 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002289 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002290 skip |= LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00141",
2291 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2292 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2293 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2294 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002295 }
2296 }
2297 }
2298
Dave Houltonc991cc92018-03-06 11:08:51 -07002299 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2300 if (FormatIsCompressed(dst_state->createInfo.format) ||
2301 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002302 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002303
2304 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002305 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2306 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2307 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002308 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002309 skip |= LogError(dst_state->image, vuid,
2310 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
2311 "texel width & height (%d, %d).",
2312 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002313 }
2314
Dave Houlton94a00372017-12-14 15:08:47 -07002315 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002316 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2317 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002318 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002319 skip |= LogError(
2320 dst_state->image, vuid,
2321 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2322 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2323 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002324 }
2325
Dave Houltonee281a52017-12-08 13:51:02 -07002326 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2327 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2328 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002329 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002330 skip |= LogError(dst_state->image, vuid,
2331 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2332 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2333 "height (%d).",
2334 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002335 }
2336
Dave Houltonee281a52017-12-08 13:51:02 -07002337 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2338 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2339 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002340 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002341 skip |= LogError(
2342 dst_state->image, vuid,
2343 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2344 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2345 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002346 }
2347 } // Compressed
2348 }
2349 return skip;
2350}
2351
Dave Houltonc991cc92018-03-06 11:08:51 -07002352// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002353bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002354 const IMAGE_STATE *dst_image_state, const VkImageCopy region) const {
Dave Houltonc991cc92018-03-06 11:08:51 -07002355 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002356
2357 // Neither image is multiplane
2358 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2359 // If neither image is multi-plane the aspectMask member of src and dst must match
2360 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2361 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002362 ss << "vkCmdCopyImage(): Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002363 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002364 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002365 }
2366 } else {
2367 // Source image multiplane checks
2368 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2369 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2370 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2371 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002372 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002373 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002374 }
2375 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2376 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2377 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002378 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002379 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002380 }
2381 // Single-plane to multi-plane
2382 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2383 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2384 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002385 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002386 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002387 }
2388
2389 // Dest image multiplane checks
2390 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2391 aspect = region.dstSubresource.aspectMask;
2392 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2393 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002394 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002395 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002396 }
2397 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2398 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2399 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002400 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002401 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002402 }
2403 // Multi-plane to single-plane
2404 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2405 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2406 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002407 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002408 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002409 }
2410 }
2411
2412 return skip;
2413}
2414
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002415bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2416 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002417 const VkImageCopy *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002418 const auto *cb_node = GetCBState(commandBuffer);
2419 const auto *src_image_state = GetImageState(srcImage);
2420 const auto *dst_image_state = GetImageState(dstImage);
sfricke-samsungdce5f692020-03-07 13:59:31 -08002421 const VkFormat src_format = src_image_state->createInfo.format;
2422 const VkFormat dst_format = dst_image_state->createInfo.format;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002423 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002424
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002425 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002426
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002427 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2428
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002429 for (uint32_t i = 0; i < regionCount; i++) {
2430 const VkImageCopy region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002431
2432 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2433 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08002434 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07002435
Dave Houlton6f9059e2017-05-02 17:15:13 -06002436 bool slice_override = false;
2437 uint32_t depth_slices = 0;
2438
2439 // Special case for copying between a 1D/2D array and a 3D image
2440 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2441 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2442 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002443 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002444 slice_override = (depth_slices != 1);
2445 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2446 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002447 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002448 slice_override = (depth_slices != 1);
2449 }
2450
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002451 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2452 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
2453 skip |= ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002454 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002455 skip |= ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002456 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002457 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002458 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2459 "VUID-vkCmdCopyImage-srcSubresource-01698");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002460 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002461 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2462 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002463
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002464 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002465 // No chance of mismatch if we're overriding depth slice count
2466 if (!slice_override) {
2467 // The number of depth slices in srcSubresource and dstSubresource must match
2468 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2469 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002470 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2471 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002472 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002473 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2474 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002475 if (src_slices != dst_slices) {
2476 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002477 ss << "vkCmdCopyImage(): number of depth slices in source and destination subresources for pRegions[" << i
Dave Houlton6f9059e2017-05-02 17:15:13 -06002478 << "] do not match";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002479 skip |= LogError(command_buffer, "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06002480 }
2481 }
2482 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002483 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002484 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002485 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002486 ss << "vkCmdCopyImage(): number of layers in source and destination subresources for pRegions[" << i
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002487 << "] do not match";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002488 skip |= LogError(command_buffer, "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002489 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002490 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002491
Dave Houltonc991cc92018-03-06 11:08:51 -07002492 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002493 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002494 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region);
Dave Houltonc991cc92018-03-06 11:08:51 -07002495 }
2496
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002497 if (!device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002498 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2499 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002500 char const str[] = "vkCmdCopyImage(): Src and dest aspectMasks for each region must match";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002501 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002502 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002503 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002504
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002505 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002506 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002507 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002508 ss << "vkCmdCopyImage(): pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002509 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002510 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002511 }
2512
2513 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002514 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002515 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002516 ss << "vkCmdCopyImage(): pRegion[" << i
2517 << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002518 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002519 }
2520
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002521 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
2522 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
2523 // 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 -07002524 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2525 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002526 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002527 ss << "vkCmdCopyImage(): Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002528 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
2529 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
2530 << " ] exceeds the source image dimensions";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002531 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-pRegions-00122", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002532 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002533
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002534 // 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 -07002535 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2536 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002537 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002538 ss << "vkCmdCopyImage(): Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002539 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
2540 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
2541 << " ] exceeds the destination image dimensions";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002542 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-pRegions-00123", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002543 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002544 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002545
Dave Houltonfc1a4052017-04-27 14:32:45 -06002546 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002547 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2548 if (slice_override) src_copy_extent.depth = depth_slices;
2549 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002550 if (extent_check & x_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002551 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002552 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00144",
2553 "vkCmdCopyImage(): Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2554 "width [%1d].",
2555 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002556 }
2557
2558 if (extent_check & y_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002559 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002560 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00145",
2561 "vkCmdCopyImage(): Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2562 "height [%1d].",
2563 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002564 }
2565 if (extent_check & z_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002566 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002567 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00147",
2568 "vkCmdCopyImage(): Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2569 "depth [%1d].",
2570 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002571 }
2572
Dave Houltonee281a52017-12-08 13:51:02 -07002573 // Adjust dest extent if necessary
2574 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2575 if (slice_override) dst_copy_extent.depth = depth_slices;
2576
2577 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002578 if (extent_check & x_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002579 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00150",
2580 "vkCmdCopyImage(): Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2581 "width [%1d].",
2582 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002583 }
2584 if (extent_check & y_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002585 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00151",
2586 "vkCmdCopyImage(): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2587 "height [%1d].",
2588 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002589 }
2590 if (extent_check & z_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002591 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00153",
2592 "vkCmdCopyImage(): Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2593 "depth [%1d].",
2594 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002595 }
2596
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002597 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2598 // must not overlap in memory
2599 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002600 for (uint32_t j = 0; j < regionCount; j++) {
2601 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
sfricke-samsungdce5f692020-03-07 13:59:31 -08002602 FormatIsMultiplane(src_format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002603 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002604 ss << "vkCmdCopyImage(): pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002605 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002606 }
2607 }
2608 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08002609
2610 // Check depth for 2D as post Maintaince 1 requires both while prior only required one to be 2D
2611 if (device_extensions.vk_khr_maintenance1) {
2612 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
2613 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
2614 (src_copy_extent.depth != 1)) {
2615 skip |= LogError(
2616 command_buffer, "VUID-VkImageCopy-srcImage-01790",
2617 "vkCmdCopyImage(): pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1", i,
2618 src_copy_extent.depth);
2619 }
2620 } else {
2621 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
2622 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
2623 (src_copy_extent.depth != 1)) {
2624 skip |= LogError(
2625 command_buffer, "VUID-VkImageCopy-srcImage-01789",
2626 "vkCmdCopyImage(): pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1", i,
2627 src_copy_extent.depth);
2628 }
2629 }
2630
2631 // Check if 2D with 3D and depth not equal to 2D layerCount
2632 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
2633 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2634 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
2635 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01791",
2636 "vkCmdCopyImage(): pRegion[%u] srcImage is 2D, dstImage is 3D and extent.depth is %u and has to be "
2637 "srcSubresource.layerCount (%u)",
2638 i, src_copy_extent.depth, region.srcSubresource.layerCount);
2639 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2640 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
2641 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
2642 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01792",
2643 "vkCmdCopyImage(): pRegion[%u] srcImage is 3D, dstImage is 2D and extent.depth is %u and has to be "
2644 "dstSubresource.layerCount (%u)",
2645 i, src_copy_extent.depth, region.dstSubresource.layerCount);
2646 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002647 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002648
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002649 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2650 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2651 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
sfricke-samsungdce5f692020-03-07 13:59:31 -08002652 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
2653 if (src_format != dst_format) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002654 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002655 skip |= LogError(command_buffer, kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002656 }
2657 } else {
sfricke-samsungdce5f692020-03-07 13:59:31 -08002658 if ((!FormatSizesAreEqual(src_format, dst_format, regionCount, pRegions)) && (!FormatIsMultiplane(src_format)) &&
2659 (!FormatIsMultiplane(dst_format))) {
2660 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-vkCmdCopyImage-srcImage-01548"
2661 : "VUID-vkCmdCopyImage-srcImage-00135";
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002662 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
sfricke-samsungdce5f692020-03-07 13:59:31 -08002663 skip |= LogError(command_buffer, vuid, "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002664 }
2665 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002666
Dave Houlton33c22b72017-02-28 13:16:02 -07002667 // Source and dest image sample counts must match
2668 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2669 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002670 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002671 }
2672
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002673 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2674 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002675 // Validate that SRC & DST images have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002676 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyImage-srcImage-00126",
2677 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2678 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyImage-dstImage-00131",
2679 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002680 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002681 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
2682 "VUID-vkCmdCopyImage-srcImage-01995", "VUID-vkCmdCopyImage-srcImage-01995");
2683 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
2684 "VUID-vkCmdCopyImage-dstImage-01996", "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002685 }
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002686 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyImage()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002687 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002688 skip |= ValidateCmd(cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
2689 skip |= InsideRenderPass(cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002690 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002691 const char *invalid_src_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2692 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2693 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
2694 const char *invalid_dst_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2695 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2696 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002697 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002698 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002699 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2700 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002701 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002702 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2703 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002704 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
2705 "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002706 }
2707
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002708 return skip;
2709}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002710
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002711void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2712 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2713 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06002714 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
2715 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06002716 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002717 auto src_image_state = GetImageState(srcImage);
2718 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002719
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002720 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002721 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002722 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
2723 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002724 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002725}
2726
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002727// Returns true if sub_rect is entirely contained within rect
2728static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2729 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2730 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2731 return false;
2732 return true;
2733}
2734
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002735bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002736 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
2737 const VkRect2D &render_area, uint32_t rect_count,
2738 const VkClearRect *clear_rects) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07002739 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07002740 const IMAGE_VIEW_STATE *image_view_state = nullptr;
2741 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07002742 image_view_state = GetImageViewState(framebuffer->createInfo.pAttachments[fb_attachment]);
John Zulauff2582972019-02-09 14:53:30 -07002743 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002744
2745 for (uint32_t j = 0; j < rect_count; j++) {
2746 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002747 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00016",
2748 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2749 "the current render pass instance.",
2750 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07002751 }
2752
2753 if (image_view_state) {
2754 // The layers specified by a given element of pRects must be contained within every attachment that
2755 // pAttachments refers to
2756 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
2757 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
2758 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002759 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00017",
2760 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
2761 "of pAttachment[%d].",
2762 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07002763 }
2764 }
2765 }
2766 return skip;
2767}
2768
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002769bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2770 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002771 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002772 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06002773 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02002774 if (!cb_node) return skip;
2775
2776 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
2777 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
2778 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Petr Kraus2dffb382019-08-10 02:52:12 +02002779 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002780
2781 // Validate that attachment is in reference list of active subpass
2782 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002783 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07002784 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01002785 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002786 const auto *framebuffer = GetFramebufferState(cb_node->activeFramebuffer);
John Zulauf3a548ef2019-02-01 16:14:07 -07002787 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002788
John Zulauf3a548ef2019-02-01 16:14:07 -07002789 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2790 auto clear_desc = &pAttachments[attachment_index];
2791 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002792
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002793 if (0 == clear_desc->aspectMask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002794 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002795 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002796 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002797 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07002798 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
2799 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
2800 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2801 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002802 skip |= LogError(
2803 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
2804 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
2805 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
2806 attachment_index, clear_desc->colorAttachment,
2807 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
2808 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07002809
John Zulauff2582972019-02-09 14:53:30 -07002810 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
2811 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002812 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002813 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
2814 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
2815 " subpass %u. colorAttachmentCount=%u",
2816 attachment_index, clear_desc->colorAttachment,
2817 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
2818 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002819 }
John Zulauff2582972019-02-09 14:53:30 -07002820 fb_attachment = color_attachment;
2821
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002822 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2823 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2824 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002825 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002826 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002827 }
2828 } else { // Must be depth and/or stencil
2829 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2830 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002831 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002832 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-parameter", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002833 }
2834 if (!subpass_desc->pDepthStencilAttachment ||
2835 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002836 skip |= LogPerformanceWarning(
2837 commandBuffer, kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002838 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002839 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07002840 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002841 }
2842 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002843 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002844 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
2845 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06002846 }
2847 }
2848 }
2849 return skip;
2850}
2851
2852void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2853 const VkClearAttachment *pAttachments, uint32_t rectCount,
2854 const VkClearRect *pRects) {
2855 auto *cb_node = GetCBState(commandBuffer);
2856 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
2857 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
2858 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
2859 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
2860 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2861 const auto clear_desc = &pAttachments[attachment_index];
2862 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
2863 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
2864 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
2865 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2866 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
2867 subpass_desc->pDepthStencilAttachment) {
2868 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
2869 }
2870 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07002871 if (!clear_rect_copy) {
2872 // We need a copy of the clear rectangles that will persist until the last lambda executes
2873 // but we want to create it as lazily as possible
2874 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002875 }
John Zulauf441558b2019-08-12 11:47:39 -06002876 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
2877 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002878 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
John Zulauff1640d12019-08-13 15:39:58 -06002879 const CMD_BUFFER_STATE *prim_cb, VkFramebuffer fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07002880 assert(rectCount == clear_rect_copy->size());
John Zulauf441558b2019-08-12 11:47:39 -06002881 const FRAMEBUFFER_STATE *framebuffer = GetFramebufferState(fb);
John Zulauf3a548ef2019-02-01 16:14:07 -07002882 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
2883 bool skip = false;
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002884 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
2885 rectCount, clear_rect_copy->data());
John Zulauf3a548ef2019-02-01 16:14:07 -07002886 return skip;
2887 };
2888 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002889 }
2890 }
2891 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002892}
2893
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002894bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2895 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002896 const VkImageResolve *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002897 const auto *cb_node = GetCBState(commandBuffer);
2898 const auto *src_image_state = GetImageState(srcImage);
2899 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002900
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002901 bool skip = false;
2902 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002903 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-srcImage-00256");
2904 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-00258");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002905 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002906 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002907 skip |= ValidateCmd(cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
2908 skip |= InsideRenderPass(cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002909 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, "vkCmdResolveImage()",
2910 "VUID-vkCmdResolveImage-dstImage-02003", "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002911
Cort Stratton7df30962018-05-17 19:45:57 -07002912 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002913 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002914 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002915 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
2916 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
2917 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002918 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002919 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
2920 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002921 // For each region, the number of layers in the image subresource should not be zero
2922 // For each region, src and dest image aspect must be color only
2923 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002924 skip |=
2925 ValidateImageSubresourceLayers(cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()", "srcSubresource", i);
2926 skip |=
2927 ValidateImageSubresourceLayers(cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()", "dstSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002928 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002929 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
2930 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002931 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002932 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
2933 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002934 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i, "vkCmdResolveImage()",
2935 "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
2936 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i, "vkCmdResolveImage()",
2937 "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
2938 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002939 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2940 "VUID-vkCmdResolveImage-srcSubresource-01711");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002941 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002942 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2943 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07002944
2945 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002946 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002947 skip |= LogError(
2948 cb_node->commandBuffer, "VUID-VkImageResolve-layerCount-00267",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002949 "vkCmdResolveImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002950 }
Cort Stratton7df30962018-05-17 19:45:57 -07002951 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002952 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
2953 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
2954 char const str[] =
Graeme Leese79b60cb2018-11-28 11:51:20 +00002955 "vkCmdResolveImage(): src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002956 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002957 }
2958 }
2959
2960 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2961 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002962 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002963 }
2964 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
2965 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002966 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageType, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002967 }
2968 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
2969 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002970 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-srcImage-00257", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002971 }
2972 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
2973 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002974 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-dstImage-00259", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002975 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002976 } else {
2977 assert(0);
2978 }
2979 return skip;
2980}
2981
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002982bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2983 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002984 const VkImageBlit *pRegions, VkFilter filter) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002985 const auto *cb_node = GetCBState(commandBuffer);
2986 const auto *src_image_state = GetImageState(srcImage);
2987 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002988
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002989 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07002990 if (cb_node) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002991 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
John Zulauf5c2750c2018-01-30 15:04:56 -07002992 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002993 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002994 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06002995 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002996 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06002997 "VUID-vkCmdBlitImage-dstImage-00234");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002998 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
2999 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
Dave Houltond8ed0212018-05-16 17:18:24 -06003000 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003001 ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdBlitImage-srcImage-00219",
3002 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06003003 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003004 ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdBlitImage-dstImage-00224",
3005 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003006 skip |=
3007 ValidateCmdQueueFlags(cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003008 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
3009 skip |= InsideRenderPass(cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003010 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003011 "VUID-vkCmdBlitImage-srcImage-01999", "VUID-vkCmdBlitImage-srcImage-01999");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003012 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003013 "VUID-vkCmdBlitImage-dstImage-02000", "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04003014
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003015 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003016
Dave Houlton33c2d252017-06-09 17:08:32 -06003017 VkFormat src_format = src_image_state->createInfo.format;
3018 VkFormat dst_format = dst_image_state->createInfo.format;
3019 VkImageType src_type = src_image_state->createInfo.imageType;
3020 VkImageType dst_type = dst_image_state->createInfo.imageType;
3021
Cort Stratton186b1a22018-05-01 20:18:06 -04003022 if (VK_FILTER_LINEAR == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003023 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003024 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001",
3025 "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04003026 } else if (VK_FILTER_CUBIC_IMG == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003027 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
3028 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02002",
3029 "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06003030 }
3031
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003032 if (FormatRequiresYcbcrConversion(src_format)) {
3033 skip |= LogError(device, "VUID-vkCmdBlitImage-srcImage-01561",
3034 "vkCmdBlitImage(): srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
3035 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
3036 string_VkFormat(src_format));
3037 }
3038
3039 if (FormatRequiresYcbcrConversion(dst_format)) {
3040 skip |= LogError(device, "VUID-vkCmdBlitImage-dstImage-01562",
3041 "vkCmdBlitImage(): dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
3042 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
3043 string_VkFormat(dst_format));
3044 }
3045
Dave Houlton33c2d252017-06-09 17:08:32 -06003046 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003047 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-filter-00237",
3048 "vkCmdBlitImage(): source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003049 }
3050
Dave Houlton33c2d252017-06-09 17:08:32 -06003051 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
3052 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003053 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00228",
3054 "vkCmdBlitImage(): source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003055 }
3056
3057 // Validate consistency for unsigned formats
3058 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3059 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003060 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003061 << "the other one must also have unsigned integer format. "
3062 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003063 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003064 }
3065
3066 // Validate consistency for signed formats
3067 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3068 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003069 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003070 << "the other one must also have signed integer format. "
3071 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003072 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003073 }
3074
3075 // Validate filter for Depth/Stencil formats
3076 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3077 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003078 ss << "vkCmdBlitImage(): If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003079 << "then filter must be VK_FILTER_NEAREST.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003080 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003081 }
3082
3083 // Validate aspect bits and formats for depth/stencil images
3084 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3085 if (src_format != dst_format) {
3086 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003087 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003088 << "stencil, the other one must have exactly the same format. "
3089 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3090 << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003091 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003092 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003093 } // Depth or Stencil
3094
3095 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003096 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003097 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003098 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3099 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3100 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003101 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003102 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3103 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003104 for (uint32_t i = 0; i < regionCount; i++) {
3105 const VkImageBlit rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003106 bool hit_error = false;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003107 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003108 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3109 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003110 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003111 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3112 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003113 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3114 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
3115 skip |= ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003116 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003117 skip |= ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003118 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003119 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003120 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3121 "VUID-vkCmdBlitImage-srcSubresource-01707");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003122 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003123 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3124 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003125 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003126 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3127 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003128 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003129 ss << "vkCmdBlitImage(): pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003130 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003131 }
Dave Houlton48989f32017-05-26 15:01:46 -06003132 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3133 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003134 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003135 ss << "vkCmdBlitImage(): pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003136 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003137 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003138
3139 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003140 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003141 skip |= LogError(
3142 cb_node->commandBuffer, "VUID-VkImageBlit-layerCount-00239",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003143 "vkCmdBlitImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003144 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003145
Dave Houlton48989f32017-05-26 15:01:46 -06003146 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003147 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00238",
3148 "vkCmdBlitImage(): aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003149 }
Dave Houlton48989f32017-05-26 15:01:46 -06003150
Dave Houlton33c2d252017-06-09 17:08:32 -06003151 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003152 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00241",
3153 "vkCmdBlitImage(): region [%d] source aspectMask (0x%x) specifies aspects not present in source "
3154 "image format %s.",
3155 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003156 }
3157
3158 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003159 skip |= LogError(
3160 cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00242",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003161 "vkCmdBlitImage(): region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3162 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003163 }
3164
Dave Houlton48989f32017-05-26 15:01:46 -06003165 // Validate source image offsets
3166 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003167 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003168 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003169 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003170 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00245",
3171 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3172 "of (%1d, %1d). These must be (0, 1).",
3173 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003174 }
3175 }
3176
Dave Houlton33c2d252017-06-09 17:08:32 -06003177 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003178 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003179 skip |=
3180 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00247",
3181 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3182 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3183 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003184 }
3185 }
3186
Dave Houlton33c2d252017-06-09 17:08:32 -06003187 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003188 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3189 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003190 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003191 skip |= LogError(
3192 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00243",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003193 "vkCmdBlitImage(): region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).", i,
3194 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003195 }
3196 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3197 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003198 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003199 skip |= LogError(
3200 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00244",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003201 "vkCmdBlitImage(): region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003202 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003203 }
3204 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3205 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003206 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003207 skip |= LogError(
3208 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00246",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003209 "vkCmdBlitImage(): region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).", i,
3210 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003211 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003212 if (oob) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003213 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-pRegions-00215",
3214 "vkCmdBlitImage(): region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003215 }
Dave Houlton48989f32017-05-26 15:01:46 -06003216
3217 // Validate dest image offsets
3218 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003219 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003220 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003221 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003222 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-dstImage-00250",
3223 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3224 "(%1d, %1d). These must be (0, 1).",
3225 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003226 }
3227 }
3228
Dave Houlton33c2d252017-06-09 17:08:32 -06003229 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003230 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003231 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-dstImage-00252",
3232 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3233 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3234 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003235 }
3236 }
3237
Dave Houlton33c2d252017-06-09 17:08:32 -06003238 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003239 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3240 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003241 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003242 skip |= LogError(
3243 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00248",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003244 "vkCmdBlitImage(): region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).", i,
3245 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003246 }
3247 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3248 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003249 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003250 skip |= LogError(
3251 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00249",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003252 "vkCmdBlitImage(): region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003253 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003254 }
3255 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3256 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003257 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003258 skip |= LogError(
3259 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00251",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003260 "vkCmdBlitImage(): region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).", i,
3261 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003262 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003263 if (oob) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003264 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-pRegions-00216",
3265 "vkCmdBlitImage(): region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003266 }
3267
Dave Houlton33c2d252017-06-09 17:08:32 -06003268 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3269 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3270 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003271 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003272 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00240",
3273 "vkCmdBlitImage(): region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3274 "layerCount other than 1.",
3275 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003276 }
3277 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003278 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003279 } else {
3280 assert(0);
3281 }
3282 return skip;
3283}
3284
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003285void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3286 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3287 const VkImageBlit *pRegions, VkFilter filter) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003288 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3289 pRegions, filter);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003290 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003291 auto src_image_state = GetImageState(srcImage);
3292 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003293
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003294 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003295 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003296 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3297 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003298 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003299}
3300
John Zulauf2076e812020-01-08 14:55:54 -07003301GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap *map, const IMAGE_STATE &image_state) {
3302 assert(map);
3303 // This approach allows for a single hash lookup or/create new
3304 auto inserted = map->emplace(std::make_pair(image_state.image, nullptr));
3305 if (inserted.second) {
3306 assert(nullptr == inserted.first->second.get());
3307 GlobalImageLayoutRangeMap *layout_map = new GlobalImageLayoutRangeMap(image_state.range_encoder.SubresourceCount());
3308 inserted.first->second.reset(layout_map);
3309 return layout_map;
3310 } else {
3311 assert(nullptr != inserted.first->second.get());
3312 return inserted.first->second.get();
3313 }
3314 return nullptr;
3315}
3316
3317const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, VkImage image) {
3318 auto it = map.find(image);
3319 if (it != map.end()) {
3320 return it->second.get();
3321 }
3322 return nullptr;
3323}
3324
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003325// This validates that the initial layout specified in the command buffer for the IMAGE is the same as the global IMAGE layout
John Zulauf2076e812020-01-08 14:55:54 -07003326bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const GlobalImageLayoutMap &globalImageLayoutMap,
3327 GlobalImageLayoutMap *overlayLayoutMap_arg) const {
Matthew Ruschd7ef5482019-07-16 22:01:54 -07003328 if (disabled.image_layout_validation) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003329 bool skip = false;
John Zulauf2076e812020-01-08 14:55:54 -07003330 GlobalImageLayoutMap &overlayLayoutMap = *overlayLayoutMap_arg;
John Zulauff660ad62019-03-23 07:16:05 -06003331 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07003332 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06003333 for (const auto &layout_map_entry : pCB->image_layout_map) {
3334 const auto image = layout_map_entry.first;
3335 const auto *image_state = GetImageState(image);
3336 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06003337 const auto &subres_map = layout_map_entry.second;
John Zulauf2076e812020-01-08 14:55:54 -07003338 const auto &initial_layout_map = subres_map->GetInitialLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06003339 // Validate the initial_uses for each subresource referenced
John Zulauf2076e812020-01-08 14:55:54 -07003340 if (initial_layout_map.empty()) continue;
3341
3342 auto *overlay_map = GetLayoutRangeMap(&overlayLayoutMap, *image_state);
3343 const auto *global_map = GetLayoutRangeMap(globalImageLayoutMap, image);
3344 if (global_map == nullptr) {
3345 global_map = &empty_map;
3346 }
3347
3348 // Note: don't know if it would matter
3349 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
3350
3351 auto pos = initial_layout_map.begin();
3352 const auto end = initial_layout_map.end();
3353 sparse_container::parallel_iterator<const ImageSubresourceLayoutMap::LayoutMap> current_layout(*overlay_map, *global_map,
3354 pos->first.begin);
3355 while (pos != end) {
locke-lunargf155ccf2020-02-18 11:34:15 -07003356 VkImageLayout initial_layout = pos->second;
John Zulauf2076e812020-01-08 14:55:54 -07003357 VkImageLayout image_layout = kInvalidLayout;
John Zulauf2076e812020-01-08 14:55:54 -07003358 if (current_layout->range.empty()) break; // When we are past the end of data in overlay and global... stop looking
locke-lunargf155ccf2020-02-18 11:34:15 -07003359 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07003360 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07003361 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07003362 image_layout = current_layout->pos_B->lower_bound->second;
3363 }
3364 const auto intersected_range = pos->first & current_layout->range;
3365 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
3366 // TODO: Set memory invalid which is in mem_tracker currently
3367 } else if (image_layout != initial_layout) {
3368 // Need to look up the inital layout *state* to get a bit more information
3369 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(pos->first.begin);
3370 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
3371 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
3372 if (!matches) {
3373 std::string formatted_label = FormatDebugLabel(" ", pCB->debug_label);
3374 // We can report all the errors for the intersected range directly
3375 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
3376 const auto subresource = image_state->range_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003377 skip |= LogError(
3378 pCB->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06003379 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
locke-lunargadbb54c2019-06-26 00:05:17 -06003380 "to be in layout %s--instead, current layout is %s.%s",
John Zulauf2076e812020-01-08 14:55:54 -07003381 report_data->FormatHandle(image).c_str(), subresource.aspectMask, subresource.arrayLayer,
3382 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout),
locke-lunarga344e7c2020-01-02 19:48:53 -07003383 formatted_label.c_str());
John Zulaufb61ed972019-04-09 16:12:35 -06003384 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003385 }
3386 }
John Zulauf2076e812020-01-08 14:55:54 -07003387 if (pos->first.includes(intersected_range.end)) {
3388 current_layout.seek(intersected_range.end);
3389 } else {
3390 ++pos;
3391 if (pos != end) {
3392 current_layout.seek(pos->first.begin);
3393 }
3394 }
John Zulauff660ad62019-03-23 07:16:05 -06003395 }
3396
locke-lunargf155ccf2020-02-18 11:34:15 -07003397 // Update all layout set operations (which will be a subset of the initial_layouts)
John Zulauf2076e812020-01-08 14:55:54 -07003398 sparse_container::splice(overlay_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003399 }
John Zulauff660ad62019-03-23 07:16:05 -06003400
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003401 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003402}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003403
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003404void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06003405 for (const auto &layout_map_entry : pCB->image_layout_map) {
3406 const auto image = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07003407 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06003408 const auto *image_state = GetImageState(image);
3409 if (!image_state) continue; // Can't set layouts of a dead image
John Zulauf2076e812020-01-08 14:55:54 -07003410 auto *global_map = GetLayoutRangeMap(&imageLayoutMap, *image_state);
3411 sparse_container::splice(global_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Tony Barbourdf013b92017-01-25 12:53:48 -07003412 }
3413}
3414
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003415// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003416// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3417// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003418bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3419 const VkImageLayout first_layout, const uint32_t attachment,
John Zulauf9d2b6382019-07-25 15:21:36 -06003420 const VkAttachmentDescription2KHR &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003421 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003422 const char *vuid;
3423 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3424
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003425 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
3426 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003427 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3428 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3429 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003430 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
3431 "Cannot clear attachment %d with invalid first layout %s.", attachment,
3432 string_VkImageLayout(first_layout));
Shannon McPherson3ea65132018-12-05 10:37:39 -07003433 } else if (!use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3434 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003435 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
3436 "Cannot clear attachment %d with invalid first layout %s.", attachment,
3437 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003438 }
3439 }
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003440 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3441 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003442 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01566";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003443 skip |= LogError(device, vuid, "Cannot clear attachment %d with invalid first layout %s.", attachment,
3444 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003445 }
3446 }
3447
3448 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3449 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003450 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01567";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003451 skip |= LogError(device, vuid, "Cannot clear attachment %d with invalid first layout %s.", attachment,
3452 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003453 }
3454 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003455 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003456}
3457
Mark Lobodzinskiac02c612020-01-17 14:52:35 -07003458bool CoreChecks::ValidateLayouts(RenderPassCreateVersion rp_version, VkDevice device, const VkRenderPassCreateInfo2KHR *pCreateInfo,
3459 const char *function_name) const {
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003460 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003461 const char *vuid;
3462 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003463
Jason Ekstranda1906302017-12-03 20:16:32 -08003464 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3465 VkFormat format = pCreateInfo->pAttachments[i].format;
3466 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3467 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3468 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003469 skip |= LogWarning(device, kVUID_Core_DrawState_InvalidRenderpass,
3470 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
3471 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3472 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3473 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003474 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003475 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003476 skip |=
3477 LogWarning(device, kVUID_Core_DrawState_InvalidRenderpass,
3478 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3479 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3480 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3481 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003482 }
3483 }
3484 }
3485
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003486 // Track when we're observing the first use of an attachment
3487 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3488 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003489 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003490
3491 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3492 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3493 auto attach_index = subpass.pInputAttachments[j].attachment;
3494 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003495 switch (subpass.pInputAttachments[j].layout) {
3496 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3497 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3498 // These are ideal.
3499 break;
3500
3501 case VK_IMAGE_LAYOUT_GENERAL:
3502 // May not be optimal. TODO: reconsider this warning based on other constraints.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003503 skip |= LogPerformanceWarning(device, kVUID_Core_DrawState_InvalidImageLayout,
3504 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
Cort Stratton7547f772017-05-04 15:18:52 -07003505 break;
3506
Tobias Hectorbbb12282018-10-22 15:17:59 +01003507 case VK_IMAGE_LAYOUT_UNDEFINED:
3508 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003509 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003510 skip |= LogError(device, vuid,
3511 "Layout for input attachment reference %u in subpass %u is %s but must be "
3512 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
3513 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003514 break;
3515
Piers Daniell9af77cd2019-10-16 13:54:12 -06003516 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3517 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3518 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3519 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003520 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003521 skip |= LogError(
3522 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003523 "Layout for input attachment reference %u in subpass %u is %s but must not be "
3524 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3525 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3526 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
3527 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003528 skip |= LogError(
3529 device, "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003530 "Layout for input attachment reference %u in subpass %u is %s but must not be "
3531 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3532 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3533 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
3534 } else if ((subpass.pInputAttachments[j].aspectMask &
3535 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3536 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3537 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3538 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3539 const auto *attachment_reference_stencil_layout =
3540 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pInputAttachments[j].pNext);
3541 if (attachment_reference_stencil_layout) {
3542 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3543 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3544 attachment_reference_stencil_layout->stencilLayout ==
3545 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3546 attachment_reference_stencil_layout->stencilLayout ==
3547 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3548 attachment_reference_stencil_layout->stencilLayout ==
3549 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3550 attachment_reference_stencil_layout->stencilLayout ==
3551 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3552 attachment_reference_stencil_layout->stencilLayout ==
3553 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3554 attachment_reference_stencil_layout->stencilLayout ==
3555 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3556 attachment_reference_stencil_layout->stencilLayout ==
3557 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3558 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003559 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
3560 "In the attachment reference %u in subpass %u with pNext chain instance "
3561 "VkAttachmentReferenceStencilLayoutKHR"
3562 "the stencilLayout member but must not be "
3563 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3564 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3565 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3566 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3567 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3568 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3569 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3570 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3571 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3572 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003573 }
3574 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003575 skip |= LogError(
3576 device, "VUID-VkAttachmentReference2-attachment-03315",
3577 "When the layout for input attachment reference %u in subpass %u is "
3578 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3579 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3580 "VkAttachmentReferenceStencilLayout instance.",
3581 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003582 }
3583 }
3584 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3585 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3586 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003587 skip |= LogError(
3588 device, "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003589 "When the aspectMask for input attachment reference %u in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3590 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3591 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3592 j, i);
3593 }
3594 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3595 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3596 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003597 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
3598 "When the aspectMask for input attachment reference %u in subpass %u is "
3599 "VK_IMAGE_ASPECT_STENCIL_BIT "
3600 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3601 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
3602 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003603 }
3604 }
3605 break;
3606
Graeme Leese668a9862018-10-08 10:40:02 +01003607 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3608 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003609 if (device_extensions.vk_khr_maintenance2) {
Graeme Leese668a9862018-10-08 10:40:02 +01003610 break;
3611 } else {
3612 // Intentionally fall through to generic error message
3613 }
3614 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003615
Cort Stratton7547f772017-05-04 15:18:52 -07003616 default:
3617 // No other layouts are acceptable
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003618 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
3619 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3620 string_VkImageLayout(subpass.pInputAttachments[j].layout));
Cort Stratton7547f772017-05-04 15:18:52 -07003621 }
3622
Cort Stratton7547f772017-05-04 15:18:52 -07003623 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003624 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3625 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003626
3627 bool used_as_depth =
3628 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3629 bool used_as_color = false;
3630 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3631 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3632 }
3633 if (!used_as_depth && !used_as_color &&
3634 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08003635 vuid = use_rp2 ? "VUID-VkSubpassDescription2-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003636 skip |= LogError(device, vuid,
3637 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
3638 function_name, attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07003639 }
3640 }
3641 attach_first_use[attach_index] = false;
3642 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003643
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003644 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3645 auto attach_index = subpass.pColorAttachments[j].attachment;
3646 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3647
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003648 // TODO: Need a way to validate shared presentable images here, currently just allowing
3649 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3650 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003651 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003652 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003653 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003654 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3655 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003656 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003657
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003658 case VK_IMAGE_LAYOUT_GENERAL:
3659 // May not be optimal; TODO: reconsider this warning based on other constraints?
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003660 skip |= LogPerformanceWarning(device, kVUID_Core_DrawState_InvalidImageLayout,
3661 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003662 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003663
Tobias Hectorbbb12282018-10-22 15:17:59 +01003664 case VK_IMAGE_LAYOUT_UNDEFINED:
3665 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003666 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003667 skip |= LogError(device, vuid,
3668 "Layout for color attachment reference %u in subpass %u is %s but should be "
3669 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3670 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003671 break;
3672
Piers Daniell9af77cd2019-10-16 13:54:12 -06003673 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3674 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3675 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3676 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003677 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003678 skip |= LogError(
3679 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003680 "Layout for color attachment reference %u in subpass %u is %s but must not be "
3681 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3682 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3683 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3684 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003685 skip |= LogError(
3686 device, "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003687 "Layout for color attachment reference %u in subpass %u is %s but must not be "
3688 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3689 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3690 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3691 } else if ((subpass.pColorAttachments[j].aspectMask &
3692 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3693 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3694 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3695 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3696 const auto *attachment_reference_stencil_layout =
3697 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pColorAttachments[j].pNext);
3698 if (attachment_reference_stencil_layout) {
3699 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3700 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3701 attachment_reference_stencil_layout->stencilLayout ==
3702 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3703 attachment_reference_stencil_layout->stencilLayout ==
3704 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3705 attachment_reference_stencil_layout->stencilLayout ==
3706 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3707 attachment_reference_stencil_layout->stencilLayout ==
3708 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3709 attachment_reference_stencil_layout->stencilLayout ==
3710 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3711 attachment_reference_stencil_layout->stencilLayout ==
3712 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3713 attachment_reference_stencil_layout->stencilLayout ==
3714 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3715 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003716 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
3717 "In the attachment reference %u in subpass %u with pNext chain instance "
3718 "VkAttachmentReferenceStencilLayoutKHR"
3719 "the stencilLayout member but must not be "
3720 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3721 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3722 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3723 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3724 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3725 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3726 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3727 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3728 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3729 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003730 }
3731 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003732 skip |= LogError(
3733 device, "VUID-VkAttachmentReference2-attachment-03315",
3734 "When the layout for color attachment reference %u in subpass %u is "
3735 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3736 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3737 "VkAttachmentReferenceStencilLayout instance.",
3738 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003739 }
3740 }
3741 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3742 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3743 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003744 skip |= LogError(
3745 device, "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003746 "When the aspectMask for color attachment reference %u in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3747 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3748 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3749 j, i);
3750 }
3751 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3752 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3753 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003754 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
3755 "When the aspectMask for color attachment reference %u in subpass %u is "
3756 "VK_IMAGE_ASPECT_STENCIL_BIT "
3757 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3758 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
3759 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003760 }
3761 }
3762 break;
3763
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003764 default:
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003765 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
3766 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3767 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003768 }
3769
John Zulauf4eee2692019-02-09 16:14:25 -07003770 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].attachment != VK_ATTACHMENT_UNUSED) &&
3771 (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
3772 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08003773 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003774 skip |= LogError(device, vuid,
3775 "Layout for resolve attachment reference %u in subpass %u is %s but should be "
3776 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3777 j, i, string_VkImageLayout(subpass.pResolveAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003778 }
3779
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003780 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003781 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
3782 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003783 }
3784 attach_first_use[attach_index] = false;
3785 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003786
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003787 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3788 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003789 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3790 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3791 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003792 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003793
Dave Houltona9df0ce2018-02-07 10:51:23 -07003794 case VK_IMAGE_LAYOUT_GENERAL:
3795 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3796 // doing a bunch of transitions.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003797 skip |= LogPerformanceWarning(device, kVUID_Core_DrawState_InvalidImageLayout,
3798 "GENERAL layout for depth attachment may not give optimal performance.");
Dave Houltona9df0ce2018-02-07 10:51:23 -07003799 break;
3800
Tobias Hectorbbb12282018-10-22 15:17:59 +01003801 case VK_IMAGE_LAYOUT_UNDEFINED:
3802 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003803 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003804 skip |= LogError(device, vuid,
3805 "Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
3806 "layout or GENERAL.",
3807 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003808 break;
3809
Piers Daniell9af77cd2019-10-16 13:54:12 -06003810 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3811 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3812 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3813 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003814 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003815 skip |= LogError(
3816 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003817 "Layout for depth attachment reference in subpass %u is %s but must not be "
3818 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3819 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3820 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3821 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003822 skip |= LogError(
3823 device, "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003824 "Layout for depth attachment reference in subpass %u is %s but must not be "
3825 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3826 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3827 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3828 } else if ((subpass.pDepthStencilAttachment->aspectMask &
3829 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3830 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3831 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3832 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3833 const auto *attachment_reference_stencil_layout =
3834 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pDepthStencilAttachment->pNext);
3835 if (attachment_reference_stencil_layout) {
3836 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3837 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3838 attachment_reference_stencil_layout->stencilLayout ==
3839 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3840 attachment_reference_stencil_layout->stencilLayout ==
3841 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3842 attachment_reference_stencil_layout->stencilLayout ==
3843 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3844 attachment_reference_stencil_layout->stencilLayout ==
3845 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3846 attachment_reference_stencil_layout->stencilLayout ==
3847 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3848 attachment_reference_stencil_layout->stencilLayout ==
3849 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3850 attachment_reference_stencil_layout->stencilLayout ==
3851 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3852 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003853 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
3854 "In the attachment reference in subpass %u with pNext chain instance "
3855 "VkAttachmentReferenceStencilLayoutKHR"
3856 "the stencilLayout member but must not be "
3857 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3858 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3859 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3860 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3861 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3862 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3863 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3864 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3865 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3866 i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003867 }
3868 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003869 skip |= LogError(
3870 device, "VUID-VkAttachmentReference2-attachment-03315",
3871 "When the layout for depth attachment reference in subpass %u is "
3872 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3873 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3874 "VkAttachmentReferenceStencilLayout instance.",
3875 i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003876 }
3877 }
3878 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3879 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3880 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003881 skip |= LogError(
3882 device, "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003883 "When the aspectMask for depth attachment reference in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3884 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3885 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3886 i);
3887 }
3888 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3889 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3890 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003891 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
3892 "When the aspectMask for depth attachment reference in subpass %u is "
3893 "VK_IMAGE_ASPECT_STENCIL_BIT "
3894 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3895 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
3896 i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003897 }
3898 }
3899 break;
3900
Dave Houltona9df0ce2018-02-07 10:51:23 -07003901 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3902 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003903 if (device_extensions.vk_khr_maintenance2) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003904 break;
3905 } else {
3906 // Intentionally fall through to generic error message
3907 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06003908 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003909
Dave Houltona9df0ce2018-02-07 10:51:23 -07003910 default:
3911 // No other layouts are acceptable
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003912 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
3913 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3914 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
3915 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003916 }
3917
3918 auto attach_index = subpass.pDepthStencilAttachment->attachment;
3919 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003920 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
3921 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003922 }
3923 attach_first_use[attach_index] = false;
3924 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003925 }
3926 return skip;
3927}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003928
Mark Lobodzinski96210742017-02-09 10:33:46 -07003929// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
3930// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003931template <typename T1>
3932bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
3933 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
3934 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003935 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003936 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06003937 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003938 if (strict) {
3939 correct_usage = ((actual & desired) == desired);
3940 } else {
3941 correct_usage = ((actual & desired) != 0);
3942 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003943
Mark Lobodzinski96210742017-02-09 10:33:46 -07003944 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06003945 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06003946 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003947 skip = LogError(object, kVUID_Core_MemTrack_InvalidUsageFlag,
3948 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
3949 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003950 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003951 skip = LogError(object, msgCode,
3952 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
3953 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003954 }
3955 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003956 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003957}
3958
3959// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3960// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003961bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003962 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003963 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image,
John Zulauf4fea6622019-04-01 11:38:18 -06003964 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003965}
3966
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003967bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
John Zulauf07288512019-07-05 11:09:50 -06003968 char const *func_name, const char *linear_vuid, const char *optimal_vuid) const {
Mark Lobodzinski5c048802019-03-07 10:47:31 -07003969 VkFormatProperties format_properties = GetPDFormatProperties(image_state->createInfo.format);
Cort Stratton186b1a22018-05-01 20:18:06 -04003970 bool skip = false;
3971 if (image_state->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
3972 if ((format_properties.linearTilingFeatures & desired) != desired) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003973 skip |=
3974 LogError(image_state->image, linear_vuid, "In %s, invalid linearTilingFeatures (0x%08X) for format %u used by %s.",
3975 func_name, format_properties.linearTilingFeatures, image_state->createInfo.format,
3976 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04003977 }
3978 } else if (image_state->createInfo.tiling == VK_IMAGE_TILING_OPTIMAL) {
3979 if ((format_properties.optimalTilingFeatures & desired) != desired) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003980 skip |= LogError(image_state->image, optimal_vuid,
3981 "In %s, invalid optimalTilingFeatures (0x%08X) for format %u used by %s.", func_name,
3982 format_properties.optimalTilingFeatures, image_state->createInfo.format,
3983 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04003984 }
3985 }
3986 return skip;
3987}
3988
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003989bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003990 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07003991 bool skip = false;
Cort Strattond619a302018-05-17 19:46:32 -07003992 // layerCount must not be zero
3993 if (subresource_layers->layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003994 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-layerCount-01700",
3995 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07003996 }
3997 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
3998 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003999 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00168",
4000 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004001 }
4002 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
4003 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
4004 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004005 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00167",
4006 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4007 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4008 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004009 }
4010 return skip;
4011}
4012
Mark Lobodzinski96210742017-02-09 10:33:46 -07004013// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4014// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004015bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004016 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004017 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer,
John Zulauf4fea6622019-04-01 11:38:18 -06004018 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004019}
4020
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004021bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004022 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004023 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004024
4025 const VkDeviceSize &range = pCreateInfo->range;
4026 if (range != VK_WHOLE_SIZE) {
4027 // Range must be greater than 0
4028 if (range <= 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004029 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00928",
4030 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4031 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4032 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004033 }
4034 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004035 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4036 if (SafeModulo(range, format_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004037 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00929",
4038 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4039 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4040 "(%" PRIu32 ").",
4041 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004042 }
4043 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004044 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004045 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00930",
4046 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4047 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4048 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4049 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004050 }
4051 // The sum of range and offset must be less than or equal to the size of buffer
4052 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004053 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00931",
4054 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4055 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4056 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4057 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004058 }
4059 }
4060 return skip;
4061}
4062
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004063bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004064 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004065 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004066 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4067 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004068 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00933",
4069 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
4070 "be supported for uniform texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004071 }
4072 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4073 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004074 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00934",
4075 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
4076 "be supported for storage texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004077 }
4078 return skip;
4079}
4080
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004081bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004082 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004083 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004084
Dave Houltond8ed0212018-05-16 17:18:24 -06004085 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004086
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004087 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!enabled_features.core.sparseBinding)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004088 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-00915",
4089 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
4090 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004091 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06004092
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004093 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!enabled_features.core.sparseResidencyBuffer)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004094 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-00916",
4095 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
4096 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06004097 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06004098
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004099 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004100 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-00917",
4101 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
4102 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06004103 }
Jeff Bolz87697532019-01-11 22:54:00 -06004104
4105 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
4106 if (chained_devaddr_struct) {
4107 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
4108 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004109 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4110 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
4111 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004112 }
4113 }
4114
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004115 auto chained_opaqueaddr_struct = lvl_find_in_chain<VkBufferOpaqueCaptureAddressCreateInfoKHR>(pCreateInfo->pNext);
4116 if (chained_opaqueaddr_struct) {
4117 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
4118 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004119 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
4120 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfoKHR::opaqueCaptureAddress"
4121 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004122 }
4123 }
4124
Shannon McPherson4984e642019-12-05 13:04:34 -07004125 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
Piers Daniell41b8c5d2020-01-10 15:42:00 -07004126 !enabled_features.core12.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004127 skip |= LogError(
4128 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004129 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
4130 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
4131 }
4132
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004133 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004134 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateBuffer",
4135 "pCreateInfo->pQueueFamilyIndices", "VUID-VkBufferCreateInfo-sharingMode-01419",
4136 "VUID-VkBufferCreateInfo-sharingMode-01419", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004137 }
4138
Mark Lobodzinski96210742017-02-09 10:33:46 -07004139 return skip;
4140}
4141
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004142bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004143 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004144 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004145 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004146 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4147 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004148 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004149 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4150 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004151 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004152 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4153 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4154 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004155
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004156 // Buffer view offset must be less than the size of buffer
4157 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004158 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00925",
4159 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4160 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4161 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004162 }
4163
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004164 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004165 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4166 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4167 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004168 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-02749",
4169 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4170 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4171 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004172 }
4173
4174 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
4175 VkDeviceSize elementSize = FormatElementSize(pCreateInfo->format);
4176 if ((elementSize % 3) == 0) {
4177 elementSize /= 3;
4178 }
4179 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
4180 VkDeviceSize alignmentRequirement =
4181 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4182 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
4183 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4184 }
4185 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004186 skip |= LogError(
4187 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02750",
Jeff Bolzd5554e62019-07-19 13:23:52 -05004188 "If buffer was created with usage containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
4189 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4190 ") must be a multiple of the lesser of "
4191 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4192 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4193 "(%" PRId32
4194 ") is VK_TRUE, the size of a texel of the requested format. "
4195 "If the size of a texel is a multiple of three bytes, then the size of a "
4196 "single component of format is used instead",
4197 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4198 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4199 }
4200 }
4201 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
4202 VkDeviceSize alignmentRequirement =
4203 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4204 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
4205 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4206 }
4207 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004208 skip |= LogError(
4209 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02751",
Jeff Bolzd5554e62019-07-19 13:23:52 -05004210 "If buffer was created with usage containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
4211 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4212 ") must be a multiple of the lesser of "
4213 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4214 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4215 "(%" PRId32
4216 ") is VK_TRUE, the size of a texel of the requested format. "
4217 "If the size of a texel is a multiple of three bytes, then the size of a "
4218 "single component of format is used instead",
4219 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4220 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4221 }
4222 }
4223 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004224
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004225 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004226
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004227 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004228 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004229 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004230}
4231
Mark Lobodzinski602de982017-02-09 11:01:33 -07004232// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004233bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004234 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004235 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004236
Dave Houlton1d2022c2017-03-29 11:43:58 -06004237 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004238 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004239 skip |= LogError(image, vuid, "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004240 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004241 skip |= LogError(image, vuid, "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004242 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004243 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004244 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004245 skip |= LogError(image, vuid,
4246 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
4247 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4248 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004249 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004250 skip |= LogError(image, vuid,
4251 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
4252 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4253 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004254 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004255 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004256 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004257 skip |= LogError(image, vuid, "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004258 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004259 skip |=
4260 LogError(image, vuid, "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004261 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004262 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004263 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004264 skip |=
4265 LogError(image, vuid, "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004266 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004267 skip |= LogError(image, vuid, "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.",
4268 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004269 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004270 } else if (FormatIsMultiplane(format)) {
4271 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4272 if (3 == FormatPlaneCount(format)) {
4273 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4274 }
4275 if ((aspect_mask & valid_flags) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004276 skip |=
4277 LogError(image, vuid,
4278 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4279 "set, where n = [0, 1, 2].",
4280 func_name);
Dave Houlton501b15b2018-03-30 15:07:41 -06004281 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004282 }
4283 return skip;
4284}
4285
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004286bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4287 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004288 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
4289 SubresourceRangeErrorCodes errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004290 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004291
4292 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004293 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004294 skip |= LogError(image, errorCodes.base_mip_err,
4295 "%s: %s.baseMipLevel (= %" PRIu32
4296 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4297 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004298 }
Petr Kraus4d718682017-05-18 03:38:41 +02004299
Petr Krausffa94af2017-08-08 21:46:02 +02004300 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4301 if (subresourceRange.levelCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004302 skip |= LogError(image, errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004303 } else {
4304 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004305
Petr Krausffa94af2017-08-08 21:46:02 +02004306 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004307 skip |= LogError(image, errorCodes.mip_count_err,
4308 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4309 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
4310 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
4311 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004312 }
Petr Kraus4d718682017-05-18 03:38:41 +02004313 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004314 }
Petr Kraus4d718682017-05-18 03:38:41 +02004315
4316 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004317 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004318 skip |= LogError(image, errorCodes.base_layer_err,
4319 "%s: %s.baseArrayLayer (= %" PRIu32
4320 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4321 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004322 }
Petr Kraus4d718682017-05-18 03:38:41 +02004323
Petr Krausffa94af2017-08-08 21:46:02 +02004324 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4325 if (subresourceRange.layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004326 skip |= LogError(image, errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004327 } else {
4328 const uint64_t necessary_layer_count =
4329 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004330
Petr Krausffa94af2017-08-08 21:46:02 +02004331 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004332 skip |= LogError(image, errorCodes.layer_count_err,
4333 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4334 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
4335 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
4336 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004337 }
Petr Kraus4d718682017-05-18 03:38:41 +02004338 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004339 }
Petr Kraus4d718682017-05-18 03:38:41 +02004340
Mark Lobodzinski602de982017-02-09 11:01:33 -07004341 return skip;
4342}
4343
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004344bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004345 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004346 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004347 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4348 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4349 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4350
4351 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4352 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4353
4354 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004355 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4356 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
Shannon McPherson5a0de262019-06-05 10:43:56 -06004357 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-02724"
Dave Houltond8ed0212018-05-16 17:18:24 -06004358 : "VUID-VkImageViewCreateInfo-image-01482")
4359 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4360 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
Shannon McPherson5a0de262019-06-05 10:43:56 -06004361 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
Dave Houltond8ed0212018-05-16 17:18:24 -06004362 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4363 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004364
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004365 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004366 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004367 image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004368}
4369
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004370bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004371 const VkImageSubresourceRange &subresourceRange,
4372 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004373 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004374 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4375 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4376 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4377 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004378
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004379 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004380 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image,
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004381 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004382}
4383
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004384bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004385 const VkImageSubresourceRange &subresourceRange,
4386 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004387 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004388 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4389 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4390 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4391 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004392
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004393 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004394 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image,
4395 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004396}
4397
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004398bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004399 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
John Zulaufa4472282019-08-22 14:44:34 -06004400 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004401 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004402 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4403 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4404 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4405 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004406
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004407 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004408 cmd_name, param_name, "arrayLayers", image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004409}
4410
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004411bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004412 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004413 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004414 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004415 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004416 skip |=
4417 ValidateImageUsageFlags(image_state,
4418 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
4419 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4420 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV | VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
4421 false, kVUIDUndefined, "vkCreateImageView()",
4422 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
4423 "SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004424 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004425 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004426 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004427 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004428 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004429 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004430
4431 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4432 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004433 VkImageUsageFlags image_usage = image_state->createInfo.usage;
4434 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004435 VkFormat view_format = pCreateInfo->format;
4436 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004437 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004438 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004439
Dave Houltonbd2e2622018-04-10 16:41:14 -06004440 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004441 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004442 if (chained_ivuci_struct) {
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07004443 if (device_extensions.vk_khr_maintenance2) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05004444 if (!device_extensions.vk_ext_separate_stencil_usage) {
4445 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004446 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
4447 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
4448 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05004449 }
4450 } else {
4451 const auto image_stencil_struct =
4452 lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
4453 if (image_stencil_struct == nullptr) {
4454 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004455 skip |= LogError(
4456 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004457 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
4458 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
4459 "any bits that were not set in VkImageCreateInfo::usage used to create image");
4460 }
4461 } else {
4462 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
4463 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
4464 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004465 skip |= LogError(
4466 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004467 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4468 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4469 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
4470 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
4471 }
4472 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
4473 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004474 skip |= LogError(
4475 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004476 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4477 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4478 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
4479 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
4480 }
4481 }
4482 }
4483 }
4484
Dave Houltonbd2e2622018-04-10 16:41:14 -06004485 image_usage = chained_ivuci_struct->usage;
4486 }
4487
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004488 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4489 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004490 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01004491 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06004492 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01004493 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06004494 std::stringstream ss;
4495 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01004496 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06004497 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004498 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004499 }
4500 } else {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004501 if ((!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR)) || (!FormatIsMultiplane(image_format))) {
Dave Houltonc7988072018-04-16 11:46:56 -06004502 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4503 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004504 const char *error_vuid;
4505 if ((!device_extensions.vk_khr_maintenance2) && (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4506 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
4507 } else if ((device_extensions.vk_khr_maintenance2) &&
4508 (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4509 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
4510 } else if ((!device_extensions.vk_khr_maintenance2) &&
4511 (device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4512 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
4513 } else {
4514 // both enabled
4515 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
4516 }
Dave Houltonc7988072018-04-16 11:46:56 -06004517 std::stringstream ss;
4518 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06004519 << " is not in the same format compatibility class as "
4520 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004521 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4522 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004523 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004524 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004525 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004526 }
4527 } else {
4528 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07004529 // Unless it is a multi-planar color bit aspect
4530 if ((image_format != view_format) &&
4531 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
4532 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkImageViewCreateInfo-image-01762"
4533 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07004534 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06004535 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07004536 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004537 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07004538 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004539 }
4540 }
4541
sfricke-samsungd40eda42020-02-09 17:54:31 -08004542 // Validate feature set if using CUBE_ARRAY
4543 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) && (enabled_features.core.imageCubeArray == false)) {
4544 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-viewType-01004",
4545 "vkCreateImageView(): pCreateInfo->viewType can't be VK_IMAGE_VIEW_TYPE_CUBE_ARRAY without "
4546 "enabling the imageCubeArray feature.");
4547 }
4548
Mark Lobodzinski602de982017-02-09 11:01:33 -07004549 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004550 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004551
4552 switch (image_type) {
4553 case VK_IMAGE_TYPE_1D:
4554 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004555 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4556 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4557 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004558 }
4559 break;
4560 case VK_IMAGE_TYPE_2D:
4561 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4562 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4563 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004564 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
4565 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4566 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004567 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004568 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4569 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4570 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004571 }
4572 }
4573 break;
4574 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004575 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06004576 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4577 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4578 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004579 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004580 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
4581 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4582 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004583 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4584 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004585 skip |= LogError(
4586 pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4587 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4588 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
4589 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4590 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004591 }
4592 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004593 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4594 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4595 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004596 }
4597 }
4598 } else {
4599 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004600 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4601 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4602 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004603 }
4604 }
4605 break;
4606 default:
4607 break;
4608 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004609
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004610 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004611 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07004612 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004613 }
4614
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004615 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004616 VkFormatFeatureFlags tiling_features = (image_tiling & VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4617 : format_properties.optimalTilingFeatures;
4618
4619 if (tiling_features == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004620 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-None-02273",
4621 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4622 "physical device.",
4623 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004624 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004625 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-usage-02274",
4626 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4627 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4628 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004629 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004630 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-usage-02275",
4631 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4632 "VK_IMAGE_USAGE_STORAGE_BIT.",
4633 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004634 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
4635 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004636 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-usage-02276",
4637 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4638 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4639 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004640 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4641 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004642 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-usage-02277",
4643 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4644 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4645 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
sfricke-samsungd40eda42020-02-09 17:54:31 -08004646 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
4647 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
4648 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-usage-02652",
4649 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4650 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4651 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004652 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004653
Jeff Bolz9af91c52018-09-01 21:53:57 -05004654 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4655 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004656 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
4657 "vkCreateImageView() If image was created with usage containing "
4658 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4659 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05004660 }
4661 if (view_format != VK_FORMAT_R8_UINT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004662 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
4663 "vkCreateImageView() If image was created with usage containing "
4664 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05004665 }
4666 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004667 }
4668 return skip;
4669}
4670
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004671bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
4672 uint32_t regionCount, const VkBufferCopy *pRegions) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004673 bool skip = false;
4674
4675 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
4676 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
4677 VkDeviceSize src_min = UINT64_MAX;
4678 VkDeviceSize src_max = 0;
4679 VkDeviceSize dst_min = UINT64_MAX;
4680 VkDeviceSize dst_max = 0;
4681
4682 for (uint32_t i = 0; i < regionCount; i++) {
4683 src_min = std::min(src_min, pRegions[i].srcOffset);
4684 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
4685 dst_min = std::min(dst_min, pRegions[i].dstOffset);
4686 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
4687
4688 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
4689 if (pRegions[i].srcOffset >= src_buffer_size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004690 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-srcOffset-00113",
4691 "vkCmdCopyBuffer(): pRegions[%d].srcOffset (%" PRIuLEAST64
4692 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
4693 i, pRegions[i].srcOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004694 }
4695
4696 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
4697 if (pRegions[i].dstOffset >= dst_buffer_size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004698 skip |= LogError(dst_buffer_state->buffer, "VUID-vkCmdCopyBuffer-dstOffset-00114",
4699 "vkCmdCopyBuffer(): pRegions[%d].dstOffset (%" PRIuLEAST64
4700 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
4701 i, pRegions[i].dstOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004702 }
4703
4704 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
4705 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004706 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-size-00115",
4707 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
4708 ") is greater than the source buffer size (%" PRIuLEAST64
4709 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
4710 i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004711 }
4712
4713 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
4714 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004715 skip |= LogError(dst_buffer_state->buffer, "VUID-vkCmdCopyBuffer-size-00116",
4716 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
4717 ") is greater than the destination buffer size (%" PRIuLEAST64
4718 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
4719 i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004720 }
4721 }
4722
4723 // The union of the source regions, and the union of the destination regions, must not overlap in memory
4724 if (src_buffer_state->buffer == dst_buffer_state->buffer) {
4725 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004726 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-pRegions-00117",
4727 "vkCmdCopyBuffer(): Detected overlap between source and dest regions in memory.");
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004728 }
4729 }
4730
4731 return skip;
4732}
4733
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004734bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004735 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06004736 const auto cb_node = GetCBState(commandBuffer);
4737 const auto src_buffer_state = GetBufferState(srcBuffer);
4738 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004739
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004740 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004741 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
4742 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004743 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004744 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004745 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
4746 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06004747 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004748 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
4749 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004750 skip |=
4751 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4752 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004753 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
4754 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004755 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, regionCount, pRegions);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004756 return skip;
4757}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004758
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004759bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004760 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004761 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004762 if (!buffer_state) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004763 skip |= LogError(buffer, kVUID_Core_DrawState_DoubleDestroy, "Cannot free %s that has not been allocated.",
4764 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004765 } else {
4766 if (buffer_state->in_use.load()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004767 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
4768 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004769 }
4770 }
4771 return skip;
4772}
4773
Jeff Bolz5c801d12019-10-09 10:38:45 -05004774bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
4775 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004776 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06004777 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004778
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004779 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004780 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004781 skip |=
4782 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004783 }
4784 return skip;
4785}
4786
Jeff Bolz5c801d12019-10-09 10:38:45 -05004787bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004788 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004789
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004790 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004791 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07004792 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004793 }
4794 return skip;
4795}
4796
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004797bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004798 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07004799 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06004800 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004801 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004802 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004803 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06004804 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004805 }
4806 return skip;
4807}
4808
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004809bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004810 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004811 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004812 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004813 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004814 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004815 skip |=
4816 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4817 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004818 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004819 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004820 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
4821 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004822 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07004823
4824 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004825 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
4826 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
4827 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
4828 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07004829 }
4830
4831 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004832 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
4833 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
4834 ") minus dstOffset (0x%" PRIxLEAST64 ").",
4835 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07004836 }
4837
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004838 return skip;
4839}
4840
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004841bool CoreChecks::ValidateBufferImageCopyData(uint32_t regionCount, const VkBufferImageCopy *pRegions,
4842 const IMAGE_STATE *image_state, const char *function) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004843 bool skip = false;
4844
4845 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004846 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
4847 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004848 skip |=
4849 LogError(image_state->image, "VUID-VkBufferImageCopy-srcImage-00199",
4850 "%s(): pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
4851 "and 1, respectively.",
4852 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004853 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004854 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004855
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004856 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
4857 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004858 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-srcImage-00201",
4859 "%s(): pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. For 1D and 2D images these "
4860 "must be 0 and 1, respectively.",
4861 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004862 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004863 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004864
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004865 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
4866 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004867 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-baseArrayLayer-00213",
4868 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
4869 "For 3D images these must be 0 and 1, respectively.",
4870 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004871 }
4872 }
4873
4874 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07004875 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
Locke497739c2019-03-08 11:50:47 -07004876 uint32_t element_size = FormatElementSize(image_state->createInfo.format, pRegions[i].imageSubresource.aspectMask);
4877
Dave Houltona585d132019-01-18 13:05:42 -07004878 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004879 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-bufferOffset-00193",
4880 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
4881 " must be a multiple of this format's texel size (%" PRIu32 ").",
4882 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004883 }
4884
4885 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06004886 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004887 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-bufferOffset-00194",
4888 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
4889 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004890 }
4891
4892 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
4893 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004894 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004895 LogError(image_state->image, "VUID-VkBufferImageCopy-bufferRowLength-00195",
4896 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
4897 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004898 }
4899
4900 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
4901 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004902 skip |= LogError(
4903 image_state->image, "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004904 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
4905 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004906 }
4907
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06004908 // Calculate adjusted image extent, accounting for multiplane image factors
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06004909 VkExtent3D adjusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06004910 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06004911 if ((pRegions[i].imageOffset.x < 0) || (pRegions[i].imageOffset.x > static_cast<int32_t>(adjusted_image_extent.width)) ||
4912 ((pRegions[i].imageOffset.x + pRegions[i].imageExtent.width) > static_cast<int32_t>(adjusted_image_extent.width))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004913 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00197",
4914 "%s(): Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
4915 "zero or <= image subresource width (%d).",
4916 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06004917 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06004918 }
4919
4920 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06004921 if ((pRegions[i].imageOffset.y < 0) || (pRegions[i].imageOffset.y > static_cast<int32_t>(adjusted_image_extent.height)) ||
4922 ((pRegions[i].imageOffset.y + pRegions[i].imageExtent.height) > static_cast<int32_t>(adjusted_image_extent.height))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004923 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00198",
4924 "%s(): Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
4925 "zero or <= image subresource height (%d).",
4926 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06004927 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06004928 }
4929
4930 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06004931 if ((pRegions[i].imageOffset.z < 0) || (pRegions[i].imageOffset.z > static_cast<int32_t>(adjusted_image_extent.depth)) ||
4932 ((pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth) > static_cast<int32_t>(adjusted_image_extent.depth))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004933 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00200",
4934 "%s(): Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
4935 "zero or <= image subresource depth (%d).",
4936 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06004937 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06004938 }
4939
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004940 // subresource aspectMask must have exactly 1 bit set
4941 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
4942 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
4943 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004944 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-00212",
4945 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004946 }
4947
4948 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06004949 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004950 skip |= LogError(
4951 image_state->image, "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004952 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
4953 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004954 }
4955
4956 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04004957 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07004958 auto block_size = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004959
4960 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06004961 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004962 skip |= LogError(
4963 image_state->image, "VUID-VkBufferImageCopy-bufferRowLength-00203",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004964 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
4965 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004966 }
4967
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004968 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004969 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004970 skip |= LogError(
4971 image_state->image, "VUID-VkBufferImageCopy-bufferImageHeight-00204",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004972 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
4973 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004974 }
4975
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004976 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06004977 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
4978 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
4979 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004980 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00205",
4981 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
4982 "width & height (%d, %d)..",
4983 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
4984 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004985 }
4986
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004987 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houltona585d132019-01-18 13:05:42 -07004988 uint32_t block_size_in_bytes = FormatElementSize(image_state->createInfo.format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06004989 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004990 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-bufferOffset-00206",
4991 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
4992 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
4993 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004994 }
Dave Houlton67e9b532017-03-02 17:00:10 -07004995
4996 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07004997 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06004998 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004999 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005000 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageExtent-00207",
5001 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
5002 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
5003 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
5004 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07005005 }
5006
5007 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005008 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005009 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005010 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageExtent-00208",
5011 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
5012 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
5013 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
5014 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07005015 }
5016
5017 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06005018 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005019 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005020 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageExtent-00209",
5021 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
5022 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
5023 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
5024 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07005025 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005026 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005027
5028 // Checks that apply only to multi-planar format images
5029 if (FormatIsMultiplane(image_state->createInfo.format)) {
5030 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
5031 if ((FormatPlaneCount(image_state->createInfo.format) < 3) &&
5032 (pRegions[i].imageSubresource.aspectMask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005033 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-01560",
5034 "%s(): pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
5035 "format has three planes.",
5036 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08005037 }
5038
5039 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
5040 if (0 == (pRegions[i].imageSubresource.aspectMask &
5041 (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005042 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-01560",
5043 "%s(): pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
5044 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
5045 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08005046 }
5047 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005048 }
5049
5050 return skip;
5051}
5052
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005053bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount, const VkBufferImageCopy *pRegions,
5054 const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005055 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005056 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005057
5058 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005059 VkExtent3D extent = pRegions[i].imageExtent;
5060 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005061
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005062 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
5063 {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005064 skip |= LogWarning(image_state->image, kVUID_Core_Image_ZeroAreaSubregion,
5065 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
5066 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005067 }
5068
5069 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
5070
5071 // If we're using a compressed format, valid extent is rounded up to multiple of block size (per 18.1)
unknown948b6ba2019-09-19 17:32:54 -06005072 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005073 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005074 if (image_extent.width % block_extent.width) {
5075 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
5076 }
5077 if (image_extent.height % block_extent.height) {
5078 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
5079 }
5080 if (image_extent.depth % block_extent.depth) {
5081 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
5082 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005083 }
5084
Dave Houltonfc1a4052017-04-27 14:32:45 -06005085 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005086 skip |= LogError(image_state->image, msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005087 }
5088 }
5089
5090 return skip;
5091}
5092
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005093bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
5094 const VkBufferImageCopy *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005095 bool skip = false;
5096
5097 VkDeviceSize buffer_size = buff_state->createInfo.size;
5098
5099 for (uint32_t i = 0; i < regionCount; i++) {
5100 VkExtent3D copy_extent = pRegions[i].imageExtent;
5101
5102 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
5103 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Locke497739c2019-03-08 11:50:47 -07005104 VkDeviceSize unit_size = FormatElementSize(image_state->createInfo.format,
5105 pRegions[i].imageSubresource.aspectMask); // size (bytes) of texel or block
Dave Houltonf3229d52017-02-21 15:59:08 -07005106
Tom Cooperb2550c72018-10-15 13:08:41 +01005107 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005108 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houltona585d132019-01-18 13:05:42 -07005109 auto block_dim = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005110 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
5111 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
5112
5113 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
5114 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
5115 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005116 }
5117
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005118 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
5119 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
5120 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07005121 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005122 } else {
5123 // Calculate buffer offset of final copied byte, + 1.
5124 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
5125 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
5126 max_buffer_offset *= unit_size; // convert to bytes
5127 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005128
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005129 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005130 skip |= LogError(device, msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i,
5131 buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005132 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005133 }
5134 }
5135
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005136 return skip;
5137}
5138
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005139bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005140 VkBuffer dstBuffer, uint32_t regionCount,
5141 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005142 const auto cb_node = GetCBState(commandBuffer);
5143 const auto src_image_state = GetImageState(srcImage);
5144 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005145
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005146 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005147
5148 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005149 skip |= ValidateCmd(cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005150
5151 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005152 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005153
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005154 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07005155
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005156 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005157 skip |=
5158 LogError(cb_node->createInfo.commandPool, "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
5159 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
5160 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005161 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005162 skip |= ValidateImageBounds(src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005163 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005164 skip |= ValidateBufferBounds(src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005165 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005166
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005167 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005168 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005169 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
5170 skip |=
5171 ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005172
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005173 // Validate that SRC image & DST buffer have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005174 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005175 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
5176 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005177 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005178 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
5179 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005180 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005181 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImageToBuffer()",
5182 "VUID-vkCmdCopyImageToBuffer-srcImage-01998",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005183 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04005184 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005185 skip |= InsideRenderPass(cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005186 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005187 const char *src_invalid_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5188 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
5189 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005190 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005191 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
Cort Strattond619a302018-05-17 19:46:32 -07005192 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005193 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005194 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
5195 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005196 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5197 cb_node, src_image_state, &pRegions[i], i, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
5198 skip |=
5199 ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyImageToBuffer()",
5200 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
5201 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005202 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
5203 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005204 }
5205 return skip;
5206}
5207
John Zulauf1686f232019-07-09 16:27:11 -06005208void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5209 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
5210 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
5211
5212 auto cb_node = GetCBState(commandBuffer);
5213 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06005214 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005215 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005216 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005217 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005218}
5219
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005220bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5221 VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005222 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005223 const auto cb_node = GetCBState(commandBuffer);
5224 const auto src_buffer_state = GetBufferState(srcBuffer);
5225 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005226
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005227 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005228
5229 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005230 skip |= ValidateCmd(cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005231
5232 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005233 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005234 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005235 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005236 skip |=
5237 LogError(cb_node->createInfo.commandPool, "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
5238 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
5239 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005240 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005241 skip |= ValidateImageBounds(dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005242 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005243 skip |= ValidateBufferBounds(dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005244 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005245 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005246 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005247 skip |=
5248 ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
5249 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005250 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005251 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
5252 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005253 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005254 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
5255 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005256 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005257 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyBufferToImage()",
5258 "VUID-vkCmdCopyBufferToImage-dstImage-01997",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005259 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04005260 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005261 skip |= InsideRenderPass(cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005262 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005263 const char *dst_invalid_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5264 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
5265 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005266 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005267 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
Cort Strattond619a302018-05-17 19:46:32 -07005268 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005269 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005270 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
5271 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005272 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5273 cb_node, dst_image_state, &pRegions[i], i, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
5274 skip |=
5275 ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyBufferToImage()",
5276 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
5277 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005278 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
5279 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005280 }
5281 return skip;
5282}
5283
John Zulauf1686f232019-07-09 16:27:11 -06005284void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5285 VkImageLayout dstImageLayout, uint32_t regionCount,
5286 const VkBufferImageCopy *pRegions) {
5287 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
5288
5289 auto cb_node = GetCBState(commandBuffer);
5290 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06005291 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005292 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005293 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005294 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005295}
Mike Weiblen672b58b2017-02-21 14:32:53 -07005296
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005297bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005298 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005299 bool skip = false;
5300 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
5301
Dave Houlton1d960ff2018-01-19 12:17:05 -07005302 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07005303 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
5304 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
5305 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005306 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
5307 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005308 }
5309
John Zulaufa26d3c82019-08-14 16:09:08 -06005310 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005311 if (!image_entry) {
5312 return skip;
5313 }
5314
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005315 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
5316 if (device_extensions.vk_ext_image_drm_format_modifier) {
5317 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
5318 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005319 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
5320 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
5321 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005322 }
5323 } else {
5324 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005325 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
5326 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005327 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07005328 }
5329
Dave Houlton1d960ff2018-01-19 12:17:05 -07005330 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005331 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005332 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
5333 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
5334 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005335 }
5336
Dave Houlton1d960ff2018-01-19 12:17:05 -07005337 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005338 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005339 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
5340 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
5341 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005342 }
5343
Dave Houlton1d960ff2018-01-19 12:17:05 -07005344 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07005345 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005346 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
5347 if (FormatIsMultiplane(img_format)) {
5348 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
5349 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
5350 if (FormatPlaneCount(img_format) > 2u) {
5351 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
5352 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
5353 }
5354 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005355 skip |= LogError(image, vuid,
5356 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
5357 ") must be a single-plane specifier flag.",
5358 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005359 }
5360 } else if (FormatIsColor(img_format)) {
5361 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005362 skip |= LogError(image, kVUID_Core_DrawState_InvalidImageAspect,
5363 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
5364 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005365 }
5366 } else if (FormatIsDepthOrStencil(img_format)) {
5367 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
5368 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07005369 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005370 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5371 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
5372 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
5373 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005374 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
5375 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
5376 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005377 }
5378 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005379
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005380 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005381 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005382 }
5383
Mike Weiblen672b58b2017-02-21 14:32:53 -07005384 return skip;
5385}