blob: ac7f98d6e381c434c968803755c722bb6ce0cb2e [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),
79 ahb_format(0),
John Zulaufb58415b2019-12-09 15:02:32 -070080 full_range{MakeImageFullRange(createInfo)},
unknown09edc722019-06-21 15:49:38 -060081 create_from_swapchain(VK_NULL_HANDLE),
82 bind_swapchain(VK_NULL_HANDLE),
unknown08c57af2019-06-21 16:33:35 -060083 bind_swapchain_imageIndex(0),
John Zulaufb58415b2019-12-09 15:02:32 -070084 range_encoder(full_range),
unknown08c57af2019-06-21 16:33:35 -060085 sparse_requirements{} {
John Zulauff660ad62019-03-23 07:16:05 -060086 if ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) && (createInfo.queueFamilyIndexCount > 0)) {
87 uint32_t *pQueueFamilyIndices = new uint32_t[createInfo.queueFamilyIndexCount];
88 for (uint32_t i = 0; i < createInfo.queueFamilyIndexCount; i++) {
89 pQueueFamilyIndices[i] = pCreateInfo->pQueueFamilyIndices[i];
90 }
91 createInfo.pQueueFamilyIndices = pQueueFamilyIndices;
92 }
93
94 if (createInfo.flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) {
95 sparse = true;
96 }
Locked8af3732019-05-10 09:47:56 -060097
sfricke-samsunge2441192019-11-06 14:07:57 -080098 auto *externalMemoryInfo = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(pCreateInfo->pNext);
99 if (externalMemoryInfo) {
100 external_memory_handle = externalMemoryInfo->handleTypes;
101 }
102
Locked8af3732019-05-10 09:47:56 -0600103#ifdef VK_USE_PLATFORM_ANDROID_KHR
104 auto external_format = lvl_find_in_chain<VkExternalFormatANDROID>(createInfo.pNext);
105 if (external_format) {
106 external_format_android = external_format->externalFormat;
107 } else {
108 // If externalFormat is zero, the effect is as if the VkExternalFormatANDROID structure was not present.
109 external_format_android = 0;
110 }
111#endif // VK_USE_PLATFORM_ANDROID_KHR
John Zulauff660ad62019-03-23 07:16:05 -0600112}
113
unknown2c877272019-07-11 12:56:50 -0600114bool IMAGE_STATE::IsCreateInfoEqual(const VkImageCreateInfo &other_createInfo) const {
115 bool is_equal = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
116 is_equal = is_equal && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
117 is_equal = is_equal && IsMipLevelsEqual(other_createInfo) && IsArrayLayersEqual(other_createInfo);
118 is_equal = is_equal && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
119 is_equal = is_equal && IsExtentEqual(other_createInfo) && IsTilingEqual(other_createInfo);
120 is_equal = is_equal && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
121 return is_equal && IsQueueFamilyIndicesEqual(other_createInfo);
122}
123
Jeff Bolz82f854d2019-09-17 14:56:47 -0500124// Check image compatibility rules for VK_NV_dedicated_allocation_image_aliasing
125bool IMAGE_STATE::IsCreateInfoDedicatedAllocationImageAliasingCompatible(const VkImageCreateInfo &other_createInfo) const {
126 bool is_compatible = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
127 is_compatible = is_compatible && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
128 is_compatible = is_compatible && IsMipLevelsEqual(other_createInfo);
129 is_compatible = is_compatible && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
130 is_compatible = is_compatible && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
131 is_compatible = is_compatible && IsQueueFamilyIndicesEqual(other_createInfo) && IsTilingEqual(other_createInfo);
132
133 is_compatible = is_compatible && createInfo.extent.width <= other_createInfo.extent.width &&
134 createInfo.extent.height <= other_createInfo.extent.height &&
135 createInfo.extent.depth <= other_createInfo.extent.depth &&
136 createInfo.arrayLayers <= other_createInfo.arrayLayers;
137 return is_compatible;
138}
139
unknown2c877272019-07-11 12:56:50 -0600140bool IMAGE_STATE::IsCompatibleAliasing(IMAGE_STATE *other_image_state) {
141 if (!(createInfo.flags & other_image_state->createInfo.flags & VK_IMAGE_CREATE_ALIAS_BIT)) return false;
locke-lunarg5f59e782019-12-19 10:32:23 -0700142 if ((create_from_swapchain == VK_NULL_HANDLE) && binding.mem_state &&
143 (binding.mem_state == other_image_state->binding.mem_state) && (binding.offset == other_image_state->binding.offset) &&
unknown2c877272019-07-11 12:56:50 -0600144 IsCreateInfoEqual(other_image_state->createInfo)) {
145 return true;
146 }
unknowne1661522019-07-11 13:04:18 -0600147 if ((bind_swapchain == other_image_state->bind_swapchain) && (bind_swapchain != VK_NULL_HANDLE)) {
148 return true;
149 }
unknown2c877272019-07-11 12:56:50 -0600150 return false;
151}
152
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500153IMAGE_VIEW_STATE::IMAGE_VIEW_STATE(const std::shared_ptr<IMAGE_STATE> &im, VkImageView iv, const VkImageViewCreateInfo *ci)
154 : image_view(iv),
155 create_info(*ci),
John Zulaufb58415b2019-12-09 15:02:32 -0700156 normalized_subresource_range(NormalizeSubresourceRange(*im, ci->subresourceRange)),
157 range_generator(im->range_encoder, normalized_subresource_range),
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500158 samplerConversion(VK_NULL_HANDLE),
159 image_state(im) {
John Zulauff660ad62019-03-23 07:16:05 -0600160 auto *conversionInfo = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info.pNext);
161 if (conversionInfo) samplerConversion = conversionInfo->conversion;
162 if (image_state) {
163 // A light normalization of the createInfo range
164 auto &sub_res_range = create_info.subresourceRange;
165 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
166 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
167
168 // Cache a full normalization (for "full image/whole image" comparisons)
John Zulaufb58415b2019-12-09 15:02:32 -0700169 // normalized_subresource_range = NormalizeSubresourceRange(*image_state, ci->subresourceRange);
Jeff Bolz6cede832019-08-09 23:30:39 -0500170 samples = image_state->createInfo.samples;
171 descriptor_format_bits = DescriptorRequirementsBitsFromFormat(create_info.format);
John Zulauff660ad62019-03-23 07:16:05 -0600172 }
173}
174
Dave Houltond9611312018-11-19 17:03:36 -0700175uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
176 // uint cast applies floor()
177 return 1u + (uint32_t)log2(std::max({height, width, depth}));
178}
179
180uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
181
182uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
183
John Zulaufb58415b2019-12-09 15:02:32 -0700184static VkImageSubresourceRange NormalizeSubresourceRange(const VkImageCreateInfo &image_create_info,
185 const VkImageSubresourceRange &range) {
John Zulauff660ad62019-03-23 07:16:05 -0600186 VkImageSubresourceRange norm = range;
187 norm.levelCount = ResolveRemainingLevels(&range, image_create_info.mipLevels);
188
189 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
190 // <arrayLayers> can potentially alias.
191 uint32_t layer_limit = (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR))
192 ? image_create_info.extent.depth
193 : image_create_info.arrayLayers;
194 norm.layerCount = ResolveRemainingLayers(&range, layer_limit);
195
196 // For multiplanar formats, IMAGE_ASPECT_COLOR is equivalent to adding the aspect of the individual planes
197 VkImageAspectFlags &aspect_mask = norm.aspectMask;
198 if (FormatIsMultiplane(image_create_info.format)) {
199 if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
200 aspect_mask &= ~VK_IMAGE_ASPECT_COLOR_BIT;
201 aspect_mask |= (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
202 if (FormatPlaneCount(image_create_info.format) > 2) {
203 aspect_mask |= VK_IMAGE_ASPECT_PLANE_2_BIT;
204 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700205 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700206 }
John Zulauff660ad62019-03-23 07:16:05 -0600207 return norm;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700208}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700209
John Zulaufb58415b2019-12-09 15:02:32 -0700210VkImageSubresourceRange NormalizeSubresourceRange(const IMAGE_STATE &image_state, const VkImageSubresourceRange &range) {
211 const VkImageCreateInfo &image_create_info = image_state.createInfo;
212 return NormalizeSubresourceRange(image_create_info, range);
213}
214
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500215bool CoreChecks::FindLayouts(VkImage image, std::vector<VkImageLayout> &layouts) const {
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700216 auto image_state = GetImageState(image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700217 if (!image_state) return false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700218
John Zulauf2076e812020-01-08 14:55:54 -0700219 const auto *layout_range_map = GetLayoutRangeMap(imageLayoutMap, image);
220 if (!layout_range_map) return false;
locke-lunargf155ccf2020-02-18 11:34:15 -0700221 // TODO: FindLayouts function should mutate into a ValidatePresentableLayout with the loop wrapping the LogError
222 // from the caller. You can then use decode to add the subresource of the range::begin to the error message.
223
John Zulauf2076e812020-01-08 14:55:54 -0700224 // TODO: what is this test and what is it supposed to do?! -- the logic doesn't match the comment below?!
225
226 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
227 if (layout_range_map->size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700228 return false;
229 }
locke-lunargcba7d5f2019-12-30 16:59:11 -0700230
John Zulauf2076e812020-01-08 14:55:54 -0700231 for (auto entry : *layout_range_map) {
232 layouts.push_back(entry.second);
Tony Barbourdf013b92017-01-25 12:53:48 -0700233 }
234 return true;
235}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700236
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600237// Set image layout for given VkImageSubresourceRange struct
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600238void CoreChecks::SetImageLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600239 const VkImageSubresourceRange &image_subresource_range, VkImageLayout layout,
240 VkImageLayout expected_layout) {
241 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
242 assert(subresource_map); // the non-const getter must return a valid pointer
John Zulauf4ec24ec2019-05-02 17:22:59 -0600243 if (subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600244 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700245 }
246}
John Zulauff660ad62019-03-23 07:16:05 -0600247
248// Set the initial image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600249void CoreChecks::SetImageViewInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
Jeff Bolz3e333222019-08-10 23:00:38 -0500250 if (disabled.image_layout_validation) {
251 return;
252 }
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500253 IMAGE_STATE *image_state = view_state.image_state.get();
254 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
John Zulaufb58415b2019-12-09 15:02:32 -0700255 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
John Zulauff660ad62019-03-23 07:16:05 -0600256}
257
258// Set the initial image layout for a passed non-normalized subresource range
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600259void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600260 const VkImageSubresourceRange &range, VkImageLayout layout) {
261 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
262 assert(subresource_map);
John Zulauf4ec24ec2019-05-02 17:22:59 -0600263 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(image_state, range), layout);
John Zulauff660ad62019-03-23 07:16:05 -0600264}
265
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600266void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, VkImage image, const VkImageSubresourceRange &range,
John Zulauff660ad62019-03-23 07:16:05 -0600267 VkImageLayout layout) {
268 const IMAGE_STATE *image_state = GetImageState(image);
269 if (!image_state) return;
270 SetImageInitialLayout(cb_node, *image_state, range, layout);
271};
272
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600273void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600274 const VkImageSubresourceLayers &layers, VkImageLayout layout) {
275 SetImageInitialLayout(cb_node, image_state, RangeFromLayers(layers), layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600276}
Dave Houltonddd65c52018-05-08 14:58:01 -0600277
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600278// Set image layout for all slices of an image view
Piers Daniell4fde9b72019-11-27 16:19:46 -0700279void CoreChecks::SetImageViewLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout,
280 VkImageLayout layoutStencil) {
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500281 IMAGE_STATE *image_state = view_state.image_state.get();
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600282
John Zulauff660ad62019-03-23 07:16:05 -0600283 VkImageSubresourceRange sub_range = view_state.normalized_subresource_range;
Dave Houltonddd65c52018-05-08 14:58:01 -0600284 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
285 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
John Zulauff660ad62019-03-23 07:16:05 -0600286 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 -0600287 sub_range.baseArrayLayer = 0;
288 sub_range.layerCount = image_state->createInfo.extent.depth;
289 }
290
Piers Daniell4fde9b72019-11-27 16:19:46 -0700291 if (sub_range.aspectMask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT) && layoutStencil != kInvalidLayout) {
292 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
293 SetImageLayout(cb_node, *image_state, sub_range, layout);
294 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
295 SetImageLayout(cb_node, *image_state, sub_range, layoutStencil);
296 } else {
297 SetImageLayout(cb_node, *image_state, sub_range, layout);
298 }
John Zulauf4ccf5c02018-09-21 11:46:18 -0600299}
300
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700301bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
302 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700303 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600304 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100305 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700306 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100307 const char *vuid;
308 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
309
310 if (!image_state) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700311 skip |= LogError(image, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
312 "Render Pass begin with %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
313 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
314 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100315 return skip;
316 }
317
318 auto image_usage = image_state->createInfo.usage;
319
320 // Check for layouts that mismatch image usages in the framebuffer
321 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800322 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100323 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700324 LogError(image, vuid,
325 "Layout/usage mismatch for attachment %u in %s"
326 " - the %s is %s but the image attached to %s via %s"
327 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
328 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
329 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100330 }
331
332 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
333 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800334 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100335 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700336 LogError(image, vuid,
337 "Layout/usage mismatch for attachment %u in %s"
338 " - the %s is %s but the image attached to %s via %s"
339 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
340 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
341 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100342 }
343
344 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800345 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100346 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700347 LogError(image, vuid,
348 "Layout/usage mismatch for attachment %u in %s"
349 " - the %s is %s but the image attached to %s via %s"
350 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
351 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
352 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100353 }
354
355 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800356 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100357 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700358 LogError(image, vuid,
359 "Layout/usage mismatch for attachment %u in %s"
360 " - the %s is %s but the image attached to %s via %s"
361 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
362 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
363 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100364 }
365
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600366 if (device_extensions.vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100367 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
368 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
369 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
370 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
371 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800372 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700373 skip |= LogError(image, vuid,
374 "Layout/usage mismatch for attachment %u in %s"
375 " - the %s is %s but the image attached to %s via %s"
376 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
377 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
378 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
379 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100380 }
381 } else {
382 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
383 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
384 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
385 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700386 skip |= LogError(image, "VUID-vkCmdBeginRenderPass-initialLayout-00896",
387 "Layout/usage mismatch for attachment %u in %s"
388 " - the %s is %s but the image attached to %s via %s"
389 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
390 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
391 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
392 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100393 }
394 }
395 return skip;
396}
397
John Zulauf17a01bb2019-08-09 16:41:19 -0600398bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700399 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600400 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600401 bool skip = false;
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700402 auto const pRenderPassInfo = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700403 auto const &framebufferInfo = framebuffer_state->createInfo;
Tobias Hectorc9057422019-07-23 12:15:52 +0100404 const VkImageView *attachments = framebufferInfo.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100405
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700406 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100407 auto framebuffer = framebuffer_state->framebuffer;
408
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700409 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700410 skip |= LogError(pCB->commandBuffer, kVUID_Core_DrawState_InvalidRenderpass,
411 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700412 }
John Zulauf8e308292018-09-21 11:34:37 -0600413
Tobias Hectorc9057422019-07-23 12:15:52 +0100414 const auto *attachmentInfo = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
415 if (((framebufferInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) != 0) && attachmentInfo != nullptr) {
416 attachments = attachmentInfo->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100417 }
418
Tobias Hectorc9057422019-07-23 12:15:52 +0100419 if (attachments != nullptr) {
420 const auto *const_pCB = static_cast<const CMD_BUFFER_STATE *>(pCB);
421 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
422 auto image_view = attachments[i];
423 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100424
Tobias Hectorc9057422019-07-23 12:15:52 +0100425 if (!view_state) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700426 skip |= LogError(pRenderPassBegin->renderPass, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
427 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
428 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
429 report_data->FormatHandle(image_view).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100430 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100431 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100432
433 const VkImage image = view_state->create_info.image;
434 const IMAGE_STATE *image_state = GetImageState(image);
435
436 if (!image_state) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700437 skip |= LogError(pRenderPassBegin->renderPass, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
438 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
439 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
440 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100441 continue;
442 }
443 auto attachment_initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
444 auto final_layout = pRenderPassInfo->pAttachments[i].finalLayout;
445
Piers Daniell7f894f62020-01-09 16:33:48 -0700446 // Default to expecting stencil in the same layout.
447 auto attachment_stencil_initial_layout = attachment_initial_layout;
448
449 // If a separate layout is specified, look for that.
450 const auto *attachment_description_stencil_layout =
451 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
452 if (attachment_description_stencil_layout) {
453 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
454 }
455
Tobias Hectorc9057422019-07-23 12:15:52 +0100456 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
457 // in common with the non-const version.)
458 const ImageSubresourceLayoutMap *subresource_map =
459 (attachment_initial_layout != VK_IMAGE_LAYOUT_UNDEFINED) ? GetImageSubresourceLayoutMap(const_pCB, image) : nullptr;
460
461 if (subresource_map) { // If no layout information for image yet, will be checked at QueueSubmit time
462 LayoutUseCheckAndMessage layout_check(subresource_map);
463 bool subres_skip = false;
John Zulauf5e617452019-11-19 14:44:16 -0700464 auto pos = subresource_map->Find(view_state->normalized_subresource_range);
465 for (; pos != subresource_map->End() && !subres_skip; ++pos) {
466 const VkImageSubresource &subres = pos->subresource;
Piers Daniell7f894f62020-01-09 16:33:48 -0700467
John Zulauf5e617452019-11-19 14:44:16 -0700468 // Allow for differing depth and stencil layouts
469 VkImageLayout check_layout = attachment_initial_layout;
470 if (subres.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) check_layout = attachment_stencil_initial_layout;
471
472 if (!layout_check.Check(subres, check_layout, pos->current_layout, pos->initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700473 subres_skip |= LogError(
474 device, kVUID_Core_DrawState_InvalidRenderpass,
Piers Daniell7f894f62020-01-09 16:33:48 -0700475 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
476 "and the %s layout of the attachment is %s. The layouts must match, or the render "
477 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
John Zulauf5e617452019-11-19 14:44:16 -0700478 i, string_VkImageLayout(check_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobias Hectorc9057422019-07-23 12:15:52 +0100479 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700480 }
John Zulauf5e617452019-11-19 14:44:16 -0700481
Tobias Hectorc9057422019-07-23 12:15:52 +0100482 skip |= subres_skip;
483 }
484
485 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view,
486 framebuffer, render_pass, i, "initial layout");
487
488 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer,
489 render_pass, i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100490 }
491
Tobias Hectorc9057422019-07-23 12:15:52 +0100492 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
493 auto &subpass = pRenderPassInfo->pSubpasses[j];
494 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
495 auto &attachment_ref = subpass.pInputAttachments[k];
496 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
497 auto image_view = attachments[attachment_ref.attachment];
498 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100499
Tobias Hectorc9057422019-07-23 12:15:52 +0100500 if (view_state) {
501 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700502 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
503 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100504 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100505 }
506 }
507 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100508
Tobias Hectorc9057422019-07-23 12:15:52 +0100509 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
510 auto &attachment_ref = subpass.pColorAttachments[k];
511 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
512 auto image_view = attachments[attachment_ref.attachment];
513 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100514
Tobias Hectorc9057422019-07-23 12:15:52 +0100515 if (view_state) {
516 auto image = view_state->create_info.image;
517 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
518 framebuffer, render_pass, attachment_ref.attachment,
519 "color attachment layout");
520 if (subpass.pResolveAttachments) {
521 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
522 rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
523 attachment_ref.attachment, "resolve attachment layout");
524 }
525 }
526 }
527 }
528
529 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
530 auto &attachment_ref = *subpass.pDepthStencilAttachment;
531 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
532 auto image_view = attachments[attachment_ref.attachment];
533 auto view_state = GetImageViewState(image_view);
534
535 if (view_state) {
536 auto image = view_state->create_info.image;
537 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
538 framebuffer, render_pass, attachment_ref.attachment,
539 "input attachment layout");
540 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100541 }
542 }
543 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700544 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600545 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700546}
547
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600548void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700549 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700550 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700551 auto image_view = GetAttachmentImageViewState(pFramebuffer, ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600552 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700553 VkImageLayout stencil_layout = kInvalidLayout;
554 const auto *attachment_reference_stencil_layout = lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(ref.pNext);
555 if (attachment_reference_stencil_layout) {
556 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
557 }
558
559 SetImageViewLayout(pCB, *image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600560 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700561 }
562}
563
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600564void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
565 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700566 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700567
568 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700569 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700570 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700571 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700572 }
573 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700574 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700575 }
576 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700577 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700578 }
579 }
580}
581
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700582// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
583// 1. Transition into initialLayout state
584// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600585void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700586 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700587 // First transition into initialLayout
588 auto const rpci = render_pass_state->createInfo.ptr();
589 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700590 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -0600591 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700592 VkImageLayout stencil_layout = kInvalidLayout;
593 const auto *attachment_description_stencil_layout =
594 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(rpci->pAttachments[i].pNext);
595 if (attachment_description_stencil_layout) {
596 stencil_layout = attachment_description_stencil_layout->stencilInitialLayout;
597 }
598
599 SetImageViewLayout(cb_state, *view_state, rpci->pAttachments[i].initialLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600600 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700601 }
602 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700603 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700604}
605
Dave Houlton10b39482017-03-16 13:18:15 -0600606bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600607 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600608 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600609 }
610 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600611 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600612 }
613 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600614 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600615 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700616 if (0 !=
617 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
618 if (FormatPlaneCount(format) == 1) return false;
619 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600620 return true;
621}
622
Mike Weiblen62d08a32017-03-07 22:18:27 -0700623// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Petr Krausad0096a2019-08-09 18:35:04 +0200624bool CoreChecks::ValidateBarrierLayoutToImageUsage(const VkImageMemoryBarrier &img_barrier, bool new_not_old,
625 VkImageUsageFlags usage_flags, const char *func_name,
John Zulaufa4472282019-08-22 14:44:34 -0600626 const char *barrier_pname) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700627 bool skip = false;
Petr Krausad0096a2019-08-09 18:35:04 +0200628 const VkImageLayout layout = (new_not_old) ? img_barrier.newLayout : img_barrier.oldLayout;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600629 const char *msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700630
631 switch (layout) {
632 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
633 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600634 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700635 }
636 break;
637 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
638 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600639 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700640 }
641 break;
642 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
643 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600644 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700645 }
646 break;
647 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
648 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600649 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700650 }
651 break;
652 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
653 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600654 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700655 }
656 break;
657 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
658 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600659 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700660 }
661 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600662 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500663 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
664 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
665 }
666 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700667 default:
668 // Other VkImageLayout values do not have VUs defined in this context.
669 break;
670 }
671
Dave Houlton8e9f6542018-05-18 12:18:22 -0600672 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700673 skip |= LogError(img_barrier.image, msg_code,
674 "%s: Image barrier %s %s Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".", func_name,
675 barrier_pname, ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
676 report_data->FormatHandle(img_barrier.image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700677 }
678 return skip;
679}
680
681// Verify image barriers are compatible with the images they reference.
John Zulaufa4472282019-08-22 14:44:34 -0600682bool CoreChecks::ValidateBarriersToImages(const CMD_BUFFER_STATE *cb_state, uint32_t imageMemoryBarrierCount,
683 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700684 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700685
Petr Krausad0096a2019-08-09 18:35:04 +0200686 // Scoreboard for checking for duplicate and inconsistent barriers to images
687 struct ImageBarrierScoreboardEntry {
688 uint32_t index;
689 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
690 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
691 const VkImageMemoryBarrier *barrier;
692 };
693 using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
694 using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
695
John Zulauf463c51e2018-05-31 13:29:20 -0600696 // Scoreboard for duplicate layout transition barriers within the list
697 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
698 ImageBarrierScoreboardImageMap layout_transitions;
699
Mike Weiblen62d08a32017-03-07 22:18:27 -0700700 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +0200701 const auto &img_barrier = pImageMemoryBarriers[i];
702 const std::string barrier_pname = "pImageMemoryBarrier[" + std::to_string(i) + "]";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700703
John Zulauf463c51e2018-05-31 13:29:20 -0600704 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
705 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
706 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +0200707 if (img_barrier.oldLayout != img_barrier.newLayout) {
708 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
709 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -0600710 if (image_it != layout_transitions.end()) {
711 auto &subres_map = image_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200712 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -0600713 if (subres_it != subres_map.end()) {
714 auto &entry = subres_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200715 if ((entry.barrier->newLayout != img_barrier.oldLayout) &&
716 (img_barrier.oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
717 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700718 skip = LogError(
719 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
Petr Krausad0096a2019-08-09 18:35:04 +0200720 "%s: %s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600721 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
722 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Petr Krausad0096a2019-08-09 18:35:04 +0200723 func_name, barrier_pname.c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
724 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
725 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600726 }
727 entry = new_entry;
728 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200729 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600730 }
731 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200732 layout_transitions[img_barrier.image][img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600733 }
734 }
735
Petr Krausad0096a2019-08-09 18:35:04 +0200736 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600737 if (image_state) {
738 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Petr Krausad0096a2019-08-09 18:35:04 +0200739 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, false, usage_flags, func_name, barrier_pname.c_str());
740 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, true, usage_flags, func_name, barrier_pname.c_str());
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600741
742 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
743 if (image_state->layout_locked) {
744 // TODO: Add unique id for error when available
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700745 skip |= LogError(
746 img_barrier.image, 0,
locke-lunarg9edc2812019-06-17 23:18:52 -0600747 "Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600748 " 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 +0200749 report_data->FormatHandle(img_barrier.image).c_str(), string_VkImageLayout(img_barrier.oldLayout),
750 string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600751 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600752
John Zulaufa4472282019-08-22 14:44:34 -0600753 const VkImageCreateInfo &image_create_info = image_state->createInfo;
John Zulauff660ad62019-03-23 07:16:05 -0600754 // For a Depth/Stencil image both aspects MUST be set
John Zulaufa4472282019-08-22 14:44:34 -0600755 if (FormatIsDepthAndStencil(image_create_info.format)) {
Petr Krausad0096a2019-08-09 18:35:04 +0200756 auto const aspect_mask = img_barrier.subresourceRange.aspectMask;
Piers Daniell41b8c5d2020-01-10 15:42:00 -0700757 if (enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -0600758 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
759 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700760 LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-03319",
761 "%s: Image barrier %s references %s of format %s that must have either the depth or stencil "
762 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
763 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
764 string_VkFormat(image_create_info.format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600765 }
766 } else {
767 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
768 if ((aspect_mask & ds_mask) != (ds_mask)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700769 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-03320",
770 "%s: Image barrier %s references %s of format %s that must have the depth and stencil "
771 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
772 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
773 string_VkFormat(image_create_info.format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600774 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700775 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700776 }
John Zulauff660ad62019-03-23 07:16:05 -0600777
Petr Krausad0096a2019-08-09 18:35:04 +0200778 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier.image);
779 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -0600780 // TODO: Set memory invalid which is in mem_tracker currently
781 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
782 // subresource.
783 } else if (subresource_map) {
784 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -0600785 LayoutUseCheckAndMessage layout_check(subresource_map);
Petr Krausad0096a2019-08-09 18:35:04 +0200786 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier.subresourceRange);
John Zulauf5e617452019-11-19 14:44:16 -0700787 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
788 const auto &value = *pos;
789 if (!layout_check.Check(value.subresource, img_barrier.oldLayout, value.current_layout, value.initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700790 subres_skip = LogError(
791 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
John Zulauf5e617452019-11-19 14:44:16 -0700792 "For %s you cannot transition the layout of aspect=%d level=%d layer=%d from %s when the "
793 "%s layout is %s.",
794 report_data->FormatHandle(img_barrier.image).c_str(), value.subresource.aspectMask,
795 value.subresource.mipLevel, value.subresource.arrayLayer, string_VkImageLayout(img_barrier.oldLayout),
796 layout_check.message, string_VkImageLayout(layout_check.layout));
John Zulauff660ad62019-03-23 07:16:05 -0600797 }
John Zulauf5e617452019-11-19 14:44:16 -0700798 }
John Zulauff660ad62019-03-23 07:16:05 -0600799 skip |= subres_skip;
800 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700801 }
802 }
803 return skip;
804}
805
John Zulaufe3d1c8a2019-08-12 14:34:58 -0600806bool CoreChecks::IsReleaseOp(CMD_BUFFER_STATE *cb_state, const VkImageMemoryBarrier &barrier) const {
Petr Krausad0096a2019-08-09 18:35:04 +0200807 if (!IsTransferOp(&barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700808
Jeff Bolz6835fda2019-10-06 00:15:34 -0500809 auto pool = cb_state->command_pool.get();
Petr Krausad0096a2019-08-09 18:35:04 +0200810 return pool && TempIsReleaseOp<VkImageMemoryBarrier, true>(pool, &barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700811}
812
John Zulauf6b4aae82018-05-09 13:03:36 -0600813template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -0600814bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
815 uint32_t barrier_count, const Barrier *barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600816 using BarrierRecord = QFOTransferBarrier<Barrier>;
817 bool skip = false;
Jeff Bolz6835fda2019-10-06 00:15:34 -0500818 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -0600819 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
820 const char *barrier_name = BarrierRecord::BarrierName();
821 const char *handle_name = BarrierRecord::HandleName();
822 const char *transfer_type = nullptr;
823 for (uint32_t b = 0; b < barrier_count; b++) {
824 if (!IsTransferOp(&barriers[b])) continue;
825 const BarrierRecord *barrier_record = nullptr;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700826 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufa4472282019-08-22 14:44:34 -0600827 !QueueFamilyIsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600828 const auto found = barrier_sets.release.find(barriers[b]);
829 if (found != barrier_sets.release.cend()) {
830 barrier_record = &(*found);
831 transfer_type = "releasing";
832 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600833 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufa4472282019-08-22 14:44:34 -0600834 !QueueFamilyIsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600835 const auto found = barrier_sets.acquire.find(barriers[b]);
836 if (found != barrier_sets.acquire.cend()) {
837 barrier_record = &(*found);
838 transfer_type = "acquiring";
839 }
840 }
841 if (barrier_record != nullptr) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700842 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOInCB(),
843 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
844 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
845 func_name, barrier_name, b, transfer_type, handle_name,
846 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
847 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -0600848 }
849 }
850 return skip;
851}
852
John Zulaufa4472282019-08-22 14:44:34 -0600853VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
854 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
855}
856
857const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
858 return device_state.GetImageState(barrier.image);
859}
860
861VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
862 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
863}
864
865const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
866 return device_state.GetBufferState(barrier.buffer);
867}
868
869VkBuffer BarrierHandle(const VkBufferMemoryBarrier &barrier) { return barrier.buffer; }
870
John Zulauf6b4aae82018-05-09 13:03:36 -0600871template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -0600872void CoreChecks::RecordBarrierArrayValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
873 const Barrier *barriers) {
Jeff Bolz6835fda2019-10-06 00:15:34 -0500874 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -0600875 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
876 for (uint32_t b = 0; b < barrier_count; b++) {
John Zulaufa4472282019-08-22 14:44:34 -0600877 auto &barrier = barriers[b];
878 if (IsTransferOp(&barrier)) {
879 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barrier) &&
880 !QueueFamilyIsSpecial(barrier.dstQueueFamilyIndex)) {
881 barrier_sets.release.emplace(barrier);
882 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barrier) &&
883 !QueueFamilyIsSpecial(barrier.srcQueueFamilyIndex)) {
884 barrier_sets.acquire.emplace(barrier);
885 }
886 }
887
888 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
889 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
890 if (!QueueFamilyIsIgnored(src_queue_family) && !QueueFamilyIsIgnored(dst_queue_family)) {
891 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
892 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
893 auto handle_state = BarrierHandleState(*this, barrier);
894 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
895 if (!mode_concurrent) {
896 const auto typed_handle = BarrierTypedHandle(barrier);
Jeff Bolz310775c2019-10-09 00:46:33 -0500897 cb_state->queue_submit_functions.emplace_back(
898 [func_name, cb_state, typed_handle, src_queue_family, dst_queue_family](
899 const ValidationStateTracker *device_data, const QUEUE_STATE *queue_state) {
900 return ValidateConcurrentBarrierAtSubmit(device_data, queue_state, func_name, cb_state, typed_handle,
901 src_queue_family, dst_queue_family);
John Zulaufa4472282019-08-22 14:44:34 -0600902 });
903 }
John Zulauf6b4aae82018-05-09 13:03:36 -0600904 }
905 }
906}
907
John Zulaufa4472282019-08-22 14:44:34 -0600908bool CoreChecks::ValidateBarriersQFOTransferUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600909 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700910 uint32_t imageMemBarrierCount,
John Zulaufa4472282019-08-22 14:44:34 -0600911 const VkImageMemoryBarrier *pImageMemBarriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600912 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700913 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
914 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -0600915 return skip;
916}
917
John Zulaufa4472282019-08-22 14:44:34 -0600918void CoreChecks::RecordBarrierValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
919 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
920 const VkImageMemoryBarrier *pImageMemBarriers) {
921 RecordBarrierArrayValidationInfo(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
922 RecordBarrierArrayValidationInfo(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -0600923}
924
925template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600926bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
John Zulauf3b04ebd2019-07-18 14:08:11 -0600927 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600928 // Record to the scoreboard or report that we have a duplication
929 bool skip = false;
930 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
931 if (!inserted.second && inserted.first->second != cb_state) {
932 // This is a duplication (but don't report duplicates from the same CB, as we do that at record time
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700933 skip = LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
934 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
935 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
936 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
937 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
938 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -0600939 }
940 return skip;
941}
942
943template <typename Barrier>
John Zulauf3b04ebd2019-07-18 14:08:11 -0600944bool CoreChecks::ValidateQueuedQFOTransferBarriers(const CMD_BUFFER_STATE *cb_state,
945 QFOTransferCBScoreboards<Barrier> *scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600946 using BarrierRecord = QFOTransferBarrier<Barrier>;
947 using TypeTag = typename BarrierRecord::Tag;
948 bool skip = false;
John Zulauf6b4aae82018-05-09 13:03:36 -0600949 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -0700950 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -0600951 const char *barrier_name = BarrierRecord::BarrierName();
952 const char *handle_name = BarrierRecord::HandleName();
953 // No release should have an extant duplicate (WARNING)
954 for (const auto &release : cb_barriers.release) {
955 // Check the global pending release barriers
956 const auto set_it = global_release_barriers.find(release.handle);
957 if (set_it != global_release_barriers.cend()) {
958 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
959 const auto found = set_for_handle.find(release);
960 if (found != set_for_handle.cend()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700961 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
962 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
963 " to dstQueueFamilyIndex %" PRIu32
964 " duplicates existing barrier queued for execution, without intervening acquire operation.",
965 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
966 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -0600967 }
968 }
969 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
970 }
971 // Each acquire must have a matching release (ERROR)
972 for (const auto &acquire : cb_barriers.acquire) {
973 const auto set_it = global_release_barriers.find(acquire.handle);
974 bool matching_release_found = false;
975 if (set_it != global_release_barriers.cend()) {
976 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
977 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
978 }
979 if (!matching_release_found) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700980 skip |= LogError(cb_state->commandBuffer, BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
981 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
982 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
983 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
984 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -0600985 }
986 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
987 }
988 return skip;
989}
990
John Zulauf3b04ebd2019-07-18 14:08:11 -0600991bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700992 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
John Zulauf3b04ebd2019-07-18 14:08:11 -0600993 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600994 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700995 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state, qfo_image_scoreboards);
996 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state, qfo_buffer_scoreboards);
John Zulauf6b4aae82018-05-09 13:03:36 -0600997 return skip;
998}
999
1000template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001001void CoreChecks::RecordQueuedQFOTransferBarriers(CMD_BUFFER_STATE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001002 using BarrierRecord = QFOTransferBarrier<Barrier>;
1003 using TypeTag = typename BarrierRecord::Tag;
1004 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001005 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001006
1007 // Add release barriers from this submit to the global map
1008 for (const auto &release : cb_barriers.release) {
1009 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1010 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1011 global_release_barriers[release.handle].insert(release);
1012 }
1013
1014 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1015 for (const auto &acquire : cb_barriers.acquire) {
1016 // NOTE: We're not using [] because we don't want to create entries for missing releases
1017 auto set_it = global_release_barriers.find(acquire.handle);
1018 if (set_it != global_release_barriers.end()) {
1019 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1020 set_for_handle.erase(acquire);
1021 if (set_for_handle.size() == 0) { // Clean up empty sets
1022 global_release_barriers.erase(set_it);
1023 }
1024 }
1025 }
1026}
1027
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001028void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001029 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state);
1030 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001031}
1032
John Zulauf6b4aae82018-05-09 13:03:36 -06001033// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001034void CoreChecks::EraseQFOImageRelaseBarriers(const VkImage &image) { EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image); }
John Zulauf6b4aae82018-05-09 13:03:36 -06001035
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001036void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001037 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001038 for (uint32_t i = 0; i < memBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +02001039 const auto &mem_barrier = pImgMemBarriers[i];
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001040
Chris Forbes4de4b132017-08-21 11:27:08 -07001041 // For ownership transfers, the barrier is specified twice; as a release
1042 // operation on the yielding queue family, and as an acquire operation
1043 // on the acquiring queue family. This barrier may also include a layout
1044 // transition, which occurs 'between' the two operations. For validation
1045 // purposes it doesn't seem important which side performs the layout
1046 // transition, but it must not be performed twice. We'll arbitrarily
1047 // choose to perform it as part of the acquire operation.
John Zulauf2be3fe02019-12-30 09:48:02 -07001048 //
1049 // However, we still need to record initial layout for the "initial layout" validation
1050 const bool is_release_op = IsReleaseOp(cb_state, mem_barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -07001051
Petr Krausad0096a2019-08-09 18:35:04 +02001052 auto *image_state = GetImageState(mem_barrier.image);
John Zulauff660ad62019-03-23 07:16:05 -06001053 if (!image_state) continue;
John Zulauf2be3fe02019-12-30 09:48:02 -07001054 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
unknown86bcb3a2019-07-11 13:05:36 -06001055 for (const auto &image : image_state->aliasing_images) {
1056 image_state = GetImageState(image);
John Zulauf2be3fe02019-12-30 09:48:02 -07001057 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
Dave Houltonb3f4b282018-02-22 16:25:16 -07001058 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001059 }
1060}
1061
unknown86bcb3a2019-07-11 13:05:36 -06001062void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
John Zulauf2be3fe02019-12-30 09:48:02 -07001063 const VkImageMemoryBarrier &mem_barrier, bool is_release_op) {
unknown86bcb3a2019-07-11 13:05:36 -06001064 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier.subresourceRange);
1065 const auto &image_create_info = image_state->createInfo;
1066
1067 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1068 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1069 // for all (potential) layer sub_resources.
1070 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
1071 normalized_isr.baseArrayLayer = 0;
1072 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
1073 }
1074
John Zulauf2be3fe02019-12-30 09:48:02 -07001075 if (is_release_op) {
1076 SetImageInitialLayout(cb_state, *image_state, normalized_isr, mem_barrier.oldLayout);
1077 } else {
1078 SetImageLayout(cb_state, *image_state, normalized_isr, mem_barrier.newLayout, mem_barrier.oldLayout);
1079 }
unknown86bcb3a2019-07-11 13:05:36 -06001080}
1081
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001082bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1083 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1084 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1085 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Matthew Ruschd7ef5482019-07-16 22:01:54 -07001086 if (disabled.image_layout_validation) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001087 assert(cb_node);
1088 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001089 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001090 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001091
John Zulauff660ad62019-03-23 07:16:05 -06001092 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1093 if (subresource_map) {
1094 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001095 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
John Zulauf5e617452019-11-19 14:44:16 -07001096 for (auto pos = subresource_map->Find(range); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1097 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001098 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001099 subres_skip |= LogError(cb_node->commandBuffer, layout_mismatch_msg_code,
1100 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1101 "%s layout %s.",
1102 caller, report_data->FormatHandle(image).c_str(), pos->subresource.arrayLayer,
1103 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1104 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001105 }
John Zulauf5e617452019-11-19 14:44:16 -07001106 }
John Zulauff660ad62019-03-23 07:16:05 -06001107 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001108 }
John Zulauff660ad62019-03-23 07:16:05 -06001109
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001110 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1111 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1112 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001113 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1114 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001115 skip |= LogPerformanceWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
1116 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
1117 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001118 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001119 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001120 if (image_state->shared_presentable) {
1121 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001122 skip |= LogError(device, layout_invalid_msg_code,
1123 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1124 string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001125 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001126 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001127 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001128 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001129 skip |= LogError(cb_node->commandBuffer, layout_invalid_msg_code,
1130 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1131 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1132 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001133 }
1134 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001135 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001136}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001137bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001138 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1139 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001140 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001141 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1142 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1143}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001144
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001145void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001146 FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinski2e495882019-03-06 16:11:56 -07001147 auto renderPass = GetRenderPassState(pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001148 if (!renderPass) return;
1149
Tobias Hectorbbb12282018-10-22 15:17:59 +01001150 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001151 if (framebuffer_state) {
1152 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07001153 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -06001154 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001155 VkImageLayout stencil_layout = kInvalidLayout;
1156 const auto *attachment_description_stencil_layout =
1157 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
1158 if (attachment_description_stencil_layout) {
1159 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1160 }
1161
1162 SetImageViewLayout(pCB, *view_state, pRenderPassInfo->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001163 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001164 }
1165 }
1166}
Dave Houltone19e20d2018-02-02 16:32:41 -07001167
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001168#ifdef VK_USE_PLATFORM_ANDROID_KHR
1169// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1170// This could also move into a seperate core_validation_android.cpp file... ?
1171
1172//
1173// AHB-specific validation within non-AHB APIs
1174//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001175bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001176 bool skip = false;
1177
1178 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1179 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001180 if (0 != ext_fmt_android->externalFormat) {
1181 if (VK_FORMAT_UNDEFINED != create_info->format) {
1182 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001183 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1184 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1185 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001186 }
1187
1188 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001189 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1190 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1191 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001192 }
1193
1194 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001195 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1196 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1197 "non-zero externalFormat, but usage includes bits other than VK_IMAGE_USAGE_SAMPLED_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001198 }
1199
1200 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001201 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1202 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1203 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001204 }
1205 }
1206
Mark Lobodzinski1ee06e92019-04-19 14:03:53 -06001207 if ((0 != ext_fmt_android->externalFormat) && (0 == ahb_ext_formats_set.count(ext_fmt_android->externalFormat))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001208 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
1209 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat which has "
1210 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001211 }
1212 }
1213
Dave Houltond9611312018-11-19 17:03:36 -07001214 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001215 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001216 skip |=
1217 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1218 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1219 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001220 }
1221 }
1222
1223 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1224 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1225 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001226 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001227 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1228 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1229 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1230 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001231 }
1232
1233 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001234 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1235 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1236 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1237 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1238 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001239 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001240 }
1241
1242 return skip;
1243}
1244
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001245bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001246 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001247 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001248
1249 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001250 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001251 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1252 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1253 "format member is %s.",
1254 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001255 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001256
Dave Houltond9611312018-11-19 17:03:36 -07001257 // Chain must include a compatible ycbcr conversion
1258 bool conv_found = false;
1259 uint64_t external_format = 0;
1260 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1261 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001262 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001263 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001264 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001265 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001266 }
Dave Houltond9611312018-11-19 17:03:36 -07001267 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001268 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001269 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
1270 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1271 "without a chained VkSamplerYcbcrConversionInfo struct with the same external format.");
Dave Houltond9611312018-11-19 17:03:36 -07001272 }
1273
1274 // Errors in create_info swizzles
1275 if ((create_info->components.r != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1276 (create_info->components.g != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1277 (create_info->components.b != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1278 (create_info->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001279 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1280 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1281 "includes one or more non-identity component swizzles.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001282 }
1283 }
Dave Houltond9611312018-11-19 17:03:36 -07001284
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001285 return skip;
1286}
1287
John Zulaufa26d3c82019-08-14 16:09:08 -06001288bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001289 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001290
John Zulaufa26d3c82019-08-14 16:09:08 -06001291 const IMAGE_STATE *image_state = GetImageState(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001292 if (image_state->imported_ahb && (0 == image_state->GetBoundMemory().size())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001293 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1294 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1295 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1296 "bound to memory.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001297 }
1298 return skip;
1299}
1300
1301#else
1302
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001303bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001304 return false;
1305}
1306
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001307bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001308
John Zulaufa26d3c82019-08-14 16:09:08 -06001309bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001310
1311#endif // VK_USE_PLATFORM_ANDROID_KHR
1312
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001313bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001314 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001315 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001316
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001317 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001318 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001319 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1320 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001321 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1322 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001323 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001324 }
1325
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001326 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1327 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001328 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1329 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1330 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001331 }
1332
1333 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001334 skip |= LogError(device, "VUID-VkImageCreateInfo-imageType-00954",
1335 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1336 "height (%d) and arrayLayers (%d) must be >= 6.",
1337 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001338 }
Dave Houlton130c0212018-01-29 13:39:56 -07001339 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001340
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001341 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001342 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1343 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1344 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001345 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
1346 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1347 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001348 }
1349
1350 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001351 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
1352 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1353 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001354 }
1355
ByumjinConffx991b6062019-08-14 15:17:53 -07001356 if (device_extensions.vk_ext_fragment_density_map) {
1357 uint32_t ceiling_width =
1358 (uint32_t)ceil((float)device_limits->maxFramebufferWidth /
1359 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, 1.0f));
1360 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1361 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001362 LogError(device, "VUID-VkImageCreateInfo-usage-02559",
1363 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1364 "ceiling of device "
1365 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1366 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1367 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001368 }
1369
1370 uint32_t ceiling_height =
1371 (uint32_t)ceil((float)device_limits->maxFramebufferHeight /
1372 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, 1.0f));
1373 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1374 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001375 LogError(device, "VUID-VkImageCreateInfo-usage-02560",
1376 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1377 "ceiling of device "
1378 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1379 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1380 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001381 }
1382 }
1383
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001384 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001385 VkResult result = VK_SUCCESS;
1386 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1387 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1388 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1389 &format_limits);
1390 } else {
1391 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>();
1392 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1393 image_format_info.type = pCreateInfo->imageType;
1394 image_format_info.tiling = pCreateInfo->tiling;
1395 image_format_info.usage = pCreateInfo->usage;
1396 image_format_info.flags = pCreateInfo->flags;
1397 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1398 format_limits = image_format_properties.imageFormatProperties;
1399 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001400
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001401 if (result == VK_ERROR_FORMAT_NOT_SUPPORTED) {
Lockee87f87c2019-04-23 17:53:10 -06001402#ifdef VK_USE_PLATFORM_ANDROID_KHR
1403 if (!lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext))
1404#endif // VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001405 skip |=
1406 LogError(device, kVUIDUndefined, "vkCreateImage(): Format %s is not supported for this combination of parameters.",
1407 string_VkFormat(pCreateInfo->format));
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001408 } else {
1409 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1410 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001411 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1412 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1413 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001414 }
Dave Houlton130c0212018-01-29 13:39:56 -07001415
Dave Houltona585d132019-01-18 13:05:42 -07001416 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1417 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1418 (uint64_t)pCreateInfo->samples;
1419 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * texel_count);
Dave Houlton130c0212018-01-29 13:39:56 -07001420
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001421 // Round up to imageGranularity boundary
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001422 VkDeviceSize imageGranularity = phys_dev_props.limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001423 uint64_t ig_mask = imageGranularity - 1;
1424 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001425
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001426 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001427 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
1428 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1429 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1430 total_size, format_limits.maxResourceSize);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001431 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001432
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001433 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001434 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
1435 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1436 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001437 }
1438
1439 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001440 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
1441 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
1442 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001443 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001444 }
1445
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001446 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsungcead0802020-01-30 22:20:10 -08001447 if (FormatRequiresYcbcrConversion(pCreateInfo->format)) {
1448 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
1449 const char *error_vuid = (device_extensions.vk_ext_ycbcr_image_arrays) ? "VUID-VkImageCreateInfo-format-02653"
1450 : "VUID-VkImageCreateInfo-format-02564";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001451 skip |= LogError(device, error_vuid,
1452 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
1453 "YCbCr Conversion format, arrayLayers must be 1",
1454 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001455 }
1456
1457 if (pCreateInfo->mipLevels != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001458 skip |= LogError(device, "VUID-VkImageCreateInfo-format-02561",
1459 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
1460 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001461 }
1462
1463 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001464 skip |= LogError(
1465 device, "VUID-VkImageCreateInfo-format-02562",
sfricke-samsungcead0802020-01-30 22:20:10 -08001466 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
1467 string_VkSampleCountFlagBits(pCreateInfo->samples));
1468 }
1469
1470 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001471 skip |= LogError(
1472 device, "VUID-VkImageCreateInfo-format-02563",
sfricke-samsungcead0802020-01-30 22:20:10 -08001473 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
1474 string_VkImageType(pCreateInfo->imageType));
1475 }
1476 }
1477
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06001478 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001479 skip |=
1480 LogError(device, "VUID-VkImageCreateInfo-flags-01924",
1481 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
1482 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06001483 }
1484
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001485 if (device_extensions.vk_khr_maintenance2) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06001486 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
1487 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
1488 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
1489 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001490 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001491 LogError(device, kVUIDUndefined,
1492 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1493 "format must be block, ETC or ASTC compressed, but is %s",
1494 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001495 }
1496 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
1497 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001498 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001499 LogError(device, kVUIDUndefined,
1500 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1501 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001502 }
1503 }
1504 }
1505
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001506 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001507 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateImage",
1508 "pCreateInfo->pQueueFamilyIndices", "VUID-VkImageCreateInfo-sharingMode-01420",
1509 "VUID-VkImageCreateInfo-sharingMode-01420", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001510 }
1511
unknown2c877272019-07-11 12:56:50 -06001512 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
1513 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
1514 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001515 LogError(device, "VUID-VkImageCreateInfo-format-01577",
1516 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
1517 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06001518 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001519 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001520}
1521
John Zulauf7eeb6f72019-06-17 11:56:36 -06001522void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1523 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
1524 if (VK_SUCCESS != result) return;
1525
1526 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
locke-lunarg20699892020-01-02 19:17:29 -07001527 auto image_state = Get<IMAGE_STATE>(*pImage);
1528 AddInitialLayoutintoImageLayoutMap(*image_state, imageLayoutMap);
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001529}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001530
Jeff Bolz5c801d12019-10-09 10:38:45 -05001531bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001532 const IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06001533 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001534 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001535 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001536 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001537 }
1538 return skip;
1539}
1540
John Zulauf7eeb6f72019-06-17 11:56:36 -06001541void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
1542 // Clean up validation specific data
1543 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001544
locke-lunargcba7d5f2019-12-30 16:59:11 -07001545 imageLayoutMap.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06001546
1547 // Clean up generic image state
1548 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001549}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001550
John Zulauf07288512019-07-05 11:09:50 -06001551bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001552 bool skip = false;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001553
1554 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
1555 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 -07001556 skip |= LogError(image_state->image, kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001557 }
1558
Dave Houlton1d2022c2017-03-29 11:43:58 -06001559 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001560 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001561 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -06001562 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001563 char const str[] = "vkCmdClearColorImage called with compressed image.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001564 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001565 }
1566
1567 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
1568 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001569 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-image-00002", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001570 }
1571 return skip;
1572}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001573
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001574uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1575 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1576 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001577 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001578 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001579 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001580 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001581}
1582
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001583uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1584 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1585 uint32_t array_layer_count = range->layerCount;
1586 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1587 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001588 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001589 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001590}
1591
John Zulauf07288512019-07-05 11:09:50 -06001592bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1593 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
1594 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001595 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001596 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1597 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001598 skip |= LogError(image_state->image, "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
1599 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1600 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001601 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001602
1603 } else {
1604 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1605 if (!device_extensions.vk_khr_shared_presentable_image) {
1606 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001607 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-imageLayout-00005",
1608 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1609 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001610 }
1611 } else {
1612 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
1613 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001614 skip |= LogError(
1615 image_state->image, "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001616 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
1617 func_name, string_VkImageLayout(dest_image_layout));
1618 }
1619 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001620 }
1621
John Zulauff660ad62019-03-23 07:16:05 -06001622 // Cast to const to prevent creation at validate time.
John Zulauf07288512019-07-05 11:09:50 -06001623 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06001624 if (subresource_map) {
1625 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001626 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06001627 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
John Zulauf5e617452019-11-19 14:44:16 -07001628 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1629 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06001630 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
1631 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1632 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
1633 } else {
1634 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001635 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001636 subres_skip |= LogError(cb_node->commandBuffer, error_code,
1637 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
1638 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
1639 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001640 }
John Zulauf5e617452019-11-19 14:44:16 -07001641 }
John Zulauff660ad62019-03-23 07:16:05 -06001642 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001643 }
1644
1645 return skip;
1646}
1647
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001648bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1649 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001650 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001651 bool skip = false;
1652 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06001653 const auto *cb_node = GetCBState(commandBuffer);
1654 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001655 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001656 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001657 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001658 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001659 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski544def72019-04-19 14:25:59 -06001660 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001661 skip |=
1662 ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
1663 "VUID-vkCmdClearColorImage-image-01993", "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001664 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001665 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001666 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001667 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001668 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001669 skip |= ValidateImageAttributes(image_state, pRanges[i]);
1670 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001671 }
1672 }
1673 return skip;
1674}
1675
John Zulaufeabb4462019-07-05 14:13:03 -06001676void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1677 const VkClearColorValue *pColor, uint32_t rangeCount,
1678 const VkImageSubresourceRange *pRanges) {
1679 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
1680
1681 auto cb_node = GetCBState(commandBuffer);
1682 auto image_state = GetImageState(image);
1683 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001684 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001685 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001686 }
1687 }
1688}
1689
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001690bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1691 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001692 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001693 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001694
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001695 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06001696 const auto *cb_node = GetCBState(commandBuffer);
1697 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001698 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001699 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06001700 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001701 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001702 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001703 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski544def72019-04-19 14:25:59 -06001704 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001705 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
1706 "VUID-vkCmdClearDepthStencilImage-image-01994",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001707 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001708 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001709 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Andrew Fobel3abeb992020-01-20 16:33:22 -05001710
1711 bool any_include_aspect_depth_bit = false;
1712 bool any_include_aspect_stencil_bit = false;
1713
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001714 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001715 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001716 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001717 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001718 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001719 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1720 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001721 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001722 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1723 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001724 skip |= LogError(commandBuffer, kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001725 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05001726 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
1727 any_include_aspect_depth_bit = true;
1728 }
1729 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
1730 any_include_aspect_stencil_bit = true;
1731 }
1732 }
1733 if (any_include_aspect_stencil_bit) {
1734 const auto image_stencil_struct = lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
1735 if (image_stencil_struct != nullptr) {
1736 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
1737 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001738 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
1739 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
1740 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
1741 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05001742 }
1743 } else {
1744 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001745 skip |= LogError(
1746 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05001747 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
1748 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
1749 "in VkImageCreateInfo::usage used to create image");
1750 }
1751 }
1752 }
1753 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001754 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
1755 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
1756 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001757 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001758 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001759 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001760 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001761 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001762 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1763 char const str[] =
1764 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1765 "set.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001766 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001767 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001768 }
1769 return skip;
1770}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001771
John Zulaufeabb4462019-07-05 14:13:03 -06001772void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1773 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1774 const VkImageSubresourceRange *pRanges) {
1775 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
1776 auto cb_node = GetCBState(commandBuffer);
1777 auto image_state = GetImageState(image);
1778 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001779 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001780 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001781 }
1782 }
1783}
1784
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001785// Returns true if [x, xoffset] and [y, yoffset] overlap
1786static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1787 bool result = false;
1788 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1789 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1790
1791 if (intersection_max > intersection_min) {
1792 result = true;
1793 }
1794 return result;
1795}
1796
Dave Houltonc991cc92018-03-06 11:08:51 -07001797// Returns true if source area of first copy region intersects dest area of second region
1798// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1799static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001800 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001801
Dave Houltonc991cc92018-03-06 11:08:51 -07001802 // Separate planes within a multiplane image cannot intersect
1803 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07001804 return result;
1805 }
1806
Dave Houltonc991cc92018-03-06 11:08:51 -07001807 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
1808 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
1809 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001810 result = true;
1811 switch (type) {
1812 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001813 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001814 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001815 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001816 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001817 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001818 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001819 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001820 break;
1821 default:
1822 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1823 assert(false);
1824 }
1825 }
1826 return result;
1827}
1828
Dave Houltonfc1a4052017-04-27 14:32:45 -06001829// Returns non-zero if offset and extent exceed image extents
1830static const uint32_t x_bit = 1;
1831static const uint32_t y_bit = 2;
1832static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001833static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001834 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001835 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001836 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1837 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001838 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001839 }
1840 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1841 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001842 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001843 }
1844 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1845 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001846 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001847 }
1848 return result;
1849}
1850
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001851// Test if two VkExtent3D structs are equivalent
1852static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1853 bool result = true;
1854 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1855 (extent->depth != other_extent->depth)) {
1856 result = false;
1857 }
1858 return result;
1859}
1860
Dave Houltonee281a52017-12-08 13:51:02 -07001861// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1862// Destination image texel extents must be adjusted by block size for the dest validation checks
1863VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1864 VkExtent3D adjusted_extent = extent;
unknown948b6ba2019-09-19 17:32:54 -06001865 if ((FormatIsCompressed(src_format) || FormatIsSinglePlane_422(src_format)) &&
1866 !(FormatIsCompressed(dst_format) || FormatIsSinglePlane_422(dst_format))) {
Dave Houltona585d132019-01-18 13:05:42 -07001867 VkExtent3D block_size = FormatTexelBlockExtent(src_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001868 adjusted_extent.width /= block_size.width;
1869 adjusted_extent.height /= block_size.height;
1870 adjusted_extent.depth /= block_size.depth;
unknown948b6ba2019-09-19 17:32:54 -06001871 } else if (!(FormatIsCompressed(src_format) || FormatIsSinglePlane_422(src_format)) &&
1872 (FormatIsCompressed(dst_format) || FormatIsSinglePlane_422(dst_format))) {
Dave Houltona585d132019-01-18 13:05:42 -07001873 VkExtent3D block_size = FormatTexelBlockExtent(dst_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001874 adjusted_extent.width *= block_size.width;
1875 adjusted_extent.height *= block_size.height;
1876 adjusted_extent.depth *= block_size.depth;
1877 }
1878 return adjusted_extent;
1879}
1880
Dave Houlton6f9059e2017-05-02 17:15:13 -06001881// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001882static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1883 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001884
1885 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06001886 if (mip >= img->createInfo.mipLevels) {
1887 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06001888 }
Dave Houlton1150cf52017-04-27 14:38:11 -06001889
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001890 // 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 -06001891 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05001892
Dave Houltone48cd112019-01-03 17:01:18 -07001893 // If multi-plane, adjust per-plane extent
1894 if (FormatIsMultiplane(img->createInfo.format)) {
1895 VkExtent2D divisors = FindMultiplaneExtentDivisors(img->createInfo.format, subresource->aspectMask);
1896 extent.width /= divisors.width;
1897 extent.height /= divisors.height;
1898 }
1899
Jeff Bolzef40fec2018-09-01 22:04:34 -05001900 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
1901 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
Dave Houlton142c4cb2018-10-17 15:04:41 -06001902 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1) >> mip)));
Jeff Bolzef40fec2018-09-01 22:04:34 -05001903 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
1904 } else {
1905 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1906 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1907 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
1908 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06001909
Dave Houlton6f9059e2017-05-02 17:15:13 -06001910 // Image arrays have an effective z extent that isn't diminished by mip level
1911 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001912 extent.depth = img->createInfo.arrayLayers;
1913 }
1914
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001915 return extent;
1916}
1917
1918// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001919static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001920 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1921}
1922
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001923// Test if the extent argument has any dimensions set to 0.
1924static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1925 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1926}
1927
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001928// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001929VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001930 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1931 VkExtent3D granularity = {0, 0, 0};
Jeff Bolz6835fda2019-10-06 00:15:34 -05001932 auto pPool = cb_node->command_pool.get();
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001933 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001934 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06001935 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07001936 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001937 granularity.width *= block_size.width;
1938 granularity.height *= block_size.height;
1939 }
1940 }
1941 return granularity;
1942}
1943
1944// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1945static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1946 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001947 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
1948 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001949 valid = false;
1950 }
1951 return valid;
1952}
1953
1954// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001955bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001956 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001957 bool skip = false;
1958 VkExtent3D offset_extent = {};
1959 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1960 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1961 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001962 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001963 // 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 -07001964 if (IsExtentAllZeroes(&offset_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001965 skip |= LogError(cb_node->commandBuffer, vuid,
1966 "%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 "
1967 "image transfer granularity is (w=0, h=0, d=0).",
1968 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001969 }
1970 } else {
1971 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1972 // integer multiples of the image transfer granularity.
1973 if (IsExtentAligned(&offset_extent, granularity) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001974 skip |= LogError(cb_node->commandBuffer, vuid,
1975 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
1976 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
1977 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
1978 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001979 }
1980 }
1981 return skip;
1982}
1983
1984// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001985bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001986 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001987 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001988 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001989 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001990 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
1991 // subresource extent.
1992 if (IsExtentEqual(extent, subresource_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001993 skip |= LogError(cb_node->commandBuffer, vuid,
1994 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
1995 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1996 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
1997 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001998 }
1999 } else {
2000 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2001 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2002 // subresource extent dimensions.
2003 VkExtent3D offset_extent_sum = {};
2004 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2005 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2006 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002007 bool x_ok = true;
2008 bool y_ok = true;
2009 bool z_ok = true;
2010 switch (image_type) {
2011 case VK_IMAGE_TYPE_3D:
2012 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2013 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002014 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002015 case VK_IMAGE_TYPE_2D:
2016 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2017 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002018 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002019 case VK_IMAGE_TYPE_1D:
2020 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2021 (subresource_extent->width == offset_extent_sum.width));
2022 break;
2023 default:
2024 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2025 assert(false);
2026 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002027 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002028 skip |=
2029 LogError(cb_node->commandBuffer, vuid,
2030 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2031 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2032 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2033 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2034 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2035 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002036 }
2037 }
2038 return skip;
2039}
2040
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002041bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002042 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002043 bool skip = false;
2044 if (mip_level >= img->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002045 skip |= LogError(cb_node->commandBuffer, vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2046 function, i, member, mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002047 }
2048 return skip;
2049}
2050
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002051bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002052 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002053 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002054 bool skip = false;
2055 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2056 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002057 skip |= LogError(cb_node->commandBuffer, vuid,
2058 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2059 "%u, but provided %s has %u array layers.",
2060 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2061 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002062 }
2063 return skip;
2064}
2065
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002066// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002067bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002068 const VkBufferImageCopy *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002069 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002070 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002071 VkExtent3D granularity = GetScaledItg(cb_node, img);
2072 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002073 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002074 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002075 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002076 return skip;
2077}
2078
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002079// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002080bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002081 const IMAGE_STATE *dst_img, const VkImageCopy *region,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002082 const uint32_t i, const char *function) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002083 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002084 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002085 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
2086 skip |=
2087 CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002088 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002089 const VkExtent3D extent = region->extent;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002090 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
2091 i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002092
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002093 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002094 granularity = GetScaledItg(cb_node, dst_img);
2095 skip |=
2096 CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002097 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002098 const VkExtent3D dest_effective_extent =
2099 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002100 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002101 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002102 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002103 return skip;
2104}
2105
Dave Houlton6f9059e2017-05-02 17:15:13 -06002106// Validate contents of a VkImageCopy struct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002107bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const VkImageCopy *ic_regions, const IMAGE_STATE *src_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002108 const IMAGE_STATE *dst_state) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002109 bool skip = false;
2110
2111 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002112 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002113
2114 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002115 const VkExtent3D src_copy_extent = region.extent;
2116 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002117 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2118
Dave Houlton6f9059e2017-05-02 17:15:13 -06002119 bool slice_override = false;
2120 uint32_t depth_slices = 0;
2121
2122 // Special case for copying between a 1D/2D array and a 3D image
2123 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2124 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002125 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002126 slice_override = (depth_slices != 1);
2127 } 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 -07002128 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002129 slice_override = (depth_slices != 1);
2130 }
2131
2132 // Do all checks on source image
2133 //
2134 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002135 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002136 skip |=
2137 LogError(src_state->image, "VUID-VkImageCopy-srcImage-00146",
2138 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2139 "be 0 and 1, respectively.",
2140 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002141 }
2142 }
2143
Dave Houlton533be9f2018-03-26 17:08:30 -06002144 // VUID-VkImageCopy-srcImage-01785
2145 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 -07002146 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-01785",
2147 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
2148 "these must be 0 and 1, respectively.",
2149 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002150 }
2151
Dave Houlton533be9f2018-03-26 17:08:30 -06002152 // VUID-VkImageCopy-srcImage-01787
2153 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002154 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-01787",
2155 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2156 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002157 }
2158
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002159 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002160 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002161 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002162 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002163 LogError(src_state->image, "VUID-VkImageCopy-srcImage-00141",
2164 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2165 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2166 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002167 }
2168 }
2169 } else { // Pre maint 1
2170 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002171 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002172 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-00141",
2173 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2174 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2175 "VK_IMAGE_TYPE_3D, 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 }
2180
Dave Houltonc991cc92018-03-06 11:08:51 -07002181 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002182 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002183 if (FormatIsCompressed(src_state->createInfo.format) ||
2184 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002185 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002186 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002187 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2188 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2189 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002190 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002191 skip |= LogError(src_state->image, vuid,
2192 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
2193 "texel width & height (%d, %d).",
2194 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002195 }
2196
Dave Houlton94a00372017-12-14 15:08:47 -07002197 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002198 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2199 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002200 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002201 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002202 LogError(src_state->image, vuid,
2203 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2204 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2205 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002206 }
2207
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002208 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002209 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2210 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002211 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002212 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002213 LogError(src_state->image, vuid,
2214 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2215 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2216 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002217 }
2218
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002219 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002220 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2221 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002222 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002223 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002224 LogError(src_state->image, vuid,
2225 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2226 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2227 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002228 }
2229 } // Compressed
2230
2231 // Do all checks on dest image
2232 //
2233 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002234 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002235 skip |= LogError(dst_state->image, "VUID-VkImageCopy-dstImage-00152",
2236 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
2237 "these must be 0 and 1, respectively.",
2238 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002239 }
2240 }
2241
Dave Houlton533be9f2018-03-26 17:08:30 -06002242 // VUID-VkImageCopy-dstImage-01786
2243 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 -07002244 skip |=
2245 LogError(dst_state->image, "VUID-VkImageCopy-dstImage-01786",
2246 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2247 "and 1, respectively.",
2248 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002249 }
2250
2251 // VUID-VkImageCopy-dstImage-01788
2252 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002253 skip |= LogError(dst_state->image, "VUID-VkImageCopy-dstImage-01788",
2254 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2255 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002256 }
2257
2258 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002259 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002260 skip |= LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00141",
2261 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2262 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2263 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002264 }
2265 }
2266 // VU01199 changed with mnt1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002267 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002268 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)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002270 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002271 LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00141",
2272 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2273 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2274 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002275 }
2276 }
2277 } else { // Pre maint 1
2278 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || 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)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002280 skip |= LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00141",
2281 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2282 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2283 "VK_IMAGE_TYPE_3D, 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 }
2288
Dave Houltonc991cc92018-03-06 11:08:51 -07002289 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2290 if (FormatIsCompressed(dst_state->createInfo.format) ||
2291 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002292 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002293
2294 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002295 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2296 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2297 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002298 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002299 skip |= LogError(dst_state->image, vuid,
2300 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
2301 "texel width & height (%d, %d).",
2302 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002303 }
2304
Dave Houlton94a00372017-12-14 15:08:47 -07002305 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002306 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2307 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002308 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002309 skip |= LogError(
2310 dst_state->image, vuid,
2311 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2312 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2313 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002314 }
2315
Dave Houltonee281a52017-12-08 13:51:02 -07002316 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2317 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2318 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002319 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002320 skip |= LogError(dst_state->image, vuid,
2321 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2322 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2323 "height (%d).",
2324 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002325 }
2326
Dave Houltonee281a52017-12-08 13:51:02 -07002327 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2328 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2329 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002330 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002331 skip |= LogError(
2332 dst_state->image, vuid,
2333 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2334 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2335 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002336 }
2337 } // Compressed
2338 }
2339 return skip;
2340}
2341
Dave Houltonc991cc92018-03-06 11:08:51 -07002342// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002343bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002344 const IMAGE_STATE *dst_image_state, const VkImageCopy region) const {
Dave Houltonc991cc92018-03-06 11:08:51 -07002345 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002346
2347 // Neither image is multiplane
2348 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2349 // If neither image is multi-plane the aspectMask member of src and dst must match
2350 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2351 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002352 ss << "vkCmdCopyImage(): Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002353 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002354 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002355 }
2356 } else {
2357 // Source image multiplane checks
2358 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2359 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2360 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2361 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002362 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002363 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002364 }
2365 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2366 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2367 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002368 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002369 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002370 }
2371 // Single-plane to multi-plane
2372 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2373 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2374 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002375 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002376 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002377 }
2378
2379 // Dest image multiplane checks
2380 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2381 aspect = region.dstSubresource.aspectMask;
2382 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2383 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002384 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002385 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002386 }
2387 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2388 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2389 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002390 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002391 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002392 }
2393 // Multi-plane to single-plane
2394 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2395 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2396 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002397 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002398 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002399 }
2400 }
2401
2402 return skip;
2403}
2404
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002405bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2406 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002407 const VkImageCopy *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002408 const auto *cb_node = GetCBState(commandBuffer);
2409 const auto *src_image_state = GetImageState(srcImage);
2410 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002411 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002412
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002413 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002414
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002415 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2416
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002417 for (uint32_t i = 0; i < regionCount; i++) {
2418 const VkImageCopy region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002419
2420 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2421 VkExtent3D src_copy_extent = region.extent;
2422 VkExtent3D dst_copy_extent =
2423 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
2424
Dave Houlton6f9059e2017-05-02 17:15:13 -06002425 bool slice_override = false;
2426 uint32_t depth_slices = 0;
2427
2428 // Special case for copying between a 1D/2D array and a 3D image
2429 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2430 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2431 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002432 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002433 slice_override = (depth_slices != 1);
2434 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2435 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002436 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002437 slice_override = (depth_slices != 1);
2438 }
2439
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002440 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2441 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
2442 skip |= ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002443 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002444 skip |= ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002445 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002446 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002447 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2448 "VUID-vkCmdCopyImage-srcSubresource-01698");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002449 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002450 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2451 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002452
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002453 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002454 // No chance of mismatch if we're overriding depth slice count
2455 if (!slice_override) {
2456 // The number of depth slices in srcSubresource and dstSubresource must match
2457 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2458 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002459 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2460 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002461 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002462 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2463 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002464 if (src_slices != dst_slices) {
2465 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002466 ss << "vkCmdCopyImage(): number of depth slices in source and destination subresources for pRegions[" << i
Dave Houlton6f9059e2017-05-02 17:15:13 -06002467 << "] do not match";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002468 skip |= LogError(command_buffer, "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06002469 }
2470 }
2471 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002472 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002473 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002474 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002475 ss << "vkCmdCopyImage(): number of layers in source and destination subresources for pRegions[" << i
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002476 << "] do not match";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002477 skip |= LogError(command_buffer, "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002478 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002479 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002480
Dave Houltonc991cc92018-03-06 11:08:51 -07002481 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002482 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002483 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region);
Dave Houltonc991cc92018-03-06 11:08:51 -07002484 }
2485
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002486 if (!device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002487 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2488 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002489 char const str[] = "vkCmdCopyImage(): Src and dest aspectMasks for each region must match";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002490 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002491 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002492 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002493
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002494 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07002495 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002496 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002497 ss << "vkCmdCopyImage(): pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002498 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002499 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002500 }
2501
2502 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07002503 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002504 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002505 ss << "vkCmdCopyImage(): pRegion[" << i
2506 << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002507 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002508 }
2509
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002510 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
2511 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
2512 // 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 -07002513 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2514 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002515 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002516 ss << "vkCmdCopyImage(): Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002517 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
2518 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
2519 << " ] exceeds the source image dimensions";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002520 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-pRegions-00122", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002521 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002522
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002523 // 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 -07002524 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2525 if (0 != ExceedsBounds(&region.dstOffset, &dst_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(): Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002528 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
2529 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
2530 << " ] exceeds the destination image dimensions";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002531 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-pRegions-00123", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002532 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002533 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002534
Dave Houltonfc1a4052017-04-27 14:32:45 -06002535 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002536 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2537 if (slice_override) src_copy_extent.depth = depth_slices;
2538 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002539 if (extent_check & x_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002540 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002541 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00144",
2542 "vkCmdCopyImage(): Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2543 "width [%1d].",
2544 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002545 }
2546
2547 if (extent_check & y_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002548 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002549 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00145",
2550 "vkCmdCopyImage(): Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2551 "height [%1d].",
2552 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002553 }
2554 if (extent_check & z_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002555 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002556 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00147",
2557 "vkCmdCopyImage(): Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2558 "depth [%1d].",
2559 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002560 }
2561
Dave Houltonee281a52017-12-08 13:51:02 -07002562 // Adjust dest extent if necessary
2563 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2564 if (slice_override) dst_copy_extent.depth = depth_slices;
2565
2566 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002567 if (extent_check & x_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002568 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00150",
2569 "vkCmdCopyImage(): Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2570 "width [%1d].",
2571 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002572 }
2573 if (extent_check & y_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002574 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00151",
2575 "vkCmdCopyImage(): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2576 "height [%1d].",
2577 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002578 }
2579 if (extent_check & z_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002580 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00153",
2581 "vkCmdCopyImage(): Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2582 "depth [%1d].",
2583 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002584 }
2585
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002586 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2587 // must not overlap in memory
2588 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002589 for (uint32_t j = 0; j < regionCount; j++) {
2590 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
Dave Houltonf5217612018-02-02 16:18:52 -07002591 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002592 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002593 ss << "vkCmdCopyImage(): pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002594 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002595 }
2596 }
2597 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08002598
2599 // Check depth for 2D as post Maintaince 1 requires both while prior only required one to be 2D
2600 if (device_extensions.vk_khr_maintenance1) {
2601 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
2602 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
2603 (src_copy_extent.depth != 1)) {
2604 skip |= LogError(
2605 command_buffer, "VUID-VkImageCopy-srcImage-01790",
2606 "vkCmdCopyImage(): pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1", i,
2607 src_copy_extent.depth);
2608 }
2609 } else {
2610 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
2611 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
2612 (src_copy_extent.depth != 1)) {
2613 skip |= LogError(
2614 command_buffer, "VUID-VkImageCopy-srcImage-01789",
2615 "vkCmdCopyImage(): pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1", i,
2616 src_copy_extent.depth);
2617 }
2618 }
2619
2620 // Check if 2D with 3D and depth not equal to 2D layerCount
2621 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
2622 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2623 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
2624 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01791",
2625 "vkCmdCopyImage(): pRegion[%u] srcImage is 2D, dstImage is 3D and extent.depth is %u and has to be "
2626 "srcSubresource.layerCount (%u)",
2627 i, src_copy_extent.depth, region.srcSubresource.layerCount);
2628 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2629 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
2630 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
2631 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01792",
2632 "vkCmdCopyImage(): pRegion[%u] srcImage is 3D, dstImage is 2D and extent.depth is %u and has to be "
2633 "dstSubresource.layerCount (%u)",
2634 i, src_copy_extent.depth, region.dstSubresource.layerCount);
2635 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002636 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002637
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002638 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2639 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2640 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002641 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002642 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2643 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002644 skip |= LogError(command_buffer, kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002645 }
2646 } else {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002647 if (!FormatSizesAreEqual(src_image_state->createInfo.format, dst_image_state->createInfo.format, regionCount, pRegions)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002648 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002649 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-srcImage-00135", "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002650 }
2651 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002652
Dave Houlton33c22b72017-02-28 13:16:02 -07002653 // Source and dest image sample counts must match
2654 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2655 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002656 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002657 }
2658
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002659 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2660 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002661 // Validate that SRC & DST images have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002662 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyImage-srcImage-00126",
2663 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2664 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyImage-dstImage-00131",
2665 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06002666 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002667 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
2668 "VUID-vkCmdCopyImage-srcImage-01995", "VUID-vkCmdCopyImage-srcImage-01995");
2669 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
2670 "VUID-vkCmdCopyImage-dstImage-01996", "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002671 }
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002672 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyImage()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002673 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002674 skip |= ValidateCmd(cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
2675 skip |= InsideRenderPass(cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002676 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002677 const char *invalid_src_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2678 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2679 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
2680 const char *invalid_dst_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2681 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2682 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002683 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002684 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002685 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2686 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002687 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002688 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2689 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002690 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
2691 "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002692 }
2693
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002694 return skip;
2695}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002696
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002697void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2698 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2699 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06002700 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
2701 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06002702 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002703 auto src_image_state = GetImageState(srcImage);
2704 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002705
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002706 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002707 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002708 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
2709 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002710 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002711}
2712
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002713// Returns true if sub_rect is entirely contained within rect
2714static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2715 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2716 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2717 return false;
2718 return true;
2719}
2720
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002721bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002722 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
2723 const VkRect2D &render_area, uint32_t rect_count,
2724 const VkClearRect *clear_rects) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07002725 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07002726 const IMAGE_VIEW_STATE *image_view_state = nullptr;
2727 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07002728 image_view_state = GetImageViewState(framebuffer->createInfo.pAttachments[fb_attachment]);
John Zulauff2582972019-02-09 14:53:30 -07002729 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002730
2731 for (uint32_t j = 0; j < rect_count; j++) {
2732 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002733 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00016",
2734 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2735 "the current render pass instance.",
2736 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07002737 }
2738
2739 if (image_view_state) {
2740 // The layers specified by a given element of pRects must be contained within every attachment that
2741 // pAttachments refers to
2742 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
2743 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
2744 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002745 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00017",
2746 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
2747 "of pAttachment[%d].",
2748 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07002749 }
2750 }
2751 }
2752 return skip;
2753}
2754
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002755bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2756 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002757 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002758 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06002759 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02002760 if (!cb_node) return skip;
2761
2762 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
2763 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
2764 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Petr Kraus2dffb382019-08-10 02:52:12 +02002765 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002766
2767 // Validate that attachment is in reference list of active subpass
2768 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002769 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07002770 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01002771 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002772 const auto *framebuffer = GetFramebufferState(cb_node->activeFramebuffer);
John Zulauf3a548ef2019-02-01 16:14:07 -07002773 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002774
John Zulauf3a548ef2019-02-01 16:14:07 -07002775 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2776 auto clear_desc = &pAttachments[attachment_index];
2777 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002778
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002779 if (0 == clear_desc->aspectMask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002780 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002781 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002782 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002783 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07002784 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
2785 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
2786 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2787 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002788 skip |= LogError(
2789 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
2790 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
2791 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
2792 attachment_index, clear_desc->colorAttachment,
2793 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
2794 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07002795
John Zulauff2582972019-02-09 14:53:30 -07002796 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
2797 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002798 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002799 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
2800 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
2801 " subpass %u. colorAttachmentCount=%u",
2802 attachment_index, clear_desc->colorAttachment,
2803 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
2804 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002805 }
John Zulauff2582972019-02-09 14:53:30 -07002806 fb_attachment = color_attachment;
2807
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002808 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2809 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2810 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002811 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002812 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002813 }
2814 } else { // Must be depth and/or stencil
2815 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2816 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002817 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002818 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-parameter", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002819 }
2820 if (!subpass_desc->pDepthStencilAttachment ||
2821 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002822 skip |= LogPerformanceWarning(
2823 commandBuffer, kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002824 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002825 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07002826 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002827 }
2828 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002829 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002830 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
2831 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06002832 }
2833 }
2834 }
2835 return skip;
2836}
2837
2838void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2839 const VkClearAttachment *pAttachments, uint32_t rectCount,
2840 const VkClearRect *pRects) {
2841 auto *cb_node = GetCBState(commandBuffer);
2842 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
2843 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
2844 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
2845 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
2846 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2847 const auto clear_desc = &pAttachments[attachment_index];
2848 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
2849 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
2850 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
2851 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2852 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
2853 subpass_desc->pDepthStencilAttachment) {
2854 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
2855 }
2856 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07002857 if (!clear_rect_copy) {
2858 // We need a copy of the clear rectangles that will persist until the last lambda executes
2859 // but we want to create it as lazily as possible
2860 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002861 }
John Zulauf441558b2019-08-12 11:47:39 -06002862 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
2863 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002864 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
John Zulauff1640d12019-08-13 15:39:58 -06002865 const CMD_BUFFER_STATE *prim_cb, VkFramebuffer fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07002866 assert(rectCount == clear_rect_copy->size());
John Zulauf441558b2019-08-12 11:47:39 -06002867 const FRAMEBUFFER_STATE *framebuffer = GetFramebufferState(fb);
John Zulauf3a548ef2019-02-01 16:14:07 -07002868 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
2869 bool skip = false;
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002870 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
2871 rectCount, clear_rect_copy->data());
John Zulauf3a548ef2019-02-01 16:14:07 -07002872 return skip;
2873 };
2874 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002875 }
2876 }
2877 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002878}
2879
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002880bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2881 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002882 const VkImageResolve *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002883 const auto *cb_node = GetCBState(commandBuffer);
2884 const auto *src_image_state = GetImageState(srcImage);
2885 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002886
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002887 bool skip = false;
2888 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002889 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-srcImage-00256");
2890 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-00258");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002891 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002892 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002893 skip |= ValidateCmd(cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
2894 skip |= InsideRenderPass(cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002895 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, "vkCmdResolveImage()",
2896 "VUID-vkCmdResolveImage-dstImage-02003", "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002897
Cort Stratton7df30962018-05-17 19:45:57 -07002898 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002899 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002900 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002901 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
2902 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
2903 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002904 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002905 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
2906 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002907 // For each region, the number of layers in the image subresource should not be zero
2908 // For each region, src and dest image aspect must be color only
2909 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002910 skip |=
2911 ValidateImageSubresourceLayers(cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()", "srcSubresource", i);
2912 skip |=
2913 ValidateImageSubresourceLayers(cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()", "dstSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002914 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002915 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
2916 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002917 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002918 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
2919 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002920 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i, "vkCmdResolveImage()",
2921 "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
2922 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i, "vkCmdResolveImage()",
2923 "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
2924 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002925 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2926 "VUID-vkCmdResolveImage-srcSubresource-01711");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002927 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002928 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2929 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07002930
2931 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002932 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002933 skip |= LogError(
2934 cb_node->commandBuffer, "VUID-VkImageResolve-layerCount-00267",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002935 "vkCmdResolveImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002936 }
Cort Stratton7df30962018-05-17 19:45:57 -07002937 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002938 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
2939 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
2940 char const str[] =
Graeme Leese79b60cb2018-11-28 11:51:20 +00002941 "vkCmdResolveImage(): src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002942 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002943 }
2944 }
2945
2946 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2947 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002948 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002949 }
2950 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
2951 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002952 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageType, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002953 }
2954 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
2955 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002956 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-srcImage-00257", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002957 }
2958 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
2959 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002960 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-dstImage-00259", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002961 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002962 } else {
2963 assert(0);
2964 }
2965 return skip;
2966}
2967
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002968bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2969 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002970 const VkImageBlit *pRegions, VkFilter filter) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002971 const auto *cb_node = GetCBState(commandBuffer);
2972 const auto *src_image_state = GetImageState(srcImage);
2973 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002974
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002975 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07002976 if (cb_node) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002977 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
John Zulauf5c2750c2018-01-30 15:04:56 -07002978 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002979 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002980 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06002981 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002982 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06002983 "VUID-vkCmdBlitImage-dstImage-00234");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002984 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
2985 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
Dave Houltond8ed0212018-05-16 17:18:24 -06002986 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002987 ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdBlitImage-srcImage-00219",
2988 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06002989 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002990 ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdBlitImage-dstImage-00224",
2991 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002992 skip |=
2993 ValidateCmdQueueFlags(cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002994 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
2995 skip |= InsideRenderPass(cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002996 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002997 "VUID-vkCmdBlitImage-srcImage-01999", "VUID-vkCmdBlitImage-srcImage-01999");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002998 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002999 "VUID-vkCmdBlitImage-dstImage-02000", "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04003000
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003001 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003002
Dave Houlton33c2d252017-06-09 17:08:32 -06003003 VkFormat src_format = src_image_state->createInfo.format;
3004 VkFormat dst_format = dst_image_state->createInfo.format;
3005 VkImageType src_type = src_image_state->createInfo.imageType;
3006 VkImageType dst_type = dst_image_state->createInfo.imageType;
3007
Cort Stratton186b1a22018-05-01 20:18:06 -04003008 if (VK_FILTER_LINEAR == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003009 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003010 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001",
3011 "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04003012 } else if (VK_FILTER_CUBIC_IMG == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003013 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
3014 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02002",
3015 "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06003016 }
3017
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003018 if (FormatRequiresYcbcrConversion(src_format)) {
3019 skip |= LogError(device, "VUID-vkCmdBlitImage-srcImage-01561",
3020 "vkCmdBlitImage(): srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
3021 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
3022 string_VkFormat(src_format));
3023 }
3024
3025 if (FormatRequiresYcbcrConversion(dst_format)) {
3026 skip |= LogError(device, "VUID-vkCmdBlitImage-dstImage-01562",
3027 "vkCmdBlitImage(): dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
3028 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
3029 string_VkFormat(dst_format));
3030 }
3031
Dave Houlton33c2d252017-06-09 17:08:32 -06003032 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003033 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-filter-00237",
3034 "vkCmdBlitImage(): source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003035 }
3036
Dave Houlton33c2d252017-06-09 17:08:32 -06003037 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
3038 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003039 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00228",
3040 "vkCmdBlitImage(): source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003041 }
3042
3043 // Validate consistency for unsigned formats
3044 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3045 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003046 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003047 << "the other one must also have unsigned integer format. "
3048 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003049 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003050 }
3051
3052 // Validate consistency for signed formats
3053 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3054 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003055 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003056 << "the other one must also have signed integer format. "
3057 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003058 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003059 }
3060
3061 // Validate filter for Depth/Stencil formats
3062 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3063 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003064 ss << "vkCmdBlitImage(): If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003065 << "then filter must be VK_FILTER_NEAREST.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003066 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003067 }
3068
3069 // Validate aspect bits and formats for depth/stencil images
3070 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3071 if (src_format != dst_format) {
3072 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003073 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003074 << "stencil, the other one must have exactly the same format. "
3075 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3076 << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003077 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003078 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003079 } // Depth or Stencil
3080
3081 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003082 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003083 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003084 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3085 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3086 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003087 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003088 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3089 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003090 for (uint32_t i = 0; i < regionCount; i++) {
3091 const VkImageBlit rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003092 bool hit_error = false;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003093 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003094 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3095 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003096 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003097 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3098 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003099 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3100 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
3101 skip |= ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003102 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003103 skip |= ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003104 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003105 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003106 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3107 "VUID-vkCmdBlitImage-srcSubresource-01707");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003108 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003109 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3110 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003111 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003112 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3113 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003114 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003115 ss << "vkCmdBlitImage(): pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003116 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003117 }
Dave Houlton48989f32017-05-26 15:01:46 -06003118 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3119 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003120 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003121 ss << "vkCmdBlitImage(): pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003122 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003123 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003124
3125 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003126 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003127 skip |= LogError(
3128 cb_node->commandBuffer, "VUID-VkImageBlit-layerCount-00239",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003129 "vkCmdBlitImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003130 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003131
Dave Houlton48989f32017-05-26 15:01:46 -06003132 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003133 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00238",
3134 "vkCmdBlitImage(): aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003135 }
Dave Houlton48989f32017-05-26 15:01:46 -06003136
Dave Houlton33c2d252017-06-09 17:08:32 -06003137 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003138 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00241",
3139 "vkCmdBlitImage(): region [%d] source aspectMask (0x%x) specifies aspects not present in source "
3140 "image format %s.",
3141 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003142 }
3143
3144 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003145 skip |= LogError(
3146 cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00242",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003147 "vkCmdBlitImage(): region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3148 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003149 }
3150
Dave Houlton48989f32017-05-26 15:01:46 -06003151 // Validate source image offsets
3152 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003153 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003154 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003155 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003156 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00245",
3157 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3158 "of (%1d, %1d). These must be (0, 1).",
3159 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003160 }
3161 }
3162
Dave Houlton33c2d252017-06-09 17:08:32 -06003163 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003164 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003165 skip |=
3166 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00247",
3167 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3168 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3169 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003170 }
3171 }
3172
Dave Houlton33c2d252017-06-09 17:08:32 -06003173 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003174 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3175 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003176 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003177 skip |= LogError(
3178 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00243",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003179 "vkCmdBlitImage(): region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).", i,
3180 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003181 }
3182 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3183 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003184 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003185 skip |= LogError(
3186 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00244",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003187 "vkCmdBlitImage(): region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003188 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003189 }
3190 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3191 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003192 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003193 skip |= LogError(
3194 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00246",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003195 "vkCmdBlitImage(): region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).", i,
3196 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003197 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003198 if (oob) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003199 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-pRegions-00215",
3200 "vkCmdBlitImage(): region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003201 }
Dave Houlton48989f32017-05-26 15:01:46 -06003202
3203 // Validate dest image offsets
3204 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003205 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003206 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003207 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003208 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-dstImage-00250",
3209 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3210 "(%1d, %1d). These must be (0, 1).",
3211 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003212 }
3213 }
3214
Dave Houlton33c2d252017-06-09 17:08:32 -06003215 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003216 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003217 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-dstImage-00252",
3218 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3219 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3220 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003221 }
3222 }
3223
Dave Houlton33c2d252017-06-09 17:08:32 -06003224 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003225 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3226 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003227 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003228 skip |= LogError(
3229 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00248",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003230 "vkCmdBlitImage(): region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).", i,
3231 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003232 }
3233 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3234 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003235 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003236 skip |= LogError(
3237 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00249",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003238 "vkCmdBlitImage(): region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003239 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003240 }
3241 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3242 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003243 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003244 skip |= LogError(
3245 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00251",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003246 "vkCmdBlitImage(): region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).", i,
3247 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003248 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003249 if (oob) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003250 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-pRegions-00216",
3251 "vkCmdBlitImage(): region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003252 }
3253
Dave Houlton33c2d252017-06-09 17:08:32 -06003254 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3255 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3256 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003257 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003258 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00240",
3259 "vkCmdBlitImage(): region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3260 "layerCount other than 1.",
3261 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003262 }
3263 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003264 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003265 } else {
3266 assert(0);
3267 }
3268 return skip;
3269}
3270
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003271void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3272 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3273 const VkImageBlit *pRegions, VkFilter filter) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003274 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3275 pRegions, filter);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003276 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003277 auto src_image_state = GetImageState(srcImage);
3278 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003279
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003280 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003281 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003282 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3283 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003284 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003285}
3286
John Zulauf2076e812020-01-08 14:55:54 -07003287GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap *map, const IMAGE_STATE &image_state) {
3288 assert(map);
3289 // This approach allows for a single hash lookup or/create new
3290 auto inserted = map->emplace(std::make_pair(image_state.image, nullptr));
3291 if (inserted.second) {
3292 assert(nullptr == inserted.first->second.get());
3293 GlobalImageLayoutRangeMap *layout_map = new GlobalImageLayoutRangeMap(image_state.range_encoder.SubresourceCount());
3294 inserted.first->second.reset(layout_map);
3295 return layout_map;
3296 } else {
3297 assert(nullptr != inserted.first->second.get());
3298 return inserted.first->second.get();
3299 }
3300 return nullptr;
3301}
3302
3303const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, VkImage image) {
3304 auto it = map.find(image);
3305 if (it != map.end()) {
3306 return it->second.get();
3307 }
3308 return nullptr;
3309}
3310
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003311// 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 -07003312bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const GlobalImageLayoutMap &globalImageLayoutMap,
3313 GlobalImageLayoutMap *overlayLayoutMap_arg) const {
Matthew Ruschd7ef5482019-07-16 22:01:54 -07003314 if (disabled.image_layout_validation) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003315 bool skip = false;
John Zulauf2076e812020-01-08 14:55:54 -07003316 GlobalImageLayoutMap &overlayLayoutMap = *overlayLayoutMap_arg;
John Zulauff660ad62019-03-23 07:16:05 -06003317 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07003318 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06003319 for (const auto &layout_map_entry : pCB->image_layout_map) {
3320 const auto image = layout_map_entry.first;
3321 const auto *image_state = GetImageState(image);
3322 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06003323 const auto &subres_map = layout_map_entry.second;
John Zulauf2076e812020-01-08 14:55:54 -07003324 const auto &initial_layout_map = subres_map->GetInitialLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06003325 // Validate the initial_uses for each subresource referenced
John Zulauf2076e812020-01-08 14:55:54 -07003326 if (initial_layout_map.empty()) continue;
3327
3328 auto *overlay_map = GetLayoutRangeMap(&overlayLayoutMap, *image_state);
3329 const auto *global_map = GetLayoutRangeMap(globalImageLayoutMap, image);
3330 if (global_map == nullptr) {
3331 global_map = &empty_map;
3332 }
3333
3334 // Note: don't know if it would matter
3335 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
3336
3337 auto pos = initial_layout_map.begin();
3338 const auto end = initial_layout_map.end();
3339 sparse_container::parallel_iterator<const ImageSubresourceLayoutMap::LayoutMap> current_layout(*overlay_map, *global_map,
3340 pos->first.begin);
3341 while (pos != end) {
locke-lunargf155ccf2020-02-18 11:34:15 -07003342 VkImageLayout initial_layout = pos->second;
John Zulauf2076e812020-01-08 14:55:54 -07003343 VkImageLayout image_layout = kInvalidLayout;
John Zulauf2076e812020-01-08 14:55:54 -07003344 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 -07003345 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07003346 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07003347 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07003348 image_layout = current_layout->pos_B->lower_bound->second;
3349 }
3350 const auto intersected_range = pos->first & current_layout->range;
3351 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
3352 // TODO: Set memory invalid which is in mem_tracker currently
3353 } else if (image_layout != initial_layout) {
3354 // Need to look up the inital layout *state* to get a bit more information
3355 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(pos->first.begin);
3356 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
3357 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
3358 if (!matches) {
3359 std::string formatted_label = FormatDebugLabel(" ", pCB->debug_label);
3360 // We can report all the errors for the intersected range directly
3361 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
3362 const auto subresource = image_state->range_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003363 skip |= LogError(
3364 pCB->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06003365 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
locke-lunargadbb54c2019-06-26 00:05:17 -06003366 "to be in layout %s--instead, current layout is %s.%s",
John Zulauf2076e812020-01-08 14:55:54 -07003367 report_data->FormatHandle(image).c_str(), subresource.aspectMask, subresource.arrayLayer,
3368 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout),
locke-lunarga344e7c2020-01-02 19:48:53 -07003369 formatted_label.c_str());
John Zulaufb61ed972019-04-09 16:12:35 -06003370 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003371 }
3372 }
John Zulauf2076e812020-01-08 14:55:54 -07003373 if (pos->first.includes(intersected_range.end)) {
3374 current_layout.seek(intersected_range.end);
3375 } else {
3376 ++pos;
3377 if (pos != end) {
3378 current_layout.seek(pos->first.begin);
3379 }
3380 }
John Zulauff660ad62019-03-23 07:16:05 -06003381 }
3382
locke-lunargf155ccf2020-02-18 11:34:15 -07003383 // Update all layout set operations (which will be a subset of the initial_layouts)
John Zulauf2076e812020-01-08 14:55:54 -07003384 sparse_container::splice(overlay_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003385 }
John Zulauff660ad62019-03-23 07:16:05 -06003386
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003387 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003388}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003389
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003390void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06003391 for (const auto &layout_map_entry : pCB->image_layout_map) {
3392 const auto image = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07003393 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06003394 const auto *image_state = GetImageState(image);
3395 if (!image_state) continue; // Can't set layouts of a dead image
John Zulauf2076e812020-01-08 14:55:54 -07003396 auto *global_map = GetLayoutRangeMap(&imageLayoutMap, *image_state);
3397 sparse_container::splice(global_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Tony Barbourdf013b92017-01-25 12:53:48 -07003398 }
3399}
3400
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003401// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003402// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3403// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003404bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3405 const VkImageLayout first_layout, const uint32_t attachment,
John Zulauf9d2b6382019-07-25 15:21:36 -06003406 const VkAttachmentDescription2KHR &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003407 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003408 const char *vuid;
3409 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3410
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003411 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
3412 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003413 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3414 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3415 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003416 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
3417 "Cannot clear attachment %d with invalid first layout %s.", attachment,
3418 string_VkImageLayout(first_layout));
Shannon McPherson3ea65132018-12-05 10:37:39 -07003419 } else if (!use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3420 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003421 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
3422 "Cannot clear attachment %d with invalid first layout %s.", attachment,
3423 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003424 }
3425 }
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003426 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3427 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003428 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01566";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003429 skip |= LogError(device, vuid, "Cannot clear attachment %d with invalid first layout %s.", attachment,
3430 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003431 }
3432 }
3433
3434 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3435 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003436 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01567";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003437 skip |= LogError(device, vuid, "Cannot clear attachment %d with invalid first layout %s.", attachment,
3438 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003439 }
3440 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003441 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003442}
3443
Mark Lobodzinskiac02c612020-01-17 14:52:35 -07003444bool CoreChecks::ValidateLayouts(RenderPassCreateVersion rp_version, VkDevice device, const VkRenderPassCreateInfo2KHR *pCreateInfo,
3445 const char *function_name) const {
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003446 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003447 const char *vuid;
3448 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003449
Jason Ekstranda1906302017-12-03 20:16:32 -08003450 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3451 VkFormat format = pCreateInfo->pAttachments[i].format;
3452 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3453 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3454 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003455 skip |= LogWarning(device, kVUID_Core_DrawState_InvalidRenderpass,
3456 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
3457 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3458 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3459 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003460 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003461 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003462 skip |=
3463 LogWarning(device, kVUID_Core_DrawState_InvalidRenderpass,
3464 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3465 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3466 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3467 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003468 }
3469 }
3470 }
3471
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003472 // Track when we're observing the first use of an attachment
3473 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3474 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003475 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003476
3477 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3478 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3479 auto attach_index = subpass.pInputAttachments[j].attachment;
3480 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003481 switch (subpass.pInputAttachments[j].layout) {
3482 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3483 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3484 // These are ideal.
3485 break;
3486
3487 case VK_IMAGE_LAYOUT_GENERAL:
3488 // May not be optimal. TODO: reconsider this warning based on other constraints.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003489 skip |= LogPerformanceWarning(device, kVUID_Core_DrawState_InvalidImageLayout,
3490 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
Cort Stratton7547f772017-05-04 15:18:52 -07003491 break;
3492
Tobias Hectorbbb12282018-10-22 15:17:59 +01003493 case VK_IMAGE_LAYOUT_UNDEFINED:
3494 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003495 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003496 skip |= LogError(device, vuid,
3497 "Layout for input attachment reference %u in subpass %u is %s but must be "
3498 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
3499 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003500 break;
3501
Piers Daniell9af77cd2019-10-16 13:54:12 -06003502 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3503 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3504 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3505 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003506 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003507 skip |= LogError(
3508 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003509 "Layout for input attachment reference %u in subpass %u is %s but must not be "
3510 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3511 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3512 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
3513 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003514 skip |= LogError(
3515 device, "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003516 "Layout for input attachment reference %u in subpass %u is %s but must not be "
3517 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3518 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3519 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
3520 } else if ((subpass.pInputAttachments[j].aspectMask &
3521 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3522 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3523 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3524 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3525 const auto *attachment_reference_stencil_layout =
3526 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pInputAttachments[j].pNext);
3527 if (attachment_reference_stencil_layout) {
3528 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3529 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3530 attachment_reference_stencil_layout->stencilLayout ==
3531 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3532 attachment_reference_stencil_layout->stencilLayout ==
3533 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3534 attachment_reference_stencil_layout->stencilLayout ==
3535 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3536 attachment_reference_stencil_layout->stencilLayout ==
3537 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3538 attachment_reference_stencil_layout->stencilLayout ==
3539 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3540 attachment_reference_stencil_layout->stencilLayout ==
3541 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3542 attachment_reference_stencil_layout->stencilLayout ==
3543 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3544 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003545 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
3546 "In the attachment reference %u in subpass %u with pNext chain instance "
3547 "VkAttachmentReferenceStencilLayoutKHR"
3548 "the stencilLayout member but must not be "
3549 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3550 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3551 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3552 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3553 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3554 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3555 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3556 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3557 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3558 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003559 }
3560 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003561 skip |= LogError(
3562 device, "VUID-VkAttachmentReference2-attachment-03315",
3563 "When the layout for input attachment reference %u in subpass %u is "
3564 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3565 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3566 "VkAttachmentReferenceStencilLayout instance.",
3567 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003568 }
3569 }
3570 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3571 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3572 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003573 skip |= LogError(
3574 device, "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003575 "When the aspectMask for input attachment reference %u in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3576 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3577 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3578 j, i);
3579 }
3580 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3581 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3582 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003583 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
3584 "When the aspectMask for input attachment reference %u in subpass %u is "
3585 "VK_IMAGE_ASPECT_STENCIL_BIT "
3586 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3587 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
3588 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003589 }
3590 }
3591 break;
3592
Graeme Leese668a9862018-10-08 10:40:02 +01003593 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3594 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003595 if (device_extensions.vk_khr_maintenance2) {
Graeme Leese668a9862018-10-08 10:40:02 +01003596 break;
3597 } else {
3598 // Intentionally fall through to generic error message
3599 }
3600 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003601
Cort Stratton7547f772017-05-04 15:18:52 -07003602 default:
3603 // No other layouts are acceptable
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003604 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
3605 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3606 string_VkImageLayout(subpass.pInputAttachments[j].layout));
Cort Stratton7547f772017-05-04 15:18:52 -07003607 }
3608
Cort Stratton7547f772017-05-04 15:18:52 -07003609 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003610 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3611 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003612
3613 bool used_as_depth =
3614 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3615 bool used_as_color = false;
3616 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3617 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3618 }
3619 if (!used_as_depth && !used_as_color &&
3620 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08003621 vuid = use_rp2 ? "VUID-VkSubpassDescription2-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003622 skip |= LogError(device, vuid,
3623 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
3624 function_name, attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07003625 }
3626 }
3627 attach_first_use[attach_index] = false;
3628 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003629
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003630 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3631 auto attach_index = subpass.pColorAttachments[j].attachment;
3632 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3633
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003634 // TODO: Need a way to validate shared presentable images here, currently just allowing
3635 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3636 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003637 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003638 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003639 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003640 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3641 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003642 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003643
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003644 case VK_IMAGE_LAYOUT_GENERAL:
3645 // May not be optimal; TODO: reconsider this warning based on other constraints?
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003646 skip |= LogPerformanceWarning(device, kVUID_Core_DrawState_InvalidImageLayout,
3647 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003648 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003649
Tobias Hectorbbb12282018-10-22 15:17:59 +01003650 case VK_IMAGE_LAYOUT_UNDEFINED:
3651 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003652 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003653 skip |= LogError(device, vuid,
3654 "Layout for color attachment reference %u in subpass %u is %s but should be "
3655 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3656 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003657 break;
3658
Piers Daniell9af77cd2019-10-16 13:54:12 -06003659 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3660 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3661 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3662 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003663 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003664 skip |= LogError(
3665 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003666 "Layout for color attachment reference %u in subpass %u is %s but must not be "
3667 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3668 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3669 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3670 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003671 skip |= LogError(
3672 device, "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003673 "Layout for color attachment reference %u in subpass %u is %s but must not be "
3674 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3675 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3676 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3677 } else if ((subpass.pColorAttachments[j].aspectMask &
3678 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3679 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3680 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3681 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3682 const auto *attachment_reference_stencil_layout =
3683 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pColorAttachments[j].pNext);
3684 if (attachment_reference_stencil_layout) {
3685 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3686 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3687 attachment_reference_stencil_layout->stencilLayout ==
3688 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3689 attachment_reference_stencil_layout->stencilLayout ==
3690 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3691 attachment_reference_stencil_layout->stencilLayout ==
3692 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3693 attachment_reference_stencil_layout->stencilLayout ==
3694 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3695 attachment_reference_stencil_layout->stencilLayout ==
3696 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3697 attachment_reference_stencil_layout->stencilLayout ==
3698 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3699 attachment_reference_stencil_layout->stencilLayout ==
3700 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3701 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003702 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
3703 "In the attachment reference %u in subpass %u with pNext chain instance "
3704 "VkAttachmentReferenceStencilLayoutKHR"
3705 "the stencilLayout member but must not be "
3706 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3707 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3708 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3709 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3710 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3711 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3712 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3713 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3714 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3715 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003716 }
3717 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003718 skip |= LogError(
3719 device, "VUID-VkAttachmentReference2-attachment-03315",
3720 "When the layout for color attachment reference %u in subpass %u is "
3721 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3722 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3723 "VkAttachmentReferenceStencilLayout instance.",
3724 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003725 }
3726 }
3727 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3728 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3729 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003730 skip |= LogError(
3731 device, "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003732 "When the aspectMask for color attachment reference %u in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3733 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3734 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3735 j, i);
3736 }
3737 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3738 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3739 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003740 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
3741 "When the aspectMask for color attachment reference %u in subpass %u is "
3742 "VK_IMAGE_ASPECT_STENCIL_BIT "
3743 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3744 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
3745 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003746 }
3747 }
3748 break;
3749
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003750 default:
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003751 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
3752 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3753 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003754 }
3755
John Zulauf4eee2692019-02-09 16:14:25 -07003756 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].attachment != VK_ATTACHMENT_UNUSED) &&
3757 (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
3758 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08003759 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003760 skip |= LogError(device, vuid,
3761 "Layout for resolve attachment reference %u in subpass %u is %s but should be "
3762 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3763 j, i, string_VkImageLayout(subpass.pResolveAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003764 }
3765
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003766 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003767 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
3768 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003769 }
3770 attach_first_use[attach_index] = false;
3771 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003772
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003773 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3774 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003775 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3776 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3777 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003778 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003779
Dave Houltona9df0ce2018-02-07 10:51:23 -07003780 case VK_IMAGE_LAYOUT_GENERAL:
3781 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3782 // doing a bunch of transitions.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003783 skip |= LogPerformanceWarning(device, kVUID_Core_DrawState_InvalidImageLayout,
3784 "GENERAL layout for depth attachment may not give optimal performance.");
Dave Houltona9df0ce2018-02-07 10:51:23 -07003785 break;
3786
Tobias Hectorbbb12282018-10-22 15:17:59 +01003787 case VK_IMAGE_LAYOUT_UNDEFINED:
3788 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003789 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003790 skip |= LogError(device, vuid,
3791 "Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
3792 "layout or GENERAL.",
3793 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003794 break;
3795
Piers Daniell9af77cd2019-10-16 13:54:12 -06003796 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3797 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3798 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3799 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003800 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003801 skip |= LogError(
3802 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003803 "Layout for depth attachment reference in subpass %u is %s but must not be "
3804 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3805 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3806 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3807 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003808 skip |= LogError(
3809 device, "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003810 "Layout for depth attachment reference in subpass %u is %s but must not be "
3811 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3812 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3813 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3814 } else if ((subpass.pDepthStencilAttachment->aspectMask &
3815 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3816 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3817 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3818 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3819 const auto *attachment_reference_stencil_layout =
3820 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pDepthStencilAttachment->pNext);
3821 if (attachment_reference_stencil_layout) {
3822 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3823 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3824 attachment_reference_stencil_layout->stencilLayout ==
3825 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3826 attachment_reference_stencil_layout->stencilLayout ==
3827 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3828 attachment_reference_stencil_layout->stencilLayout ==
3829 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3830 attachment_reference_stencil_layout->stencilLayout ==
3831 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3832 attachment_reference_stencil_layout->stencilLayout ==
3833 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3834 attachment_reference_stencil_layout->stencilLayout ==
3835 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3836 attachment_reference_stencil_layout->stencilLayout ==
3837 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3838 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003839 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
3840 "In the attachment reference in subpass %u with pNext chain instance "
3841 "VkAttachmentReferenceStencilLayoutKHR"
3842 "the stencilLayout member but must not be "
3843 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3844 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3845 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3846 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3847 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3848 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3849 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3850 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3851 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3852 i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003853 }
3854 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003855 skip |= LogError(
3856 device, "VUID-VkAttachmentReference2-attachment-03315",
3857 "When the layout for depth attachment reference in subpass %u is "
3858 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3859 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3860 "VkAttachmentReferenceStencilLayout instance.",
3861 i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003862 }
3863 }
3864 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3865 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3866 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003867 skip |= LogError(
3868 device, "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003869 "When the aspectMask for depth attachment reference in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3870 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3871 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3872 i);
3873 }
3874 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3875 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3876 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003877 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
3878 "When the aspectMask for depth attachment reference in subpass %u is "
3879 "VK_IMAGE_ASPECT_STENCIL_BIT "
3880 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3881 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
3882 i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003883 }
3884 }
3885 break;
3886
Dave Houltona9df0ce2018-02-07 10:51:23 -07003887 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3888 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003889 if (device_extensions.vk_khr_maintenance2) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003890 break;
3891 } else {
3892 // Intentionally fall through to generic error message
3893 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06003894 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003895
Dave Houltona9df0ce2018-02-07 10:51:23 -07003896 default:
3897 // No other layouts are acceptable
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003898 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
3899 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3900 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
3901 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003902 }
3903
3904 auto attach_index = subpass.pDepthStencilAttachment->attachment;
3905 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003906 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
3907 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003908 }
3909 attach_first_use[attach_index] = false;
3910 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003911 }
3912 return skip;
3913}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003914
Mark Lobodzinski96210742017-02-09 10:33:46 -07003915// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
3916// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003917template <typename T1>
3918bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
3919 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
3920 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003921 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003922 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06003923 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003924 if (strict) {
3925 correct_usage = ((actual & desired) == desired);
3926 } else {
3927 correct_usage = ((actual & desired) != 0);
3928 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003929
Mark Lobodzinski96210742017-02-09 10:33:46 -07003930 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06003931 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06003932 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003933 skip = LogError(object, kVUID_Core_MemTrack_InvalidUsageFlag,
3934 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
3935 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003936 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003937 skip = LogError(object, msgCode,
3938 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
3939 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003940 }
3941 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003942 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003943}
3944
3945// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3946// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003947bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003948 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003949 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image,
John Zulauf4fea6622019-04-01 11:38:18 -06003950 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003951}
3952
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003953bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
John Zulauf07288512019-07-05 11:09:50 -06003954 char const *func_name, const char *linear_vuid, const char *optimal_vuid) const {
Mark Lobodzinski5c048802019-03-07 10:47:31 -07003955 VkFormatProperties format_properties = GetPDFormatProperties(image_state->createInfo.format);
Cort Stratton186b1a22018-05-01 20:18:06 -04003956 bool skip = false;
3957 if (image_state->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
3958 if ((format_properties.linearTilingFeatures & desired) != desired) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003959 skip |=
3960 LogError(image_state->image, linear_vuid, "In %s, invalid linearTilingFeatures (0x%08X) for format %u used by %s.",
3961 func_name, format_properties.linearTilingFeatures, image_state->createInfo.format,
3962 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04003963 }
3964 } else if (image_state->createInfo.tiling == VK_IMAGE_TILING_OPTIMAL) {
3965 if ((format_properties.optimalTilingFeatures & desired) != desired) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003966 skip |= LogError(image_state->image, optimal_vuid,
3967 "In %s, invalid optimalTilingFeatures (0x%08X) for format %u used by %s.", func_name,
3968 format_properties.optimalTilingFeatures, image_state->createInfo.format,
3969 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04003970 }
3971 }
3972 return skip;
3973}
3974
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003975bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003976 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07003977 bool skip = false;
Cort Strattond619a302018-05-17 19:46:32 -07003978 // layerCount must not be zero
3979 if (subresource_layers->layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003980 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-layerCount-01700",
3981 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07003982 }
3983 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
3984 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003985 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00168",
3986 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07003987 }
3988 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
3989 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3990 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003991 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00167",
3992 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
3993 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3994 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07003995 }
3996 return skip;
3997}
3998
Mark Lobodzinski96210742017-02-09 10:33:46 -07003999// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4000// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004001bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004002 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004003 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer,
John Zulauf4fea6622019-04-01 11:38:18 -06004004 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004005}
4006
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004007bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004008 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004009 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004010
4011 const VkDeviceSize &range = pCreateInfo->range;
4012 if (range != VK_WHOLE_SIZE) {
4013 // Range must be greater than 0
4014 if (range <= 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004015 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00928",
4016 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4017 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4018 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004019 }
4020 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004021 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4022 if (SafeModulo(range, format_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004023 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00929",
4024 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4025 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4026 "(%" PRIu32 ").",
4027 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004028 }
4029 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004030 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004031 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00930",
4032 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4033 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4034 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4035 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004036 }
4037 // The sum of range and offset must be less than or equal to the size of buffer
4038 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004039 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00931",
4040 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4041 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4042 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4043 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004044 }
4045 }
4046 return skip;
4047}
4048
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004049bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004050 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004051 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004052 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4053 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004054 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00933",
4055 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
4056 "be supported for uniform texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004057 }
4058 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4059 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004060 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00934",
4061 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
4062 "be supported for storage texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004063 }
4064 return skip;
4065}
4066
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004067bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004068 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004069 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004070
Dave Houltond8ed0212018-05-16 17:18:24 -06004071 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004072
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004073 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!enabled_features.core.sparseBinding)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004074 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-00915",
4075 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
4076 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004077 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06004078
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004079 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!enabled_features.core.sparseResidencyBuffer)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004080 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-00916",
4081 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
4082 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06004083 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06004084
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004085 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004086 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-00917",
4087 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
4088 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06004089 }
Jeff Bolz87697532019-01-11 22:54:00 -06004090
4091 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
4092 if (chained_devaddr_struct) {
4093 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
4094 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004095 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4096 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
4097 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004098 }
4099 }
4100
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004101 auto chained_opaqueaddr_struct = lvl_find_in_chain<VkBufferOpaqueCaptureAddressCreateInfoKHR>(pCreateInfo->pNext);
4102 if (chained_opaqueaddr_struct) {
4103 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
4104 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004105 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
4106 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfoKHR::opaqueCaptureAddress"
4107 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004108 }
4109 }
4110
Shannon McPherson4984e642019-12-05 13:04:34 -07004111 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
Piers Daniell41b8c5d2020-01-10 15:42:00 -07004112 !enabled_features.core12.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004113 skip |= LogError(
4114 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004115 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
4116 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
4117 }
4118
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004119 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004120 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateBuffer",
4121 "pCreateInfo->pQueueFamilyIndices", "VUID-VkBufferCreateInfo-sharingMode-01419",
4122 "VUID-VkBufferCreateInfo-sharingMode-01419", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004123 }
4124
Mark Lobodzinski96210742017-02-09 10:33:46 -07004125 return skip;
4126}
4127
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004128bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004129 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004130 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004131 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004132 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4133 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004134 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004135 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4136 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004137 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004138 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4139 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4140 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004141
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004142 // Buffer view offset must be less than the size of buffer
4143 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004144 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00925",
4145 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4146 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4147 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004148 }
4149
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004150 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004151 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4152 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4153 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004154 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-02749",
4155 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4156 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4157 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004158 }
4159
4160 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
4161 VkDeviceSize elementSize = FormatElementSize(pCreateInfo->format);
4162 if ((elementSize % 3) == 0) {
4163 elementSize /= 3;
4164 }
4165 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
4166 VkDeviceSize alignmentRequirement =
4167 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4168 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
4169 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4170 }
4171 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004172 skip |= LogError(
4173 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02750",
Jeff Bolzd5554e62019-07-19 13:23:52 -05004174 "If buffer was created with usage containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
4175 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4176 ") must be a multiple of the lesser of "
4177 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4178 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4179 "(%" PRId32
4180 ") is VK_TRUE, the size of a texel of the requested format. "
4181 "If the size of a texel is a multiple of three bytes, then the size of a "
4182 "single component of format is used instead",
4183 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4184 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4185 }
4186 }
4187 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
4188 VkDeviceSize alignmentRequirement =
4189 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4190 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
4191 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4192 }
4193 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004194 skip |= LogError(
4195 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02751",
Jeff Bolzd5554e62019-07-19 13:23:52 -05004196 "If buffer was created with usage containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
4197 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4198 ") must be a multiple of the lesser of "
4199 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4200 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4201 "(%" PRId32
4202 ") is VK_TRUE, the size of a texel of the requested format. "
4203 "If the size of a texel is a multiple of three bytes, then the size of a "
4204 "single component of format is used instead",
4205 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4206 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4207 }
4208 }
4209 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004210
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004211 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004212
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004213 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004214 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004215 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004216}
4217
Mark Lobodzinski602de982017-02-09 11:01:33 -07004218// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004219bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004220 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004221 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004222
Dave Houlton1d2022c2017-03-29 11:43:58 -06004223 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004224 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004225 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 -07004226 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004227 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 -07004228 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004229 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004230 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004231 skip |= LogError(image, vuid,
4232 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
4233 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4234 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004235 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004236 skip |= LogError(image, vuid,
4237 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
4238 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4239 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004240 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004241 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004242 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004243 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 -07004244 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004245 skip |=
4246 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 -07004247 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004248 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004249 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004250 skip |=
4251 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 -07004252 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004253 skip |= LogError(image, vuid, "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.",
4254 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004255 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004256 } else if (FormatIsMultiplane(format)) {
4257 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4258 if (3 == FormatPlaneCount(format)) {
4259 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4260 }
4261 if ((aspect_mask & valid_flags) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004262 skip |=
4263 LogError(image, vuid,
4264 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4265 "set, where n = [0, 1, 2].",
4266 func_name);
Dave Houlton501b15b2018-03-30 15:07:41 -06004267 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004268 }
4269 return skip;
4270}
4271
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004272bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4273 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004274 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
4275 SubresourceRangeErrorCodes errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004276 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004277
4278 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004279 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004280 skip |= LogError(image, errorCodes.base_mip_err,
4281 "%s: %s.baseMipLevel (= %" PRIu32
4282 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4283 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004284 }
Petr Kraus4d718682017-05-18 03:38:41 +02004285
Petr Krausffa94af2017-08-08 21:46:02 +02004286 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4287 if (subresourceRange.levelCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004288 skip |= LogError(image, errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004289 } else {
4290 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004291
Petr Krausffa94af2017-08-08 21:46:02 +02004292 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004293 skip |= LogError(image, errorCodes.mip_count_err,
4294 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4295 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
4296 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
4297 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004298 }
Petr Kraus4d718682017-05-18 03:38:41 +02004299 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004300 }
Petr Kraus4d718682017-05-18 03:38:41 +02004301
4302 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004303 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004304 skip |= LogError(image, errorCodes.base_layer_err,
4305 "%s: %s.baseArrayLayer (= %" PRIu32
4306 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4307 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004308 }
Petr Kraus4d718682017-05-18 03:38:41 +02004309
Petr Krausffa94af2017-08-08 21:46:02 +02004310 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4311 if (subresourceRange.layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004312 skip |= LogError(image, errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004313 } else {
4314 const uint64_t necessary_layer_count =
4315 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004316
Petr Krausffa94af2017-08-08 21:46:02 +02004317 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004318 skip |= LogError(image, errorCodes.layer_count_err,
4319 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4320 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
4321 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
4322 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004323 }
Petr Kraus4d718682017-05-18 03:38:41 +02004324 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004325 }
Petr Kraus4d718682017-05-18 03:38:41 +02004326
Mark Lobodzinski602de982017-02-09 11:01:33 -07004327 return skip;
4328}
4329
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004330bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004331 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004332 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004333 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4334 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4335 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4336
4337 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4338 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4339
4340 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004341 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4342 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
Shannon McPherson5a0de262019-06-05 10:43:56 -06004343 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-02724"
Dave Houltond8ed0212018-05-16 17:18:24 -06004344 : "VUID-VkImageViewCreateInfo-image-01482")
4345 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4346 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
Shannon McPherson5a0de262019-06-05 10:43:56 -06004347 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
Dave Houltond8ed0212018-05-16 17:18:24 -06004348 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4349 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004350
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004351 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004352 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004353 image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004354}
4355
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004356bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004357 const VkImageSubresourceRange &subresourceRange,
4358 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004359 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004360 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4361 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4362 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4363 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004364
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004365 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004366 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image,
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004367 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004368}
4369
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004370bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -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-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4375 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4376 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4377 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
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 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image,
4381 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004382}
4383
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004384bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004385 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
John Zulaufa4472282019-08-22 14:44:34 -06004386 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-VkImageMemoryBarrier-subresourceRange-01486";
4389 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4390 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4391 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
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 cmd_name, param_name, "arrayLayers", image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004395}
4396
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004397bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004398 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004399 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004400 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004401 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004402 skip |=
4403 ValidateImageUsageFlags(image_state,
4404 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
4405 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4406 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV | VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
4407 false, kVUIDUndefined, "vkCreateImageView()",
4408 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
4409 "SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004410 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004411 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004412 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004413 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004414 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004415 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004416
4417 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4418 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004419 VkImageUsageFlags image_usage = image_state->createInfo.usage;
4420 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004421 VkFormat view_format = pCreateInfo->format;
4422 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004423 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004424 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004425
Dave Houltonbd2e2622018-04-10 16:41:14 -06004426 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004427 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004428 if (chained_ivuci_struct) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05004429 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance2) {
4430 if (!device_extensions.vk_ext_separate_stencil_usage) {
4431 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004432 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
4433 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
4434 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05004435 }
4436 } else {
4437 const auto image_stencil_struct =
4438 lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
4439 if (image_stencil_struct == nullptr) {
4440 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004441 skip |= LogError(
4442 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004443 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
4444 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
4445 "any bits that were not set in VkImageCreateInfo::usage used to create image");
4446 }
4447 } else {
4448 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
4449 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
4450 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004451 skip |= LogError(
4452 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004453 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4454 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4455 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
4456 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
4457 }
4458 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
4459 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004460 skip |= LogError(
4461 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004462 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4463 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4464 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
4465 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
4466 }
4467 }
4468 }
4469 }
4470
Dave Houltonbd2e2622018-04-10 16:41:14 -06004471 image_usage = chained_ivuci_struct->usage;
4472 }
4473
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004474 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4475 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004476 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01004477 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06004478 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01004479 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06004480 std::stringstream ss;
4481 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01004482 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06004483 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004484 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004485 }
4486 } else {
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004487 if ((!device_extensions.vk_khr_maintenance2 ||
Dave Houltonc7988072018-04-16 11:46:56 -06004488 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
4489 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4490 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
4491 std::stringstream ss;
4492 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06004493 << " is not in the same format compatibility class as "
4494 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004495 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4496 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004497 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01018", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004498 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004499 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004500 }
4501 } else {
4502 // Format MUST be IDENTICAL to the format the image was created with
4503 if (image_format != view_format) {
4504 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06004505 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07004506 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004507 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004508 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01019", "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004509 }
4510 }
4511
sfricke-samsungd40eda42020-02-09 17:54:31 -08004512 // Validate feature set if using CUBE_ARRAY
4513 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) && (enabled_features.core.imageCubeArray == false)) {
4514 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-viewType-01004",
4515 "vkCreateImageView(): pCreateInfo->viewType can't be VK_IMAGE_VIEW_TYPE_CUBE_ARRAY without "
4516 "enabling the imageCubeArray feature.");
4517 }
4518
Mark Lobodzinski602de982017-02-09 11:01:33 -07004519 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004520 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004521
4522 switch (image_type) {
4523 case VK_IMAGE_TYPE_1D:
4524 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004525 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4526 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4527 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004528 }
4529 break;
4530 case VK_IMAGE_TYPE_2D:
4531 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4532 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4533 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004534 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
4535 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4536 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004537 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004538 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4539 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4540 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004541 }
4542 }
4543 break;
4544 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004545 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06004546 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4547 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4548 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004549 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004550 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
4551 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4552 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004553 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4554 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004555 skip |= LogError(
4556 pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4557 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4558 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
4559 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4560 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004561 }
4562 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004563 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4564 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4565 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004566 }
4567 }
4568 } else {
4569 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004570 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4571 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4572 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004573 }
4574 }
4575 break;
4576 default:
4577 break;
4578 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004579
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004580 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004581 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07004582 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004583 }
4584
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004585 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004586 VkFormatFeatureFlags tiling_features = (image_tiling & VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4587 : format_properties.optimalTilingFeatures;
4588
4589 if (tiling_features == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004590 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-None-02273",
4591 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4592 "physical device.",
4593 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004594 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004595 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-usage-02274",
4596 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4597 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4598 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004599 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004600 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-usage-02275",
4601 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4602 "VK_IMAGE_USAGE_STORAGE_BIT.",
4603 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004604 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
4605 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004606 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-usage-02276",
4607 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4608 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4609 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004610 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4611 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004612 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-usage-02277",
4613 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4614 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4615 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
sfricke-samsungd40eda42020-02-09 17:54:31 -08004616 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
4617 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
4618 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-usage-02652",
4619 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4620 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4621 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004622 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004623
Jeff Bolz9af91c52018-09-01 21:53:57 -05004624 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4625 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004626 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
4627 "vkCreateImageView() If image was created with usage containing "
4628 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4629 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05004630 }
4631 if (view_format != VK_FORMAT_R8_UINT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004632 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
4633 "vkCreateImageView() If image was created with usage containing "
4634 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05004635 }
4636 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004637 }
4638 return skip;
4639}
4640
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004641bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
4642 uint32_t regionCount, const VkBufferCopy *pRegions) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004643 bool skip = false;
4644
4645 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
4646 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
4647 VkDeviceSize src_min = UINT64_MAX;
4648 VkDeviceSize src_max = 0;
4649 VkDeviceSize dst_min = UINT64_MAX;
4650 VkDeviceSize dst_max = 0;
4651
4652 for (uint32_t i = 0; i < regionCount; i++) {
4653 src_min = std::min(src_min, pRegions[i].srcOffset);
4654 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
4655 dst_min = std::min(dst_min, pRegions[i].dstOffset);
4656 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
4657
4658 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
4659 if (pRegions[i].srcOffset >= src_buffer_size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004660 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-srcOffset-00113",
4661 "vkCmdCopyBuffer(): pRegions[%d].srcOffset (%" PRIuLEAST64
4662 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
4663 i, pRegions[i].srcOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004664 }
4665
4666 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
4667 if (pRegions[i].dstOffset >= dst_buffer_size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004668 skip |= LogError(dst_buffer_state->buffer, "VUID-vkCmdCopyBuffer-dstOffset-00114",
4669 "vkCmdCopyBuffer(): pRegions[%d].dstOffset (%" PRIuLEAST64
4670 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
4671 i, pRegions[i].dstOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004672 }
4673
4674 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
4675 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004676 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-size-00115",
4677 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
4678 ") is greater than the source buffer size (%" PRIuLEAST64
4679 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
4680 i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004681 }
4682
4683 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
4684 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004685 skip |= LogError(dst_buffer_state->buffer, "VUID-vkCmdCopyBuffer-size-00116",
4686 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
4687 ") is greater than the destination buffer size (%" PRIuLEAST64
4688 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
4689 i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004690 }
4691 }
4692
4693 // The union of the source regions, and the union of the destination regions, must not overlap in memory
4694 if (src_buffer_state->buffer == dst_buffer_state->buffer) {
4695 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004696 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-pRegions-00117",
4697 "vkCmdCopyBuffer(): Detected overlap between source and dest regions in memory.");
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004698 }
4699 }
4700
4701 return skip;
4702}
4703
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004704bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004705 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06004706 const auto cb_node = GetCBState(commandBuffer);
4707 const auto src_buffer_state = GetBufferState(srcBuffer);
4708 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004709
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004710 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004711 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
4712 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004713 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004714 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004715 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
4716 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06004717 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004718 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
4719 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004720 skip |=
4721 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4722 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004723 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
4724 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004725 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, regionCount, pRegions);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004726 return skip;
4727}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004728
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004729bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004730 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004731 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004732 if (!buffer_state) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004733 skip |= LogError(buffer, kVUID_Core_DrawState_DoubleDestroy, "Cannot free %s that has not been allocated.",
4734 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004735 } else {
4736 if (buffer_state->in_use.load()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004737 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
4738 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004739 }
4740 }
4741 return skip;
4742}
4743
Jeff Bolz5c801d12019-10-09 10:38:45 -05004744bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
4745 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004746 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06004747 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004748
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004749 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004750 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004751 skip |=
4752 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004753 }
4754 return skip;
4755}
4756
Jeff Bolz5c801d12019-10-09 10:38:45 -05004757bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004758 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004759
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004760 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004761 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07004762 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004763 }
4764 return skip;
4765}
4766
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004767bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004768 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07004769 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06004770 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004771 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004772 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004773 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06004774 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004775 }
4776 return skip;
4777}
4778
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004779bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004780 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004781 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004782 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004783 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004784 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004785 skip |=
4786 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4787 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004788 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004789 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004790 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
4791 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004792 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07004793
4794 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004795 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
4796 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
4797 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
4798 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07004799 }
4800
4801 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004802 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
4803 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
4804 ") minus dstOffset (0x%" PRIxLEAST64 ").",
4805 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07004806 }
4807
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004808 return skip;
4809}
4810
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004811bool CoreChecks::ValidateBufferImageCopyData(uint32_t regionCount, const VkBufferImageCopy *pRegions,
4812 const IMAGE_STATE *image_state, const char *function) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004813 bool skip = false;
4814
4815 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004816 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
4817 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004818 skip |=
4819 LogError(image_state->image, "VUID-VkBufferImageCopy-srcImage-00199",
4820 "%s(): pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
4821 "and 1, respectively.",
4822 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004823 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004824 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004825
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004826 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
4827 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004828 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-srcImage-00201",
4829 "%s(): pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. For 1D and 2D images these "
4830 "must be 0 and 1, respectively.",
4831 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004832 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004833 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004834
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004835 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
4836 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004837 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-baseArrayLayer-00213",
4838 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
4839 "For 3D images these must be 0 and 1, respectively.",
4840 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004841 }
4842 }
4843
4844 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07004845 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
Locke497739c2019-03-08 11:50:47 -07004846 uint32_t element_size = FormatElementSize(image_state->createInfo.format, pRegions[i].imageSubresource.aspectMask);
4847
Dave Houltona585d132019-01-18 13:05:42 -07004848 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004849 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-bufferOffset-00193",
4850 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
4851 " must be a multiple of this format's texel size (%" PRIu32 ").",
4852 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004853 }
4854
4855 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06004856 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004857 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-bufferOffset-00194",
4858 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
4859 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004860 }
4861
4862 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
4863 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004864 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004865 LogError(image_state->image, "VUID-VkBufferImageCopy-bufferRowLength-00195",
4866 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
4867 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004868 }
4869
4870 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
4871 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004872 skip |= LogError(
4873 image_state->image, "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004874 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
4875 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004876 }
4877
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06004878 // Calculate adjusted image extent, accounting for multiplane image factors
4879 VkExtent3D adusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
4880 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
4881 if ((pRegions[i].imageOffset.x < 0) || (pRegions[i].imageOffset.x > static_cast<int32_t>(adusted_image_extent.width)) ||
4882 ((pRegions[i].imageOffset.x + pRegions[i].imageExtent.width) > static_cast<int32_t>(adusted_image_extent.width))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004883 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00197",
4884 "%s(): Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
4885 "zero or <= image subresource width (%d).",
4886 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
4887 adusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06004888 }
4889
4890 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
4891 if ((pRegions[i].imageOffset.y < 0) || (pRegions[i].imageOffset.y > static_cast<int32_t>(adusted_image_extent.height)) ||
4892 ((pRegions[i].imageOffset.y + pRegions[i].imageExtent.height) > static_cast<int32_t>(adusted_image_extent.height))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004893 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00198",
4894 "%s(): Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
4895 "zero or <= image subresource height (%d).",
4896 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
4897 adusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06004898 }
4899
4900 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
4901 if ((pRegions[i].imageOffset.z < 0) || (pRegions[i].imageOffset.z > static_cast<int32_t>(adusted_image_extent.depth)) ||
4902 ((pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth) > static_cast<int32_t>(adusted_image_extent.depth))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004903 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00200",
4904 "%s(): Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
4905 "zero or <= image subresource depth (%d).",
4906 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
4907 adusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06004908 }
4909
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004910 // subresource aspectMask must have exactly 1 bit set
4911 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
4912 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
4913 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004914 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-00212",
4915 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004916 }
4917
4918 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06004919 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004920 skip |= LogError(
4921 image_state->image, "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004922 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
4923 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004924 }
4925
4926 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04004927 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07004928 auto block_size = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004929
4930 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06004931 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004932 skip |= LogError(
4933 image_state->image, "VUID-VkBufferImageCopy-bufferRowLength-00203",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004934 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
4935 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004936 }
4937
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004938 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004939 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004940 skip |= LogError(
4941 image_state->image, "VUID-VkBufferImageCopy-bufferImageHeight-00204",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004942 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
4943 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004944 }
4945
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004946 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06004947 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
4948 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
4949 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004950 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00205",
4951 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
4952 "width & height (%d, %d)..",
4953 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
4954 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004955 }
4956
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004957 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houltona585d132019-01-18 13:05:42 -07004958 uint32_t block_size_in_bytes = FormatElementSize(image_state->createInfo.format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06004959 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004960 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-bufferOffset-00206",
4961 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
4962 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
4963 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004964 }
Dave Houlton67e9b532017-03-02 17:00:10 -07004965
4966 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07004967 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06004968 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004969 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004970 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageExtent-00207",
4971 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
4972 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
4973 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
4974 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07004975 }
4976
4977 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004978 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004979 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004980 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageExtent-00208",
4981 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
4982 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
4983 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
4984 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07004985 }
4986
4987 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06004988 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004989 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004990 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageExtent-00209",
4991 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
4992 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
4993 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
4994 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07004995 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004996 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08004997
4998 // Checks that apply only to multi-planar format images
4999 if (FormatIsMultiplane(image_state->createInfo.format)) {
5000 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
5001 if ((FormatPlaneCount(image_state->createInfo.format) < 3) &&
5002 (pRegions[i].imageSubresource.aspectMask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005003 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-01560",
5004 "%s(): pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
5005 "format has three planes.",
5006 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08005007 }
5008
5009 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
5010 if (0 == (pRegions[i].imageSubresource.aspectMask &
5011 (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 -07005012 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-01560",
5013 "%s(): pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
5014 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
5015 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08005016 }
5017 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005018 }
5019
5020 return skip;
5021}
5022
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005023bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount, const VkBufferImageCopy *pRegions,
5024 const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005025 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005026 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005027
5028 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005029 VkExtent3D extent = pRegions[i].imageExtent;
5030 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005031
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005032 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
5033 {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005034 skip |= LogWarning(image_state->image, kVUID_Core_Image_ZeroAreaSubregion,
5035 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
5036 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005037 }
5038
5039 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
5040
5041 // 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 -06005042 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005043 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005044 if (image_extent.width % block_extent.width) {
5045 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
5046 }
5047 if (image_extent.height % block_extent.height) {
5048 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
5049 }
5050 if (image_extent.depth % block_extent.depth) {
5051 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
5052 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005053 }
5054
Dave Houltonfc1a4052017-04-27 14:32:45 -06005055 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005056 skip |= LogError(image_state->image, msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005057 }
5058 }
5059
5060 return skip;
5061}
5062
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005063bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
5064 const VkBufferImageCopy *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005065 bool skip = false;
5066
5067 VkDeviceSize buffer_size = buff_state->createInfo.size;
5068
5069 for (uint32_t i = 0; i < regionCount; i++) {
5070 VkExtent3D copy_extent = pRegions[i].imageExtent;
5071
5072 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
5073 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Locke497739c2019-03-08 11:50:47 -07005074 VkDeviceSize unit_size = FormatElementSize(image_state->createInfo.format,
5075 pRegions[i].imageSubresource.aspectMask); // size (bytes) of texel or block
Dave Houltonf3229d52017-02-21 15:59:08 -07005076
Tom Cooperb2550c72018-10-15 13:08:41 +01005077 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005078 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houltona585d132019-01-18 13:05:42 -07005079 auto block_dim = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005080 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
5081 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
5082
5083 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
5084 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
5085 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005086 }
5087
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005088 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
5089 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
5090 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07005091 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005092 } else {
5093 // Calculate buffer offset of final copied byte, + 1.
5094 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
5095 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
5096 max_buffer_offset *= unit_size; // convert to bytes
5097 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005098
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005099 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005100 skip |= LogError(device, msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i,
5101 buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005102 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005103 }
5104 }
5105
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005106 return skip;
5107}
5108
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005109bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005110 VkBuffer dstBuffer, uint32_t regionCount,
5111 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005112 const auto cb_node = GetCBState(commandBuffer);
5113 const auto src_image_state = GetImageState(srcImage);
5114 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005115
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005116 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005117
5118 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005119 skip |= ValidateCmd(cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005120
5121 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005122 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005123
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005124 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07005125
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005126 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005127 skip |=
5128 LogError(cb_node->createInfo.commandPool, "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
5129 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
5130 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005131 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005132 skip |= ValidateImageBounds(src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005133 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005134 skip |= ValidateBufferBounds(src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005135 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005136
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005137 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005138 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005139 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
5140 skip |=
5141 ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005142
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005143 // Validate that SRC image & DST buffer have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005144 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005145 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
5146 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005147 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005148 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
5149 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06005150 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005151 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImageToBuffer()",
5152 "VUID-vkCmdCopyImageToBuffer-srcImage-01998",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005153 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04005154 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005155 skip |= InsideRenderPass(cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005156 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005157 const char *src_invalid_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5158 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
5159 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005160 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005161 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
Cort Strattond619a302018-05-17 19:46:32 -07005162 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005163 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005164 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
5165 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005166 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5167 cb_node, src_image_state, &pRegions[i], i, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
5168 skip |=
5169 ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyImageToBuffer()",
5170 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
5171 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005172 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
5173 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005174 }
5175 return skip;
5176}
5177
John Zulauf1686f232019-07-09 16:27:11 -06005178void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5179 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
5180 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
5181
5182 auto cb_node = GetCBState(commandBuffer);
5183 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06005184 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005185 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005186 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005187 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005188}
5189
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005190bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5191 VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005192 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005193 const auto cb_node = GetCBState(commandBuffer);
5194 const auto src_buffer_state = GetBufferState(srcBuffer);
5195 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005196
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005197 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005198
5199 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005200 skip |= ValidateCmd(cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005201
5202 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005203 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005204 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005205 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005206 skip |=
5207 LogError(cb_node->createInfo.commandPool, "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
5208 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
5209 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005210 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005211 skip |= ValidateImageBounds(dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005212 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005213 skip |= ValidateBufferBounds(dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005214 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005215 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005216 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005217 skip |=
5218 ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
5219 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005220 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005221 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
5222 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005223 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005224 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
5225 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06005226 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005227 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyBufferToImage()",
5228 "VUID-vkCmdCopyBufferToImage-dstImage-01997",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005229 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04005230 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005231 skip |= InsideRenderPass(cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005232 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005233 const char *dst_invalid_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5234 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
5235 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005236 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005237 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
Cort Strattond619a302018-05-17 19:46:32 -07005238 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005239 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005240 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
5241 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005242 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5243 cb_node, dst_image_state, &pRegions[i], i, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
5244 skip |=
5245 ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyBufferToImage()",
5246 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
5247 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005248 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
5249 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005250 }
5251 return skip;
5252}
5253
John Zulauf1686f232019-07-09 16:27:11 -06005254void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5255 VkImageLayout dstImageLayout, uint32_t regionCount,
5256 const VkBufferImageCopy *pRegions) {
5257 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
5258
5259 auto cb_node = GetCBState(commandBuffer);
5260 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06005261 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005262 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005263 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005264 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005265}
Mike Weiblen672b58b2017-02-21 14:32:53 -07005266
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005267bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005268 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005269 bool skip = false;
5270 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
5271
Dave Houlton1d960ff2018-01-19 12:17:05 -07005272 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07005273 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
5274 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
5275 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005276 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
5277 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005278 }
5279
John Zulaufa26d3c82019-08-14 16:09:08 -06005280 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005281 if (!image_entry) {
5282 return skip;
5283 }
5284
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005285 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
5286 if (device_extensions.vk_ext_image_drm_format_modifier) {
5287 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
5288 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005289 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
5290 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
5291 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005292 }
5293 } else {
5294 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005295 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
5296 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005297 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07005298 }
5299
Dave Houlton1d960ff2018-01-19 12:17:05 -07005300 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005301 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005302 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
5303 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
5304 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005305 }
5306
Dave Houlton1d960ff2018-01-19 12:17:05 -07005307 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005308 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005309 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
5310 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
5311 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005312 }
5313
Dave Houlton1d960ff2018-01-19 12:17:05 -07005314 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07005315 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005316 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
5317 if (FormatIsMultiplane(img_format)) {
5318 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
5319 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
5320 if (FormatPlaneCount(img_format) > 2u) {
5321 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
5322 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
5323 }
5324 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005325 skip |= LogError(image, vuid,
5326 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
5327 ") must be a single-plane specifier flag.",
5328 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005329 }
5330 } else if (FormatIsColor(img_format)) {
5331 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005332 skip |= LogError(image, kVUID_Core_DrawState_InvalidImageAspect,
5333 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
5334 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005335 }
5336 } else if (FormatIsDepthOrStencil(img_format)) {
5337 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
5338 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07005339 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005340 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5341 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
5342 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
5343 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005344 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
5345 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
5346 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005347 }
5348 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005349
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005350 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005351 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005352 }
5353
Mike Weiblen672b58b2017-02-21 14:32:53 -07005354 return skip;
5355}