blob: f36f778c877c13e1b2b4e7cd1933c42925622d84 [file] [log] [blame]
John Zulauff4c07882019-01-24 14:03:36 -07001/* Copyright (c) 2015-2019 The Khronos Group Inc.
2 * Copyright (c) 2015-2019 Valve Corporation
3 * Copyright (c) 2015-2019 LunarG, Inc.
4 * Copyright (C) 2015-2019 Google Inc.
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06005 *
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: Tobin Ehlis <tobine@google.com>
John Zulaufc483f442017-12-15 14:02:06 -070019 * John Zulauf <jzulauf@lunarg.com>
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060020 */
21
Tobin Ehlisf922ef82016-11-30 10:19:14 -070022// Allow use of STL min and max functions in Windows
23#define NOMINMAX
24
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -070025#include "chassis.h"
Mark Lobodzinski76d76662019-02-14 14:38:21 -070026#include "core_validation_error_enums.h"
27#include "core_validation.h"
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060028#include "descriptor_sets.h"
John Zulaufd47d0612018-02-16 13:00:34 -070029#include "hash_vk_types.h"
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060030#include "vk_enum_string_helper.h"
31#include "vk_safe_struct.h"
Jeff Bolzfdf96072018-04-10 14:32:18 -050032#include "vk_typemap_helper.h"
Tobin Ehlisc8266452017-04-07 12:20:30 -060033#include "buffer_validation.h"
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060034#include <sstream>
Mark Lobodzinski2eee5d82016-12-02 15:33:18 -070035#include <algorithm>
John Zulauff4c07882019-01-24 14:03:36 -070036#include <array>
John Zulauf1f8174b2018-02-16 12:58:37 -070037#include <memory>
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060038
Jeff Bolzfdf96072018-04-10 14:32:18 -050039// ExtendedBinding collects a VkDescriptorSetLayoutBinding and any extended
40// state that comes from a different array/structure so they can stay together
41// while being sorted by binding number.
42struct ExtendedBinding {
43 ExtendedBinding(const VkDescriptorSetLayoutBinding *l, VkDescriptorBindingFlagsEXT f) : layout_binding(l), binding_flags(f) {}
44
45 const VkDescriptorSetLayoutBinding *layout_binding;
46 VkDescriptorBindingFlagsEXT binding_flags;
47};
48
John Zulauf508d13a2018-01-05 15:10:34 -070049struct BindingNumCmp {
Jeff Bolzfdf96072018-04-10 14:32:18 -050050 bool operator()(const ExtendedBinding &a, const ExtendedBinding &b) const {
51 return a.layout_binding->binding < b.layout_binding->binding;
John Zulauf508d13a2018-01-05 15:10:34 -070052 }
53};
54
John Zulauf613fd982019-06-04 15:14:41 -060055using DescriptorSet = cvdescriptorset::DescriptorSet;
John Zulauf4a015c92019-06-04 09:50:05 -060056using DescriptorSetLayout = cvdescriptorset::DescriptorSetLayout;
John Zulaufd47d0612018-02-16 13:00:34 -070057using DescriptorSetLayoutDef = cvdescriptorset::DescriptorSetLayoutDef;
58using DescriptorSetLayoutId = cvdescriptorset::DescriptorSetLayoutId;
59
John Zulauf34ebf272018-02-16 13:08:47 -070060// Canonical dictionary of DescriptorSetLayoutDef (without any handle/device specific information)
61cvdescriptorset::DescriptorSetLayoutDict descriptor_set_layout_dict;
John Zulaufd47d0612018-02-16 13:00:34 -070062
Shannon McPhersonc06c33d2018-06-28 17:21:12 -060063DescriptorSetLayoutId GetCanonicalId(const VkDescriptorSetLayoutCreateInfo *p_create_info) {
John Zulauf34ebf272018-02-16 13:08:47 -070064 return descriptor_set_layout_dict.look_up(DescriptorSetLayoutDef(p_create_info));
John Zulaufd47d0612018-02-16 13:00:34 -070065}
John Zulauf34ebf272018-02-16 13:08:47 -070066
Tobin Ehlis0a43bde2016-05-03 08:31:08 -060067// Construct DescriptorSetLayout instance from given create info
John Zulauf48a6a702017-12-22 17:14:54 -070068// Proactively reserve and resize as possible, as the reallocation was visible in profiling
John Zulauf1f8174b2018-02-16 12:58:37 -070069cvdescriptorset::DescriptorSetLayoutDef::DescriptorSetLayoutDef(const VkDescriptorSetLayoutCreateInfo *p_create_info)
70 : flags_(p_create_info->flags), binding_count_(0), descriptor_count_(0), dynamic_descriptor_count_(0) {
Jeff Bolzfdf96072018-04-10 14:32:18 -050071 const auto *flags_create_info = lvl_find_in_chain<VkDescriptorSetLayoutBindingFlagsCreateInfoEXT>(p_create_info->pNext);
72
John Zulauf48a6a702017-12-22 17:14:54 -070073 binding_type_stats_ = {0, 0, 0};
Jeff Bolzfdf96072018-04-10 14:32:18 -050074 std::set<ExtendedBinding, BindingNumCmp> sorted_bindings;
John Zulauf508d13a2018-01-05 15:10:34 -070075 const uint32_t input_bindings_count = p_create_info->bindingCount;
76 // Sort the input bindings in binding number order, eliminating duplicates
77 for (uint32_t i = 0; i < input_bindings_count; i++) {
Jeff Bolzfdf96072018-04-10 14:32:18 -050078 VkDescriptorBindingFlagsEXT flags = 0;
79 if (flags_create_info && flags_create_info->bindingCount == p_create_info->bindingCount) {
80 flags = flags_create_info->pBindingFlags[i];
81 }
82 sorted_bindings.insert(ExtendedBinding(p_create_info->pBindings + i, flags));
John Zulaufb6d71202017-12-22 16:47:09 -070083 }
84
85 // Store the create info in the sorted order from above
Tobin Ehlisa3525e02016-11-17 10:50:52 -070086 std::map<uint32_t, uint32_t> binding_to_dyn_count;
John Zulauf508d13a2018-01-05 15:10:34 -070087 uint32_t index = 0;
88 binding_count_ = static_cast<uint32_t>(sorted_bindings.size());
89 bindings_.reserve(binding_count_);
Jeff Bolzfdf96072018-04-10 14:32:18 -050090 binding_flags_.reserve(binding_count_);
John Zulauf508d13a2018-01-05 15:10:34 -070091 binding_to_index_map_.reserve(binding_count_);
92 for (auto input_binding : sorted_bindings) {
93 // Add to binding and map, s.t. it is robust to invalid duplication of binding_num
Jeff Bolzfdf96072018-04-10 14:32:18 -050094 const auto binding_num = input_binding.layout_binding->binding;
John Zulauf508d13a2018-01-05 15:10:34 -070095 binding_to_index_map_[binding_num] = index++;
Jeff Bolzfdf96072018-04-10 14:32:18 -050096 bindings_.emplace_back(input_binding.layout_binding);
John Zulauf508d13a2018-01-05 15:10:34 -070097 auto &binding_info = bindings_.back();
Jeff Bolzfdf96072018-04-10 14:32:18 -050098 binding_flags_.emplace_back(input_binding.binding_flags);
John Zulauf508d13a2018-01-05 15:10:34 -070099
John Zulaufb6d71202017-12-22 16:47:09 -0700100 descriptor_count_ += binding_info.descriptorCount;
101 if (binding_info.descriptorCount > 0) {
102 non_empty_bindings_.insert(binding_num);
Tobin Ehlis9637fb22016-12-12 15:59:34 -0700103 }
John Zulaufb6d71202017-12-22 16:47:09 -0700104
105 if (binding_info.descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC ||
106 binding_info.descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC) {
107 binding_to_dyn_count[binding_num] = binding_info.descriptorCount;
108 dynamic_descriptor_count_ += binding_info.descriptorCount;
John Zulauf48a6a702017-12-22 17:14:54 -0700109 binding_type_stats_.dynamic_buffer_count++;
110 } else if ((binding_info.descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER) ||
111 (binding_info.descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_BUFFER)) {
112 binding_type_stats_.non_dynamic_buffer_count++;
113 } else {
114 binding_type_stats_.image_sampler_count++;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600115 }
116 }
Tobin Ehlis9637fb22016-12-12 15:59:34 -0700117 assert(bindings_.size() == binding_count_);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500118 assert(binding_flags_.size() == binding_count_);
Tobin Ehlis9637fb22016-12-12 15:59:34 -0700119 uint32_t global_index = 0;
John Zulauf7705bfc2019-06-10 09:52:04 -0600120 global_index_range_.reserve(binding_count_);
121 // Vector order is finalized so build vectors of descriptors and dynamic offsets by binding index
Tobin Ehlis9637fb22016-12-12 15:59:34 -0700122 for (uint32_t i = 0; i < binding_count_; ++i) {
John Zulaufc483f442017-12-15 14:02:06 -0700123 auto final_index = global_index + bindings_[i].descriptorCount;
John Zulauf7705bfc2019-06-10 09:52:04 -0600124 global_index_range_.emplace_back(global_index, final_index);
John Zulaufc483f442017-12-15 14:02:06 -0700125 global_index = final_index;
Tobin Ehlis9637fb22016-12-12 15:59:34 -0700126 }
John Zulaufb6d71202017-12-22 16:47:09 -0700127
Tobin Ehlisa3525e02016-11-17 10:50:52 -0700128 // Now create dyn offset array mapping for any dynamic descriptors
129 uint32_t dyn_array_idx = 0;
John Zulaufb6d71202017-12-22 16:47:09 -0700130 binding_to_dynamic_array_idx_map_.reserve(binding_to_dyn_count.size());
Tobin Ehlisa3525e02016-11-17 10:50:52 -0700131 for (const auto &bc_pair : binding_to_dyn_count) {
132 binding_to_dynamic_array_idx_map_[bc_pair.first] = dyn_array_idx;
133 dyn_array_idx += bc_pair.second;
134 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600135}
Tobin Ehlis154c2692016-10-25 09:36:53 -0600136
John Zulaufd47d0612018-02-16 13:00:34 -0700137size_t cvdescriptorset::DescriptorSetLayoutDef::hash() const {
138 hash_util::HashCombiner hc;
139 hc << flags_;
140 hc.Combine(bindings_);
John Zulauf223b69d2018-11-09 16:00:59 -0700141 hc.Combine(binding_flags_);
John Zulaufd47d0612018-02-16 13:00:34 -0700142 return hc.Value();
143}
144//
145
John Zulauf1f8174b2018-02-16 12:58:37 -0700146// Return valid index or "end" i.e. binding_count_;
147// The asserts in "Get" are reduced to the set where no valid answer(like null or 0) could be given
148// Common code for all binding lookups.
149uint32_t cvdescriptorset::DescriptorSetLayoutDef::GetIndexFromBinding(uint32_t binding) const {
150 const auto &bi_itr = binding_to_index_map_.find(binding);
151 if (bi_itr != binding_to_index_map_.cend()) return bi_itr->second;
152 return GetBindingCount();
153}
154VkDescriptorSetLayoutBinding const *cvdescriptorset::DescriptorSetLayoutDef::GetDescriptorSetLayoutBindingPtrFromIndex(
155 const uint32_t index) const {
156 if (index >= bindings_.size()) return nullptr;
157 return bindings_[index].ptr();
158}
159// Return descriptorCount for given index, 0 if index is unavailable
160uint32_t cvdescriptorset::DescriptorSetLayoutDef::GetDescriptorCountFromIndex(const uint32_t index) const {
161 if (index >= bindings_.size()) return 0;
162 return bindings_[index].descriptorCount;
163}
164// For the given index, return descriptorType
165VkDescriptorType cvdescriptorset::DescriptorSetLayoutDef::GetTypeFromIndex(const uint32_t index) const {
166 assert(index < bindings_.size());
167 if (index < bindings_.size()) return bindings_[index].descriptorType;
168 return VK_DESCRIPTOR_TYPE_MAX_ENUM;
169}
170// For the given index, return stageFlags
171VkShaderStageFlags cvdescriptorset::DescriptorSetLayoutDef::GetStageFlagsFromIndex(const uint32_t index) const {
172 assert(index < bindings_.size());
173 if (index < bindings_.size()) return bindings_[index].stageFlags;
174 return VkShaderStageFlags(0);
175}
Jeff Bolzfdf96072018-04-10 14:32:18 -0500176// Return binding flags for given index, 0 if index is unavailable
177VkDescriptorBindingFlagsEXT cvdescriptorset::DescriptorSetLayoutDef::GetDescriptorBindingFlagsFromIndex(
178 const uint32_t index) const {
179 if (index >= binding_flags_.size()) return 0;
180 return binding_flags_[index];
181}
John Zulauf1f8174b2018-02-16 12:58:37 -0700182
John Zulauf7705bfc2019-06-10 09:52:04 -0600183const cvdescriptorset::IndexRange &cvdescriptorset::DescriptorSetLayoutDef::GetGlobalIndexRangeFromIndex(uint32_t index) const {
184 const static IndexRange kInvalidRange = {0xFFFFFFFF, 0xFFFFFFFF};
185 if (index >= binding_flags_.size()) return kInvalidRange;
186 return global_index_range_[index];
John Zulauf1f8174b2018-02-16 12:58:37 -0700187}
188
John Zulauf7705bfc2019-06-10 09:52:04 -0600189// For the given binding, return the global index range (half open)
190// As start and end are often needed in pairs, get both with a single lookup.
John Zulauf1f8174b2018-02-16 12:58:37 -0700191const cvdescriptorset::IndexRange &cvdescriptorset::DescriptorSetLayoutDef::GetGlobalIndexRangeFromBinding(
192 const uint32_t binding) const {
John Zulauf7705bfc2019-06-10 09:52:04 -0600193 uint32_t index = GetIndexFromBinding(binding);
194 return GetGlobalIndexRangeFromIndex(index);
John Zulauf1f8174b2018-02-16 12:58:37 -0700195}
196
197// For given binding, return ptr to ImmutableSampler array
198VkSampler const *cvdescriptorset::DescriptorSetLayoutDef::GetImmutableSamplerPtrFromBinding(const uint32_t binding) const {
199 const auto &bi_itr = binding_to_index_map_.find(binding);
200 if (bi_itr != binding_to_index_map_.end()) {
201 return bindings_[bi_itr->second].pImmutableSamplers;
202 }
203 return nullptr;
204}
205// Move to next valid binding having a non-zero binding count
206uint32_t cvdescriptorset::DescriptorSetLayoutDef::GetNextValidBinding(const uint32_t binding) const {
207 auto it = non_empty_bindings_.upper_bound(binding);
208 assert(it != non_empty_bindings_.cend());
209 if (it != non_empty_bindings_.cend()) return *it;
210 return GetMaxBinding() + 1;
211}
212// For given index, return ptr to ImmutableSampler array
213VkSampler const *cvdescriptorset::DescriptorSetLayoutDef::GetImmutableSamplerPtrFromIndex(const uint32_t index) const {
214 if (index < bindings_.size()) {
215 return bindings_[index].pImmutableSamplers;
216 }
217 return nullptr;
218}
John Zulauf9ce3b252019-06-06 15:20:22 -0600219
220// If our layout is compatible with rh_ds_layout, return true.
221bool cvdescriptorset::DescriptorSetLayout::IsCompatible(DescriptorSetLayout const *rh_ds_layout) const {
222 bool compatible = (this == rh_ds_layout) || (GetLayoutDef() == rh_ds_layout->GetLayoutDef());
223 return compatible;
224}
John Zulauf1f8174b2018-02-16 12:58:37 -0700225// If our layout is compatible with rh_ds_layout, return true,
226// else return false and fill in error_msg will description of what causes incompatibility
John Zulauf9ce3b252019-06-06 15:20:22 -0600227bool cvdescriptorset::VerifySetLayoutCompatibility(DescriptorSetLayout const *lh_ds_layout, DescriptorSetLayout const *rh_ds_layout,
228 std::string *error_msg) {
229 // Short circuit the detailed check.
230 if (lh_ds_layout->IsCompatible(rh_ds_layout)) return true;
John Zulauf1f8174b2018-02-16 12:58:37 -0700231
John Zulauf9ce3b252019-06-06 15:20:22 -0600232 // Do a detailed compatibility check of this lhs def (referenced by lh_ds_layout), vs. the rhs (layout and def)
233 // Should only be run if trivial accept has failed, and in that context should return false.
234 VkDescriptorSetLayout lh_dsl_handle = lh_ds_layout->GetDescriptorSetLayout();
235 VkDescriptorSetLayout rh_dsl_handle = rh_ds_layout->GetDescriptorSetLayout();
236 DescriptorSetLayoutDef const *lh_ds_layout_def = lh_ds_layout->GetLayoutDef();
237 DescriptorSetLayoutDef const *rh_ds_layout_def = rh_ds_layout->GetLayoutDef();
238
239 // Check descriptor counts
240 if (lh_ds_layout_def->GetTotalDescriptorCount() != rh_ds_layout_def->GetTotalDescriptorCount()) {
John Zulauf1f8174b2018-02-16 12:58:37 -0700241 std::stringstream error_str;
John Zulauf9ce3b252019-06-06 15:20:22 -0600242 error_str << "DescriptorSetLayout " << lh_dsl_handle << " has " << lh_ds_layout_def->GetTotalDescriptorCount()
243 << " descriptors, but DescriptorSetLayout " << rh_dsl_handle << ", which comes from pipelineLayout, has "
244 << rh_ds_layout_def->GetTotalDescriptorCount() << " descriptors.";
John Zulauf1f8174b2018-02-16 12:58:37 -0700245 *error_msg = error_str.str();
246 return false; // trivial fail case
247 }
John Zulaufd47d0612018-02-16 13:00:34 -0700248
John Zulauf1f8174b2018-02-16 12:58:37 -0700249 // Descriptor counts match so need to go through bindings one-by-one
250 // and verify that type and stageFlags match
John Zulauf9ce3b252019-06-06 15:20:22 -0600251 for (const auto &binding : lh_ds_layout_def->GetBindings()) {
John Zulauf1f8174b2018-02-16 12:58:37 -0700252 // TODO : Do we also need to check immutable samplers?
253 // VkDescriptorSetLayoutBinding *rh_binding;
254 if (binding.descriptorCount != rh_ds_layout_def->GetDescriptorCountFromBinding(binding.binding)) {
255 std::stringstream error_str;
John Zulauf9ce3b252019-06-06 15:20:22 -0600256 error_str << "Binding " << binding.binding << " for DescriptorSetLayout " << lh_dsl_handle
257 << " has a descriptorCount of " << binding.descriptorCount << " but binding " << binding.binding
258 << " for DescriptorSetLayout " << rh_dsl_handle
259 << ", which comes from pipelineLayout, has a descriptorCount of "
John Zulauf1f8174b2018-02-16 12:58:37 -0700260 << rh_ds_layout_def->GetDescriptorCountFromBinding(binding.binding);
261 *error_msg = error_str.str();
262 return false;
263 } else if (binding.descriptorType != rh_ds_layout_def->GetTypeFromBinding(binding.binding)) {
264 std::stringstream error_str;
John Zulauf9ce3b252019-06-06 15:20:22 -0600265 error_str << "Binding " << binding.binding << " for DescriptorSetLayout " << lh_dsl_handle << " is type '"
John Zulauf1f8174b2018-02-16 12:58:37 -0700266 << string_VkDescriptorType(binding.descriptorType) << "' but binding " << binding.binding
John Zulauf9ce3b252019-06-06 15:20:22 -0600267 << " for DescriptorSetLayout " << rh_dsl_handle << ", which comes from pipelineLayout, is type '"
John Zulauf1f8174b2018-02-16 12:58:37 -0700268 << string_VkDescriptorType(rh_ds_layout_def->GetTypeFromBinding(binding.binding)) << "'";
269 *error_msg = error_str.str();
270 return false;
271 } else if (binding.stageFlags != rh_ds_layout_def->GetStageFlagsFromBinding(binding.binding)) {
272 std::stringstream error_str;
John Zulauf9ce3b252019-06-06 15:20:22 -0600273 error_str << "Binding " << binding.binding << " for DescriptorSetLayout " << lh_dsl_handle << " has stageFlags "
274 << binding.stageFlags << " but binding " << binding.binding << " for DescriptorSetLayout " << rh_dsl_handle
John Zulauf1f8174b2018-02-16 12:58:37 -0700275 << ", which comes from pipelineLayout, has stageFlags "
276 << rh_ds_layout_def->GetStageFlagsFromBinding(binding.binding);
277 *error_msg = error_str.str();
278 return false;
279 }
280 }
John Zulauf9ce3b252019-06-06 15:20:22 -0600281 // No detailed check should succeed if the trivial check failed -- or the dictionary has failed somehow.
282 bool compatible = true;
283 assert(!compatible);
284 return compatible;
John Zulauf1f8174b2018-02-16 12:58:37 -0700285}
286
287bool cvdescriptorset::DescriptorSetLayoutDef::IsNextBindingConsistent(const uint32_t binding) const {
288 if (!binding_to_index_map_.count(binding + 1)) return false;
289 auto const &bi_itr = binding_to_index_map_.find(binding);
290 if (bi_itr != binding_to_index_map_.end()) {
291 const auto &next_bi_itr = binding_to_index_map_.find(binding + 1);
292 if (next_bi_itr != binding_to_index_map_.end()) {
293 auto type = bindings_[bi_itr->second].descriptorType;
294 auto stage_flags = bindings_[bi_itr->second].stageFlags;
295 auto immut_samp = bindings_[bi_itr->second].pImmutableSamplers ? true : false;
Jeff Bolzfdf96072018-04-10 14:32:18 -0500296 auto flags = binding_flags_[bi_itr->second];
John Zulauf1f8174b2018-02-16 12:58:37 -0700297 if ((type != bindings_[next_bi_itr->second].descriptorType) ||
298 (stage_flags != bindings_[next_bi_itr->second].stageFlags) ||
Jeff Bolzfdf96072018-04-10 14:32:18 -0500299 (immut_samp != (bindings_[next_bi_itr->second].pImmutableSamplers ? true : false)) ||
300 (flags != binding_flags_[next_bi_itr->second])) {
John Zulauf1f8174b2018-02-16 12:58:37 -0700301 return false;
302 }
303 return true;
304 }
305 }
306 return false;
307}
John Zulauf1f8174b2018-02-16 12:58:37 -0700308
309// The DescriptorSetLayout stores the per handle data for a descriptor set layout, and references the common defintion for the
310// handle invariant portion
311cvdescriptorset::DescriptorSetLayout::DescriptorSetLayout(const VkDescriptorSetLayoutCreateInfo *p_create_info,
312 const VkDescriptorSetLayout layout)
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600313 : layout_(layout), layout_destroyed_(false), layout_id_(GetCanonicalId(p_create_info)) {}
John Zulauf1f8174b2018-02-16 12:58:37 -0700314
Tobin Ehlis154c2692016-10-25 09:36:53 -0600315// Validate descriptor set layout create info
John Zulaufd9435c32019-06-05 15:55:36 -0600316bool cvdescriptorset::ValidateDescriptorSetLayoutCreateInfo(
Jeff Bolzfdf96072018-04-10 14:32:18 -0500317 const debug_report_data *report_data, const VkDescriptorSetLayoutCreateInfo *create_info, const bool push_descriptor_ext,
318 const uint32_t max_push_descriptors, const bool descriptor_indexing_ext,
Jeff Bolze54ae892018-09-08 12:16:29 -0500319 const VkPhysicalDeviceDescriptorIndexingFeaturesEXT *descriptor_indexing_features,
320 const VkPhysicalDeviceInlineUniformBlockFeaturesEXT *inline_uniform_block_features,
321 const VkPhysicalDeviceInlineUniformBlockPropertiesEXT *inline_uniform_block_props) {
Tobin Ehlis154c2692016-10-25 09:36:53 -0600322 bool skip = false;
323 std::unordered_set<uint32_t> bindings;
John Zulauf0fdeab32018-01-23 11:27:35 -0700324 uint64_t total_descriptors = 0;
325
Jeff Bolzfdf96072018-04-10 14:32:18 -0500326 const auto *flags_create_info = lvl_find_in_chain<VkDescriptorSetLayoutBindingFlagsCreateInfoEXT>(create_info->pNext);
327
328 const bool push_descriptor_set = !!(create_info->flags & VK_DESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT_KHR);
John Zulauf0fdeab32018-01-23 11:27:35 -0700329 if (push_descriptor_set && !push_descriptor_ext) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600330 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Dave Houlton51653902018-06-22 17:32:13 -0600331 kVUID_Core_DrawState_ExtensionNotEnabled,
Mark Lobodzinskifb5a3e62018-04-13 10:46:48 -0600332 "Attempted to use %s in %s but its required extension %s has not been enabled.\n",
John Zulauf0fdeab32018-01-23 11:27:35 -0700333 "VK_DESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT_KHR", "VkDescriptorSetLayoutCreateInfo::flags",
334 VK_KHR_PUSH_DESCRIPTOR_EXTENSION_NAME);
335 }
336
Jeff Bolzfdf96072018-04-10 14:32:18 -0500337 const bool update_after_bind_set = !!(create_info->flags & VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT);
338 if (update_after_bind_set && !descriptor_indexing_ext) {
339 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Dave Houlton51653902018-06-22 17:32:13 -0600340 kVUID_Core_DrawState_ExtensionNotEnabled,
Jeff Bolzfdf96072018-04-10 14:32:18 -0500341 "Attemped to use %s in %s but its required extension %s has not been enabled.\n",
342 "VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT", "VkDescriptorSetLayoutCreateInfo::flags",
343 VK_EXT_DESCRIPTOR_INDEXING_EXTENSION_NAME);
344 }
345
John Zulauf0fdeab32018-01-23 11:27:35 -0700346 auto valid_type = [push_descriptor_set](const VkDescriptorType type) {
347 return !push_descriptor_set ||
Dave Houlton142c4cb2018-10-17 15:04:41 -0600348 ((type != VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC) && (type != VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC) &&
Jeff Bolze54ae892018-09-08 12:16:29 -0500349 (type != VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT));
John Zulauf0fdeab32018-01-23 11:27:35 -0700350 };
351
Jeff Bolzfdf96072018-04-10 14:32:18 -0500352 uint32_t max_binding = 0;
353
Tobin Ehlis154c2692016-10-25 09:36:53 -0600354 for (uint32_t i = 0; i < create_info->bindingCount; ++i) {
John Zulauf0fdeab32018-01-23 11:27:35 -0700355 const auto &binding_info = create_info->pBindings[i];
Jeff Bolzfdf96072018-04-10 14:32:18 -0500356 max_binding = std::max(max_binding, binding_info.binding);
357
John Zulauf0fdeab32018-01-23 11:27:35 -0700358 if (!bindings.insert(binding_info.binding).second) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600359 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Dave Houltond8ed0212018-05-16 17:18:24 -0600360 "VUID-VkDescriptorSetLayoutCreateInfo-binding-00279",
361 "duplicated binding number in VkDescriptorSetLayoutBinding.");
Tobin Ehlis154c2692016-10-25 09:36:53 -0600362 }
John Zulauf0fdeab32018-01-23 11:27:35 -0700363 if (!valid_type(binding_info.descriptorType)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600364 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Dave Houlton142c4cb2018-10-17 15:04:41 -0600365 (binding_info.descriptorType == VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT)
366 ? "VUID-VkDescriptorSetLayoutCreateInfo-flags-02208"
367 : "VUID-VkDescriptorSetLayoutCreateInfo-flags-00280",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600368 "invalid type %s ,for push descriptors in VkDescriptorSetLayoutBinding entry %" PRIu32 ".",
369 string_VkDescriptorType(binding_info.descriptorType), i);
John Zulauf0fdeab32018-01-23 11:27:35 -0700370 }
Jeff Bolze54ae892018-09-08 12:16:29 -0500371
372 if (binding_info.descriptorType == VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT) {
373 if ((binding_info.descriptorCount % 4) != 0) {
374 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
375 "VUID-VkDescriptorSetLayoutBinding-descriptorType-02209",
Dave Houlton142c4cb2018-10-17 15:04:41 -0600376 "descriptorCount =(%" PRIu32 ") must be a multiple of 4", binding_info.descriptorCount);
Jeff Bolze54ae892018-09-08 12:16:29 -0500377 }
378 if (binding_info.descriptorCount > inline_uniform_block_props->maxInlineUniformBlockSize) {
379 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
380 "VUID-VkDescriptorSetLayoutBinding-descriptorType-02210",
381 "descriptorCount =(%" PRIu32 ") must be less than or equal to maxInlineUniformBlockSize",
382 binding_info.descriptorCount);
383 }
384 }
385
John Zulauf0fdeab32018-01-23 11:27:35 -0700386 total_descriptors += binding_info.descriptorCount;
Tobin Ehlis154c2692016-10-25 09:36:53 -0600387 }
John Zulauf0fdeab32018-01-23 11:27:35 -0700388
Jeff Bolzfdf96072018-04-10 14:32:18 -0500389 if (flags_create_info) {
390 if (flags_create_info->bindingCount != 0 && flags_create_info->bindingCount != create_info->bindingCount) {
391 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Dave Houltond8ed0212018-05-16 17:18:24 -0600392 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-bindingCount-03002",
Jeff Bolzfdf96072018-04-10 14:32:18 -0500393 "VkDescriptorSetLayoutCreateInfo::bindingCount (%d) != "
394 "VkDescriptorSetLayoutBindingFlagsCreateInfoEXT::bindingCount (%d)",
395 create_info->bindingCount, flags_create_info->bindingCount);
396 }
397
398 if (flags_create_info->bindingCount == create_info->bindingCount) {
399 for (uint32_t i = 0; i < create_info->bindingCount; ++i) {
400 const auto &binding_info = create_info->pBindings[i];
401
402 if (flags_create_info->pBindingFlags[i] & VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT) {
403 if (!update_after_bind_set) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600404 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
405 "VUID-VkDescriptorSetLayoutCreateInfo-flags-03000",
406 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500407 }
408
409 if (binding_info.descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER &&
410 !descriptor_indexing_features->descriptorBindingUniformBufferUpdateAfterBind) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600411 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
412 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-"
413 "descriptorBindingUniformBufferUpdateAfterBind-03005",
414 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500415 }
416 if ((binding_info.descriptorType == VK_DESCRIPTOR_TYPE_SAMPLER ||
417 binding_info.descriptorType == VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER ||
418 binding_info.descriptorType == VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE) &&
419 !descriptor_indexing_features->descriptorBindingSampledImageUpdateAfterBind) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600420 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
421 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-"
422 "descriptorBindingSampledImageUpdateAfterBind-03006",
423 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500424 }
425 if (binding_info.descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_IMAGE &&
426 !descriptor_indexing_features->descriptorBindingStorageImageUpdateAfterBind) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600427 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
428 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-"
429 "descriptorBindingStorageImageUpdateAfterBind-03007",
430 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500431 }
432 if (binding_info.descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_BUFFER &&
433 !descriptor_indexing_features->descriptorBindingStorageBufferUpdateAfterBind) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600434 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
435 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-"
436 "descriptorBindingStorageBufferUpdateAfterBind-03008",
437 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500438 }
439 if (binding_info.descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER &&
440 !descriptor_indexing_features->descriptorBindingUniformTexelBufferUpdateAfterBind) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600441 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
442 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-"
443 "descriptorBindingUniformTexelBufferUpdateAfterBind-03009",
444 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500445 }
446 if (binding_info.descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER &&
447 !descriptor_indexing_features->descriptorBindingStorageTexelBufferUpdateAfterBind) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600448 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
449 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-"
450 "descriptorBindingStorageTexelBufferUpdateAfterBind-03010",
451 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500452 }
453 if ((binding_info.descriptorType == VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT ||
454 binding_info.descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC ||
455 binding_info.descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC)) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600456 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
457 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-None-03011",
458 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500459 }
Jeff Bolze54ae892018-09-08 12:16:29 -0500460
461 if (binding_info.descriptorType == VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT &&
462 !inline_uniform_block_features->descriptorBindingInlineUniformBlockUpdateAfterBind) {
463 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Dave Houlton142c4cb2018-10-17 15:04:41 -0600464 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-"
465 "descriptorBindingInlineUniformBlockUpdateAfterBind-02211",
466 "Invalid flags (VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT) for "
467 "VkDescriptorSetLayoutBinding entry %" PRIu32
468 " with descriptorBindingInlineUniformBlockUpdateAfterBind not enabled",
469 i);
Jeff Bolze54ae892018-09-08 12:16:29 -0500470 }
Jeff Bolzfdf96072018-04-10 14:32:18 -0500471 }
472
473 if (flags_create_info->pBindingFlags[i] & VK_DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT_EXT) {
474 if (!descriptor_indexing_features->descriptorBindingUpdateUnusedWhilePending) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600475 skip |= log_msg(
476 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
477 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-descriptorBindingUpdateUnusedWhilePending-03012",
478 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500479 }
480 }
481
482 if (flags_create_info->pBindingFlags[i] & VK_DESCRIPTOR_BINDING_PARTIALLY_BOUND_BIT_EXT) {
483 if (!descriptor_indexing_features->descriptorBindingPartiallyBound) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600484 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
485 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-descriptorBindingPartiallyBound-03013",
486 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500487 }
488 }
489
490 if (flags_create_info->pBindingFlags[i] & VK_DESCRIPTOR_BINDING_VARIABLE_DESCRIPTOR_COUNT_BIT_EXT) {
491 if (binding_info.binding != max_binding) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600492 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
493 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-pBindingFlags-03004",
494 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500495 }
496
497 if (!descriptor_indexing_features->descriptorBindingVariableDescriptorCount) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600498 skip |= log_msg(
499 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
500 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-descriptorBindingVariableDescriptorCount-03014",
501 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500502 }
503 if ((binding_info.descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC ||
504 binding_info.descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC)) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600505 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
506 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-pBindingFlags-03015",
507 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500508 }
509 }
510
511 if (push_descriptor_set &&
512 (flags_create_info->pBindingFlags[i] &
513 (VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT | VK_DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT_EXT |
514 VK_DESCRIPTOR_BINDING_VARIABLE_DESCRIPTOR_COUNT_BIT_EXT))) {
515 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Dave Houltond8ed0212018-05-16 17:18:24 -0600516 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-flags-03003",
517 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500518 }
519 }
520 }
521 }
522
John Zulauf0fdeab32018-01-23 11:27:35 -0700523 if ((push_descriptor_set) && (total_descriptors > max_push_descriptors)) {
524 const char *undefined = push_descriptor_ext ? "" : " -- undefined";
Dave Houltond8ed0212018-05-16 17:18:24 -0600525 skip |=
526 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
527 "VUID-VkDescriptorSetLayoutCreateInfo-flags-00281",
528 "for push descriptor, total descriptor count in layout (%" PRIu64
529 ") must not be greater than VkPhysicalDevicePushDescriptorPropertiesKHR::maxPushDescriptors (%" PRIu32 "%s).",
530 total_descriptors, max_push_descriptors, undefined);
John Zulauf0fdeab32018-01-23 11:27:35 -0700531 }
532
Tobin Ehlis154c2692016-10-25 09:36:53 -0600533 return skip;
534}
535
Tobin Ehlis68d0adf2016-06-01 11:33:50 -0600536cvdescriptorset::AllocateDescriptorSetsData::AllocateDescriptorSetsData(uint32_t count)
537 : required_descriptors_by_type{}, layout_nodes(count, nullptr) {}
538
Tobin Ehlis93f22372016-10-12 14:34:12 -0600539cvdescriptorset::DescriptorSet::DescriptorSet(const VkDescriptorSet set, const VkDescriptorPool pool,
Jeff Bolzfdf96072018-04-10 14:32:18 -0500540 const std::shared_ptr<DescriptorSetLayout const> &layout, uint32_t variable_count,
Mark Lobodzinski3840ca02019-03-08 18:36:11 -0700541 CoreChecks *dev_data)
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -0700542 : some_update_(false),
543 set_(set),
544 pool_state_(nullptr),
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600545 p_layout_(layout),
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -0700546 device_data_(dev_data),
Jeff Bolzfdf96072018-04-10 14:32:18 -0500547 variable_count_(variable_count) {
Mark Lobodzinski7804bd42019-03-06 11:28:48 -0700548 pool_state_ = dev_data->GetDescriptorPoolState(pool);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600549 // Foreach binding, create default descriptors of given type
John Zulaufb6d71202017-12-22 16:47:09 -0700550 descriptors_.reserve(p_layout_->GetTotalDescriptorCount());
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600551 for (uint32_t i = 0; i < p_layout_->GetBindingCount(); ++i) {
552 auto type = p_layout_->GetTypeFromIndex(i);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600553 switch (type) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700554 case VK_DESCRIPTOR_TYPE_SAMPLER: {
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600555 auto immut_sampler = p_layout_->GetImmutableSamplerPtrFromIndex(i);
556 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di) {
Tobin Ehlis082c7512017-05-08 11:24:57 -0600557 if (immut_sampler) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700558 descriptors_.emplace_back(new SamplerDescriptor(immut_sampler + di));
Tobin Ehlis082c7512017-05-08 11:24:57 -0600559 some_update_ = true; // Immutable samplers are updated at creation
560 } else
Chris Forbes9f340852017-05-09 08:51:38 -0700561 descriptors_.emplace_back(new SamplerDescriptor(nullptr));
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700562 }
563 break;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600564 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700565 case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER: {
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600566 auto immut = p_layout_->GetImmutableSamplerPtrFromIndex(i);
567 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di) {
Tobin Ehlis082c7512017-05-08 11:24:57 -0600568 if (immut) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700569 descriptors_.emplace_back(new ImageSamplerDescriptor(immut + di));
Tobin Ehlis082c7512017-05-08 11:24:57 -0600570 some_update_ = true; // Immutable samplers are updated at creation
571 } else
Chris Forbes9f340852017-05-09 08:51:38 -0700572 descriptors_.emplace_back(new ImageSamplerDescriptor(nullptr));
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700573 }
574 break;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600575 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700576 // ImageDescriptors
577 case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
578 case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT:
579 case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE:
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600580 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di)
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700581 descriptors_.emplace_back(new ImageDescriptor(type));
582 break;
583 case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
584 case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600585 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di)
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700586 descriptors_.emplace_back(new TexelDescriptor(type));
587 break;
588 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
589 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:
590 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
591 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC:
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600592 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di)
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700593 descriptors_.emplace_back(new BufferDescriptor(type));
594 break;
Jeff Bolze54ae892018-09-08 12:16:29 -0500595 case VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT:
596 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di)
597 descriptors_.emplace_back(new InlineUniformDescriptor(type));
598 break;
Eric Werness30127fd2018-10-31 21:01:03 -0700599 case VK_DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_NV:
Jeff Bolzfbe51582018-09-13 10:01:35 -0500600 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di)
601 descriptors_.emplace_back(new AccelerationStructureDescriptor(type));
602 break;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700603 default:
604 assert(0); // Bad descriptor type specified
605 break;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600606 }
607 }
608}
Tobin Ehlis56a30942016-05-19 08:00:00 -0600609
Mark Lobodzinski729a8d32017-01-26 12:16:30 -0700610cvdescriptorset::DescriptorSet::~DescriptorSet() { InvalidateBoundCmdBuffers(); }
Chris Forbes57989132016-07-26 17:06:10 +1200611
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600612static std::string StringDescriptorReqViewType(descriptor_req req) {
Chris Forbes6e58ebd2016-08-31 12:58:14 -0700613 std::string result("");
Chris Forbes57989132016-07-26 17:06:10 +1200614 for (unsigned i = 0; i <= VK_IMAGE_VIEW_TYPE_END_RANGE; i++) {
615 if (req & (1 << i)) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700616 if (result.size()) result += ", ";
Chris Forbes6e58ebd2016-08-31 12:58:14 -0700617 result += string_VkImageViewType(VkImageViewType(i));
Chris Forbes57989132016-07-26 17:06:10 +1200618 }
619 }
620
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700621 if (!result.size()) result = "(none)";
Chris Forbes6e58ebd2016-08-31 12:58:14 -0700622
623 return result;
Chris Forbes57989132016-07-26 17:06:10 +1200624}
625
Chris Forbesda01e8d2018-08-27 15:36:57 -0700626static char const *StringDescriptorReqComponentType(descriptor_req req) {
627 if (req & DESCRIPTOR_REQ_COMPONENT_TYPE_SINT) return "SINT";
628 if (req & DESCRIPTOR_REQ_COMPONENT_TYPE_UINT) return "UINT";
629 if (req & DESCRIPTOR_REQ_COMPONENT_TYPE_FLOAT) return "FLOAT";
630 return "(none)";
631}
632
Chris Forbesda01e8d2018-08-27 15:36:57 -0700633static unsigned DescriptorRequirementsBitsFromFormat(VkFormat fmt) {
634 if (FormatIsSInt(fmt)) return DESCRIPTOR_REQ_COMPONENT_TYPE_SINT;
635 if (FormatIsUInt(fmt)) return DESCRIPTOR_REQ_COMPONENT_TYPE_UINT;
636 if (FormatIsDepthAndStencil(fmt)) return DESCRIPTOR_REQ_COMPONENT_TYPE_FLOAT | DESCRIPTOR_REQ_COMPONENT_TYPE_UINT;
637 if (fmt == VK_FORMAT_UNDEFINED) return 0;
638 // everything else -- UNORM/SNORM/FLOAT/USCALED/SSCALED is all float in the shader.
639 return DESCRIPTOR_REQ_COMPONENT_TYPE_FLOAT;
640}
641
Tobin Ehlis3066db62016-08-22 08:12:23 -0600642// Validate that the state of this set is appropriate for the given bindings and dynamic_offsets at Draw time
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600643// This includes validating that all descriptors in the given bindings are updated,
644// that any update buffers are valid, and that any dynamic offsets are within the bounds of their buffers.
645// Return true if state is acceptable, or false and write an error message into error string
John Zulauf382e1912019-06-10 15:27:44 -0600646bool cvdescriptorset::ValidateDrawState(const DescriptorSet *descriptor_set, const std::map<uint32_t, descriptor_req> &bindings,
647 const std::vector<uint32_t> &dynamic_offsets, CMD_BUFFER_STATE *cb_node, const char *caller,
648 std::string *error) {
649 auto device_data = descriptor_set->GetDeviceData();
Chris Forbesc7090a82016-07-25 18:10:41 +1200650 for (auto binding_pair : bindings) {
651 auto binding = binding_pair.first;
John Zulauf382e1912019-06-10 15:27:44 -0600652 DescriptorSetLayout::ConstBindingIterator binding_it(descriptor_set->GetLayout().get(), binding);
653 if (binding_it.AtEnd()) { // End at construction is the condition for an invalid binding.
Tobin Ehlis58c59582016-06-21 12:34:33 -0600654 std::stringstream error_str;
655 error_str << "Attempting to validate DrawState for binding #" << binding
656 << " which is an invalid binding for this descriptor set.";
657 *error = error_str.str();
658 return false;
659 }
John Zulauf382e1912019-06-10 15:27:44 -0600660 // Copy the range, the end range is subject to update based on variable length descriptor arrays.
661 cvdescriptorset::IndexRange index_range = binding_it.GetGlobalIndexRange();
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700662 auto array_idx = 0; // Track array idx if we're dealing with array descriptors
Jeff Bolzfdf96072018-04-10 14:32:18 -0500663
John Zulauf382e1912019-06-10 15:27:44 -0600664 if (binding_it.IsVariableDescriptorCount()) {
Jeff Bolzfdf96072018-04-10 14:32:18 -0500665 // Only validate the first N descriptors if it uses variable_count
John Zulauf382e1912019-06-10 15:27:44 -0600666 index_range.end = index_range.start + descriptor_set->GetVariableDescriptorCount();
Jeff Bolzfdf96072018-04-10 14:32:18 -0500667 }
668
John Zulaufc483f442017-12-15 14:02:06 -0700669 for (uint32_t i = index_range.start; i < index_range.end; ++i, ++array_idx) {
Lockeb994adf2019-03-29 23:52:31 -0600670 uint32_t index = i - index_range.start;
John Zulauf382e1912019-06-10 15:27:44 -0600671 const auto *descriptor = descriptor_set->GetDescriptorFromGlobalIndex(i);
Lockeb994adf2019-03-29 23:52:31 -0600672
John Zulauf382e1912019-06-10 15:27:44 -0600673 if ((binding_it.GetDescriptorBindingFlags() &
Tobin Ehlisda77de72018-12-13 08:53:28 -0700674 (VK_DESCRIPTOR_BINDING_PARTIALLY_BOUND_BIT_EXT | VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT)) ||
John Zulauf382e1912019-06-10 15:27:44 -0600675 descriptor->GetClass() == InlineUniform) {
Jeff Bolzfdf96072018-04-10 14:32:18 -0500676 // Can't validate the descriptor because it may not have been updated,
677 // or the view could have been destroyed
678 continue;
John Zulauf382e1912019-06-10 15:27:44 -0600679 } else if (!descriptor->updated) {
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700680 std::stringstream error_str;
Lockeb994adf2019-03-29 23:52:31 -0600681 error_str << "Descriptor in binding #" << binding << " index " << index
Tobin Ehlisc604bd72019-06-19 11:54:51 -0600682 << " is being used in draw but has never been updated via vkUpdateDescriptorSets() or a similar call.";
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700683 *error = error_str.str();
684 return false;
685 } else {
John Zulauf382e1912019-06-10 15:27:44 -0600686 auto descriptor_class = descriptor->GetClass();
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700687 if (descriptor_class == GeneralBuffer) {
688 // Verify that buffers are valid
John Zulauf382e1912019-06-10 15:27:44 -0600689 auto buffer = static_cast<const BufferDescriptor *>(descriptor)->GetBuffer();
690 auto buffer_node = device_data->GetBufferState(buffer);
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700691 if (!buffer_node) {
692 std::stringstream error_str;
Lockeb994adf2019-03-29 23:52:31 -0600693 error_str << "Descriptor in binding #" << binding << " index " << index << " references invalid buffer "
694 << buffer << ".";
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700695 *error = error_str.str();
696 return false;
John Zulauf48a6a702017-12-22 17:14:54 -0700697 } else if (!buffer_node->sparse) {
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700698 for (auto mem_binding : buffer_node->GetBoundMemory()) {
John Zulauf382e1912019-06-10 15:27:44 -0600699 if (!device_data->GetDevMemState(mem_binding)) {
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700700 std::stringstream error_str;
Lockeb994adf2019-03-29 23:52:31 -0600701 error_str << "Descriptor in binding #" << binding << " index " << index << " uses buffer " << buffer
702 << " that references invalid memory " << mem_binding << ".";
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700703 *error = error_str.str();
Tobin Ehlisc8266452017-04-07 12:20:30 -0600704 return false;
705 }
706 }
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700707 }
John Zulauf382e1912019-06-10 15:27:44 -0600708 if (descriptor->IsDynamic()) {
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700709 // Validate that dynamic offsets are within the buffer
710 auto buffer_size = buffer_node->createInfo.size;
John Zulauf382e1912019-06-10 15:27:44 -0600711 auto range = static_cast<const BufferDescriptor *>(descriptor)->GetRange();
712 auto desc_offset = static_cast<const BufferDescriptor *>(descriptor)->GetOffset();
713 auto dyn_offset = dynamic_offsets[binding_it.GetDynamicOffsetIndex() + array_idx];
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700714 if (VK_WHOLE_SIZE == range) {
715 if ((dyn_offset + desc_offset) > buffer_size) {
716 std::stringstream error_str;
Lockeb994adf2019-03-29 23:52:31 -0600717 error_str << "Dynamic descriptor in binding #" << binding << " index " << index << " uses buffer "
718 << buffer << " with update range of VK_WHOLE_SIZE has dynamic offset " << dyn_offset
719 << " combined with offset " << desc_offset << " that oversteps the buffer size of "
720 << buffer_size << ".";
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700721 *error = error_str.str();
722 return false;
723 }
724 } else {
725 if ((dyn_offset + desc_offset + range) > buffer_size) {
726 std::stringstream error_str;
Lockeb994adf2019-03-29 23:52:31 -0600727 error_str << "Dynamic descriptor in binding #" << binding << " index " << index << " uses buffer "
728 << buffer << " with dynamic offset " << dyn_offset << " combined with offset "
729 << desc_offset << " and range " << range << " that oversteps the buffer size of "
730 << buffer_size << ".";
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700731 *error = error_str.str();
732 return false;
733 }
734 }
735 }
736 } else if (descriptor_class == ImageSampler || descriptor_class == Image) {
737 VkImageView image_view;
738 VkImageLayout image_layout;
739 if (descriptor_class == ImageSampler) {
John Zulauf382e1912019-06-10 15:27:44 -0600740 image_view = static_cast<const ImageSamplerDescriptor *>(descriptor)->GetImageView();
741 image_layout = static_cast<const ImageSamplerDescriptor *>(descriptor)->GetImageLayout();
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700742 } else {
John Zulauf382e1912019-06-10 15:27:44 -0600743 image_view = static_cast<const ImageDescriptor *>(descriptor)->GetImageView();
744 image_layout = static_cast<const ImageDescriptor *>(descriptor)->GetImageLayout();
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700745 }
746 auto reqs = binding_pair.second;
747
John Zulauf382e1912019-06-10 15:27:44 -0600748 auto image_view_state = device_data->GetImageViewState(image_view);
Tobin Ehlis836a1372017-07-14 11:25:21 -0600749 if (nullptr == image_view_state) {
750 // Image view must have been destroyed since initial update. Could potentially flag the descriptor
751 // as "invalid" (updated = false) at DestroyImageView() time and detect this error at bind time
752 std::stringstream error_str;
Lockeb994adf2019-03-29 23:52:31 -0600753 error_str << "Descriptor in binding #" << binding << " index " << index << " is using imageView "
754 << image_view << " that has been destroyed.";
Tobin Ehlis836a1372017-07-14 11:25:21 -0600755 *error = error_str.str();
756 return false;
757 }
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700758 auto image_view_ci = image_view_state->create_info;
759
760 if ((reqs & DESCRIPTOR_REQ_ALL_VIEW_TYPE_BITS) && (~reqs & (1 << image_view_ci.viewType))) {
761 // bad view type
762 std::stringstream error_str;
Lockeb994adf2019-03-29 23:52:31 -0600763 error_str << "Descriptor in binding #" << binding << " index " << index
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600764 << " requires an image view of type " << StringDescriptorReqViewType(reqs) << " but got "
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700765 << string_VkImageViewType(image_view_ci.viewType) << ".";
766 *error = error_str.str();
767 return false;
768 }
769
Chris Forbesda01e8d2018-08-27 15:36:57 -0700770 auto format_bits = DescriptorRequirementsBitsFromFormat(image_view_ci.format);
771 if (!(reqs & format_bits)) {
772 // bad component type
773 std::stringstream error_str;
Lockeb994adf2019-03-29 23:52:31 -0600774 error_str << "Descriptor in binding #" << binding << " index " << index << " requires "
Chris Forbesda01e8d2018-08-27 15:36:57 -0700775 << StringDescriptorReqComponentType(reqs) << " component type, but bound descriptor format is "
776 << string_VkFormat(image_view_ci.format) << ".";
777 *error = error_str.str();
778 return false;
779 }
780
John Zulauf382e1912019-06-10 15:27:44 -0600781 auto image_node = device_data->GetImageState(image_view_ci.image);
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700782 assert(image_node);
783 // Verify Image Layout
John Zulauff660ad62019-03-23 07:16:05 -0600784 // No "invalid layout" VUID required for this call, since the optimal_layout parameter is UNDEFINED.
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700785 bool hit_error = false;
John Zulauf382e1912019-06-10 15:27:44 -0600786 device_data->VerifyImageLayout(cb_node, image_node, image_view_state->normalized_subresource_range,
787 image_view_ci.subresourceRange.aspectMask, image_layout,
788 VK_IMAGE_LAYOUT_UNDEFINED, caller, kVUIDUndefined,
789 "VUID-VkDescriptorImageInfo-imageLayout-00344", &hit_error);
John Zulauff660ad62019-03-23 07:16:05 -0600790 if (hit_error) {
791 *error =
792 "Image layout specified at vkUpdateDescriptorSet* or vkCmdPushDescriptorSet* time "
793 "doesn't match actual image layout at time descriptor is used. See previous error callback for "
794 "specific details.";
795 return false;
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700796 }
John Zulauff660ad62019-03-23 07:16:05 -0600797
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700798 // Verify Sample counts
799 if ((reqs & DESCRIPTOR_REQ_SINGLE_SAMPLE) && image_node->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
800 std::stringstream error_str;
Lockeb994adf2019-03-29 23:52:31 -0600801 error_str << "Descriptor in binding #" << binding << " index " << index
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700802 << " requires bound image to have VK_SAMPLE_COUNT_1_BIT but got "
803 << string_VkSampleCountFlagBits(image_node->createInfo.samples) << ".";
804 *error = error_str.str();
805 return false;
806 }
807 if ((reqs & DESCRIPTOR_REQ_MULTI_SAMPLE) && image_node->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
808 std::stringstream error_str;
Lockeb994adf2019-03-29 23:52:31 -0600809 error_str << "Descriptor in binding #" << binding << " index " << index
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700810 << " requires bound image to have multiple samples, but got VK_SAMPLE_COUNT_1_BIT.";
811 *error = error_str.str();
812 return false;
Chris Forbes57989132016-07-26 17:06:10 +1200813 }
Chris Forbese92dd1d2019-01-21 15:58:57 -0800814 } else if (descriptor_class == TexelBuffer) {
John Zulauf382e1912019-06-10 15:27:44 -0600815 auto texel_buffer = static_cast<const TexelDescriptor *>(descriptor);
816 auto buffer_view = device_data->GetBufferViewState(texel_buffer->GetBufferView());
Chris Forbese92dd1d2019-01-21 15:58:57 -0800817
Locke2d9c3dd2019-04-08 16:29:09 -0600818 if (nullptr == buffer_view) {
819 std::stringstream error_str;
820 error_str << "Descriptor in binding #" << binding << " index " << index << " is using bufferView "
821 << buffer_view << " that has been destroyed.";
822 *error = error_str.str();
823 return false;
824 }
825 auto buffer = buffer_view->create_info.buffer;
John Zulauf382e1912019-06-10 15:27:44 -0600826 auto buffer_state = device_data->GetBufferState(buffer);
Locke2d9c3dd2019-04-08 16:29:09 -0600827 if (!buffer_state) {
828 std::stringstream error_str;
829 error_str << "Descriptor in binding #" << binding << " index " << index << " is using buffer "
830 << buffer_state << " that has been destroyed.";
831 *error = error_str.str();
832 return false;
833 }
Chris Forbese92dd1d2019-01-21 15:58:57 -0800834 auto reqs = binding_pair.second;
835 auto format_bits = DescriptorRequirementsBitsFromFormat(buffer_view->create_info.format);
836
837 if (!(reqs & format_bits)) {
838 // bad component type
839 std::stringstream error_str;
Lockeb994adf2019-03-29 23:52:31 -0600840 error_str << "Descriptor in binding #" << binding << " index " << index << " requires "
Chris Forbese92dd1d2019-01-21 15:58:57 -0800841 << StringDescriptorReqComponentType(reqs) << " component type, but bound descriptor format is "
842 << string_VkFormat(buffer_view->create_info.format) << ".";
843 *error = error_str.str();
844 return false;
845 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600846 }
Tobin Ehlisb1a2e4b2018-03-16 07:54:24 -0600847 if (descriptor_class == ImageSampler || descriptor_class == PlainSampler) {
848 // Verify Sampler still valid
849 VkSampler sampler;
850 if (descriptor_class == ImageSampler) {
John Zulauf382e1912019-06-10 15:27:44 -0600851 sampler = static_cast<const ImageSamplerDescriptor *>(descriptor)->GetSampler();
Tobin Ehlisb1a2e4b2018-03-16 07:54:24 -0600852 } else {
John Zulauf382e1912019-06-10 15:27:44 -0600853 sampler = static_cast<const SamplerDescriptor *>(descriptor)->GetSampler();
Tobin Ehlisb1a2e4b2018-03-16 07:54:24 -0600854 }
John Zulauf382e1912019-06-10 15:27:44 -0600855 if (!ValidateSampler(sampler, device_data)) {
Tobin Ehlisb1a2e4b2018-03-16 07:54:24 -0600856 std::stringstream error_str;
Lockeb994adf2019-03-29 23:52:31 -0600857 error_str << "Descriptor in binding #" << binding << " index " << index << " is using sampler " << sampler
858 << " that has been destroyed.";
Tobin Ehlisb1a2e4b2018-03-16 07:54:24 -0600859 *error = error_str.str();
860 return false;
Lockea223c102019-04-05 00:38:24 -0600861 } else {
John Zulauf382e1912019-06-10 15:27:44 -0600862 SAMPLER_STATE *sampler_state = device_data->GetSamplerState(sampler);
863 if (sampler_state->samplerConversion && !descriptor->IsImmutableSampler()) {
Lockea223c102019-04-05 00:38:24 -0600864 std::stringstream error_str;
John Zulauf382e1912019-06-10 15:27:44 -0600865 error_str << "sampler (" << sampler << ") in the descriptor set (" << descriptor_set->GetSet()
Lockea223c102019-04-05 00:38:24 -0600866 << ") contains a YCBCR conversion (" << sampler_state->samplerConversion
867 << ") , then the sampler MUST also exists as an immutable sampler.";
868 *error = error_str.str();
869 }
Tobin Ehlisb1a2e4b2018-03-16 07:54:24 -0600870 }
871 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600872 }
873 }
874 }
875 return true;
876}
Chris Forbes57989132016-07-26 17:06:10 +1200877
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600878// For given bindings, place any update buffers or images into the passed-in unordered_sets
Tobin Ehliscebc4c02016-08-22 10:10:43 -0600879uint32_t cvdescriptorset::DescriptorSet::GetStorageUpdates(const std::map<uint32_t, descriptor_req> &bindings,
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600880 std::unordered_set<VkBuffer> *buffer_set,
881 std::unordered_set<VkImageView> *image_set) const {
882 auto num_updates = 0;
Chris Forbesc7090a82016-07-25 18:10:41 +1200883 for (auto binding_pair : bindings) {
884 auto binding = binding_pair.first;
Tobin Ehlis58c59582016-06-21 12:34:33 -0600885 // If a binding doesn't exist, skip it
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600886 if (!p_layout_->HasBinding(binding)) {
Tobin Ehlis58c59582016-06-21 12:34:33 -0600887 continue;
888 }
John Zulaufc483f442017-12-15 14:02:06 -0700889 uint32_t start_idx = p_layout_->GetGlobalIndexRangeFromBinding(binding).start;
Tobin Ehlis81f17852016-05-05 09:04:33 -0600890 if (descriptors_[start_idx]->IsStorage()) {
891 if (Image == descriptors_[start_idx]->descriptor_class) {
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600892 for (uint32_t i = 0; i < p_layout_->GetDescriptorCountFromBinding(binding); ++i) {
Tobin Ehlis81f17852016-05-05 09:04:33 -0600893 if (descriptors_[start_idx + i]->updated) {
894 image_set->insert(static_cast<ImageDescriptor *>(descriptors_[start_idx + i].get())->GetImageView());
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600895 num_updates++;
896 }
897 }
Tobin Ehlis81f17852016-05-05 09:04:33 -0600898 } else if (TexelBuffer == descriptors_[start_idx]->descriptor_class) {
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600899 for (uint32_t i = 0; i < p_layout_->GetDescriptorCountFromBinding(binding); ++i) {
Tobin Ehlis81f17852016-05-05 09:04:33 -0600900 if (descriptors_[start_idx + i]->updated) {
901 auto bufferview = static_cast<TexelDescriptor *>(descriptors_[start_idx + i].get())->GetBufferView();
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -0700902 auto bv_state = device_data_->GetBufferViewState(bufferview);
Tobin Ehlis8b872462016-09-14 08:12:08 -0600903 if (bv_state) {
904 buffer_set->insert(bv_state->create_info.buffer);
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600905 num_updates++;
906 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600907 }
908 }
Tobin Ehlis81f17852016-05-05 09:04:33 -0600909 } else if (GeneralBuffer == descriptors_[start_idx]->descriptor_class) {
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600910 for (uint32_t i = 0; i < p_layout_->GetDescriptorCountFromBinding(binding); ++i) {
Tobin Ehlis81f17852016-05-05 09:04:33 -0600911 if (descriptors_[start_idx + i]->updated) {
912 buffer_set->insert(static_cast<BufferDescriptor *>(descriptors_[start_idx + i].get())->GetBuffer());
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600913 num_updates++;
914 }
915 }
916 }
917 }
918 }
919 return num_updates;
920}
Tobin Ehlis9906d9d2016-05-17 14:23:46 -0600921// Set is being deleted or updates so invalidate all bound cmd buffers
922void cvdescriptorset::DescriptorSet::InvalidateBoundCmdBuffers() {
John Zulauf4fea6622019-04-01 11:38:18 -0600923 device_data_->InvalidateCommandBuffers(cb_bindings, VulkanTypedHandle(set_, kVulkanObjectTypeDescriptorSet));
Tobin Ehlis9906d9d2016-05-17 14:23:46 -0600924}
John Zulauf1d27e0a2018-11-05 10:12:48 -0700925
926// Loop through the write updates to do for a push descriptor set, ignoring dstSet
927void cvdescriptorset::DescriptorSet::PerformPushDescriptorsUpdate(uint32_t write_count, const VkWriteDescriptorSet *p_wds) {
928 assert(IsPushDescriptor());
929 for (uint32_t i = 0; i < write_count; i++) {
930 PerformWriteUpdate(&p_wds[i]);
931 }
932}
933
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600934// Perform write update in given update struct
Tobin Ehlis300888c2016-05-18 13:43:26 -0600935void cvdescriptorset::DescriptorSet::PerformWriteUpdate(const VkWriteDescriptorSet *update) {
Tobin Ehlisf922ef82016-11-30 10:19:14 -0700936 // Perform update on a per-binding basis as consecutive updates roll over to next binding
937 auto descriptors_remaining = update->descriptorCount;
938 auto binding_being_updated = update->dstBinding;
939 auto offset = update->dstArrayElement;
Tobin Ehlise16805c2017-08-09 09:10:37 -0600940 uint32_t update_index = 0;
Tobin Ehlisf922ef82016-11-30 10:19:14 -0700941 while (descriptors_remaining) {
942 uint32_t update_count = std::min(descriptors_remaining, GetDescriptorCountFromBinding(binding_being_updated));
John Zulaufc483f442017-12-15 14:02:06 -0700943 auto global_idx = p_layout_->GetGlobalIndexRangeFromBinding(binding_being_updated).start + offset;
Tobin Ehlisf922ef82016-11-30 10:19:14 -0700944 // Loop over the updates for a single binding at a time
Tobin Ehlise16805c2017-08-09 09:10:37 -0600945 for (uint32_t di = 0; di < update_count; ++di, ++update_index) {
946 descriptors_[global_idx + di]->WriteUpdate(update, update_index);
Tobin Ehlisf922ef82016-11-30 10:19:14 -0700947 }
948 // Roll over to next binding in case of consecutive update
949 descriptors_remaining -= update_count;
950 offset = 0;
951 binding_being_updated++;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600952 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700953 if (update->descriptorCount) some_update_ = true;
Tobin Ehlis56a30942016-05-19 08:00:00 -0600954
Jeff Bolzfdf96072018-04-10 14:32:18 -0500955 if (!(p_layout_->GetDescriptorBindingFlagsFromBinding(update->dstBinding) &
956 (VK_DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT_EXT | VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT))) {
957 InvalidateBoundCmdBuffers();
958 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600959}
Tobin Ehlis300888c2016-05-18 13:43:26 -0600960// Validate Copy update
John Zulaufd9435c32019-06-05 15:55:36 -0600961bool cvdescriptorset::ValidateCopyUpdate(const debug_report_data *report_data, const VkCopyDescriptorSet *update,
962 const DescriptorSet *dst_set, const DescriptorSet *src_set, const char *func_name,
963 std::string *error_code, std::string *error_msg) {
964 auto dst_layout = dst_set->GetLayout();
965 auto src_layout = src_set->GetLayout();
966
John Zulauf5dfd45c2018-01-17 11:06:34 -0700967 // Verify dst layout still valid
John Zulaufd9435c32019-06-05 15:55:36 -0600968 if (dst_layout->IsDestroyed()) {
Dave Houlton00c154e2018-05-24 13:20:50 -0600969 *error_code = "VUID-VkCopyDescriptorSet-dstSet-parameter";
John Zulauf5dfd45c2018-01-17 11:06:34 -0700970 string_sprintf(error_msg,
locke-lunarg9edc2812019-06-17 23:18:52 -0600971 "Cannot call %s to perform copy update on dstSet %s"
972 " created with destroyed %s.",
John Zulaufd9435c32019-06-05 15:55:36 -0600973 func_name, report_data->FormatHandle(dst_set->GetSet()).c_str(),
974 report_data->FormatHandle(dst_layout->GetDescriptorSetLayout()).c_str());
John Zulauf5dfd45c2018-01-17 11:06:34 -0700975 return false;
976 }
977
978 // Verify src layout still valid
John Zulaufd9435c32019-06-05 15:55:36 -0600979 if (src_layout->IsDestroyed()) {
Dave Houlton00c154e2018-05-24 13:20:50 -0600980 *error_code = "VUID-VkCopyDescriptorSet-srcSet-parameter";
John Zulaufb45fdc32018-10-12 15:14:17 -0600981 string_sprintf(error_msg,
Lockeca0d9792019-03-03 23:48:13 -0700982 "Cannot call %s to perform copy update of dstSet %s"
locke-lunarg9edc2812019-06-17 23:18:52 -0600983 " from srcSet %s"
984 " created with destroyed %s.",
John Zulaufd9435c32019-06-05 15:55:36 -0600985 func_name, report_data->FormatHandle(dst_set->GetSet()).c_str(),
986 report_data->FormatHandle(src_set->GetSet()).c_str(),
987 report_data->FormatHandle(src_layout->GetDescriptorSetLayout()).c_str());
John Zulauf5dfd45c2018-01-17 11:06:34 -0700988 return false;
989 }
990
John Zulaufd9435c32019-06-05 15:55:36 -0600991 if (!dst_layout->HasBinding(update->dstBinding)) {
Dave Houlton00c154e2018-05-24 13:20:50 -0600992 *error_code = "VUID-VkCopyDescriptorSet-dstBinding-00347";
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600993 std::stringstream error_str;
John Zulaufd9435c32019-06-05 15:55:36 -0600994 error_str << "DescriptorSet " << dst_set->GetSet() << " does not have copy update dest binding of " << update->dstBinding;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -0600995 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600996 return false;
997 }
998 if (!src_set->HasBinding(update->srcBinding)) {
Dave Houlton00c154e2018-05-24 13:20:50 -0600999 *error_code = "VUID-VkCopyDescriptorSet-srcBinding-00345";
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001000 std::stringstream error_str;
John Zulaufd9435c32019-06-05 15:55:36 -06001001 error_str << "DescriptorSet " << dst_set->GetSet() << " does not have copy update src binding of " << update->srcBinding;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001002 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001003 return false;
1004 }
Jeff Bolzfdf96072018-04-10 14:32:18 -05001005 // Verify idle ds
John Zulaufd9435c32019-06-05 15:55:36 -06001006 if (dst_set->in_use.load() &&
1007 !(dst_layout->GetDescriptorBindingFlagsFromBinding(update->dstBinding) &
Jeff Bolzfdf96072018-04-10 14:32:18 -05001008 (VK_DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT_EXT | VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT))) {
1009 // TODO : Re-using Free Idle error code, need copy update idle error code
Dave Houlton00c154e2018-05-24 13:20:50 -06001010 *error_code = "VUID-vkFreeDescriptorSets-pDescriptorSets-00309";
Jeff Bolzfdf96072018-04-10 14:32:18 -05001011 std::stringstream error_str;
John Zulaufd9435c32019-06-05 15:55:36 -06001012 error_str << "Cannot call " << func_name << " to perform copy update on descriptor set " << dst_set->GetSet()
Jeff Bolzfdf96072018-04-10 14:32:18 -05001013 << " that is in use by a command buffer";
1014 *error_msg = error_str.str();
1015 return false;
1016 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001017 // src & dst set bindings are valid
1018 // Check bounds of src & dst
John Zulaufc483f442017-12-15 14:02:06 -07001019 auto src_start_idx = src_set->GetGlobalIndexRangeFromBinding(update->srcBinding).start + update->srcArrayElement;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001020 if ((src_start_idx + update->descriptorCount) > src_set->GetTotalDescriptorCount()) {
1021 // SRC update out of bounds
Dave Houlton00c154e2018-05-24 13:20:50 -06001022 *error_code = "VUID-VkCopyDescriptorSet-srcArrayElement-00346";
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001023 std::stringstream error_str;
1024 error_str << "Attempting copy update from descriptorSet " << update->srcSet << " binding#" << update->srcBinding
John Zulaufc483f442017-12-15 14:02:06 -07001025 << " with offset index of " << src_set->GetGlobalIndexRangeFromBinding(update->srcBinding).start
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001026 << " plus update array offset of " << update->srcArrayElement << " and update of " << update->descriptorCount
Tobin Ehlis1d81edd2016-11-21 09:50:49 -07001027 << " descriptors oversteps total number of descriptors in set: " << src_set->GetTotalDescriptorCount();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001028 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001029 return false;
1030 }
John Zulaufd9435c32019-06-05 15:55:36 -06001031 auto dst_start_idx = dst_layout->GetGlobalIndexRangeFromBinding(update->dstBinding).start + update->dstArrayElement;
1032 if ((dst_start_idx + update->descriptorCount) > dst_layout->GetTotalDescriptorCount()) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001033 // DST update out of bounds
Dave Houlton00c154e2018-05-24 13:20:50 -06001034 *error_code = "VUID-VkCopyDescriptorSet-dstArrayElement-00348";
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001035 std::stringstream error_str;
John Zulaufd9435c32019-06-05 15:55:36 -06001036 error_str << "Attempting copy update to descriptorSet " << dst_set->GetSet() << " binding#" << update->dstBinding
1037 << " with offset index of " << dst_layout->GetGlobalIndexRangeFromBinding(update->dstBinding).start
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001038 << " plus update array offset of " << update->dstArrayElement << " and update of " << update->descriptorCount
John Zulaufd9435c32019-06-05 15:55:36 -06001039 << " descriptors oversteps total number of descriptors in set: " << dst_layout->GetTotalDescriptorCount();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001040 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001041 return false;
1042 }
1043 // Check that types match
Dave Houltond8ed0212018-05-16 17:18:24 -06001044 // TODO : Base default error case going from here is "VUID-VkAcquireNextImageInfoKHR-semaphore-parameter"2ba which covers all
1045 // consistency issues, need more fine-grained error codes
Dave Houlton00c154e2018-05-24 13:20:50 -06001046 *error_code = "VUID-VkCopyDescriptorSet-srcSet-00349";
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001047 auto src_type = src_set->GetTypeFromBinding(update->srcBinding);
John Zulaufd9435c32019-06-05 15:55:36 -06001048 auto dst_type = dst_layout->GetTypeFromBinding(update->dstBinding);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001049 if (src_type != dst_type) {
1050 std::stringstream error_str;
John Zulaufd9435c32019-06-05 15:55:36 -06001051 error_str << "Attempting copy update to descriptorSet " << dst_set->GetSet() << " binding #" << update->dstBinding
1052 << " with type " << string_VkDescriptorType(dst_type) << " from descriptorSet " << src_set->GetSet()
1053 << " binding #" << update->srcBinding << " with type " << string_VkDescriptorType(src_type)
1054 << ". Types do not match";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001055 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001056 return false;
1057 }
1058 // Verify consistency of src & dst bindings if update crosses binding boundaries
John Zulaufd9435c32019-06-05 15:55:36 -06001059 if ((!VerifyUpdateConsistency(DescriptorSetLayout::ConstBindingIterator(src_layout.get(), update->srcBinding),
John Zulauf4a015c92019-06-04 09:50:05 -06001060 update->srcArrayElement, update->descriptorCount, "copy update from", src_set->GetSet(),
1061 error_msg)) ||
John Zulaufd9435c32019-06-05 15:55:36 -06001062 (!VerifyUpdateConsistency(DescriptorSetLayout::ConstBindingIterator(dst_layout.get(), update->dstBinding),
1063 update->dstArrayElement, update->descriptorCount, "copy update to", dst_set->GetSet(),
1064 error_msg))) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001065 return false;
1066 }
Jeff Bolzfdf96072018-04-10 14:32:18 -05001067
John Zulaufd9435c32019-06-05 15:55:36 -06001068 if ((src_layout->GetCreateFlags() & VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT) &&
1069 !(dst_layout->GetCreateFlags() & VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001070 *error_code = "VUID-VkCopyDescriptorSet-srcSet-01918";
Jeff Bolzfdf96072018-04-10 14:32:18 -05001071 std::stringstream error_str;
1072 error_str << "If pname:srcSet's (" << update->srcSet
1073 << ") layout was created with the "
1074 "ename:VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT flag "
1075 "set, then pname:dstSet's ("
1076 << update->dstSet
1077 << ") layout must: also have been created with the "
1078 "ename:VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT flag set";
1079 *error_msg = error_str.str();
1080 return false;
1081 }
1082
John Zulaufd9435c32019-06-05 15:55:36 -06001083 if (!(src_layout->GetCreateFlags() & VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT) &&
1084 (dst_layout->GetCreateFlags() & VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001085 *error_code = "VUID-VkCopyDescriptorSet-srcSet-01919";
Jeff Bolzfdf96072018-04-10 14:32:18 -05001086 std::stringstream error_str;
1087 error_str << "If pname:srcSet's (" << update->srcSet
1088 << ") layout was created without the "
1089 "ename:VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT flag "
1090 "set, then pname:dstSet's ("
1091 << update->dstSet
1092 << ") layout must: also have been created without the "
1093 "ename:VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT flag set";
1094 *error_msg = error_str.str();
1095 return false;
1096 }
1097
1098 if ((src_set->GetPoolState()->createInfo.flags & VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT) &&
John Zulaufd9435c32019-06-05 15:55:36 -06001099 !(dst_set->GetPoolState()->createInfo.flags & VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001100 *error_code = "VUID-VkCopyDescriptorSet-srcSet-01920";
Jeff Bolzfdf96072018-04-10 14:32:18 -05001101 std::stringstream error_str;
1102 error_str << "If the descriptor pool from which pname:srcSet (" << update->srcSet
1103 << ") was allocated was created "
1104 "with the ename:VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT flag "
1105 "set, then the descriptor pool from which pname:dstSet ("
1106 << update->dstSet
1107 << ") was allocated must: "
1108 "also have been created with the ename:VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT flag set";
1109 *error_msg = error_str.str();
1110 return false;
1111 }
1112
1113 if (!(src_set->GetPoolState()->createInfo.flags & VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT) &&
John Zulaufd9435c32019-06-05 15:55:36 -06001114 (dst_set->GetPoolState()->createInfo.flags & VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001115 *error_code = "VUID-VkCopyDescriptorSet-srcSet-01921";
Jeff Bolzfdf96072018-04-10 14:32:18 -05001116 std::stringstream error_str;
1117 error_str << "If the descriptor pool from which pname:srcSet (" << update->srcSet
1118 << ") was allocated was created "
1119 "without the ename:VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT flag "
1120 "set, then the descriptor pool from which pname:dstSet ("
1121 << update->dstSet
1122 << ") was allocated must: "
1123 "also have been created without the ename:VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT flag set";
1124 *error_msg = error_str.str();
1125 return false;
1126 }
1127
Jeff Bolze54ae892018-09-08 12:16:29 -05001128 if (src_type == VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT) {
1129 if ((update->srcArrayElement % 4) != 0) {
1130 *error_code = "VUID-VkCopyDescriptorSet-srcBinding-02223";
1131 std::stringstream error_str;
1132 error_str << "Attempting copy update to VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT binding with "
1133 << "srcArrayElement " << update->srcArrayElement << " not a multiple of 4";
1134 *error_msg = error_str.str();
1135 return false;
1136 }
1137 if ((update->dstArrayElement % 4) != 0) {
1138 *error_code = "VUID-VkCopyDescriptorSet-dstBinding-02224";
1139 std::stringstream error_str;
1140 error_str << "Attempting copy update to VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT binding with "
1141 << "dstArrayElement " << update->dstArrayElement << " not a multiple of 4";
1142 *error_msg = error_str.str();
1143 return false;
1144 }
1145 if ((update->descriptorCount % 4) != 0) {
1146 *error_code = "VUID-VkCopyDescriptorSet-srcBinding-02225";
1147 std::stringstream error_str;
1148 error_str << "Attempting copy update to VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT binding with "
1149 << "descriptorCount " << update->descriptorCount << " not a multiple of 4";
1150 *error_msg = error_str.str();
1151 return false;
1152 }
1153 }
1154
Tobin Ehlisd41e7b62016-05-19 07:56:18 -06001155 // Update parameters all look good and descriptor updated so verify update contents
John Zulaufd9435c32019-06-05 15:55:36 -06001156 if (!VerifyCopyUpdateContents(dst_set->GetDeviceData(), update, src_set, src_type, src_start_idx, func_name, error_code,
1157 error_msg))
1158 return false;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001159
1160 // All checks passed so update is good
1161 return true;
1162}
1163// Perform Copy update
1164void cvdescriptorset::DescriptorSet::PerformCopyUpdate(const VkCopyDescriptorSet *update, const DescriptorSet *src_set) {
John Zulaufc483f442017-12-15 14:02:06 -07001165 auto src_start_idx = src_set->GetGlobalIndexRangeFromBinding(update->srcBinding).start + update->srcArrayElement;
1166 auto dst_start_idx = p_layout_->GetGlobalIndexRangeFromBinding(update->dstBinding).start + update->dstArrayElement;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001167 // Update parameters all look good so perform update
1168 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
Józef Kucia5297e372017-10-13 22:31:34 +02001169 auto src = src_set->descriptors_[src_start_idx + di].get();
1170 auto dst = descriptors_[dst_start_idx + di].get();
1171 if (src->updated) {
1172 dst->CopyUpdate(src);
1173 some_update_ = true;
1174 } else {
1175 dst->updated = false;
1176 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001177 }
Tobin Ehlis56a30942016-05-19 08:00:00 -06001178
Jeff Bolzfdf96072018-04-10 14:32:18 -05001179 if (!(p_layout_->GetDescriptorBindingFlagsFromBinding(update->dstBinding) &
1180 (VK_DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT_EXT | VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT))) {
1181 InvalidateBoundCmdBuffers();
1182 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001183}
Tobin Ehlis56a30942016-05-19 08:00:00 -06001184
John Zulauf6f3d2bd2018-10-29 17:08:42 -06001185// Update the drawing state for the affected descriptors.
1186// Set cb_node to this set and this set to cb_node.
1187// Add the bindings of the descriptor
1188// Set the layout based on the current descriptor layout (will mask subsequent layer mismatch errors)
1189// TODO: Modify the UpdateDrawState virtural functions to *only* set initial layout and not change layouts
Tobin Ehlisf9519102016-08-17 09:49:13 -06001190// Prereq: This should be called for a set that has been confirmed to be active for the given cb_node, meaning it's going
1191// to be used in a draw by the given cb_node
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001192void cvdescriptorset::DescriptorSet::UpdateDrawState(CoreChecks *device_data, CMD_BUFFER_STATE *cb_node,
John Zulauf6f3d2bd2018-10-29 17:08:42 -06001193 const std::map<uint32_t, descriptor_req> &binding_req_map) {
Tobin Ehlis9252c2b2016-07-21 14:40:22 -06001194 // bind cb to this descriptor set
1195 cb_bindings.insert(cb_node);
Tobin Ehlis7ca20be2016-10-12 15:09:16 -06001196 // Add bindings for descriptor set, the set's pool, and individual objects in the set
John Zulauf4fea6622019-04-01 11:38:18 -06001197 cb_node->object_bindings.emplace(set_, kVulkanObjectTypeDescriptorSet);
Tobin Ehlis7ca20be2016-10-12 15:09:16 -06001198 pool_state_->cb_bindings.insert(cb_node);
John Zulauf4fea6622019-04-01 11:38:18 -06001199 cb_node->object_bindings.emplace(pool_state_->pool, kVulkanObjectTypeDescriptorPool);
Tobin Ehlisf9519102016-08-17 09:49:13 -06001200 // For the active slots, use set# to look up descriptorSet from boundDescriptorSets, and bind all of that descriptor set's
1201 // resources
Tobin Ehlis022528b2016-12-29 12:22:32 -07001202 for (auto binding_req_pair : binding_req_map) {
1203 auto binding = binding_req_pair.first;
Tony-LunarG62c5dba2018-12-20 14:27:23 -07001204 // We aren't validating descriptors created with PARTIALLY_BOUND or UPDATE_AFTER_BIND, so don't record state
1205 if (p_layout_->GetDescriptorBindingFlagsFromBinding(binding) &
1206 (VK_DESCRIPTOR_BINDING_PARTIALLY_BOUND_BIT_EXT | VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT)) {
1207 continue;
1208 }
John Zulaufc483f442017-12-15 14:02:06 -07001209 auto range = p_layout_->GetGlobalIndexRangeFromBinding(binding);
1210 for (uint32_t i = range.start; i < range.end; ++i) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001211 descriptors_[i]->UpdateDrawState(device_data, cb_node);
Mark Lobodzinski2872f4a2018-09-03 17:00:53 -06001212 }
1213 }
1214}
1215
John Zulauf48a6a702017-12-22 17:14:54 -07001216void cvdescriptorset::DescriptorSet::FilterAndTrackOneBindingReq(const BindingReqMap::value_type &binding_req_pair,
1217 const BindingReqMap &in_req, BindingReqMap *out_req,
1218 TrackedBindings *bindings) {
1219 assert(out_req);
1220 assert(bindings);
1221 const auto binding = binding_req_pair.first;
1222 // Use insert and look at the boolean ("was inserted") in the returned pair to see if this is a new set member.
1223 // Saves one hash lookup vs. find ... compare w/ end ... insert.
1224 const auto it_bool_pair = bindings->insert(binding);
1225 if (it_bool_pair.second) {
1226 out_req->emplace(binding_req_pair);
1227 }
1228}
Mark Lobodzinski2872f4a2018-09-03 17:00:53 -06001229
John Zulauf48a6a702017-12-22 17:14:54 -07001230void cvdescriptorset::DescriptorSet::FilterAndTrackOneBindingReq(const BindingReqMap::value_type &binding_req_pair,
1231 const BindingReqMap &in_req, BindingReqMap *out_req,
1232 TrackedBindings *bindings, uint32_t limit) {
1233 if (bindings->size() < limit) FilterAndTrackOneBindingReq(binding_req_pair, in_req, out_req, bindings);
1234}
1235
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001236void cvdescriptorset::DescriptorSet::FilterAndTrackBindingReqs(CMD_BUFFER_STATE *cb_state, const BindingReqMap &in_req,
John Zulauf48a6a702017-12-22 17:14:54 -07001237 BindingReqMap *out_req) {
1238 TrackedBindings &bound = cached_validation_[cb_state].command_binding_and_usage;
1239 if (bound.size() == GetBindingCount()) {
1240 return; // All bindings are bound, out req is empty
1241 }
1242 for (const auto &binding_req_pair : in_req) {
1243 const auto binding = binding_req_pair.first;
1244 // If a binding doesn't exist, or has already been bound, skip it
1245 if (p_layout_->HasBinding(binding)) {
1246 FilterAndTrackOneBindingReq(binding_req_pair, in_req, out_req, &bound);
1247 }
1248 }
1249}
1250
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001251void cvdescriptorset::DescriptorSet::FilterAndTrackBindingReqs(CMD_BUFFER_STATE *cb_state, PIPELINE_STATE *pipeline,
John Zulauf48a6a702017-12-22 17:14:54 -07001252 const BindingReqMap &in_req, BindingReqMap *out_req) {
1253 auto &validated = cached_validation_[cb_state];
1254 auto &image_sample_val = validated.image_samplers[pipeline];
1255 auto *const dynamic_buffers = &validated.dynamic_buffers;
1256 auto *const non_dynamic_buffers = &validated.non_dynamic_buffers;
1257 const auto &stats = p_layout_->GetBindingTypeStats();
1258 for (const auto &binding_req_pair : in_req) {
1259 auto binding = binding_req_pair.first;
1260 VkDescriptorSetLayoutBinding const *layout_binding = p_layout_->GetDescriptorSetLayoutBindingPtrFromBinding(binding);
1261 if (!layout_binding) {
1262 continue;
1263 }
1264 // Caching criteria differs per type.
1265 // If image_layout have changed , the image descriptors need to be validated against them.
1266 if ((layout_binding->descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC) ||
1267 (layout_binding->descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC)) {
1268 FilterAndTrackOneBindingReq(binding_req_pair, in_req, out_req, dynamic_buffers, stats.dynamic_buffer_count);
1269 } else if ((layout_binding->descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER) ||
1270 (layout_binding->descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_BUFFER)) {
1271 FilterAndTrackOneBindingReq(binding_req_pair, in_req, out_req, non_dynamic_buffers, stats.non_dynamic_buffer_count);
1272 } else {
1273 // This is rather crude, as the changed layouts may not impact the bound descriptors,
1274 // but the simple "versioning" is a simple "dirt" test.
1275 auto &version = image_sample_val[binding]; // Take advantage of default construtor zero initialzing new entries
1276 if (version != cb_state->image_layout_change_count) {
1277 version = cb_state->image_layout_change_count;
1278 out_req->emplace(binding_req_pair);
1279 }
1280 }
1281 }
1282}
Tobin Ehlis9252c2b2016-07-21 14:40:22 -06001283
Tobin Ehlis300888c2016-05-18 13:43:26 -06001284cvdescriptorset::SamplerDescriptor::SamplerDescriptor(const VkSampler *immut) : sampler_(VK_NULL_HANDLE), immutable_(false) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001285 updated = false;
1286 descriptor_class = PlainSampler;
1287 if (immut) {
1288 sampler_ = *immut;
1289 immutable_ = true;
1290 updated = true;
1291 }
1292}
Tobin Ehlise2f80292016-06-02 10:08:53 -06001293// Validate given sampler. Currently this only checks to make sure it exists in the samplerMap
Mark Lobodzinski3840ca02019-03-08 18:36:11 -07001294bool cvdescriptorset::ValidateSampler(const VkSampler sampler, CoreChecks *dev_data) {
Mark Lobodzinskif8d1ef92019-03-06 11:53:27 -07001295 return (dev_data->GetSamplerState(sampler) != nullptr);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001296}
Tobin Ehlis56a30942016-05-19 08:00:00 -06001297
Tobin Ehlis554bf382016-05-24 11:14:43 -06001298bool cvdescriptorset::ValidateImageUpdate(VkImageView image_view, VkImageLayout image_layout, VkDescriptorType type,
Mark Lobodzinski3840ca02019-03-08 18:36:11 -07001299 CoreChecks *dev_data, const char *func_name, std::string *error_code,
John Zulaufb45fdc32018-10-12 15:14:17 -06001300 std::string *error_msg) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001301 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00326";
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07001302 auto iv_state = dev_data->GetImageViewState(image_view);
Tobin Ehlis8b26a382016-09-14 08:02:49 -06001303 if (!iv_state) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001304 std::stringstream error_str;
1305 error_str << "Invalid VkImageView: " << image_view;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001306 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001307 return false;
Tobin Ehlis1809f912016-05-25 09:24:36 -06001308 }
Tobin Ehlis81280962016-07-20 14:04:20 -06001309 // Note that when an imageview is created, we validated that memory is bound so no need to re-check here
Tobin Ehlis1809f912016-05-25 09:24:36 -06001310 // Validate that imageLayout is compatible with aspect_mask and image format
1311 // and validate that image usage bits are correct for given usage
Tobin Ehlis8b26a382016-09-14 08:02:49 -06001312 VkImageAspectFlags aspect_mask = iv_state->create_info.subresourceRange.aspectMask;
1313 VkImage image = iv_state->create_info.image;
Tobin Ehlis1809f912016-05-25 09:24:36 -06001314 VkFormat format = VK_FORMAT_MAX_ENUM;
1315 VkImageUsageFlags usage = 0;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001316 auto image_node = dev_data->GetImageState(image);
Tobin Ehlis1c9c55f2016-06-02 11:49:22 -06001317 if (image_node) {
1318 format = image_node->createInfo.format;
1319 usage = image_node->createInfo.usage;
Tobin Ehlis029d2fe2016-09-21 09:19:15 -06001320 // Validate that memory is bound to image
Tobin Ehlis2cb8eb22017-01-03 14:09:57 -07001321 // TODO: This should have its own valid usage id apart from 2524 which is from CreateImageView case. The only
1322 // the error here occurs is if memory bound to a created imageView has been freed.
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001323 if (dev_data->ValidateMemoryIsBoundToImage(image_node, func_name, "VUID-VkImageViewCreateInfo-image-01020")) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001324 *error_code = "VUID-VkImageViewCreateInfo-image-01020";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001325 *error_msg = "No memory bound to image.";
Tobin Ehlis029d2fe2016-09-21 09:19:15 -06001326 return false;
Tobin Ehlisfed999f2016-09-21 15:09:45 -06001327 }
Chris Forbes67757ff2017-07-21 13:59:01 -07001328
1329 // KHR_maintenance1 allows rendering into 2D or 2DArray views which slice a 3D image,
1330 // but not binding them to descriptor sets.
1331 if (image_node->createInfo.imageType == VK_IMAGE_TYPE_3D &&
1332 (iv_state->create_info.viewType == VK_IMAGE_VIEW_TYPE_2D ||
1333 iv_state->create_info.viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001334 *error_code = "VUID-VkDescriptorImageInfo-imageView-00343";
Chris Forbes67757ff2017-07-21 13:59:01 -07001335 *error_msg = "ImageView must not be a 2D or 2DArray view of a 3D image";
1336 return false;
1337 }
Tobin Ehlis1809f912016-05-25 09:24:36 -06001338 }
1339 // First validate that format and layout are compatible
1340 if (format == VK_FORMAT_MAX_ENUM) {
1341 std::stringstream error_str;
1342 error_str << "Invalid image (" << image << ") in imageView (" << image_view << ").";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001343 *error_msg = error_str.str();
Tobin Ehlis1809f912016-05-25 09:24:36 -06001344 return false;
1345 }
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001346 // TODO : The various image aspect and format checks here are based on general spec language in 11.5 Image Views section under
1347 // vkCreateImageView(). What's the best way to create unique id for these cases?
Dave Houlton1d2022c2017-03-29 11:43:58 -06001348 bool ds = FormatIsDepthOrStencil(format);
Tobin Ehlis1809f912016-05-25 09:24:36 -06001349 switch (image_layout) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001350 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
1351 // Only Color bit must be set
1352 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Tobin Ehlis1809f912016-05-25 09:24:36 -06001353 std::stringstream error_str;
Dave Houltona9df0ce2018-02-07 10:51:23 -07001354 error_str
1355 << "ImageView (" << image_view
1356 << ") uses layout VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL but does not have VK_IMAGE_ASPECT_COLOR_BIT set.";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001357 *error_msg = error_str.str();
Tobin Ehlis1809f912016-05-25 09:24:36 -06001358 return false;
1359 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001360 // format must NOT be DS
1361 if (ds) {
1362 std::stringstream error_str;
1363 error_str << "ImageView (" << image_view
1364 << ") uses layout VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL but the image format is "
1365 << string_VkFormat(format) << " which is not a color format.";
1366 *error_msg = error_str.str();
1367 return false;
1368 }
1369 break;
1370 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
1371 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
1372 // Depth or stencil bit must be set, but both must NOT be set
Tobin Ehlisbbf3f912016-06-15 13:03:58 -06001373 if (aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) {
1374 if (aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) {
1375 // both must NOT be set
1376 std::stringstream error_str;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001377 error_str << "ImageView (" << image_view << ") has both STENCIL and DEPTH aspects set";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001378 *error_msg = error_str.str();
Tobin Ehlisbbf3f912016-06-15 13:03:58 -06001379 return false;
1380 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001381 } else if (!(aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
1382 // Neither were set
1383 std::stringstream error_str;
1384 error_str << "ImageView (" << image_view << ") has layout " << string_VkImageLayout(image_layout)
1385 << " but does not have STENCIL or DEPTH aspects set";
1386 *error_msg = error_str.str();
1387 return false;
Tobin Ehlisbbf3f912016-06-15 13:03:58 -06001388 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001389 // format must be DS
1390 if (!ds) {
1391 std::stringstream error_str;
1392 error_str << "ImageView (" << image_view << ") has layout " << string_VkImageLayout(image_layout)
1393 << " but the image format is " << string_VkFormat(format) << " which is not a depth/stencil format.";
1394 *error_msg = error_str.str();
1395 return false;
1396 }
1397 break;
1398 default:
1399 // For other layouts if the source is depth/stencil image, both aspect bits must not be set
1400 if (ds) {
1401 if (aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) {
1402 if (aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) {
1403 // both must NOT be set
1404 std::stringstream error_str;
1405 error_str << "ImageView (" << image_view << ") has layout " << string_VkImageLayout(image_layout)
1406 << " and is using depth/stencil image of format " << string_VkFormat(format)
1407 << " but it has both STENCIL and DEPTH aspects set, which is illegal. When using a depth/stencil "
1408 "image in a descriptor set, please only set either VK_IMAGE_ASPECT_DEPTH_BIT or "
1409 "VK_IMAGE_ASPECT_STENCIL_BIT depending on whether it will be used for depth reads or stencil "
1410 "reads respectively.";
1411 *error_msg = error_str.str();
1412 return false;
1413 }
1414 }
1415 }
1416 break;
Tobin Ehlis1809f912016-05-25 09:24:36 -06001417 }
1418 // Now validate that usage flags are correctly set for given type of update
Tobin Ehlisfb4cf712016-10-10 14:02:48 -06001419 // As we're switching per-type, if any type has specific layout requirements, check those here as well
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001420 // TODO : The various image usage bit requirements are in general spec language for VkImageUsageFlags bit block in 11.3 Images
1421 // under vkCreateImage()
Dave Houltond8ed0212018-05-16 17:18:24 -06001422 // TODO : Need to also validate case "VUID-VkWriteDescriptorSet-descriptorType-00336" where STORAGE_IMAGE & INPUT_ATTACH types
1423 // must have been created with identify swizzle
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06001424 const char *error_usage_bit = nullptr;
Tobin Ehlis1809f912016-05-25 09:24:36 -06001425 switch (type) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001426 case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
1427 case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER: {
1428 if (!(usage & VK_IMAGE_USAGE_SAMPLED_BIT)) {
1429 error_usage_bit = "VK_IMAGE_USAGE_SAMPLED_BIT";
1430 }
1431 break;
Tobin Ehlis1809f912016-05-25 09:24:36 -06001432 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001433 case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE: {
1434 if (!(usage & VK_IMAGE_USAGE_STORAGE_BIT)) {
1435 error_usage_bit = "VK_IMAGE_USAGE_STORAGE_BIT";
1436 } else if (VK_IMAGE_LAYOUT_GENERAL != image_layout) {
1437 std::stringstream error_str;
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001438 // TODO : Need to create custom enum error codes for these cases
1439 if (image_node->shared_presentable) {
1440 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != image_layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001441 error_str << "ImageView (" << image_view
1442 << ") of VK_DESCRIPTOR_TYPE_STORAGE_IMAGE type with a front-buffered image is being updated with "
1443 "layout "
1444 << string_VkImageLayout(image_layout)
1445 << " but according to spec section 13.1 Descriptor Types, 'Front-buffered images that report "
1446 "support for VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT must be in the "
1447 "VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR layout.'";
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001448 *error_msg = error_str.str();
1449 return false;
1450 }
1451 } else if (VK_IMAGE_LAYOUT_GENERAL != image_layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001452 error_str << "ImageView (" << image_view
1453 << ") of VK_DESCRIPTOR_TYPE_STORAGE_IMAGE type is being updated with layout "
1454 << string_VkImageLayout(image_layout)
1455 << " but according to spec section 13.1 Descriptor Types, 'Load and store operations on storage "
1456 "images can only be done on images in VK_IMAGE_LAYOUT_GENERAL layout.'";
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001457 *error_msg = error_str.str();
1458 return false;
1459 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001460 }
1461 break;
Tobin Ehlis1809f912016-05-25 09:24:36 -06001462 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001463 case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT: {
1464 if (!(usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) {
1465 error_usage_bit = "VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT";
1466 }
1467 break;
Tobin Ehlis1809f912016-05-25 09:24:36 -06001468 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001469 default:
1470 break;
Tobin Ehlis1809f912016-05-25 09:24:36 -06001471 }
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06001472 if (error_usage_bit) {
Tobin Ehlis1809f912016-05-25 09:24:36 -06001473 std::stringstream error_str;
1474 error_str << "ImageView (" << image_view << ") with usage mask 0x" << usage
1475 << " being used for a descriptor update of type " << string_VkDescriptorType(type) << " does not have "
1476 << error_usage_bit << " set.";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001477 *error_msg = error_str.str();
Tobin Ehlis1809f912016-05-25 09:24:36 -06001478 return false;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001479 }
John Zulauff4c07882019-01-24 14:03:36 -07001480
1481 if ((type == VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE) || (type == VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER)) {
1482 // Test that the layout is compatible with the descriptorType for the two sampled image types
1483 const static std::array<VkImageLayout, 3> valid_layouts = {
Jeremy Hayesd0549f62019-06-05 10:15:36 -06001484 {VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL, VK_IMAGE_LAYOUT_GENERAL}};
John Zulauff4c07882019-01-24 14:03:36 -07001485
1486 struct ExtensionLayout {
1487 VkImageLayout layout;
1488 bool DeviceExtensions::*extension;
1489 };
1490
1491 const static std::array<ExtensionLayout, 3> extended_layouts{
1492 {// Note double brace req'd for aggregate initialization
1493 {VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR, &DeviceExtensions::vk_khr_shared_presentable_image},
1494 {VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, &DeviceExtensions::vk_khr_maintenance2},
1495 {VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, &DeviceExtensions::vk_khr_maintenance2}}};
1496 auto is_layout = [image_layout, dev_data](const ExtensionLayout &ext_layout) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001497 return dev_data->device_extensions.*(ext_layout.extension) && (ext_layout.layout == image_layout);
John Zulauff4c07882019-01-24 14:03:36 -07001498 };
1499
1500 bool valid_layout = (std::find(valid_layouts.cbegin(), valid_layouts.cend(), image_layout) != valid_layouts.cend()) ||
1501 std::any_of(extended_layouts.cbegin(), extended_layouts.cend(), is_layout);
1502
1503 if (!valid_layout) {
1504 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-01403";
1505 std::stringstream error_str;
1506 error_str << "Descriptor update with descriptorType " << string_VkDescriptorType(type)
1507 << " is being updated with invalid imageLayout " << string_VkImageLayout(image_layout)
1508 << ". Allowed layouts are: VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
1509 << "VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL, VK_IMAGE_LAYOUT_GENERAL";
1510 for (auto &ext_layout : extended_layouts) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001511 if (dev_data->device_extensions.*(ext_layout.extension)) {
John Zulauff4c07882019-01-24 14:03:36 -07001512 error_str << ", " << string_VkImageLayout(ext_layout.layout);
1513 }
1514 }
1515 *error_msg = error_str.str();
1516 return false;
1517 }
1518 }
1519
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001520 return true;
1521}
Tobin Ehlis56a30942016-05-19 08:00:00 -06001522
Tobin Ehlis300888c2016-05-18 13:43:26 -06001523void cvdescriptorset::SamplerDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
Chris Forbesfea2c542018-04-13 09:34:15 -07001524 if (!immutable_) {
1525 sampler_ = update->pImageInfo[index].sampler;
1526 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001527 updated = true;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001528}
1529
Tobin Ehlis300888c2016-05-18 13:43:26 -06001530void cvdescriptorset::SamplerDescriptor::CopyUpdate(const Descriptor *src) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001531 if (!immutable_) {
1532 auto update_sampler = static_cast<const SamplerDescriptor *>(src)->sampler_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001533 sampler_ = update_sampler;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001534 }
1535 updated = true;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001536}
Tobin Ehlis56a30942016-05-19 08:00:00 -06001537
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001538void cvdescriptorset::SamplerDescriptor::UpdateDrawState(CoreChecks *dev_data, CMD_BUFFER_STATE *cb_node) {
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001539 if (!immutable_) {
Mark Lobodzinskif8d1ef92019-03-06 11:53:27 -07001540 auto sampler_state = dev_data->GetSamplerState(sampler_);
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001541 if (sampler_state) dev_data->AddCommandBufferBindingSampler(cb_node, sampler_state);
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001542 }
1543}
1544
Tobin Ehlis300888c2016-05-18 13:43:26 -06001545cvdescriptorset::ImageSamplerDescriptor::ImageSamplerDescriptor(const VkSampler *immut)
Chris Forbes9f340852017-05-09 08:51:38 -07001546 : sampler_(VK_NULL_HANDLE), immutable_(false), image_view_(VK_NULL_HANDLE), image_layout_(VK_IMAGE_LAYOUT_UNDEFINED) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001547 updated = false;
1548 descriptor_class = ImageSampler;
1549 if (immut) {
1550 sampler_ = *immut;
1551 immutable_ = true;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001552 }
1553}
Tobin Ehlis56a30942016-05-19 08:00:00 -06001554
Tobin Ehlis300888c2016-05-18 13:43:26 -06001555void cvdescriptorset::ImageSamplerDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001556 updated = true;
Tobin Ehlis56a30942016-05-19 08:00:00 -06001557 const auto &image_info = update->pImageInfo[index];
Chris Forbesfea2c542018-04-13 09:34:15 -07001558 if (!immutable_) {
1559 sampler_ = image_info.sampler;
1560 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06001561 image_view_ = image_info.imageView;
1562 image_layout_ = image_info.imageLayout;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001563}
1564
Tobin Ehlis300888c2016-05-18 13:43:26 -06001565void cvdescriptorset::ImageSamplerDescriptor::CopyUpdate(const Descriptor *src) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001566 if (!immutable_) {
1567 auto update_sampler = static_cast<const ImageSamplerDescriptor *>(src)->sampler_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001568 sampler_ = update_sampler;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001569 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001570 auto image_view = static_cast<const ImageSamplerDescriptor *>(src)->image_view_;
1571 auto image_layout = static_cast<const ImageSamplerDescriptor *>(src)->image_layout_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001572 updated = true;
1573 image_view_ = image_view;
1574 image_layout_ = image_layout;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001575}
1576
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001577void cvdescriptorset::ImageSamplerDescriptor::UpdateDrawState(CoreChecks *dev_data, CMD_BUFFER_STATE *cb_node) {
Tobin Ehlis81e46372016-08-17 13:33:44 -06001578 // First add binding for any non-immutable sampler
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001579 if (!immutable_) {
Mark Lobodzinskif8d1ef92019-03-06 11:53:27 -07001580 auto sampler_state = dev_data->GetSamplerState(sampler_);
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001581 if (sampler_state) dev_data->AddCommandBufferBindingSampler(cb_node, sampler_state);
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001582 }
Tobin Ehlis81e46372016-08-17 13:33:44 -06001583 // Add binding for image
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07001584 auto iv_state = dev_data->GetImageViewState(image_view_);
Tobin Ehlis8b26a382016-09-14 08:02:49 -06001585 if (iv_state) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001586 dev_data->AddCommandBufferBindingImageView(cb_node, iv_state);
John Zulauff660ad62019-03-23 07:16:05 -06001587 dev_data->SetImageViewInitialLayout(cb_node, *iv_state, image_layout_);
Jeff Bolz148d94e2018-12-13 21:25:56 -06001588 }
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001589}
1590
Tobin Ehlis300888c2016-05-18 13:43:26 -06001591cvdescriptorset::ImageDescriptor::ImageDescriptor(const VkDescriptorType type)
1592 : storage_(false), image_view_(VK_NULL_HANDLE), image_layout_(VK_IMAGE_LAYOUT_UNDEFINED) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001593 updated = false;
1594 descriptor_class = Image;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001595 if (VK_DESCRIPTOR_TYPE_STORAGE_IMAGE == type) storage_ = true;
Petr Kraus13c98a62017-12-09 00:22:39 +01001596}
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001597
Tobin Ehlis300888c2016-05-18 13:43:26 -06001598void cvdescriptorset::ImageDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001599 updated = true;
Tobin Ehlis56a30942016-05-19 08:00:00 -06001600 const auto &image_info = update->pImageInfo[index];
Tobin Ehlis300888c2016-05-18 13:43:26 -06001601 image_view_ = image_info.imageView;
1602 image_layout_ = image_info.imageLayout;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001603}
1604
Tobin Ehlis300888c2016-05-18 13:43:26 -06001605void cvdescriptorset::ImageDescriptor::CopyUpdate(const Descriptor *src) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001606 auto image_view = static_cast<const ImageDescriptor *>(src)->image_view_;
1607 auto image_layout = static_cast<const ImageDescriptor *>(src)->image_layout_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001608 updated = true;
1609 image_view_ = image_view;
1610 image_layout_ = image_layout;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001611}
1612
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001613void cvdescriptorset::ImageDescriptor::UpdateDrawState(CoreChecks *dev_data, CMD_BUFFER_STATE *cb_node) {
Tobin Ehlis81e46372016-08-17 13:33:44 -06001614 // Add binding for image
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07001615 auto iv_state = dev_data->GetImageViewState(image_view_);
Tobin Ehlis8b26a382016-09-14 08:02:49 -06001616 if (iv_state) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001617 dev_data->AddCommandBufferBindingImageView(cb_node, iv_state);
John Zulauff660ad62019-03-23 07:16:05 -06001618 dev_data->SetImageViewInitialLayout(cb_node, *iv_state, image_layout_);
Jeff Bolz148d94e2018-12-13 21:25:56 -06001619 }
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001620}
1621
Tobin Ehlis300888c2016-05-18 13:43:26 -06001622cvdescriptorset::BufferDescriptor::BufferDescriptor(const VkDescriptorType type)
1623 : storage_(false), dynamic_(false), buffer_(VK_NULL_HANDLE), offset_(0), range_(0) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001624 updated = false;
1625 descriptor_class = GeneralBuffer;
1626 if (VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC == type) {
1627 dynamic_ = true;
1628 } else if (VK_DESCRIPTOR_TYPE_STORAGE_BUFFER == type) {
1629 storage_ = true;
1630 } else if (VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC == type) {
1631 dynamic_ = true;
1632 storage_ = true;
1633 }
1634}
Tobin Ehlis300888c2016-05-18 13:43:26 -06001635void cvdescriptorset::BufferDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001636 updated = true;
Tobin Ehlis56a30942016-05-19 08:00:00 -06001637 const auto &buffer_info = update->pBufferInfo[index];
Tobin Ehlis300888c2016-05-18 13:43:26 -06001638 buffer_ = buffer_info.buffer;
1639 offset_ = buffer_info.offset;
1640 range_ = buffer_info.range;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001641}
1642
Tobin Ehlis300888c2016-05-18 13:43:26 -06001643void cvdescriptorset::BufferDescriptor::CopyUpdate(const Descriptor *src) {
1644 auto buff_desc = static_cast<const BufferDescriptor *>(src);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001645 updated = true;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001646 buffer_ = buff_desc->buffer_;
1647 offset_ = buff_desc->offset_;
1648 range_ = buff_desc->range_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001649}
1650
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001651void cvdescriptorset::BufferDescriptor::UpdateDrawState(CoreChecks *dev_data, CMD_BUFFER_STATE *cb_node) {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07001652 auto buffer_node = dev_data->GetBufferState(buffer_);
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001653 if (buffer_node) dev_data->AddCommandBufferBindingBuffer(cb_node, buffer_node);
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001654}
1655
Tobin Ehlis300888c2016-05-18 13:43:26 -06001656cvdescriptorset::TexelDescriptor::TexelDescriptor(const VkDescriptorType type) : buffer_view_(VK_NULL_HANDLE), storage_(false) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001657 updated = false;
1658 descriptor_class = TexelBuffer;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001659 if (VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER == type) storage_ = true;
Petr Kraus13c98a62017-12-09 00:22:39 +01001660}
Tobin Ehlis56a30942016-05-19 08:00:00 -06001661
Tobin Ehlis300888c2016-05-18 13:43:26 -06001662void cvdescriptorset::TexelDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001663 updated = true;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001664 buffer_view_ = update->pTexelBufferView[index];
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001665}
1666
Tobin Ehlis300888c2016-05-18 13:43:26 -06001667void cvdescriptorset::TexelDescriptor::CopyUpdate(const Descriptor *src) {
1668 updated = true;
1669 buffer_view_ = static_cast<const TexelDescriptor *>(src)->buffer_view_;
1670}
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001671
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001672void cvdescriptorset::TexelDescriptor::UpdateDrawState(CoreChecks *dev_data, CMD_BUFFER_STATE *cb_node) {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07001673 auto bv_state = dev_data->GetBufferViewState(buffer_view_);
Tobin Ehlis8b872462016-09-14 08:12:08 -06001674 if (bv_state) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001675 dev_data->AddCommandBufferBindingBufferView(cb_node, bv_state);
Tobin Ehlis81e46372016-08-17 13:33:44 -06001676 }
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001677}
1678
Tobin Ehlis300888c2016-05-18 13:43:26 -06001679// This is a helper function that iterates over a set of Write and Copy updates, pulls the DescriptorSet* for updated
1680// sets, and then calls their respective Validate[Write|Copy]Update functions.
1681// If the update hits an issue for which the callback returns "true", meaning that the call down the chain should
1682// be skipped, then true is returned.
1683// If there is no issue with the update, then false is returned.
Mark Lobodzinski3840ca02019-03-08 18:36:11 -07001684bool CoreChecks::ValidateUpdateDescriptorSets(uint32_t write_count, const VkWriteDescriptorSet *p_wds, uint32_t copy_count,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001685 const VkCopyDescriptorSet *p_cds, const char *func_name) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001686 bool skip = false;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001687 // Validate Write updates
Tobin Ehlis56a30942016-05-19 08:00:00 -06001688 for (uint32_t i = 0; i < write_count; i++) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001689 auto dest_set = p_wds[i].dstSet;
Mark Lobodzinskifc2f0d32019-03-06 11:25:39 -07001690 auto set_node = GetSetNode(dest_set);
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001691 if (!set_node) {
John Zulaufb45fdc32018-10-12 15:14:17 -06001692 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_EXT,
1693 HandleToUint64(dest_set), kVUID_Core_DrawState_InvalidDescriptorSet,
locke-lunarg9edc2812019-06-17 23:18:52 -06001694 "Cannot call %s on %s that has not been allocated.", func_name,
Lockeca0d9792019-03-03 23:48:13 -07001695 report_data->FormatHandle(dest_set).c_str());
Tobin Ehlis300888c2016-05-18 13:43:26 -06001696 } else {
Dave Houltond8ed0212018-05-16 17:18:24 -06001697 std::string error_code;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001698 std::string error_str;
John Zulauf613fd982019-06-04 15:14:41 -06001699 if (!ValidateWriteUpdate(set_node, report_data, &p_wds[i], func_name, &error_code, &error_str)) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001700 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_EXT,
locke-lunarg9edc2812019-06-17 23:18:52 -06001701 HandleToUint64(dest_set), error_code, "%s failed write update validation for %s with error: %s.",
1702 func_name, report_data->FormatHandle(dest_set).c_str(), error_str.c_str());
Tobin Ehlis300888c2016-05-18 13:43:26 -06001703 }
1704 }
1705 }
1706 // Now validate copy updates
Tobin Ehlis56a30942016-05-19 08:00:00 -06001707 for (uint32_t i = 0; i < copy_count; ++i) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001708 auto dst_set = p_cds[i].dstSet;
1709 auto src_set = p_cds[i].srcSet;
Mark Lobodzinskifc2f0d32019-03-06 11:25:39 -07001710 auto src_node = GetSetNode(src_set);
1711 auto dst_node = GetSetNode(dst_set);
Tobin Ehlisa1712752017-01-04 09:41:47 -07001712 // Object_tracker verifies that src & dest descriptor set are valid
1713 assert(src_node);
1714 assert(dst_node);
Dave Houltond8ed0212018-05-16 17:18:24 -06001715 std::string error_code;
Tobin Ehlisa1712752017-01-04 09:41:47 -07001716 std::string error_str;
John Zulaufd9435c32019-06-05 15:55:36 -06001717 if (!ValidateCopyUpdate(report_data, &p_cds[i], dst_node, src_node, func_name, &error_code, &error_str)) {
locke-lunarg9edc2812019-06-17 23:18:52 -06001718 skip |=
1719 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_EXT,
1720 HandleToUint64(dst_set), error_code, "%s failed copy update from %s to %s with error: %s.", func_name,
1721 report_data->FormatHandle(src_set).c_str(), report_data->FormatHandle(dst_set).c_str(), error_str.c_str());
Tobin Ehlis300888c2016-05-18 13:43:26 -06001722 }
1723 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001724 return skip;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001725}
1726// This is a helper function that iterates over a set of Write and Copy updates, pulls the DescriptorSet* for updated
1727// sets, and then calls their respective Perform[Write|Copy]Update functions.
1728// Prerequisite : ValidateUpdateDescriptorSets() should be called and return "false" prior to calling PerformUpdateDescriptorSets()
1729// with the same set of updates.
1730// This is split from the validate code to allow validation prior to calling down the chain, and then update after
1731// calling down the chain.
Mark Lobodzinski3840ca02019-03-08 18:36:11 -07001732void cvdescriptorset::PerformUpdateDescriptorSets(CoreChecks *dev_data, uint32_t write_count, const VkWriteDescriptorSet *p_wds,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001733 uint32_t copy_count, const VkCopyDescriptorSet *p_cds) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001734 // Write updates first
1735 uint32_t i = 0;
1736 for (i = 0; i < write_count; ++i) {
1737 auto dest_set = p_wds[i].dstSet;
Mark Lobodzinskifc2f0d32019-03-06 11:25:39 -07001738 auto set_node = dev_data->GetSetNode(dest_set);
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001739 if (set_node) {
1740 set_node->PerformWriteUpdate(&p_wds[i]);
Tobin Ehlis300888c2016-05-18 13:43:26 -06001741 }
1742 }
1743 // Now copy updates
1744 for (i = 0; i < copy_count; ++i) {
1745 auto dst_set = p_cds[i].dstSet;
1746 auto src_set = p_cds[i].srcSet;
Mark Lobodzinskifc2f0d32019-03-06 11:25:39 -07001747 auto src_node = dev_data->GetSetNode(src_set);
1748 auto dst_node = dev_data->GetSetNode(dst_set);
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001749 if (src_node && dst_node) {
1750 dst_node->PerformCopyUpdate(&p_cds[i], src_node);
Tobin Ehlis300888c2016-05-18 13:43:26 -06001751 }
1752 }
1753}
Mark Lobodzinski3d63a042017-03-09 16:24:13 -07001754
Mark Lobodzinski3840ca02019-03-08 18:36:11 -07001755cvdescriptorset::DecodedTemplateUpdate::DecodedTemplateUpdate(CoreChecks *device_data, VkDescriptorSet descriptorSet,
John Zulauf1d27e0a2018-11-05 10:12:48 -07001756 const TEMPLATE_STATE *template_state, const void *pData,
1757 VkDescriptorSetLayout push_layout) {
John Zulaufb845eb22018-10-12 11:41:06 -06001758 auto const &create_info = template_state->create_info;
1759 inline_infos.resize(create_info.descriptorUpdateEntryCount); // Make sure we have one if we need it
1760 desc_writes.reserve(create_info.descriptorUpdateEntryCount); // emplaced, so reserved without initialization
John Zulauf1d27e0a2018-11-05 10:12:48 -07001761 VkDescriptorSetLayout effective_dsl = create_info.templateType == VK_DESCRIPTOR_UPDATE_TEMPLATE_TYPE_DESCRIPTOR_SET
1762 ? create_info.descriptorSetLayout
1763 : push_layout;
1764 auto layout_obj = GetDescriptorSetLayout(device_data, effective_dsl);
Mark Lobodzinski3d63a042017-03-09 16:24:13 -07001765
1766 // Create a WriteDescriptorSet struct for each template update entry
1767 for (uint32_t i = 0; i < create_info.descriptorUpdateEntryCount; i++) {
1768 auto binding_count = layout_obj->GetDescriptorCountFromBinding(create_info.pDescriptorUpdateEntries[i].dstBinding);
1769 auto binding_being_updated = create_info.pDescriptorUpdateEntries[i].dstBinding;
1770 auto dst_array_element = create_info.pDescriptorUpdateEntries[i].dstArrayElement;
1771
John Zulaufb6d71202017-12-22 16:47:09 -07001772 desc_writes.reserve(desc_writes.size() + create_info.pDescriptorUpdateEntries[i].descriptorCount);
Mark Lobodzinski3d63a042017-03-09 16:24:13 -07001773 for (uint32_t j = 0; j < create_info.pDescriptorUpdateEntries[i].descriptorCount; j++) {
1774 desc_writes.emplace_back();
1775 auto &write_entry = desc_writes.back();
1776
1777 size_t offset = create_info.pDescriptorUpdateEntries[i].offset + j * create_info.pDescriptorUpdateEntries[i].stride;
1778 char *update_entry = (char *)(pData) + offset;
1779
1780 if (dst_array_element >= binding_count) {
1781 dst_array_element = 0;
Mark Lobodzinski4aa479d2017-03-10 09:14:00 -07001782 binding_being_updated = layout_obj->GetNextValidBinding(binding_being_updated);
Mark Lobodzinski3d63a042017-03-09 16:24:13 -07001783 }
1784
1785 write_entry.sType = VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET;
1786 write_entry.pNext = NULL;
1787 write_entry.dstSet = descriptorSet;
1788 write_entry.dstBinding = binding_being_updated;
1789 write_entry.dstArrayElement = dst_array_element;
1790 write_entry.descriptorCount = 1;
1791 write_entry.descriptorType = create_info.pDescriptorUpdateEntries[i].descriptorType;
1792
1793 switch (create_info.pDescriptorUpdateEntries[i].descriptorType) {
1794 case VK_DESCRIPTOR_TYPE_SAMPLER:
1795 case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER:
1796 case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
1797 case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE:
1798 case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT:
1799 write_entry.pImageInfo = reinterpret_cast<VkDescriptorImageInfo *>(update_entry);
1800 break;
1801
1802 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
1803 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
1804 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:
1805 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC:
1806 write_entry.pBufferInfo = reinterpret_cast<VkDescriptorBufferInfo *>(update_entry);
1807 break;
1808
1809 case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
1810 case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:
1811 write_entry.pTexelBufferView = reinterpret_cast<VkBufferView *>(update_entry);
1812 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -06001813 case VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT: {
1814 VkWriteDescriptorSetInlineUniformBlockEXT *inline_info = &inline_infos[i];
1815 inline_info->sType = VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET_INLINE_UNIFORM_BLOCK_EXT;
1816 inline_info->pNext = nullptr;
1817 inline_info->dataSize = create_info.pDescriptorUpdateEntries[i].descriptorCount;
1818 inline_info->pData = update_entry;
1819 write_entry.pNext = inline_info;
Ricardo Garciafee15732019-05-28 11:13:31 +02001820 // descriptorCount must match the dataSize member of the VkWriteDescriptorSetInlineUniformBlockEXT structure
1821 write_entry.descriptorCount = inline_info->dataSize;
Dave Houlton142c4cb2018-10-17 15:04:41 -06001822 // skip the rest of the array, they just represent bytes in the update
1823 j = create_info.pDescriptorUpdateEntries[i].descriptorCount;
1824 break;
1825 }
Mark Lobodzinski3d63a042017-03-09 16:24:13 -07001826 default:
1827 assert(0);
1828 break;
1829 }
1830 dst_array_element++;
1831 }
1832 }
John Zulaufb845eb22018-10-12 11:41:06 -06001833}
John Zulaufb45fdc32018-10-12 15:14:17 -06001834// These helper functions carry out the validate and record descriptor updates peformed via update templates. They decode
1835// the templatized data and leverage the non-template UpdateDescriptor helper functions.
Mark Lobodzinski3840ca02019-03-08 18:36:11 -07001836bool CoreChecks::ValidateUpdateDescriptorSetsWithTemplateKHR(VkDescriptorSet descriptorSet, const TEMPLATE_STATE *template_state,
1837 const void *pData) {
John Zulaufb45fdc32018-10-12 15:14:17 -06001838 // Translate the templated update into a normal update for validation...
Mark Lobodzinski3840ca02019-03-08 18:36:11 -07001839 cvdescriptorset::DecodedTemplateUpdate decoded_update(this, descriptorSet, template_state, pData);
1840 return ValidateUpdateDescriptorSets(static_cast<uint32_t>(decoded_update.desc_writes.size()), decoded_update.desc_writes.data(),
1841 0, NULL, "vkUpdateDescriptorSetWithTemplate()");
John Zulaufb45fdc32018-10-12 15:14:17 -06001842}
John Zulaufb845eb22018-10-12 11:41:06 -06001843
Mark Lobodzinski254c8512019-03-09 12:21:15 -07001844void CoreChecks::PerformUpdateDescriptorSetsWithTemplateKHR(VkDescriptorSet descriptorSet, const TEMPLATE_STATE *template_state,
1845 const void *pData) {
John Zulaufb45fdc32018-10-12 15:14:17 -06001846 // Translate the templated update into a normal update for validation...
Mark Lobodzinski254c8512019-03-09 12:21:15 -07001847 cvdescriptorset::DecodedTemplateUpdate decoded_update(this, descriptorSet, template_state, pData);
1848 cvdescriptorset::PerformUpdateDescriptorSets(this, static_cast<uint32_t>(decoded_update.desc_writes.size()),
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001849 decoded_update.desc_writes.data(), 0, NULL);
Mark Lobodzinski3d63a042017-03-09 16:24:13 -07001850}
John Zulauf4e7bcb52018-11-02 10:46:30 -06001851
1852std::string cvdescriptorset::DescriptorSet::StringifySetAndLayout() const {
1853 std::string out;
1854 uint64_t layout_handle = HandleToUint64(p_layout_->GetDescriptorSetLayout());
1855 if (IsPushDescriptor()) {
1856 string_sprintf(&out, "Push Descriptors defined with VkDescriptorSetLayout 0x%" PRIxLEAST64, layout_handle);
John Zulauf4e7bcb52018-11-02 10:46:30 -06001857 } else {
Bob Ellisonaf2f8532019-03-12 11:05:47 -06001858 string_sprintf(&out, "VkDescriptorSet 0x%" PRIxLEAST64 " allocated with VkDescriptorSetLayout 0x%" PRIxLEAST64,
John Zulauf4e7bcb52018-11-02 10:46:30 -06001859 HandleToUint64(set_), layout_handle);
1860 }
1861 return out;
1862};
1863
John Zulauf1d27e0a2018-11-05 10:12:48 -07001864// Loop through the write updates to validate for a push descriptor set, ignoring dstSet
John Zulaufd9435c32019-06-05 15:55:36 -06001865bool cvdescriptorset::ValidatePushDescriptorsUpdate(const DescriptorSet *push_set, const debug_report_data *report_data,
1866 uint32_t write_count, const VkWriteDescriptorSet *p_wds,
1867 const char *func_name) {
1868 assert(push_set->IsPushDescriptor());
John Zulauf1d27e0a2018-11-05 10:12:48 -07001869 bool skip = false;
1870 for (uint32_t i = 0; i < write_count; i++) {
1871 std::string error_code;
1872 std::string error_str;
John Zulaufd9435c32019-06-05 15:55:36 -06001873 if (!ValidateWriteUpdate(push_set, report_data, &p_wds[i], func_name, &error_code, &error_str)) {
John Zulauf1d27e0a2018-11-05 10:12:48 -07001874 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_LAYOUT_EXT,
John Zulaufd9435c32019-06-05 15:55:36 -06001875 HandleToUint64(push_set->GetDescriptorSetLayout()), error_code, "%s failed update validation: %s.",
John Zulauf1d27e0a2018-11-05 10:12:48 -07001876 func_name, error_str.c_str());
1877 }
1878 }
1879 return skip;
1880}
1881
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001882// For the given buffer, verify that its creation parameters are appropriate for the given type
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001883// If there's an error, update the error_msg string with details and return false, else return true
John Zulaufd9435c32019-06-05 15:55:36 -06001884bool cvdescriptorset::ValidateBufferUsage(BUFFER_STATE const *buffer_node, VkDescriptorType type, std::string *error_code,
1885 std::string *error_msg) {
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001886 // Verify that usage bits set correctly for given type
Tobin Ehlis94bc5d22016-06-02 07:46:52 -06001887 auto usage = buffer_node->createInfo.usage;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06001888 const char *error_usage_bit = nullptr;
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001889 switch (type) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001890 case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
1891 if (!(usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001892 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00334";
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001893 error_usage_bit = "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT";
1894 }
1895 break;
1896 case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:
1897 if (!(usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001898 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00335";
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001899 error_usage_bit = "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT";
1900 }
1901 break;
1902 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
1903 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:
1904 if (!(usage & VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001905 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00330";
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001906 error_usage_bit = "VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT";
1907 }
1908 break;
1909 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
1910 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC:
1911 if (!(usage & VK_BUFFER_USAGE_STORAGE_BUFFER_BIT)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001912 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00331";
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001913 error_usage_bit = "VK_BUFFER_USAGE_STORAGE_BUFFER_BIT";
1914 }
1915 break;
1916 default:
1917 break;
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001918 }
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06001919 if (error_usage_bit) {
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001920 std::stringstream error_str;
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001921 error_str << "Buffer (" << buffer_node->buffer << ") with usage mask 0x" << usage
1922 << " being used for a descriptor update of type " << string_VkDescriptorType(type) << " does not have "
1923 << error_usage_bit << " set.";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001924 *error_msg = error_str.str();
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001925 return false;
1926 }
1927 return true;
1928}
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001929// For buffer descriptor updates, verify the buffer usage and VkDescriptorBufferInfo struct which includes:
1930// 1. buffer is valid
1931// 2. buffer was created with correct usage flags
1932// 3. offset is less than buffer size
1933// 4. range is either VK_WHOLE_SIZE or falls in (0, (buffer size - offset)]
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -07001934// 5. range and offset are within the device's limits
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001935// If there's an error, update the error_msg string with details and return false, else return true
John Zulaufd9435c32019-06-05 15:55:36 -06001936bool cvdescriptorset::ValidateBufferUpdate(CoreChecks *device_data, VkDescriptorBufferInfo const *buffer_info,
1937 VkDescriptorType type, const char *func_name, std::string *error_code,
1938 std::string *error_msg) {
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001939 // First make sure that buffer is valid
John Zulaufd9435c32019-06-05 15:55:36 -06001940 auto buffer_node = device_data->GetBufferState(buffer_info->buffer);
Tobin Ehlisfa8b6182016-12-22 13:40:45 -07001941 // Any invalid buffer should already be caught by object_tracker
1942 assert(buffer_node);
John Zulaufd9435c32019-06-05 15:55:36 -06001943 if (device_data->ValidateMemoryIsBoundToBuffer(buffer_node, func_name, "VUID-VkWriteDescriptorSet-descriptorType-00329")) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001944 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00329";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001945 *error_msg = "No memory bound to buffer.";
Tobin Ehlis81280962016-07-20 14:04:20 -06001946 return false;
Tobin Ehlisfed999f2016-09-21 15:09:45 -06001947 }
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001948 // Verify usage bits
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001949 if (!ValidateBufferUsage(buffer_node, type, error_code, error_msg)) {
1950 // error_msg will have been updated by ValidateBufferUsage()
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001951 return false;
1952 }
1953 // offset must be less than buffer size
Jeremy Hayesd1a6a822017-03-09 14:39:45 -07001954 if (buffer_info->offset >= buffer_node->createInfo.size) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001955 *error_code = "VUID-VkDescriptorBufferInfo-offset-00340";
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001956 std::stringstream error_str;
Jeremy Hayesd1a6a822017-03-09 14:39:45 -07001957 error_str << "VkDescriptorBufferInfo offset of " << buffer_info->offset << " is greater than or equal to buffer "
1958 << buffer_node->buffer << " size of " << buffer_node->createInfo.size;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001959 *error_msg = error_str.str();
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001960 return false;
1961 }
1962 if (buffer_info->range != VK_WHOLE_SIZE) {
1963 // Range must be VK_WHOLE_SIZE or > 0
1964 if (!buffer_info->range) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001965 *error_code = "VUID-VkDescriptorBufferInfo-range-00341";
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001966 std::stringstream error_str;
1967 error_str << "VkDescriptorBufferInfo range is not VK_WHOLE_SIZE and is zero, which is not allowed.";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001968 *error_msg = error_str.str();
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001969 return false;
1970 }
1971 // Range must be VK_WHOLE_SIZE or <= (buffer size - offset)
1972 if (buffer_info->range > (buffer_node->createInfo.size - buffer_info->offset)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001973 *error_code = "VUID-VkDescriptorBufferInfo-range-00342";
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001974 std::stringstream error_str;
1975 error_str << "VkDescriptorBufferInfo range is " << buffer_info->range << " which is greater than buffer size ("
1976 << buffer_node->createInfo.size << ") minus requested offset of " << buffer_info->offset;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001977 *error_msg = error_str.str();
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001978 return false;
1979 }
1980 }
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -07001981 // Check buffer update sizes against device limits
John Zulaufd9435c32019-06-05 15:55:36 -06001982 const auto &limits = device_data->phys_dev_props.limits;
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -07001983 if (VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER == type || VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC == type) {
John Zulaufd9435c32019-06-05 15:55:36 -06001984 auto max_ub_range = limits.maxUniformBufferRange;
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -07001985 if (buffer_info->range != VK_WHOLE_SIZE && buffer_info->range > max_ub_range) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001986 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00332";
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -07001987 std::stringstream error_str;
1988 error_str << "VkDescriptorBufferInfo range is " << buffer_info->range
1989 << " which is greater than this device's maxUniformBufferRange (" << max_ub_range << ")";
1990 *error_msg = error_str.str();
1991 return false;
Peter Kohaut2794a292018-07-13 11:13:47 +02001992 } else if (buffer_info->range == VK_WHOLE_SIZE && (buffer_node->createInfo.size - buffer_info->offset) > max_ub_range) {
1993 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00332";
1994 std::stringstream error_str;
Peter Kohaut18f413d2018-07-16 13:15:42 +02001995 error_str << "VkDescriptorBufferInfo range is VK_WHOLE_SIZE but effective range "
1996 << "(" << (buffer_node->createInfo.size - buffer_info->offset) << ") is greater than this device's "
Peter Kohaut2794a292018-07-13 11:13:47 +02001997 << "maxUniformBufferRange (" << max_ub_range << ")";
1998 *error_msg = error_str.str();
1999 return false;
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -07002000 }
2001 } else if (VK_DESCRIPTOR_TYPE_STORAGE_BUFFER == type || VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC == type) {
John Zulaufd9435c32019-06-05 15:55:36 -06002002 auto max_sb_range = limits.maxStorageBufferRange;
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -07002003 if (buffer_info->range != VK_WHOLE_SIZE && buffer_info->range > max_sb_range) {
Dave Houlton00c154e2018-05-24 13:20:50 -06002004 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00333";
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -07002005 std::stringstream error_str;
2006 error_str << "VkDescriptorBufferInfo range is " << buffer_info->range
2007 << " which is greater than this device's maxStorageBufferRange (" << max_sb_range << ")";
2008 *error_msg = error_str.str();
2009 return false;
Peter Kohaut2794a292018-07-13 11:13:47 +02002010 } else if (buffer_info->range == VK_WHOLE_SIZE && (buffer_node->createInfo.size - buffer_info->offset) > max_sb_range) {
2011 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00333";
2012 std::stringstream error_str;
Peter Kohaut18f413d2018-07-16 13:15:42 +02002013 error_str << "VkDescriptorBufferInfo range is VK_WHOLE_SIZE but effective range "
2014 << "(" << (buffer_node->createInfo.size - buffer_info->offset) << ") is greater than this device's "
Peter Kohaut2794a292018-07-13 11:13:47 +02002015 << "maxStorageBufferRange (" << max_sb_range << ")";
2016 *error_msg = error_str.str();
2017 return false;
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -07002018 }
2019 }
Tobin Ehlis3d38f082016-07-01 17:36:48 -06002020 return true;
2021}
Tobin Ehlis300888c2016-05-18 13:43:26 -06002022// Verify that the contents of the update are ok, but don't perform actual update
John Zulaufd9435c32019-06-05 15:55:36 -06002023bool cvdescriptorset::VerifyCopyUpdateContents(CoreChecks *device_data, const VkCopyDescriptorSet *update,
2024 const DescriptorSet *src_set, VkDescriptorType type, uint32_t index,
2025 const char *func_name, std::string *error_code, std::string *error_msg) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06002026 // Note : Repurposing some Write update error codes here as specific details aren't called out for copy updates like they are
2027 // for write updates
John Zulaufd9435c32019-06-05 15:55:36 -06002028 switch (src_set->GetDescriptorFromGlobalIndex(index)->descriptor_class) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002029 case PlainSampler: {
2030 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
John Zulaufd9435c32019-06-05 15:55:36 -06002031 const auto src_desc = src_set->GetDescriptorFromGlobalIndex(index + di);
Józef Kucia5297e372017-10-13 22:31:34 +02002032 if (!src_desc->updated) continue;
2033 if (!src_desc->IsImmutableSampler()) {
John Zulaufd9435c32019-06-05 15:55:36 -06002034 auto update_sampler = static_cast<const SamplerDescriptor *>(src_desc)->GetSampler();
2035 if (!ValidateSampler(update_sampler, device_data)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06002036 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00325";
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002037 std::stringstream error_str;
2038 error_str << "Attempted copy update to sampler descriptor with invalid sampler: " << update_sampler << ".";
2039 *error_msg = error_str.str();
2040 return false;
2041 }
2042 } else {
2043 // TODO : Warn here
2044 }
2045 }
2046 break;
2047 }
2048 case ImageSampler: {
2049 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
John Zulaufd9435c32019-06-05 15:55:36 -06002050 const auto src_desc = src_set->GetDescriptorFromGlobalIndex(index + di);
Józef Kucia5297e372017-10-13 22:31:34 +02002051 if (!src_desc->updated) continue;
2052 auto img_samp_desc = static_cast<const ImageSamplerDescriptor *>(src_desc);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002053 // First validate sampler
2054 if (!img_samp_desc->IsImmutableSampler()) {
2055 auto update_sampler = img_samp_desc->GetSampler();
John Zulaufd9435c32019-06-05 15:55:36 -06002056 if (!ValidateSampler(update_sampler, device_data)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06002057 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00325";
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002058 std::stringstream error_str;
2059 error_str << "Attempted copy update to sampler descriptor with invalid sampler: " << update_sampler << ".";
2060 *error_msg = error_str.str();
2061 return false;
2062 }
2063 } else {
2064 // TODO : Warn here
2065 }
2066 // Validate image
2067 auto image_view = img_samp_desc->GetImageView();
2068 auto image_layout = img_samp_desc->GetImageLayout();
John Zulaufd9435c32019-06-05 15:55:36 -06002069 if (!ValidateImageUpdate(image_view, image_layout, type, device_data, func_name, error_code, error_msg)) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06002070 std::stringstream error_str;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002071 error_str << "Attempted copy update to combined image sampler descriptor failed due to: " << error_msg->c_str();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06002072 *error_msg = error_str.str();
Tobin Ehlis300888c2016-05-18 13:43:26 -06002073 return false;
2074 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06002075 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002076 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06002077 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002078 case Image: {
2079 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
John Zulaufd9435c32019-06-05 15:55:36 -06002080 const auto src_desc = src_set->GetDescriptorFromGlobalIndex(index + di);
Józef Kucia5297e372017-10-13 22:31:34 +02002081 if (!src_desc->updated) continue;
2082 auto img_desc = static_cast<const ImageDescriptor *>(src_desc);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002083 auto image_view = img_desc->GetImageView();
2084 auto image_layout = img_desc->GetImageLayout();
John Zulaufd9435c32019-06-05 15:55:36 -06002085 if (!ValidateImageUpdate(image_view, image_layout, type, device_data, func_name, error_code, error_msg)) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06002086 std::stringstream error_str;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002087 error_str << "Attempted copy update to image descriptor failed due to: " << error_msg->c_str();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06002088 *error_msg = error_str.str();
Tobin Ehlis300888c2016-05-18 13:43:26 -06002089 return false;
2090 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06002091 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002092 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06002093 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002094 case TexelBuffer: {
2095 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
John Zulaufd9435c32019-06-05 15:55:36 -06002096 const auto src_desc = src_set->GetDescriptorFromGlobalIndex(index + di);
Józef Kucia5297e372017-10-13 22:31:34 +02002097 if (!src_desc->updated) continue;
John Zulaufd9435c32019-06-05 15:55:36 -06002098 auto buffer_view = static_cast<const TexelDescriptor *>(src_desc)->GetBufferView();
2099 auto bv_state = device_data->GetBufferViewState(buffer_view);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002100 if (!bv_state) {
Dave Houlton00c154e2018-05-24 13:20:50 -06002101 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00323";
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002102 std::stringstream error_str;
2103 error_str << "Attempted copy update to texel buffer descriptor with invalid buffer view: " << buffer_view;
2104 *error_msg = error_str.str();
2105 return false;
2106 }
2107 auto buffer = bv_state->create_info.buffer;
John Zulaufd9435c32019-06-05 15:55:36 -06002108 if (!ValidateBufferUsage(device_data->GetBufferState(buffer), type, error_code, error_msg)) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002109 std::stringstream error_str;
2110 error_str << "Attempted copy update to texel buffer descriptor failed due to: " << error_msg->c_str();
2111 *error_msg = error_str.str();
2112 return false;
2113 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06002114 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002115 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06002116 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002117 case GeneralBuffer: {
2118 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
John Zulaufd9435c32019-06-05 15:55:36 -06002119 const auto src_desc = src_set->GetDescriptorFromGlobalIndex(index + di);
Józef Kucia5297e372017-10-13 22:31:34 +02002120 if (!src_desc->updated) continue;
John Zulaufd9435c32019-06-05 15:55:36 -06002121 auto buffer = static_cast<const BufferDescriptor *>(src_desc)->GetBuffer();
2122 if (!ValidateBufferUsage(device_data->GetBufferState(buffer), type, error_code, error_msg)) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002123 std::stringstream error_str;
2124 error_str << "Attempted copy update to buffer descriptor failed due to: " << error_msg->c_str();
2125 *error_msg = error_str.str();
2126 return false;
2127 }
Tobin Ehliscbcf2342016-05-24 13:07:12 -06002128 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002129 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06002130 }
Jeff Bolze54ae892018-09-08 12:16:29 -05002131 case InlineUniform:
Jeff Bolzfbe51582018-09-13 10:01:35 -05002132 case AccelerationStructure:
Jeff Bolze54ae892018-09-08 12:16:29 -05002133 break;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002134 default:
2135 assert(0); // We've already verified update type so should never get here
2136 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06002137 }
2138 // All checks passed so update contents are good
2139 return true;
Chris Forbesb4e0bdb2016-05-31 16:34:40 +12002140}
Tobin Ehlisf320b192017-03-14 11:22:50 -06002141// Update the common AllocateDescriptorSetsData
Mark Lobodzinski3840ca02019-03-08 18:36:11 -07002142void CoreChecks::UpdateAllocateDescriptorSetsData(const VkDescriptorSetAllocateInfo *p_alloc_info,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002143 cvdescriptorset::AllocateDescriptorSetsData *ds_data) {
Tobin Ehlisf320b192017-03-14 11:22:50 -06002144 for (uint32_t i = 0; i < p_alloc_info->descriptorSetCount; i++) {
Mark Lobodzinski3840ca02019-03-08 18:36:11 -07002145 auto layout = GetDescriptorSetLayout(this, p_alloc_info->pSetLayouts[i]);
Tobin Ehlisf320b192017-03-14 11:22:50 -06002146 if (layout) {
2147 ds_data->layout_nodes[i] = layout;
2148 // Count total descriptors required per type
2149 for (uint32_t j = 0; j < layout->GetBindingCount(); ++j) {
2150 const auto &binding_layout = layout->GetDescriptorSetLayoutBindingPtrFromIndex(j);
2151 uint32_t typeIndex = static_cast<uint32_t>(binding_layout->descriptorType);
2152 ds_data->required_descriptors_by_type[typeIndex] += binding_layout->descriptorCount;
2153 }
2154 }
2155 // Any unknown layouts will be flagged as errors during ValidateAllocateDescriptorSets() call
2156 }
Petr Kraus13c98a62017-12-09 00:22:39 +01002157}
Tobin Ehlisee471462016-05-26 11:21:59 -06002158// Verify that the state at allocate time is correct, but don't actually allocate the sets yet
Mark Lobodzinski3840ca02019-03-08 18:36:11 -07002159bool CoreChecks::ValidateAllocateDescriptorSets(const VkDescriptorSetAllocateInfo *p_alloc_info,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002160 const cvdescriptorset::AllocateDescriptorSetsData *ds_data) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002161 bool skip = false;
Mark Lobodzinski7804bd42019-03-06 11:28:48 -07002162 auto pool_state = GetDescriptorPoolState(p_alloc_info->descriptorPool);
Tobin Ehlisee471462016-05-26 11:21:59 -06002163
2164 for (uint32_t i = 0; i < p_alloc_info->descriptorSetCount; i++) {
Mark Lobodzinski3840ca02019-03-08 18:36:11 -07002165 auto layout = GetDescriptorSetLayout(this, p_alloc_info->pSetLayouts[i]);
John Zulauf5562d062018-01-24 11:54:05 -07002166 if (layout) { // nullptr layout indicates no valid layout handle for this device, validated/logged in object_tracker
John Zulauf1d27e0a2018-11-05 10:12:48 -07002167 if (layout->IsPushDescriptor()) {
John Zulauf5562d062018-01-24 11:54:05 -07002168 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_LAYOUT_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002169 HandleToUint64(p_alloc_info->pSetLayouts[i]), "VUID-VkDescriptorSetAllocateInfo-pSetLayouts-00308",
locke-lunarg9edc2812019-06-17 23:18:52 -06002170 "%s specified at pSetLayouts[%" PRIu32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002171 "] in vkAllocateDescriptorSets() was created with invalid flag %s set.",
Lockeca0d9792019-03-03 23:48:13 -07002172 report_data->FormatHandle(p_alloc_info->pSetLayouts[i]).c_str(), i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002173 "VK_DESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT_KHR");
John Zulauf5562d062018-01-24 11:54:05 -07002174 }
Jeff Bolzfdf96072018-04-10 14:32:18 -05002175 if (layout->GetCreateFlags() & VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT &&
2176 !(pool_state->createInfo.flags & VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT)) {
2177 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_LAYOUT_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002178 0, "VUID-VkDescriptorSetAllocateInfo-pSetLayouts-03044",
Jeff Bolzfdf96072018-04-10 14:32:18 -05002179 "Descriptor set layout create flags and pool create flags mismatch for index (%d)", i);
2180 }
Tobin Ehlisee471462016-05-26 11:21:59 -06002181 }
2182 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002183 if (!device_extensions.vk_khr_maintenance1) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002184 // Track number of descriptorSets allowable in this pool
2185 if (pool_state->availableSets < p_alloc_info->descriptorSetCount) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002186 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_POOL_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002187 HandleToUint64(pool_state->pool), "VUID-VkDescriptorSetAllocateInfo-descriptorSetCount-00306",
locke-lunarg9edc2812019-06-17 23:18:52 -06002188 "Unable to allocate %u descriptorSets from %s"
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002189 ". This pool only has %d descriptorSets remaining.",
Lockeca0d9792019-03-03 23:48:13 -07002190 p_alloc_info->descriptorSetCount, report_data->FormatHandle(pool_state->pool).c_str(),
2191 pool_state->availableSets);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002192 }
2193 // Determine whether descriptor counts are satisfiable
Jeff Bolze54ae892018-09-08 12:16:29 -05002194 for (auto it = ds_data->required_descriptors_by_type.begin(); it != ds_data->required_descriptors_by_type.end(); ++it) {
2195 if (ds_data->required_descriptors_by_type.at(it->first) > pool_state->availableDescriptorTypeCount[it->first]) {
Lockeca0d9792019-03-03 23:48:13 -07002196 skip |= log_msg(
2197 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_POOL_EXT,
2198 HandleToUint64(pool_state->pool), "VUID-VkDescriptorSetAllocateInfo-descriptorPool-00307",
locke-lunarg9edc2812019-06-17 23:18:52 -06002199 "Unable to allocate %u descriptors of type %s from %s"
Lockeca0d9792019-03-03 23:48:13 -07002200 ". This pool only has %d descriptors of this type remaining.",
2201 ds_data->required_descriptors_by_type.at(it->first), string_VkDescriptorType(VkDescriptorType(it->first)),
2202 report_data->FormatHandle(pool_state->pool).c_str(), pool_state->availableDescriptorTypeCount[it->first]);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002203 }
Tobin Ehlisee471462016-05-26 11:21:59 -06002204 }
2205 }
Tobin Ehlis5d749ea2016-07-18 13:14:01 -06002206
Jeff Bolzfdf96072018-04-10 14:32:18 -05002207 const auto *count_allocate_info = lvl_find_in_chain<VkDescriptorSetVariableDescriptorCountAllocateInfoEXT>(p_alloc_info->pNext);
2208
2209 if (count_allocate_info) {
2210 if (count_allocate_info->descriptorSetCount != 0 &&
2211 count_allocate_info->descriptorSetCount != p_alloc_info->descriptorSetCount) {
2212 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_LAYOUT_EXT, 0,
Dave Houltond8ed0212018-05-16 17:18:24 -06002213 "VUID-VkDescriptorSetVariableDescriptorCountAllocateInfoEXT-descriptorSetCount-03045",
Jeff Bolzfdf96072018-04-10 14:32:18 -05002214 "VkDescriptorSetAllocateInfo::descriptorSetCount (%d) != "
2215 "VkDescriptorSetVariableDescriptorCountAllocateInfoEXT::descriptorSetCount (%d)",
2216 p_alloc_info->descriptorSetCount, count_allocate_info->descriptorSetCount);
2217 }
2218 if (count_allocate_info->descriptorSetCount == p_alloc_info->descriptorSetCount) {
2219 for (uint32_t i = 0; i < p_alloc_info->descriptorSetCount; i++) {
Mark Lobodzinski3840ca02019-03-08 18:36:11 -07002220 auto layout = GetDescriptorSetLayout(this, p_alloc_info->pSetLayouts[i]);
Jeff Bolzfdf96072018-04-10 14:32:18 -05002221 if (count_allocate_info->pDescriptorCounts[i] > layout->GetDescriptorCountFromBinding(layout->GetMaxBinding())) {
2222 skip |= log_msg(
2223 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_LAYOUT_EXT, 0,
Dave Houltond8ed0212018-05-16 17:18:24 -06002224 "VUID-VkDescriptorSetVariableDescriptorCountAllocateInfoEXT-pSetLayouts-03046",
2225 "pDescriptorCounts[%d] = (%d), binding's descriptorCount = (%d)", i,
Jeff Bolzfdf96072018-04-10 14:32:18 -05002226 count_allocate_info->pDescriptorCounts[i], layout->GetDescriptorCountFromBinding(layout->GetMaxBinding()));
2227 }
2228 }
2229 }
2230 }
2231
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002232 return skip;
Tobin Ehlisee471462016-05-26 11:21:59 -06002233}
2234// Decrement allocated sets from the pool and insert new sets into set_map
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002235void CoreChecks::PerformAllocateDescriptorSets(const VkDescriptorSetAllocateInfo *p_alloc_info,
2236 const VkDescriptorSet *descriptor_sets,
Mark Lobodzinskia33af952019-04-25 14:59:05 -06002237 const cvdescriptorset::AllocateDescriptorSetsData *ds_data) {
2238 auto pool_state = descriptorPoolMap[p_alloc_info->descriptorPool].get();
Mark Lobodzinskic9430182017-06-13 13:00:05 -06002239 // Account for sets and individual descriptors allocated from pool
Tobin Ehlisee471462016-05-26 11:21:59 -06002240 pool_state->availableSets -= p_alloc_info->descriptorSetCount;
Jeff Bolze54ae892018-09-08 12:16:29 -05002241 for (auto it = ds_data->required_descriptors_by_type.begin(); it != ds_data->required_descriptors_by_type.end(); ++it) {
2242 pool_state->availableDescriptorTypeCount[it->first] -= ds_data->required_descriptors_by_type.at(it->first);
Tobin Ehlis68d0adf2016-06-01 11:33:50 -06002243 }
Jeff Bolzfdf96072018-04-10 14:32:18 -05002244
2245 const auto *variable_count_info = lvl_find_in_chain<VkDescriptorSetVariableDescriptorCountAllocateInfoEXT>(p_alloc_info->pNext);
2246 bool variable_count_valid = variable_count_info && variable_count_info->descriptorSetCount == p_alloc_info->descriptorSetCount;
2247
Mark Lobodzinskic9430182017-06-13 13:00:05 -06002248 // Create tracking object for each descriptor set; insert into global map and the pool's set.
Tobin Ehlisee471462016-05-26 11:21:59 -06002249 for (uint32_t i = 0; i < p_alloc_info->descriptorSetCount; i++) {
Jeff Bolzfdf96072018-04-10 14:32:18 -05002250 uint32_t variable_count = variable_count_valid ? variable_count_info->pDescriptorCounts[i] : 0;
2251
Mark Lobodzinski14112ab2019-04-25 15:29:34 -06002252 std::unique_ptr<cvdescriptorset::DescriptorSet> new_ds(new cvdescriptorset::DescriptorSet(
2253 descriptor_sets[i], p_alloc_info->descriptorPool, ds_data->layout_nodes[i], variable_count, this));
2254 pool_state->sets.insert(new_ds.get());
Tobin Ehlisee471462016-05-26 11:21:59 -06002255 new_ds->in_use.store(0);
Mark Lobodzinski14112ab2019-04-25 15:29:34 -06002256 setMap[descriptor_sets[i]] = std::move(new_ds);
Tobin Ehlisee471462016-05-26 11:21:59 -06002257 }
2258}
John Zulauf48a6a702017-12-22 17:14:54 -07002259
2260cvdescriptorset::PrefilterBindRequestMap::PrefilterBindRequestMap(cvdescriptorset::DescriptorSet &ds, const BindingReqMap &in_map,
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002261 CMD_BUFFER_STATE *cb_state)
John Zulauf48a6a702017-12-22 17:14:54 -07002262 : filtered_map_(), orig_map_(in_map) {
2263 if (ds.GetTotalDescriptorCount() > kManyDescriptors_) {
2264 filtered_map_.reset(new std::map<uint32_t, descriptor_req>());
2265 ds.FilterAndTrackBindingReqs(cb_state, orig_map_, filtered_map_.get());
2266 }
2267}
2268cvdescriptorset::PrefilterBindRequestMap::PrefilterBindRequestMap(cvdescriptorset::DescriptorSet &ds, const BindingReqMap &in_map,
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002269 CMD_BUFFER_STATE *cb_state, PIPELINE_STATE *pipeline)
John Zulauf48a6a702017-12-22 17:14:54 -07002270 : filtered_map_(), orig_map_(in_map) {
2271 if (ds.GetTotalDescriptorCount() > kManyDescriptors_) {
2272 filtered_map_.reset(new std::map<uint32_t, descriptor_req>());
2273 ds.FilterAndTrackBindingReqs(cb_state, pipeline, orig_map_, filtered_map_.get());
2274 }
Artem Kharytoniuk2456f992018-01-12 14:17:41 +01002275}
John Zulauf4a015c92019-06-04 09:50:05 -06002276
2277// Starting at offset descriptor of given binding, parse over update_count
2278// descriptor updates and verify that for any binding boundaries that are crossed, the next binding(s) are all consistent
2279// Consistency means that their type, stage flags, and whether or not they use immutable samplers matches
2280// If so, return true. If not, fill in error_msg and return false
2281bool cvdescriptorset::VerifyUpdateConsistency(DescriptorSetLayout::ConstBindingIterator current_binding, uint32_t offset,
2282 uint32_t update_count, const char *type, const VkDescriptorSet set,
2283 std::string *error_msg) {
2284 // Verify consecutive bindings match (if needed)
2285 auto orig_binding = current_binding;
2286 // Track count of descriptors in the current_bindings that are remaining to be updated
2287 auto binding_remaining = current_binding.GetDescriptorCount();
2288 // First, it's legal to offset beyond your own binding so handle that case
2289 // Really this is just searching for the binding in which the update begins and adjusting offset accordingly
2290 while (offset >= binding_remaining && !current_binding.AtEnd()) {
2291 // Advance to next binding, decrement offset by binding size
2292 offset -= binding_remaining;
2293 ++current_binding;
2294 binding_remaining = current_binding.GetDescriptorCount(); // Accessors are safe if AtEnd
2295 }
2296 assert(!current_binding.AtEnd()); // As written assumes range check has been made before calling
2297 binding_remaining -= offset;
2298 while (update_count > binding_remaining) { // While our updates overstep current binding
2299 // Verify next consecutive binding matches type, stage flags & immutable sampler use
2300 auto next_binding = current_binding.Next();
2301 if (!current_binding.IsConsistent(next_binding)) {
2302 std::stringstream error_str;
2303 error_str << "Attempting " << type;
2304 if (current_binding.Layout()->IsPushDescriptor()) {
2305 error_str << " push descriptors";
2306 } else {
2307 error_str << " descriptor set " << set;
2308 }
2309 error_str << " binding #" << orig_binding.Binding() << " with #" << update_count
2310 << " descriptors being updated but this update oversteps the bounds of this binding and the next binding is "
2311 "not consistent with current binding so this update is invalid.";
2312 *error_msg = error_str.str();
2313 return false;
2314 }
2315 current_binding = next_binding;
2316 // For sake of this check consider the bindings updated and grab count for next binding
2317 update_count -= binding_remaining;
2318 binding_remaining = current_binding.GetDescriptorCount();
2319 }
2320 return true;
2321}
John Zulauf4956fff2019-06-04 16:54:38 -06002322
2323// Validate the state for a given write update but don't actually perform the update
2324// If an error would occur for this update, return false and fill in details in error_msg string
2325bool cvdescriptorset::ValidateWriteUpdate(const DescriptorSet *dest_set, const debug_report_data *report_data,
2326 const VkWriteDescriptorSet *update, const char *func_name, std::string *error_code,
2327 std::string *error_msg) {
2328 const auto dest_layout = dest_set->GetLayout();
2329
2330 // Verify dst layout still valid
2331 if (dest_layout->IsDestroyed()) {
2332 *error_code = "VUID-VkWriteDescriptorSet-dstSet-00320";
2333 string_sprintf(error_msg, "Cannot call %s to perform write update on %s which has been destroyed", func_name,
2334 dest_set->StringifySetAndLayout().c_str());
2335 return false;
2336 }
2337 // Verify dst binding exists
2338 if (!dest_layout->HasBinding(update->dstBinding)) {
2339 *error_code = "VUID-VkWriteDescriptorSet-dstBinding-00315";
2340 std::stringstream error_str;
2341 error_str << dest_set->StringifySetAndLayout() << " does not have binding " << update->dstBinding;
2342 *error_msg = error_str.str();
2343 return false;
2344 }
2345
2346 DescriptorSetLayout::ConstBindingIterator dest(dest_layout.get(), update->dstBinding);
2347 // Make sure binding isn't empty
2348 if (0 == dest.GetDescriptorCount()) {
2349 *error_code = "VUID-VkWriteDescriptorSet-dstBinding-00316";
2350 std::stringstream error_str;
2351 error_str << dest_set->StringifySetAndLayout() << " cannot updated binding " << update->dstBinding
2352 << " that has 0 descriptors";
2353 *error_msg = error_str.str();
2354 return false;
2355 }
2356
2357 // Verify idle ds
2358 if (dest_set->in_use.load() && !(dest.GetDescriptorBindingFlags() & (VK_DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT_EXT |
2359 VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT))) {
2360 // TODO : Re-using Free Idle error code, need write update idle error code
2361 *error_code = "VUID-vkFreeDescriptorSets-pDescriptorSets-00309";
2362 std::stringstream error_str;
2363 error_str << "Cannot call " << func_name << " to perform write update on " << dest_set->StringifySetAndLayout()
2364 << " that is in use by a command buffer";
2365 *error_msg = error_str.str();
2366 return false;
2367 }
2368 // We know that binding is valid, verify update and do update on each descriptor
2369 auto start_idx = dest.GetGlobalIndexRange().start + update->dstArrayElement;
2370 auto type = dest.GetType();
2371 if (type != update->descriptorType) {
2372 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00319";
2373 std::stringstream error_str;
2374 error_str << "Attempting write update to " << dest_set->StringifySetAndLayout() << " binding #" << update->dstBinding
2375 << " with type " << string_VkDescriptorType(type) << " but update type is "
2376 << string_VkDescriptorType(update->descriptorType);
2377 *error_msg = error_str.str();
2378 return false;
2379 }
2380 auto total_descriptors = dest_layout->GetTotalDescriptorCount();
2381 if (update->descriptorCount > (total_descriptors - start_idx)) {
2382 *error_code = "VUID-VkWriteDescriptorSet-dstArrayElement-00321";
2383 std::stringstream error_str;
2384 error_str << "Attempting write update to " << dest_set->StringifySetAndLayout() << " binding #" << update->dstBinding
2385 << " with " << total_descriptors - start_idx
2386 << " descriptors in that binding and all successive bindings of the set, but update of "
2387 << update->descriptorCount << " descriptors combined with update array element offset of "
2388 << update->dstArrayElement << " oversteps the available number of consecutive descriptors";
2389 *error_msg = error_str.str();
2390 return false;
2391 }
2392 if (type == VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT) {
2393 if ((update->dstArrayElement % 4) != 0) {
2394 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-02219";
2395 std::stringstream error_str;
2396 error_str << "Attempting write update to " << dest_set->StringifySetAndLayout() << " binding #" << update->dstBinding
2397 << " with "
2398 << "dstArrayElement " << update->dstArrayElement << " not a multiple of 4";
2399 *error_msg = error_str.str();
2400 return false;
2401 }
2402 if ((update->descriptorCount % 4) != 0) {
2403 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-02220";
2404 std::stringstream error_str;
2405 error_str << "Attempting write update to " << dest_set->StringifySetAndLayout() << " binding #" << update->dstBinding
2406 << " with "
2407 << "descriptorCount " << update->descriptorCount << " not a multiple of 4";
2408 *error_msg = error_str.str();
2409 return false;
2410 }
2411 const auto *write_inline_info = lvl_find_in_chain<VkWriteDescriptorSetInlineUniformBlockEXT>(update->pNext);
2412 if (!write_inline_info || write_inline_info->dataSize != update->descriptorCount) {
2413 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-02221";
2414 std::stringstream error_str;
2415 if (!write_inline_info) {
2416 error_str << "Attempting write update to " << dest_set->StringifySetAndLayout() << " binding #"
2417 << update->dstBinding << " with "
2418 << "VkWriteDescriptorSetInlineUniformBlockEXT missing";
2419 } else {
2420 error_str << "Attempting write update to " << dest_set->StringifySetAndLayout() << " binding #"
2421 << update->dstBinding << " with "
2422 << "VkWriteDescriptorSetInlineUniformBlockEXT dataSize " << write_inline_info->dataSize
2423 << " not equal to "
2424 << "VkWriteDescriptorSet descriptorCount " << update->descriptorCount;
2425 }
2426 *error_msg = error_str.str();
2427 return false;
2428 }
2429 // This error is probably unreachable due to the previous two errors
2430 if (write_inline_info && (write_inline_info->dataSize % 4) != 0) {
2431 *error_code = "VUID-VkWriteDescriptorSetInlineUniformBlockEXT-dataSize-02222";
2432 std::stringstream error_str;
2433 error_str << "Attempting write update to " << dest_set->StringifySetAndLayout() << " binding #" << update->dstBinding
2434 << " with "
2435 << "VkWriteDescriptorSetInlineUniformBlockEXT dataSize " << write_inline_info->dataSize
2436 << " not a multiple of 4";
2437 *error_msg = error_str.str();
2438 return false;
2439 }
2440 }
2441 // Verify consecutive bindings match (if needed)
2442 if (!VerifyUpdateConsistency(DescriptorSetLayout::ConstBindingIterator(dest_layout.get(), update->dstBinding),
2443 update->dstArrayElement, update->descriptorCount, "write update to", dest_set->GetSet(),
2444 error_msg)) {
2445 // TODO : Should break out "consecutive binding updates" language into valid usage statements
2446 *error_code = "VUID-VkWriteDescriptorSet-dstArrayElement-00321";
2447 return false;
2448 }
2449 // Update is within bounds and consistent so last step is to validate update contents
John Zulauf459939f2019-06-04 16:49:35 -06002450 if (!VerifyWriteUpdateContents(dest_set, update, start_idx, func_name, error_code, error_msg)) {
John Zulauf4956fff2019-06-04 16:54:38 -06002451 std::stringstream error_str;
2452 error_str << "Write update to " << dest_set->StringifySetAndLayout() << " binding #" << update->dstBinding
2453 << " failed with error message: " << error_msg->c_str();
2454 *error_msg = error_str.str();
2455 return false;
2456 }
2457 // All checks passed, update is clean
2458 return true;
2459}
John Zulaufadb3f542019-06-04 17:01:00 -06002460
2461// Verify that the contents of the update are ok, but don't perform actual update
2462bool cvdescriptorset::VerifyWriteUpdateContents(const DescriptorSet *dest_set, const VkWriteDescriptorSet *update,
2463 const uint32_t index, const char *func_name, std::string *error_code,
2464 std::string *error_msg) {
2465 auto *device_data = dest_set->GetDeviceData();
2466 switch (update->descriptorType) {
2467 case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER: {
2468 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
2469 // Validate image
2470 auto image_view = update->pImageInfo[di].imageView;
2471 auto image_layout = update->pImageInfo[di].imageLayout;
2472 if (!ValidateImageUpdate(image_view, image_layout, update->descriptorType, device_data, func_name, error_code,
2473 error_msg)) {
2474 std::stringstream error_str;
2475 error_str << "Attempted write update to combined image sampler descriptor failed due to: "
2476 << error_msg->c_str();
2477 *error_msg = error_str.str();
2478 return false;
2479 }
2480 if (device_data->device_extensions.vk_khr_sampler_ycbcr_conversion) {
2481 ImageSamplerDescriptor *desc = (ImageSamplerDescriptor *)dest_set->GetDescriptorFromGlobalIndex(index + di);
2482 if (desc->IsImmutableSampler()) {
2483 auto sampler_state = device_data->GetSamplerState(desc->GetSampler());
2484 auto iv_state = device_data->GetImageViewState(image_view);
2485 if (iv_state && sampler_state) {
2486 if (iv_state->samplerConversion != sampler_state->samplerConversion) {
2487 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-01948";
2488 std::stringstream error_str;
2489 error_str << "Attempted write update to combined image sampler and image view and sampler ycbcr "
2490 "conversions are not identical, sampler: "
2491 << desc->GetSampler() << " image view: " << iv_state->image_view << ".";
2492 *error_msg = error_str.str();
2493 return false;
2494 }
2495 }
2496 } else {
2497 auto iv_state = device_data->GetImageViewState(image_view);
2498 if (iv_state && (iv_state->samplerConversion != VK_NULL_HANDLE)) {
2499 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-01947";
2500 std::stringstream error_str;
2501 error_str << "Because dstSet (" << update->dstSet << ") is bound to image view ("
2502 << iv_state->image_view
2503 << ") that includes a YCBCR conversion, it must have been allocated with a layout that "
2504 "includes an immutable sampler.";
2505 *error_msg = error_str.str();
2506 return false;
2507 }
2508 }
2509 }
2510 }
2511 }
2512 // fall through
2513 case VK_DESCRIPTOR_TYPE_SAMPLER: {
2514 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
2515 SamplerDescriptor *desc = (SamplerDescriptor *)dest_set->GetDescriptorFromGlobalIndex(index + di);
2516 if (!desc->IsImmutableSampler()) {
2517 if (!ValidateSampler(update->pImageInfo[di].sampler, device_data)) {
2518 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00325";
2519 std::stringstream error_str;
2520 error_str << "Attempted write update to sampler descriptor with invalid sampler: "
2521 << update->pImageInfo[di].sampler << ".";
2522 *error_msg = error_str.str();
2523 return false;
2524 }
2525 } else {
2526 // TODO : Warn here
2527 }
2528 }
2529 break;
2530 }
2531 case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
2532 case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT:
2533 case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE: {
2534 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
2535 auto image_view = update->pImageInfo[di].imageView;
2536 auto image_layout = update->pImageInfo[di].imageLayout;
2537 if (!ValidateImageUpdate(image_view, image_layout, update->descriptorType, device_data, func_name, error_code,
2538 error_msg)) {
2539 std::stringstream error_str;
2540 error_str << "Attempted write update to image descriptor failed due to: " << error_msg->c_str();
2541 *error_msg = error_str.str();
2542 return false;
2543 }
2544 }
2545 break;
2546 }
2547 case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
2548 case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER: {
2549 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
2550 auto buffer_view = update->pTexelBufferView[di];
2551 auto bv_state = device_data->GetBufferViewState(buffer_view);
2552 if (!bv_state) {
2553 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00323";
2554 std::stringstream error_str;
2555 error_str << "Attempted write update to texel buffer descriptor with invalid buffer view: " << buffer_view;
2556 *error_msg = error_str.str();
2557 return false;
2558 }
2559 auto buffer = bv_state->create_info.buffer;
2560 auto buffer_state = device_data->GetBufferState(buffer);
2561 // Verify that buffer underlying the view hasn't been destroyed prematurely
2562 if (!buffer_state) {
2563 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00323";
2564 std::stringstream error_str;
2565 error_str << "Attempted write update to texel buffer descriptor failed because underlying buffer (" << buffer
2566 << ") has been destroyed: " << error_msg->c_str();
2567 *error_msg = error_str.str();
2568 return false;
John Zulaufd9435c32019-06-05 15:55:36 -06002569 } else if (!ValidateBufferUsage(buffer_state, update->descriptorType, error_code, error_msg)) {
John Zulaufadb3f542019-06-04 17:01:00 -06002570 std::stringstream error_str;
2571 error_str << "Attempted write update to texel buffer descriptor failed due to: " << error_msg->c_str();
2572 *error_msg = error_str.str();
2573 return false;
2574 }
2575 }
2576 break;
2577 }
2578 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
2579 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:
2580 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
2581 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC: {
2582 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
John Zulaufd9435c32019-06-05 15:55:36 -06002583 if (!ValidateBufferUpdate(device_data, update->pBufferInfo + di, update->descriptorType, func_name, error_code,
2584 error_msg)) {
John Zulaufadb3f542019-06-04 17:01:00 -06002585 std::stringstream error_str;
2586 error_str << "Attempted write update to buffer descriptor failed due to: " << error_msg->c_str();
2587 *error_msg = error_str.str();
2588 return false;
2589 }
2590 }
2591 break;
2592 }
2593 case VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT:
2594 break;
2595 case VK_DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_NV:
2596 // XXX TODO
2597 break;
2598 default:
2599 assert(0); // We've already verified update type so should never get here
2600 break;
2601 }
2602 // All checks passed so update contents are good
2603 return true;
2604}