blob: 8df8cd3fa399440148dd268fa96665e99e1e0f9b [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 Zulaufb6d71202017-12-22 16:47:09 -0700120 binding_to_global_index_range_map_.reserve(binding_count_);
121 // Vector order is finalized so create maps of bindings to descriptors and descriptors to indices
Tobin Ehlis9637fb22016-12-12 15:59:34 -0700122 for (uint32_t i = 0; i < binding_count_; ++i) {
123 auto binding_num = bindings_[i].binding;
John Zulaufc483f442017-12-15 14:02:06 -0700124 auto final_index = global_index + bindings_[i].descriptorCount;
125 binding_to_global_index_range_map_[binding_num] = IndexRange(global_index, final_index);
John Zulaufb6d71202017-12-22 16:47:09 -0700126 if (final_index != global_index) {
127 global_start_to_index_map_[global_index] = i;
128 }
John Zulaufc483f442017-12-15 14:02:06 -0700129 global_index = final_index;
Tobin Ehlis9637fb22016-12-12 15:59:34 -0700130 }
John Zulaufb6d71202017-12-22 16:47:09 -0700131
Tobin Ehlisa3525e02016-11-17 10:50:52 -0700132 // Now create dyn offset array mapping for any dynamic descriptors
133 uint32_t dyn_array_idx = 0;
John Zulaufb6d71202017-12-22 16:47:09 -0700134 binding_to_dynamic_array_idx_map_.reserve(binding_to_dyn_count.size());
Tobin Ehlisa3525e02016-11-17 10:50:52 -0700135 for (const auto &bc_pair : binding_to_dyn_count) {
136 binding_to_dynamic_array_idx_map_[bc_pair.first] = dyn_array_idx;
137 dyn_array_idx += bc_pair.second;
138 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600139}
Tobin Ehlis154c2692016-10-25 09:36:53 -0600140
John Zulaufd47d0612018-02-16 13:00:34 -0700141size_t cvdescriptorset::DescriptorSetLayoutDef::hash() const {
142 hash_util::HashCombiner hc;
143 hc << flags_;
144 hc.Combine(bindings_);
John Zulauf223b69d2018-11-09 16:00:59 -0700145 hc.Combine(binding_flags_);
John Zulaufd47d0612018-02-16 13:00:34 -0700146 return hc.Value();
147}
148//
149
John Zulauf1f8174b2018-02-16 12:58:37 -0700150// Return valid index or "end" i.e. binding_count_;
151// The asserts in "Get" are reduced to the set where no valid answer(like null or 0) could be given
152// Common code for all binding lookups.
153uint32_t cvdescriptorset::DescriptorSetLayoutDef::GetIndexFromBinding(uint32_t binding) const {
154 const auto &bi_itr = binding_to_index_map_.find(binding);
155 if (bi_itr != binding_to_index_map_.cend()) return bi_itr->second;
156 return GetBindingCount();
157}
158VkDescriptorSetLayoutBinding const *cvdescriptorset::DescriptorSetLayoutDef::GetDescriptorSetLayoutBindingPtrFromIndex(
159 const uint32_t index) const {
160 if (index >= bindings_.size()) return nullptr;
161 return bindings_[index].ptr();
162}
163// Return descriptorCount for given index, 0 if index is unavailable
164uint32_t cvdescriptorset::DescriptorSetLayoutDef::GetDescriptorCountFromIndex(const uint32_t index) const {
165 if (index >= bindings_.size()) return 0;
166 return bindings_[index].descriptorCount;
167}
168// For the given index, return descriptorType
169VkDescriptorType cvdescriptorset::DescriptorSetLayoutDef::GetTypeFromIndex(const uint32_t index) const {
170 assert(index < bindings_.size());
171 if (index < bindings_.size()) return bindings_[index].descriptorType;
172 return VK_DESCRIPTOR_TYPE_MAX_ENUM;
173}
174// For the given index, return stageFlags
175VkShaderStageFlags cvdescriptorset::DescriptorSetLayoutDef::GetStageFlagsFromIndex(const uint32_t index) const {
176 assert(index < bindings_.size());
177 if (index < bindings_.size()) return bindings_[index].stageFlags;
178 return VkShaderStageFlags(0);
179}
Jeff Bolzfdf96072018-04-10 14:32:18 -0500180// Return binding flags for given index, 0 if index is unavailable
181VkDescriptorBindingFlagsEXT cvdescriptorset::DescriptorSetLayoutDef::GetDescriptorBindingFlagsFromIndex(
182 const uint32_t index) const {
183 if (index >= binding_flags_.size()) return 0;
184 return binding_flags_[index];
185}
John Zulauf1f8174b2018-02-16 12:58:37 -0700186
187// For the given global index, return index
188uint32_t cvdescriptorset::DescriptorSetLayoutDef::GetIndexFromGlobalIndex(const uint32_t global_index) const {
189 auto start_it = global_start_to_index_map_.upper_bound(global_index);
190 uint32_t index = binding_count_;
191 assert(start_it != global_start_to_index_map_.cbegin());
192 if (start_it != global_start_to_index_map_.cbegin()) {
193 --start_it;
194 index = start_it->second;
195#ifndef NDEBUG
196 const auto &range = GetGlobalIndexRangeFromBinding(bindings_[index].binding);
197 assert(range.start <= global_index && global_index < range.end);
198#endif
199 }
200 return index;
201}
202
203// For the given binding, return the global index range
204// As start and end are often needed in pairs, get both with a single hash lookup.
205const cvdescriptorset::IndexRange &cvdescriptorset::DescriptorSetLayoutDef::GetGlobalIndexRangeFromBinding(
206 const uint32_t binding) const {
207 assert(binding_to_global_index_range_map_.count(binding));
208 // In error case max uint32_t so index is out of bounds to break ASAP
209 const static IndexRange kInvalidRange = {0xFFFFFFFF, 0xFFFFFFFF};
210 const auto &range_it = binding_to_global_index_range_map_.find(binding);
211 if (range_it != binding_to_global_index_range_map_.end()) {
212 return range_it->second;
213 }
214 return kInvalidRange;
215}
216
217// For given binding, return ptr to ImmutableSampler array
218VkSampler const *cvdescriptorset::DescriptorSetLayoutDef::GetImmutableSamplerPtrFromBinding(const uint32_t binding) const {
219 const auto &bi_itr = binding_to_index_map_.find(binding);
220 if (bi_itr != binding_to_index_map_.end()) {
221 return bindings_[bi_itr->second].pImmutableSamplers;
222 }
223 return nullptr;
224}
225// Move to next valid binding having a non-zero binding count
226uint32_t cvdescriptorset::DescriptorSetLayoutDef::GetNextValidBinding(const uint32_t binding) const {
227 auto it = non_empty_bindings_.upper_bound(binding);
228 assert(it != non_empty_bindings_.cend());
229 if (it != non_empty_bindings_.cend()) return *it;
230 return GetMaxBinding() + 1;
231}
232// For given index, return ptr to ImmutableSampler array
233VkSampler const *cvdescriptorset::DescriptorSetLayoutDef::GetImmutableSamplerPtrFromIndex(const uint32_t index) const {
234 if (index < bindings_.size()) {
235 return bindings_[index].pImmutableSamplers;
236 }
237 return nullptr;
238}
John Zulauf9ce3b252019-06-06 15:20:22 -0600239
240// If our layout is compatible with rh_ds_layout, return true.
241bool cvdescriptorset::DescriptorSetLayout::IsCompatible(DescriptorSetLayout const *rh_ds_layout) const {
242 bool compatible = (this == rh_ds_layout) || (GetLayoutDef() == rh_ds_layout->GetLayoutDef());
243 return compatible;
244}
John Zulauf1f8174b2018-02-16 12:58:37 -0700245// If our layout is compatible with rh_ds_layout, return true,
246// else return false and fill in error_msg will description of what causes incompatibility
John Zulauf9ce3b252019-06-06 15:20:22 -0600247bool cvdescriptorset::VerifySetLayoutCompatibility(DescriptorSetLayout const *lh_ds_layout, DescriptorSetLayout const *rh_ds_layout,
248 std::string *error_msg) {
249 // Short circuit the detailed check.
250 if (lh_ds_layout->IsCompatible(rh_ds_layout)) return true;
John Zulauf1f8174b2018-02-16 12:58:37 -0700251
John Zulauf9ce3b252019-06-06 15:20:22 -0600252 // Do a detailed compatibility check of this lhs def (referenced by lh_ds_layout), vs. the rhs (layout and def)
253 // Should only be run if trivial accept has failed, and in that context should return false.
254 VkDescriptorSetLayout lh_dsl_handle = lh_ds_layout->GetDescriptorSetLayout();
255 VkDescriptorSetLayout rh_dsl_handle = rh_ds_layout->GetDescriptorSetLayout();
256 DescriptorSetLayoutDef const *lh_ds_layout_def = lh_ds_layout->GetLayoutDef();
257 DescriptorSetLayoutDef const *rh_ds_layout_def = rh_ds_layout->GetLayoutDef();
258
259 // Check descriptor counts
260 if (lh_ds_layout_def->GetTotalDescriptorCount() != rh_ds_layout_def->GetTotalDescriptorCount()) {
John Zulauf1f8174b2018-02-16 12:58:37 -0700261 std::stringstream error_str;
John Zulauf9ce3b252019-06-06 15:20:22 -0600262 error_str << "DescriptorSetLayout " << lh_dsl_handle << " has " << lh_ds_layout_def->GetTotalDescriptorCount()
263 << " descriptors, but DescriptorSetLayout " << rh_dsl_handle << ", which comes from pipelineLayout, has "
264 << rh_ds_layout_def->GetTotalDescriptorCount() << " descriptors.";
John Zulauf1f8174b2018-02-16 12:58:37 -0700265 *error_msg = error_str.str();
266 return false; // trivial fail case
267 }
John Zulaufd47d0612018-02-16 13:00:34 -0700268
John Zulauf1f8174b2018-02-16 12:58:37 -0700269 // Descriptor counts match so need to go through bindings one-by-one
270 // and verify that type and stageFlags match
John Zulauf9ce3b252019-06-06 15:20:22 -0600271 for (const auto &binding : lh_ds_layout_def->GetBindings()) {
John Zulauf1f8174b2018-02-16 12:58:37 -0700272 // TODO : Do we also need to check immutable samplers?
273 // VkDescriptorSetLayoutBinding *rh_binding;
274 if (binding.descriptorCount != rh_ds_layout_def->GetDescriptorCountFromBinding(binding.binding)) {
275 std::stringstream error_str;
John Zulauf9ce3b252019-06-06 15:20:22 -0600276 error_str << "Binding " << binding.binding << " for DescriptorSetLayout " << lh_dsl_handle
277 << " has a descriptorCount of " << binding.descriptorCount << " but binding " << binding.binding
278 << " for DescriptorSetLayout " << rh_dsl_handle
279 << ", which comes from pipelineLayout, has a descriptorCount of "
John Zulauf1f8174b2018-02-16 12:58:37 -0700280 << rh_ds_layout_def->GetDescriptorCountFromBinding(binding.binding);
281 *error_msg = error_str.str();
282 return false;
283 } else if (binding.descriptorType != rh_ds_layout_def->GetTypeFromBinding(binding.binding)) {
284 std::stringstream error_str;
John Zulauf9ce3b252019-06-06 15:20:22 -0600285 error_str << "Binding " << binding.binding << " for DescriptorSetLayout " << lh_dsl_handle << " is type '"
John Zulauf1f8174b2018-02-16 12:58:37 -0700286 << string_VkDescriptorType(binding.descriptorType) << "' but binding " << binding.binding
John Zulauf9ce3b252019-06-06 15:20:22 -0600287 << " for DescriptorSetLayout " << rh_dsl_handle << ", which comes from pipelineLayout, is type '"
John Zulauf1f8174b2018-02-16 12:58:37 -0700288 << string_VkDescriptorType(rh_ds_layout_def->GetTypeFromBinding(binding.binding)) << "'";
289 *error_msg = error_str.str();
290 return false;
291 } else if (binding.stageFlags != rh_ds_layout_def->GetStageFlagsFromBinding(binding.binding)) {
292 std::stringstream error_str;
John Zulauf9ce3b252019-06-06 15:20:22 -0600293 error_str << "Binding " << binding.binding << " for DescriptorSetLayout " << lh_dsl_handle << " has stageFlags "
294 << binding.stageFlags << " but binding " << binding.binding << " for DescriptorSetLayout " << rh_dsl_handle
John Zulauf1f8174b2018-02-16 12:58:37 -0700295 << ", which comes from pipelineLayout, has stageFlags "
296 << rh_ds_layout_def->GetStageFlagsFromBinding(binding.binding);
297 *error_msg = error_str.str();
298 return false;
299 }
300 }
John Zulauf9ce3b252019-06-06 15:20:22 -0600301 // No detailed check should succeed if the trivial check failed -- or the dictionary has failed somehow.
302 bool compatible = true;
303 assert(!compatible);
304 return compatible;
John Zulauf1f8174b2018-02-16 12:58:37 -0700305}
306
307bool cvdescriptorset::DescriptorSetLayoutDef::IsNextBindingConsistent(const uint32_t binding) const {
308 if (!binding_to_index_map_.count(binding + 1)) return false;
309 auto const &bi_itr = binding_to_index_map_.find(binding);
310 if (bi_itr != binding_to_index_map_.end()) {
311 const auto &next_bi_itr = binding_to_index_map_.find(binding + 1);
312 if (next_bi_itr != binding_to_index_map_.end()) {
313 auto type = bindings_[bi_itr->second].descriptorType;
314 auto stage_flags = bindings_[bi_itr->second].stageFlags;
315 auto immut_samp = bindings_[bi_itr->second].pImmutableSamplers ? true : false;
Jeff Bolzfdf96072018-04-10 14:32:18 -0500316 auto flags = binding_flags_[bi_itr->second];
John Zulauf1f8174b2018-02-16 12:58:37 -0700317 if ((type != bindings_[next_bi_itr->second].descriptorType) ||
318 (stage_flags != bindings_[next_bi_itr->second].stageFlags) ||
Jeff Bolzfdf96072018-04-10 14:32:18 -0500319 (immut_samp != (bindings_[next_bi_itr->second].pImmutableSamplers ? true : false)) ||
320 (flags != binding_flags_[next_bi_itr->second])) {
John Zulauf1f8174b2018-02-16 12:58:37 -0700321 return false;
322 }
323 return true;
324 }
325 }
326 return false;
327}
John Zulauf1f8174b2018-02-16 12:58:37 -0700328
329// The DescriptorSetLayout stores the per handle data for a descriptor set layout, and references the common defintion for the
330// handle invariant portion
331cvdescriptorset::DescriptorSetLayout::DescriptorSetLayout(const VkDescriptorSetLayoutCreateInfo *p_create_info,
332 const VkDescriptorSetLayout layout)
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600333 : layout_(layout), layout_destroyed_(false), layout_id_(GetCanonicalId(p_create_info)) {}
John Zulauf1f8174b2018-02-16 12:58:37 -0700334
Tobin Ehlis154c2692016-10-25 09:36:53 -0600335// Validate descriptor set layout create info
John Zulaufd9435c32019-06-05 15:55:36 -0600336bool cvdescriptorset::ValidateDescriptorSetLayoutCreateInfo(
Jeff Bolzfdf96072018-04-10 14:32:18 -0500337 const debug_report_data *report_data, const VkDescriptorSetLayoutCreateInfo *create_info, const bool push_descriptor_ext,
338 const uint32_t max_push_descriptors, const bool descriptor_indexing_ext,
Jeff Bolze54ae892018-09-08 12:16:29 -0500339 const VkPhysicalDeviceDescriptorIndexingFeaturesEXT *descriptor_indexing_features,
340 const VkPhysicalDeviceInlineUniformBlockFeaturesEXT *inline_uniform_block_features,
341 const VkPhysicalDeviceInlineUniformBlockPropertiesEXT *inline_uniform_block_props) {
Tobin Ehlis154c2692016-10-25 09:36:53 -0600342 bool skip = false;
343 std::unordered_set<uint32_t> bindings;
John Zulauf0fdeab32018-01-23 11:27:35 -0700344 uint64_t total_descriptors = 0;
345
Jeff Bolzfdf96072018-04-10 14:32:18 -0500346 const auto *flags_create_info = lvl_find_in_chain<VkDescriptorSetLayoutBindingFlagsCreateInfoEXT>(create_info->pNext);
347
348 const bool push_descriptor_set = !!(create_info->flags & VK_DESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT_KHR);
John Zulauf0fdeab32018-01-23 11:27:35 -0700349 if (push_descriptor_set && !push_descriptor_ext) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600350 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 -0600351 kVUID_Core_DrawState_ExtensionNotEnabled,
Mark Lobodzinskifb5a3e62018-04-13 10:46:48 -0600352 "Attempted to use %s in %s but its required extension %s has not been enabled.\n",
John Zulauf0fdeab32018-01-23 11:27:35 -0700353 "VK_DESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT_KHR", "VkDescriptorSetLayoutCreateInfo::flags",
354 VK_KHR_PUSH_DESCRIPTOR_EXTENSION_NAME);
355 }
356
Jeff Bolzfdf96072018-04-10 14:32:18 -0500357 const bool update_after_bind_set = !!(create_info->flags & VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT);
358 if (update_after_bind_set && !descriptor_indexing_ext) {
359 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 -0600360 kVUID_Core_DrawState_ExtensionNotEnabled,
Jeff Bolzfdf96072018-04-10 14:32:18 -0500361 "Attemped to use %s in %s but its required extension %s has not been enabled.\n",
362 "VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT", "VkDescriptorSetLayoutCreateInfo::flags",
363 VK_EXT_DESCRIPTOR_INDEXING_EXTENSION_NAME);
364 }
365
John Zulauf0fdeab32018-01-23 11:27:35 -0700366 auto valid_type = [push_descriptor_set](const VkDescriptorType type) {
367 return !push_descriptor_set ||
Dave Houlton142c4cb2018-10-17 15:04:41 -0600368 ((type != VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC) && (type != VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC) &&
Jeff Bolze54ae892018-09-08 12:16:29 -0500369 (type != VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT));
John Zulauf0fdeab32018-01-23 11:27:35 -0700370 };
371
Jeff Bolzfdf96072018-04-10 14:32:18 -0500372 uint32_t max_binding = 0;
373
Tobin Ehlis154c2692016-10-25 09:36:53 -0600374 for (uint32_t i = 0; i < create_info->bindingCount; ++i) {
John Zulauf0fdeab32018-01-23 11:27:35 -0700375 const auto &binding_info = create_info->pBindings[i];
Jeff Bolzfdf96072018-04-10 14:32:18 -0500376 max_binding = std::max(max_binding, binding_info.binding);
377
John Zulauf0fdeab32018-01-23 11:27:35 -0700378 if (!bindings.insert(binding_info.binding).second) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600379 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 -0600380 "VUID-VkDescriptorSetLayoutCreateInfo-binding-00279",
381 "duplicated binding number in VkDescriptorSetLayoutBinding.");
Tobin Ehlis154c2692016-10-25 09:36:53 -0600382 }
John Zulauf0fdeab32018-01-23 11:27:35 -0700383 if (!valid_type(binding_info.descriptorType)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -0600384 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 -0600385 (binding_info.descriptorType == VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT)
386 ? "VUID-VkDescriptorSetLayoutCreateInfo-flags-02208"
387 : "VUID-VkDescriptorSetLayoutCreateInfo-flags-00280",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600388 "invalid type %s ,for push descriptors in VkDescriptorSetLayoutBinding entry %" PRIu32 ".",
389 string_VkDescriptorType(binding_info.descriptorType), i);
John Zulauf0fdeab32018-01-23 11:27:35 -0700390 }
Jeff Bolze54ae892018-09-08 12:16:29 -0500391
392 if (binding_info.descriptorType == VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT) {
393 if ((binding_info.descriptorCount % 4) != 0) {
394 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
395 "VUID-VkDescriptorSetLayoutBinding-descriptorType-02209",
Dave Houlton142c4cb2018-10-17 15:04:41 -0600396 "descriptorCount =(%" PRIu32 ") must be a multiple of 4", binding_info.descriptorCount);
Jeff Bolze54ae892018-09-08 12:16:29 -0500397 }
398 if (binding_info.descriptorCount > inline_uniform_block_props->maxInlineUniformBlockSize) {
399 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
400 "VUID-VkDescriptorSetLayoutBinding-descriptorType-02210",
401 "descriptorCount =(%" PRIu32 ") must be less than or equal to maxInlineUniformBlockSize",
402 binding_info.descriptorCount);
403 }
404 }
405
John Zulauf0fdeab32018-01-23 11:27:35 -0700406 total_descriptors += binding_info.descriptorCount;
Tobin Ehlis154c2692016-10-25 09:36:53 -0600407 }
John Zulauf0fdeab32018-01-23 11:27:35 -0700408
Jeff Bolzfdf96072018-04-10 14:32:18 -0500409 if (flags_create_info) {
410 if (flags_create_info->bindingCount != 0 && flags_create_info->bindingCount != create_info->bindingCount) {
411 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 -0600412 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-bindingCount-03002",
Jeff Bolzfdf96072018-04-10 14:32:18 -0500413 "VkDescriptorSetLayoutCreateInfo::bindingCount (%d) != "
414 "VkDescriptorSetLayoutBindingFlagsCreateInfoEXT::bindingCount (%d)",
415 create_info->bindingCount, flags_create_info->bindingCount);
416 }
417
418 if (flags_create_info->bindingCount == create_info->bindingCount) {
419 for (uint32_t i = 0; i < create_info->bindingCount; ++i) {
420 const auto &binding_info = create_info->pBindings[i];
421
422 if (flags_create_info->pBindingFlags[i] & VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT) {
423 if (!update_after_bind_set) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600424 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
425 "VUID-VkDescriptorSetLayoutCreateInfo-flags-03000",
426 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500427 }
428
429 if (binding_info.descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER &&
430 !descriptor_indexing_features->descriptorBindingUniformBufferUpdateAfterBind) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600431 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
432 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-"
433 "descriptorBindingUniformBufferUpdateAfterBind-03005",
434 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500435 }
436 if ((binding_info.descriptorType == VK_DESCRIPTOR_TYPE_SAMPLER ||
437 binding_info.descriptorType == VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER ||
438 binding_info.descriptorType == VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE) &&
439 !descriptor_indexing_features->descriptorBindingSampledImageUpdateAfterBind) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600440 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
441 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-"
442 "descriptorBindingSampledImageUpdateAfterBind-03006",
443 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500444 }
445 if (binding_info.descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_IMAGE &&
446 !descriptor_indexing_features->descriptorBindingStorageImageUpdateAfterBind) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600447 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
448 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-"
449 "descriptorBindingStorageImageUpdateAfterBind-03007",
450 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500451 }
452 if (binding_info.descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_BUFFER &&
453 !descriptor_indexing_features->descriptorBindingStorageBufferUpdateAfterBind) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600454 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
455 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-"
456 "descriptorBindingStorageBufferUpdateAfterBind-03008",
457 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500458 }
459 if (binding_info.descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER &&
460 !descriptor_indexing_features->descriptorBindingUniformTexelBufferUpdateAfterBind) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600461 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
462 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-"
463 "descriptorBindingUniformTexelBufferUpdateAfterBind-03009",
464 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500465 }
466 if (binding_info.descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER &&
467 !descriptor_indexing_features->descriptorBindingStorageTexelBufferUpdateAfterBind) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600468 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
469 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-"
470 "descriptorBindingStorageTexelBufferUpdateAfterBind-03010",
471 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500472 }
473 if ((binding_info.descriptorType == VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT ||
474 binding_info.descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC ||
475 binding_info.descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC)) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600476 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
477 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-None-03011",
478 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500479 }
Jeff Bolze54ae892018-09-08 12:16:29 -0500480
481 if (binding_info.descriptorType == VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT &&
482 !inline_uniform_block_features->descriptorBindingInlineUniformBlockUpdateAfterBind) {
483 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 -0600484 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-"
485 "descriptorBindingInlineUniformBlockUpdateAfterBind-02211",
486 "Invalid flags (VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT) for "
487 "VkDescriptorSetLayoutBinding entry %" PRIu32
488 " with descriptorBindingInlineUniformBlockUpdateAfterBind not enabled",
489 i);
Jeff Bolze54ae892018-09-08 12:16:29 -0500490 }
Jeff Bolzfdf96072018-04-10 14:32:18 -0500491 }
492
493 if (flags_create_info->pBindingFlags[i] & VK_DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT_EXT) {
494 if (!descriptor_indexing_features->descriptorBindingUpdateUnusedWhilePending) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600495 skip |= log_msg(
496 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
497 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-descriptorBindingUpdateUnusedWhilePending-03012",
498 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500499 }
500 }
501
502 if (flags_create_info->pBindingFlags[i] & VK_DESCRIPTOR_BINDING_PARTIALLY_BOUND_BIT_EXT) {
503 if (!descriptor_indexing_features->descriptorBindingPartiallyBound) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600504 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
505 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-descriptorBindingPartiallyBound-03013",
506 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500507 }
508 }
509
510 if (flags_create_info->pBindingFlags[i] & VK_DESCRIPTOR_BINDING_VARIABLE_DESCRIPTOR_COUNT_BIT_EXT) {
511 if (binding_info.binding != max_binding) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600512 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
513 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-pBindingFlags-03004",
514 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500515 }
516
517 if (!descriptor_indexing_features->descriptorBindingVariableDescriptorCount) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600518 skip |= log_msg(
519 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
520 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-descriptorBindingVariableDescriptorCount-03014",
521 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500522 }
523 if ((binding_info.descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC ||
524 binding_info.descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC)) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600525 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
526 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-pBindingFlags-03015",
527 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500528 }
529 }
530
531 if (push_descriptor_set &&
532 (flags_create_info->pBindingFlags[i] &
533 (VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT | VK_DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT_EXT |
534 VK_DESCRIPTOR_BINDING_VARIABLE_DESCRIPTOR_COUNT_BIT_EXT))) {
535 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 -0600536 "VUID-VkDescriptorSetLayoutBindingFlagsCreateInfoEXT-flags-03003",
537 "Invalid flags for VkDescriptorSetLayoutBinding entry %" PRIu32, i);
Jeff Bolzfdf96072018-04-10 14:32:18 -0500538 }
539 }
540 }
541 }
542
John Zulauf0fdeab32018-01-23 11:27:35 -0700543 if ((push_descriptor_set) && (total_descriptors > max_push_descriptors)) {
544 const char *undefined = push_descriptor_ext ? "" : " -- undefined";
Dave Houltond8ed0212018-05-16 17:18:24 -0600545 skip |=
546 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
547 "VUID-VkDescriptorSetLayoutCreateInfo-flags-00281",
548 "for push descriptor, total descriptor count in layout (%" PRIu64
549 ") must not be greater than VkPhysicalDevicePushDescriptorPropertiesKHR::maxPushDescriptors (%" PRIu32 "%s).",
550 total_descriptors, max_push_descriptors, undefined);
John Zulauf0fdeab32018-01-23 11:27:35 -0700551 }
552
Tobin Ehlis154c2692016-10-25 09:36:53 -0600553 return skip;
554}
555
Tobin Ehlis68d0adf2016-06-01 11:33:50 -0600556cvdescriptorset::AllocateDescriptorSetsData::AllocateDescriptorSetsData(uint32_t count)
557 : required_descriptors_by_type{}, layout_nodes(count, nullptr) {}
558
Tobin Ehlis93f22372016-10-12 14:34:12 -0600559cvdescriptorset::DescriptorSet::DescriptorSet(const VkDescriptorSet set, const VkDescriptorPool pool,
Jeff Bolzfdf96072018-04-10 14:32:18 -0500560 const std::shared_ptr<DescriptorSetLayout const> &layout, uint32_t variable_count,
Mark Lobodzinski3840ca02019-03-08 18:36:11 -0700561 CoreChecks *dev_data)
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -0700562 : some_update_(false),
563 set_(set),
564 pool_state_(nullptr),
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600565 p_layout_(layout),
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -0700566 device_data_(dev_data),
Jeff Bolzfdf96072018-04-10 14:32:18 -0500567 variable_count_(variable_count) {
Mark Lobodzinski7804bd42019-03-06 11:28:48 -0700568 pool_state_ = dev_data->GetDescriptorPoolState(pool);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600569 // Foreach binding, create default descriptors of given type
John Zulaufb6d71202017-12-22 16:47:09 -0700570 descriptors_.reserve(p_layout_->GetTotalDescriptorCount());
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600571 for (uint32_t i = 0; i < p_layout_->GetBindingCount(); ++i) {
572 auto type = p_layout_->GetTypeFromIndex(i);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600573 switch (type) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700574 case VK_DESCRIPTOR_TYPE_SAMPLER: {
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600575 auto immut_sampler = p_layout_->GetImmutableSamplerPtrFromIndex(i);
576 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di) {
Tobin Ehlis082c7512017-05-08 11:24:57 -0600577 if (immut_sampler) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700578 descriptors_.emplace_back(new SamplerDescriptor(immut_sampler + di));
Tobin Ehlis082c7512017-05-08 11:24:57 -0600579 some_update_ = true; // Immutable samplers are updated at creation
580 } else
Chris Forbes9f340852017-05-09 08:51:38 -0700581 descriptors_.emplace_back(new SamplerDescriptor(nullptr));
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700582 }
583 break;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600584 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700585 case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER: {
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600586 auto immut = p_layout_->GetImmutableSamplerPtrFromIndex(i);
587 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di) {
Tobin Ehlis082c7512017-05-08 11:24:57 -0600588 if (immut) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700589 descriptors_.emplace_back(new ImageSamplerDescriptor(immut + di));
Tobin Ehlis082c7512017-05-08 11:24:57 -0600590 some_update_ = true; // Immutable samplers are updated at creation
591 } else
Chris Forbes9f340852017-05-09 08:51:38 -0700592 descriptors_.emplace_back(new ImageSamplerDescriptor(nullptr));
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700593 }
594 break;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600595 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700596 // ImageDescriptors
597 case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
598 case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT:
599 case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE:
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600600 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di)
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700601 descriptors_.emplace_back(new ImageDescriptor(type));
602 break;
603 case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
604 case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600605 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di)
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700606 descriptors_.emplace_back(new TexelDescriptor(type));
607 break;
608 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
609 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:
610 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
611 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC:
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600612 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di)
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700613 descriptors_.emplace_back(new BufferDescriptor(type));
614 break;
Jeff Bolze54ae892018-09-08 12:16:29 -0500615 case VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT:
616 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di)
617 descriptors_.emplace_back(new InlineUniformDescriptor(type));
618 break;
Eric Werness30127fd2018-10-31 21:01:03 -0700619 case VK_DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_NV:
Jeff Bolzfbe51582018-09-13 10:01:35 -0500620 for (uint32_t di = 0; di < p_layout_->GetDescriptorCountFromIndex(i); ++di)
621 descriptors_.emplace_back(new AccelerationStructureDescriptor(type));
622 break;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700623 default:
624 assert(0); // Bad descriptor type specified
625 break;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600626 }
627 }
628}
Tobin Ehlis56a30942016-05-19 08:00:00 -0600629
Mark Lobodzinski729a8d32017-01-26 12:16:30 -0700630cvdescriptorset::DescriptorSet::~DescriptorSet() { InvalidateBoundCmdBuffers(); }
Chris Forbes57989132016-07-26 17:06:10 +1200631
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600632static std::string StringDescriptorReqViewType(descriptor_req req) {
Chris Forbes6e58ebd2016-08-31 12:58:14 -0700633 std::string result("");
Chris Forbes57989132016-07-26 17:06:10 +1200634 for (unsigned i = 0; i <= VK_IMAGE_VIEW_TYPE_END_RANGE; i++) {
635 if (req & (1 << i)) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700636 if (result.size()) result += ", ";
Chris Forbes6e58ebd2016-08-31 12:58:14 -0700637 result += string_VkImageViewType(VkImageViewType(i));
Chris Forbes57989132016-07-26 17:06:10 +1200638 }
639 }
640
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700641 if (!result.size()) result = "(none)";
Chris Forbes6e58ebd2016-08-31 12:58:14 -0700642
643 return result;
Chris Forbes57989132016-07-26 17:06:10 +1200644}
645
Chris Forbesda01e8d2018-08-27 15:36:57 -0700646static char const *StringDescriptorReqComponentType(descriptor_req req) {
647 if (req & DESCRIPTOR_REQ_COMPONENT_TYPE_SINT) return "SINT";
648 if (req & DESCRIPTOR_REQ_COMPONENT_TYPE_UINT) return "UINT";
649 if (req & DESCRIPTOR_REQ_COMPONENT_TYPE_FLOAT) return "FLOAT";
650 return "(none)";
651}
652
Chris Forbesda01e8d2018-08-27 15:36:57 -0700653static unsigned DescriptorRequirementsBitsFromFormat(VkFormat fmt) {
654 if (FormatIsSInt(fmt)) return DESCRIPTOR_REQ_COMPONENT_TYPE_SINT;
655 if (FormatIsUInt(fmt)) return DESCRIPTOR_REQ_COMPONENT_TYPE_UINT;
656 if (FormatIsDepthAndStencil(fmt)) return DESCRIPTOR_REQ_COMPONENT_TYPE_FLOAT | DESCRIPTOR_REQ_COMPONENT_TYPE_UINT;
657 if (fmt == VK_FORMAT_UNDEFINED) return 0;
658 // everything else -- UNORM/SNORM/FLOAT/USCALED/SSCALED is all float in the shader.
659 return DESCRIPTOR_REQ_COMPONENT_TYPE_FLOAT;
660}
661
Tobin Ehlis3066db62016-08-22 08:12:23 -0600662// 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 -0600663// This includes validating that all descriptors in the given bindings are updated,
664// that any update buffers are valid, and that any dynamic offsets are within the bounds of their buffers.
665// Return true if state is acceptable, or false and write an error message into error string
Tobin Ehliscebc4c02016-08-22 10:10:43 -0600666bool cvdescriptorset::DescriptorSet::ValidateDrawState(const std::map<uint32_t, descriptor_req> &bindings,
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600667 const std::vector<uint32_t> &dynamic_offsets, CMD_BUFFER_STATE *cb_node,
Tobin Ehlisc8266452017-04-07 12:20:30 -0600668 const char *caller, std::string *error) const {
Chris Forbesc7090a82016-07-25 18:10:41 +1200669 for (auto binding_pair : bindings) {
670 auto binding = binding_pair.first;
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600671 if (!p_layout_->HasBinding(binding)) {
Tobin Ehlis58c59582016-06-21 12:34:33 -0600672 std::stringstream error_str;
673 error_str << "Attempting to validate DrawState for binding #" << binding
674 << " which is an invalid binding for this descriptor set.";
675 *error = error_str.str();
676 return false;
677 }
John Zulaufc483f442017-12-15 14:02:06 -0700678 IndexRange index_range = p_layout_->GetGlobalIndexRangeFromBinding(binding);
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700679 auto array_idx = 0; // Track array idx if we're dealing with array descriptors
Jeff Bolzfdf96072018-04-10 14:32:18 -0500680
681 if (IsVariableDescriptorCount(binding)) {
682 // Only validate the first N descriptors if it uses variable_count
683 index_range.end = index_range.start + GetVariableDescriptorCount();
684 }
685
John Zulaufc483f442017-12-15 14:02:06 -0700686 for (uint32_t i = index_range.start; i < index_range.end; ++i, ++array_idx) {
Lockeb994adf2019-03-29 23:52:31 -0600687 uint32_t index = i - index_range.start;
688
Tobin Ehlisda77de72018-12-13 08:53:28 -0700689 if ((p_layout_->GetDescriptorBindingFlagsFromBinding(binding) &
690 (VK_DESCRIPTOR_BINDING_PARTIALLY_BOUND_BIT_EXT | VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT)) ||
Jeff Bolze54ae892018-09-08 12:16:29 -0500691 descriptors_[i]->GetClass() == InlineUniform) {
Jeff Bolzfdf96072018-04-10 14:32:18 -0500692 // Can't validate the descriptor because it may not have been updated,
693 // or the view could have been destroyed
694 continue;
695 } else if (!descriptors_[i]->updated) {
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700696 std::stringstream error_str;
Lockeb994adf2019-03-29 23:52:31 -0600697 error_str << "Descriptor in binding #" << binding << " index " << index
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700698 << " is being used in draw but has not been updated.";
699 *error = error_str.str();
700 return false;
701 } else {
702 auto descriptor_class = descriptors_[i]->GetClass();
703 if (descriptor_class == GeneralBuffer) {
704 // Verify that buffers are valid
705 auto buffer = static_cast<BufferDescriptor *>(descriptors_[i].get())->GetBuffer();
Mark Lobodzinski6ed74142019-03-06 11:35:39 -0700706 auto buffer_node = device_data_->GetBufferState(buffer);
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700707 if (!buffer_node) {
708 std::stringstream error_str;
Lockeb994adf2019-03-29 23:52:31 -0600709 error_str << "Descriptor in binding #" << binding << " index " << index << " references invalid buffer "
710 << buffer << ".";
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700711 *error = error_str.str();
712 return false;
John Zulauf48a6a702017-12-22 17:14:54 -0700713 } else if (!buffer_node->sparse) {
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700714 for (auto mem_binding : buffer_node->GetBoundMemory()) {
Mark Lobodzinski0a41e0e2019-04-25 12:12:40 -0600715 if (!device_data_->GetDevMemState(mem_binding)) {
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700716 std::stringstream error_str;
Lockeb994adf2019-03-29 23:52:31 -0600717 error_str << "Descriptor in binding #" << binding << " index " << index << " uses buffer " << buffer
718 << " that references invalid memory " << mem_binding << ".";
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700719 *error = error_str.str();
Tobin Ehlisc8266452017-04-07 12:20:30 -0600720 return false;
721 }
722 }
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700723 }
724 if (descriptors_[i]->IsDynamic()) {
725 // Validate that dynamic offsets are within the buffer
726 auto buffer_size = buffer_node->createInfo.size;
727 auto range = static_cast<BufferDescriptor *>(descriptors_[i].get())->GetRange();
728 auto desc_offset = static_cast<BufferDescriptor *>(descriptors_[i].get())->GetOffset();
729 auto dyn_offset = dynamic_offsets[GetDynamicOffsetIndexFromBinding(binding) + array_idx];
730 if (VK_WHOLE_SIZE == range) {
731 if ((dyn_offset + desc_offset) > buffer_size) {
732 std::stringstream error_str;
Lockeb994adf2019-03-29 23:52:31 -0600733 error_str << "Dynamic descriptor in binding #" << binding << " index " << index << " uses buffer "
734 << buffer << " with update range of VK_WHOLE_SIZE has dynamic offset " << dyn_offset
735 << " combined with offset " << desc_offset << " that oversteps the buffer size of "
736 << buffer_size << ".";
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700737 *error = error_str.str();
738 return false;
739 }
740 } else {
741 if ((dyn_offset + desc_offset + range) > buffer_size) {
742 std::stringstream error_str;
Lockeb994adf2019-03-29 23:52:31 -0600743 error_str << "Dynamic descriptor in binding #" << binding << " index " << index << " uses buffer "
744 << buffer << " with dynamic offset " << dyn_offset << " combined with offset "
745 << desc_offset << " and range " << range << " that oversteps the buffer size of "
746 << buffer_size << ".";
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700747 *error = error_str.str();
748 return false;
749 }
750 }
751 }
752 } else if (descriptor_class == ImageSampler || descriptor_class == Image) {
753 VkImageView image_view;
754 VkImageLayout image_layout;
755 if (descriptor_class == ImageSampler) {
756 image_view = static_cast<ImageSamplerDescriptor *>(descriptors_[i].get())->GetImageView();
757 image_layout = static_cast<ImageSamplerDescriptor *>(descriptors_[i].get())->GetImageLayout();
758 } else {
759 image_view = static_cast<ImageDescriptor *>(descriptors_[i].get())->GetImageView();
760 image_layout = static_cast<ImageDescriptor *>(descriptors_[i].get())->GetImageLayout();
761 }
762 auto reqs = binding_pair.second;
763
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700764 auto image_view_state = device_data_->GetImageViewState(image_view);
Tobin Ehlis836a1372017-07-14 11:25:21 -0600765 if (nullptr == image_view_state) {
766 // Image view must have been destroyed since initial update. Could potentially flag the descriptor
767 // as "invalid" (updated = false) at DestroyImageView() time and detect this error at bind time
768 std::stringstream error_str;
Lockeb994adf2019-03-29 23:52:31 -0600769 error_str << "Descriptor in binding #" << binding << " index " << index << " is using imageView "
770 << image_view << " that has been destroyed.";
Tobin Ehlis836a1372017-07-14 11:25:21 -0600771 *error = error_str.str();
772 return false;
773 }
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700774 auto image_view_ci = image_view_state->create_info;
775
776 if ((reqs & DESCRIPTOR_REQ_ALL_VIEW_TYPE_BITS) && (~reqs & (1 << image_view_ci.viewType))) {
777 // bad view type
778 std::stringstream error_str;
Lockeb994adf2019-03-29 23:52:31 -0600779 error_str << "Descriptor in binding #" << binding << " index " << index
Shannon McPhersonc06c33d2018-06-28 17:21:12 -0600780 << " requires an image view of type " << StringDescriptorReqViewType(reqs) << " but got "
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700781 << string_VkImageViewType(image_view_ci.viewType) << ".";
782 *error = error_str.str();
783 return false;
784 }
785
Chris Forbesda01e8d2018-08-27 15:36:57 -0700786 auto format_bits = DescriptorRequirementsBitsFromFormat(image_view_ci.format);
787 if (!(reqs & format_bits)) {
788 // bad component type
789 std::stringstream error_str;
Lockeb994adf2019-03-29 23:52:31 -0600790 error_str << "Descriptor in binding #" << binding << " index " << index << " requires "
Chris Forbesda01e8d2018-08-27 15:36:57 -0700791 << StringDescriptorReqComponentType(reqs) << " component type, but bound descriptor format is "
792 << string_VkFormat(image_view_ci.format) << ".";
793 *error = error_str.str();
794 return false;
795 }
796
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700797 auto image_node = device_data_->GetImageState(image_view_ci.image);
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700798 assert(image_node);
799 // Verify Image Layout
John Zulauff660ad62019-03-23 07:16:05 -0600800 // No "invalid layout" VUID required for this call, since the optimal_layout parameter is UNDEFINED.
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700801 bool hit_error = false;
John Zulauff660ad62019-03-23 07:16:05 -0600802 device_data_->VerifyImageLayout(cb_node, image_node, image_view_state->normalized_subresource_range,
John Zulaufabcc8292019-04-08 18:07:44 -0600803 image_view_ci.subresourceRange.aspectMask, image_layout,
804 VK_IMAGE_LAYOUT_UNDEFINED, caller, kVUIDUndefined,
John Zulauff660ad62019-03-23 07:16:05 -0600805 "VUID-VkDescriptorImageInfo-imageLayout-00344", &hit_error);
806 if (hit_error) {
807 *error =
808 "Image layout specified at vkUpdateDescriptorSet* or vkCmdPushDescriptorSet* time "
809 "doesn't match actual image layout at time descriptor is used. See previous error callback for "
810 "specific details.";
811 return false;
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700812 }
John Zulauff660ad62019-03-23 07:16:05 -0600813
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700814 // Verify Sample counts
815 if ((reqs & DESCRIPTOR_REQ_SINGLE_SAMPLE) && image_node->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
816 std::stringstream error_str;
Lockeb994adf2019-03-29 23:52:31 -0600817 error_str << "Descriptor in binding #" << binding << " index " << index
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700818 << " requires bound image to have VK_SAMPLE_COUNT_1_BIT but got "
819 << string_VkSampleCountFlagBits(image_node->createInfo.samples) << ".";
820 *error = error_str.str();
821 return false;
822 }
823 if ((reqs & DESCRIPTOR_REQ_MULTI_SAMPLE) && image_node->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
824 std::stringstream error_str;
Lockeb994adf2019-03-29 23:52:31 -0600825 error_str << "Descriptor in binding #" << binding << " index " << index
Chris Forbes1f7f3ca2017-05-08 13:54:50 -0700826 << " requires bound image to have multiple samples, but got VK_SAMPLE_COUNT_1_BIT.";
827 *error = error_str.str();
828 return false;
Chris Forbes57989132016-07-26 17:06:10 +1200829 }
Chris Forbese92dd1d2019-01-21 15:58:57 -0800830 } else if (descriptor_class == TexelBuffer) {
831 auto texel_buffer = static_cast<TexelDescriptor *>(descriptors_[i].get());
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -0700832 auto buffer_view = device_data_->GetBufferViewState(texel_buffer->GetBufferView());
Chris Forbese92dd1d2019-01-21 15:58:57 -0800833
Locke2d9c3dd2019-04-08 16:29:09 -0600834 if (nullptr == buffer_view) {
835 std::stringstream error_str;
836 error_str << "Descriptor in binding #" << binding << " index " << index << " is using bufferView "
837 << buffer_view << " that has been destroyed.";
838 *error = error_str.str();
839 return false;
840 }
841 auto buffer = buffer_view->create_info.buffer;
842 auto buffer_state = device_data_->GetBufferState(buffer);
843 if (!buffer_state) {
844 std::stringstream error_str;
845 error_str << "Descriptor in binding #" << binding << " index " << index << " is using buffer "
846 << buffer_state << " that has been destroyed.";
847 *error = error_str.str();
848 return false;
849 }
Chris Forbese92dd1d2019-01-21 15:58:57 -0800850 auto reqs = binding_pair.second;
851 auto format_bits = DescriptorRequirementsBitsFromFormat(buffer_view->create_info.format);
852
853 if (!(reqs & format_bits)) {
854 // bad component type
855 std::stringstream error_str;
Lockeb994adf2019-03-29 23:52:31 -0600856 error_str << "Descriptor in binding #" << binding << " index " << index << " requires "
Chris Forbese92dd1d2019-01-21 15:58:57 -0800857 << StringDescriptorReqComponentType(reqs) << " component type, but bound descriptor format is "
858 << string_VkFormat(buffer_view->create_info.format) << ".";
859 *error = error_str.str();
860 return false;
861 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600862 }
Tobin Ehlisb1a2e4b2018-03-16 07:54:24 -0600863 if (descriptor_class == ImageSampler || descriptor_class == PlainSampler) {
864 // Verify Sampler still valid
865 VkSampler sampler;
866 if (descriptor_class == ImageSampler) {
867 sampler = static_cast<ImageSamplerDescriptor *>(descriptors_[i].get())->GetSampler();
868 } else {
869 sampler = static_cast<SamplerDescriptor *>(descriptors_[i].get())->GetSampler();
870 }
871 if (!ValidateSampler(sampler, device_data_)) {
872 std::stringstream error_str;
Lockeb994adf2019-03-29 23:52:31 -0600873 error_str << "Descriptor in binding #" << binding << " index " << index << " is using sampler " << sampler
874 << " that has been destroyed.";
Tobin Ehlisb1a2e4b2018-03-16 07:54:24 -0600875 *error = error_str.str();
876 return false;
Lockea223c102019-04-05 00:38:24 -0600877 } else {
878 SAMPLER_STATE *sampler_state = device_data_->GetSamplerState(sampler);
879 if (sampler_state->samplerConversion && !descriptors_[i].get()->IsImmutableSampler()) {
880 std::stringstream error_str;
881 error_str << "sampler (" << sampler << ") in the descriptor set (" << set_
882 << ") contains a YCBCR conversion (" << sampler_state->samplerConversion
883 << ") , then the sampler MUST also exists as an immutable sampler.";
884 *error = error_str.str();
885 }
Tobin Ehlisb1a2e4b2018-03-16 07:54:24 -0600886 }
887 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600888 }
889 }
890 }
891 return true;
892}
Chris Forbes57989132016-07-26 17:06:10 +1200893
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600894// For given bindings, place any update buffers or images into the passed-in unordered_sets
Tobin Ehliscebc4c02016-08-22 10:10:43 -0600895uint32_t cvdescriptorset::DescriptorSet::GetStorageUpdates(const std::map<uint32_t, descriptor_req> &bindings,
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600896 std::unordered_set<VkBuffer> *buffer_set,
897 std::unordered_set<VkImageView> *image_set) const {
898 auto num_updates = 0;
Chris Forbesc7090a82016-07-25 18:10:41 +1200899 for (auto binding_pair : bindings) {
900 auto binding = binding_pair.first;
Tobin Ehlis58c59582016-06-21 12:34:33 -0600901 // If a binding doesn't exist, skip it
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600902 if (!p_layout_->HasBinding(binding)) {
Tobin Ehlis58c59582016-06-21 12:34:33 -0600903 continue;
904 }
John Zulaufc483f442017-12-15 14:02:06 -0700905 uint32_t start_idx = p_layout_->GetGlobalIndexRangeFromBinding(binding).start;
Tobin Ehlis81f17852016-05-05 09:04:33 -0600906 if (descriptors_[start_idx]->IsStorage()) {
907 if (Image == descriptors_[start_idx]->descriptor_class) {
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600908 for (uint32_t i = 0; i < p_layout_->GetDescriptorCountFromBinding(binding); ++i) {
Tobin Ehlis81f17852016-05-05 09:04:33 -0600909 if (descriptors_[start_idx + i]->updated) {
910 image_set->insert(static_cast<ImageDescriptor *>(descriptors_[start_idx + i].get())->GetImageView());
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600911 num_updates++;
912 }
913 }
Tobin Ehlis81f17852016-05-05 09:04:33 -0600914 } else if (TexelBuffer == descriptors_[start_idx]->descriptor_class) {
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600915 for (uint32_t i = 0; i < p_layout_->GetDescriptorCountFromBinding(binding); ++i) {
Tobin Ehlis81f17852016-05-05 09:04:33 -0600916 if (descriptors_[start_idx + i]->updated) {
917 auto bufferview = static_cast<TexelDescriptor *>(descriptors_[start_idx + i].get())->GetBufferView();
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -0700918 auto bv_state = device_data_->GetBufferViewState(bufferview);
Tobin Ehlis8b872462016-09-14 08:12:08 -0600919 if (bv_state) {
920 buffer_set->insert(bv_state->create_info.buffer);
Tobin Ehlis0bc30632016-05-05 10:16:02 -0600921 num_updates++;
922 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600923 }
924 }
Tobin Ehlis81f17852016-05-05 09:04:33 -0600925 } else if (GeneralBuffer == descriptors_[start_idx]->descriptor_class) {
Tobin Ehlis7cd8c792017-06-20 08:30:39 -0600926 for (uint32_t i = 0; i < p_layout_->GetDescriptorCountFromBinding(binding); ++i) {
Tobin Ehlis81f17852016-05-05 09:04:33 -0600927 if (descriptors_[start_idx + i]->updated) {
928 buffer_set->insert(static_cast<BufferDescriptor *>(descriptors_[start_idx + i].get())->GetBuffer());
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600929 num_updates++;
930 }
931 }
932 }
933 }
934 }
935 return num_updates;
936}
Tobin Ehlis9906d9d2016-05-17 14:23:46 -0600937// Set is being deleted or updates so invalidate all bound cmd buffers
938void cvdescriptorset::DescriptorSet::InvalidateBoundCmdBuffers() {
John Zulauf4fea6622019-04-01 11:38:18 -0600939 device_data_->InvalidateCommandBuffers(cb_bindings, VulkanTypedHandle(set_, kVulkanObjectTypeDescriptorSet));
Tobin Ehlis9906d9d2016-05-17 14:23:46 -0600940}
John Zulauf1d27e0a2018-11-05 10:12:48 -0700941
942// Loop through the write updates to do for a push descriptor set, ignoring dstSet
943void cvdescriptorset::DescriptorSet::PerformPushDescriptorsUpdate(uint32_t write_count, const VkWriteDescriptorSet *p_wds) {
944 assert(IsPushDescriptor());
945 for (uint32_t i = 0; i < write_count; i++) {
946 PerformWriteUpdate(&p_wds[i]);
947 }
948}
949
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600950// Perform write update in given update struct
Tobin Ehlis300888c2016-05-18 13:43:26 -0600951void cvdescriptorset::DescriptorSet::PerformWriteUpdate(const VkWriteDescriptorSet *update) {
Tobin Ehlisf922ef82016-11-30 10:19:14 -0700952 // Perform update on a per-binding basis as consecutive updates roll over to next binding
953 auto descriptors_remaining = update->descriptorCount;
954 auto binding_being_updated = update->dstBinding;
955 auto offset = update->dstArrayElement;
Tobin Ehlise16805c2017-08-09 09:10:37 -0600956 uint32_t update_index = 0;
Tobin Ehlisf922ef82016-11-30 10:19:14 -0700957 while (descriptors_remaining) {
958 uint32_t update_count = std::min(descriptors_remaining, GetDescriptorCountFromBinding(binding_being_updated));
John Zulaufc483f442017-12-15 14:02:06 -0700959 auto global_idx = p_layout_->GetGlobalIndexRangeFromBinding(binding_being_updated).start + offset;
Tobin Ehlisf922ef82016-11-30 10:19:14 -0700960 // Loop over the updates for a single binding at a time
Tobin Ehlise16805c2017-08-09 09:10:37 -0600961 for (uint32_t di = 0; di < update_count; ++di, ++update_index) {
962 descriptors_[global_idx + di]->WriteUpdate(update, update_index);
Tobin Ehlisf922ef82016-11-30 10:19:14 -0700963 }
964 // Roll over to next binding in case of consecutive update
965 descriptors_remaining -= update_count;
966 offset = 0;
967 binding_being_updated++;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600968 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -0700969 if (update->descriptorCount) some_update_ = true;
Tobin Ehlis56a30942016-05-19 08:00:00 -0600970
Jeff Bolzfdf96072018-04-10 14:32:18 -0500971 if (!(p_layout_->GetDescriptorBindingFlagsFromBinding(update->dstBinding) &
972 (VK_DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT_EXT | VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT))) {
973 InvalidateBoundCmdBuffers();
974 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -0600975}
Tobin Ehlis300888c2016-05-18 13:43:26 -0600976// Validate Copy update
John Zulaufd9435c32019-06-05 15:55:36 -0600977bool cvdescriptorset::ValidateCopyUpdate(const debug_report_data *report_data, const VkCopyDescriptorSet *update,
978 const DescriptorSet *dst_set, const DescriptorSet *src_set, const char *func_name,
979 std::string *error_code, std::string *error_msg) {
980 auto dst_layout = dst_set->GetLayout();
981 auto src_layout = src_set->GetLayout();
982
John Zulauf5dfd45c2018-01-17 11:06:34 -0700983 // Verify dst layout still valid
John Zulaufd9435c32019-06-05 15:55:36 -0600984 if (dst_layout->IsDestroyed()) {
Dave Houlton00c154e2018-05-24 13:20:50 -0600985 *error_code = "VUID-VkCopyDescriptorSet-dstSet-parameter";
John Zulauf5dfd45c2018-01-17 11:06:34 -0700986 string_sprintf(error_msg,
Lockeca0d9792019-03-03 23:48:13 -0700987 "Cannot call %s to perform copy update on descriptor set dstSet %s"
988 " created with destroyed VkDescriptorSetLayout %s.",
John Zulaufd9435c32019-06-05 15:55:36 -0600989 func_name, report_data->FormatHandle(dst_set->GetSet()).c_str(),
990 report_data->FormatHandle(dst_layout->GetDescriptorSetLayout()).c_str());
John Zulauf5dfd45c2018-01-17 11:06:34 -0700991 return false;
992 }
993
994 // Verify src layout still valid
John Zulaufd9435c32019-06-05 15:55:36 -0600995 if (src_layout->IsDestroyed()) {
Dave Houlton00c154e2018-05-24 13:20:50 -0600996 *error_code = "VUID-VkCopyDescriptorSet-srcSet-parameter";
John Zulaufb45fdc32018-10-12 15:14:17 -0600997 string_sprintf(error_msg,
Lockeca0d9792019-03-03 23:48:13 -0700998 "Cannot call %s to perform copy update of dstSet %s"
999 " from descriptor set srcSet %s"
1000 " created with destroyed VkDescriptorSetLayout %s.",
John Zulaufd9435c32019-06-05 15:55:36 -06001001 func_name, report_data->FormatHandle(dst_set->GetSet()).c_str(),
1002 report_data->FormatHandle(src_set->GetSet()).c_str(),
1003 report_data->FormatHandle(src_layout->GetDescriptorSetLayout()).c_str());
John Zulauf5dfd45c2018-01-17 11:06:34 -07001004 return false;
1005 }
1006
John Zulaufd9435c32019-06-05 15:55:36 -06001007 if (!dst_layout->HasBinding(update->dstBinding)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001008 *error_code = "VUID-VkCopyDescriptorSet-dstBinding-00347";
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001009 std::stringstream error_str;
John Zulaufd9435c32019-06-05 15:55:36 -06001010 error_str << "DescriptorSet " << dst_set->GetSet() << " does not have copy update dest binding of " << update->dstBinding;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001011 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001012 return false;
1013 }
1014 if (!src_set->HasBinding(update->srcBinding)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001015 *error_code = "VUID-VkCopyDescriptorSet-srcBinding-00345";
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001016 std::stringstream error_str;
John Zulaufd9435c32019-06-05 15:55:36 -06001017 error_str << "DescriptorSet " << dst_set->GetSet() << " does not have copy update src binding of " << update->srcBinding;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001018 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001019 return false;
1020 }
Jeff Bolzfdf96072018-04-10 14:32:18 -05001021 // Verify idle ds
John Zulaufd9435c32019-06-05 15:55:36 -06001022 if (dst_set->in_use.load() &&
1023 !(dst_layout->GetDescriptorBindingFlagsFromBinding(update->dstBinding) &
Jeff Bolzfdf96072018-04-10 14:32:18 -05001024 (VK_DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT_EXT | VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT))) {
1025 // TODO : Re-using Free Idle error code, need copy update idle error code
Dave Houlton00c154e2018-05-24 13:20:50 -06001026 *error_code = "VUID-vkFreeDescriptorSets-pDescriptorSets-00309";
Jeff Bolzfdf96072018-04-10 14:32:18 -05001027 std::stringstream error_str;
John Zulaufd9435c32019-06-05 15:55:36 -06001028 error_str << "Cannot call " << func_name << " to perform copy update on descriptor set " << dst_set->GetSet()
Jeff Bolzfdf96072018-04-10 14:32:18 -05001029 << " that is in use by a command buffer";
1030 *error_msg = error_str.str();
1031 return false;
1032 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001033 // src & dst set bindings are valid
1034 // Check bounds of src & dst
John Zulaufc483f442017-12-15 14:02:06 -07001035 auto src_start_idx = src_set->GetGlobalIndexRangeFromBinding(update->srcBinding).start + update->srcArrayElement;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001036 if ((src_start_idx + update->descriptorCount) > src_set->GetTotalDescriptorCount()) {
1037 // SRC update out of bounds
Dave Houlton00c154e2018-05-24 13:20:50 -06001038 *error_code = "VUID-VkCopyDescriptorSet-srcArrayElement-00346";
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001039 std::stringstream error_str;
1040 error_str << "Attempting copy update from descriptorSet " << update->srcSet << " binding#" << update->srcBinding
John Zulaufc483f442017-12-15 14:02:06 -07001041 << " with offset index of " << src_set->GetGlobalIndexRangeFromBinding(update->srcBinding).start
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001042 << " plus update array offset of " << update->srcArrayElement << " and update of " << update->descriptorCount
Tobin Ehlis1d81edd2016-11-21 09:50:49 -07001043 << " descriptors oversteps total number of descriptors in set: " << src_set->GetTotalDescriptorCount();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001044 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001045 return false;
1046 }
John Zulaufd9435c32019-06-05 15:55:36 -06001047 auto dst_start_idx = dst_layout->GetGlobalIndexRangeFromBinding(update->dstBinding).start + update->dstArrayElement;
1048 if ((dst_start_idx + update->descriptorCount) > dst_layout->GetTotalDescriptorCount()) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001049 // DST update out of bounds
Dave Houlton00c154e2018-05-24 13:20:50 -06001050 *error_code = "VUID-VkCopyDescriptorSet-dstArrayElement-00348";
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001051 std::stringstream error_str;
John Zulaufd9435c32019-06-05 15:55:36 -06001052 error_str << "Attempting copy update to descriptorSet " << dst_set->GetSet() << " binding#" << update->dstBinding
1053 << " with offset index of " << dst_layout->GetGlobalIndexRangeFromBinding(update->dstBinding).start
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001054 << " plus update array offset of " << update->dstArrayElement << " and update of " << update->descriptorCount
John Zulaufd9435c32019-06-05 15:55:36 -06001055 << " descriptors oversteps total number of descriptors in set: " << dst_layout->GetTotalDescriptorCount();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001056 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001057 return false;
1058 }
1059 // Check that types match
Dave Houltond8ed0212018-05-16 17:18:24 -06001060 // TODO : Base default error case going from here is "VUID-VkAcquireNextImageInfoKHR-semaphore-parameter"2ba which covers all
1061 // consistency issues, need more fine-grained error codes
Dave Houlton00c154e2018-05-24 13:20:50 -06001062 *error_code = "VUID-VkCopyDescriptorSet-srcSet-00349";
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001063 auto src_type = src_set->GetTypeFromBinding(update->srcBinding);
John Zulaufd9435c32019-06-05 15:55:36 -06001064 auto dst_type = dst_layout->GetTypeFromBinding(update->dstBinding);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001065 if (src_type != dst_type) {
1066 std::stringstream error_str;
John Zulaufd9435c32019-06-05 15:55:36 -06001067 error_str << "Attempting copy update to descriptorSet " << dst_set->GetSet() << " binding #" << update->dstBinding
1068 << " with type " << string_VkDescriptorType(dst_type) << " from descriptorSet " << src_set->GetSet()
1069 << " binding #" << update->srcBinding << " with type " << string_VkDescriptorType(src_type)
1070 << ". Types do not match";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001071 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001072 return false;
1073 }
1074 // Verify consistency of src & dst bindings if update crosses binding boundaries
John Zulaufd9435c32019-06-05 15:55:36 -06001075 if ((!VerifyUpdateConsistency(DescriptorSetLayout::ConstBindingIterator(src_layout.get(), update->srcBinding),
John Zulauf4a015c92019-06-04 09:50:05 -06001076 update->srcArrayElement, update->descriptorCount, "copy update from", src_set->GetSet(),
1077 error_msg)) ||
John Zulaufd9435c32019-06-05 15:55:36 -06001078 (!VerifyUpdateConsistency(DescriptorSetLayout::ConstBindingIterator(dst_layout.get(), update->dstBinding),
1079 update->dstArrayElement, update->descriptorCount, "copy update to", dst_set->GetSet(),
1080 error_msg))) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001081 return false;
1082 }
Jeff Bolzfdf96072018-04-10 14:32:18 -05001083
John Zulaufd9435c32019-06-05 15:55:36 -06001084 if ((src_layout->GetCreateFlags() & VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT) &&
1085 !(dst_layout->GetCreateFlags() & VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001086 *error_code = "VUID-VkCopyDescriptorSet-srcSet-01918";
Jeff Bolzfdf96072018-04-10 14:32:18 -05001087 std::stringstream error_str;
1088 error_str << "If pname:srcSet's (" << update->srcSet
1089 << ") layout was created with the "
1090 "ename:VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT flag "
1091 "set, then pname:dstSet's ("
1092 << update->dstSet
1093 << ") layout must: also have been created with the "
1094 "ename:VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT flag set";
1095 *error_msg = error_str.str();
1096 return false;
1097 }
1098
John Zulaufd9435c32019-06-05 15:55:36 -06001099 if (!(src_layout->GetCreateFlags() & VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT) &&
1100 (dst_layout->GetCreateFlags() & VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001101 *error_code = "VUID-VkCopyDescriptorSet-srcSet-01919";
Jeff Bolzfdf96072018-04-10 14:32:18 -05001102 std::stringstream error_str;
1103 error_str << "If pname:srcSet's (" << update->srcSet
1104 << ") layout was created without the "
1105 "ename:VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT flag "
1106 "set, then pname:dstSet's ("
1107 << update->dstSet
1108 << ") layout must: also have been created without the "
1109 "ename:VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT flag set";
1110 *error_msg = error_str.str();
1111 return false;
1112 }
1113
1114 if ((src_set->GetPoolState()->createInfo.flags & VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT) &&
John Zulaufd9435c32019-06-05 15:55:36 -06001115 !(dst_set->GetPoolState()->createInfo.flags & VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001116 *error_code = "VUID-VkCopyDescriptorSet-srcSet-01920";
Jeff Bolzfdf96072018-04-10 14:32:18 -05001117 std::stringstream error_str;
1118 error_str << "If the descriptor pool from which pname:srcSet (" << update->srcSet
1119 << ") was allocated was created "
1120 "with the ename:VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT flag "
1121 "set, then the descriptor pool from which pname:dstSet ("
1122 << update->dstSet
1123 << ") was allocated must: "
1124 "also have been created with the ename:VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT flag set";
1125 *error_msg = error_str.str();
1126 return false;
1127 }
1128
1129 if (!(src_set->GetPoolState()->createInfo.flags & VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT) &&
John Zulaufd9435c32019-06-05 15:55:36 -06001130 (dst_set->GetPoolState()->createInfo.flags & VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001131 *error_code = "VUID-VkCopyDescriptorSet-srcSet-01921";
Jeff Bolzfdf96072018-04-10 14:32:18 -05001132 std::stringstream error_str;
1133 error_str << "If the descriptor pool from which pname:srcSet (" << update->srcSet
1134 << ") was allocated was created "
1135 "without the ename:VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT flag "
1136 "set, then the descriptor pool from which pname:dstSet ("
1137 << update->dstSet
1138 << ") was allocated must: "
1139 "also have been created without the ename:VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT flag set";
1140 *error_msg = error_str.str();
1141 return false;
1142 }
1143
Jeff Bolze54ae892018-09-08 12:16:29 -05001144 if (src_type == VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT) {
1145 if ((update->srcArrayElement % 4) != 0) {
1146 *error_code = "VUID-VkCopyDescriptorSet-srcBinding-02223";
1147 std::stringstream error_str;
1148 error_str << "Attempting copy update to VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT binding with "
1149 << "srcArrayElement " << update->srcArrayElement << " not a multiple of 4";
1150 *error_msg = error_str.str();
1151 return false;
1152 }
1153 if ((update->dstArrayElement % 4) != 0) {
1154 *error_code = "VUID-VkCopyDescriptorSet-dstBinding-02224";
1155 std::stringstream error_str;
1156 error_str << "Attempting copy update to VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT binding with "
1157 << "dstArrayElement " << update->dstArrayElement << " not a multiple of 4";
1158 *error_msg = error_str.str();
1159 return false;
1160 }
1161 if ((update->descriptorCount % 4) != 0) {
1162 *error_code = "VUID-VkCopyDescriptorSet-srcBinding-02225";
1163 std::stringstream error_str;
1164 error_str << "Attempting copy update to VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT binding with "
1165 << "descriptorCount " << update->descriptorCount << " not a multiple of 4";
1166 *error_msg = error_str.str();
1167 return false;
1168 }
1169 }
1170
Tobin Ehlisd41e7b62016-05-19 07:56:18 -06001171 // Update parameters all look good and descriptor updated so verify update contents
John Zulaufd9435c32019-06-05 15:55:36 -06001172 if (!VerifyCopyUpdateContents(dst_set->GetDeviceData(), update, src_set, src_type, src_start_idx, func_name, error_code,
1173 error_msg))
1174 return false;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001175
1176 // All checks passed so update is good
1177 return true;
1178}
1179// Perform Copy update
1180void cvdescriptorset::DescriptorSet::PerformCopyUpdate(const VkCopyDescriptorSet *update, const DescriptorSet *src_set) {
John Zulaufc483f442017-12-15 14:02:06 -07001181 auto src_start_idx = src_set->GetGlobalIndexRangeFromBinding(update->srcBinding).start + update->srcArrayElement;
1182 auto dst_start_idx = p_layout_->GetGlobalIndexRangeFromBinding(update->dstBinding).start + update->dstArrayElement;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001183 // Update parameters all look good so perform update
1184 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
Józef Kucia5297e372017-10-13 22:31:34 +02001185 auto src = src_set->descriptors_[src_start_idx + di].get();
1186 auto dst = descriptors_[dst_start_idx + di].get();
1187 if (src->updated) {
1188 dst->CopyUpdate(src);
1189 some_update_ = true;
1190 } else {
1191 dst->updated = false;
1192 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001193 }
Tobin Ehlis56a30942016-05-19 08:00:00 -06001194
Jeff Bolzfdf96072018-04-10 14:32:18 -05001195 if (!(p_layout_->GetDescriptorBindingFlagsFromBinding(update->dstBinding) &
1196 (VK_DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT_EXT | VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT))) {
1197 InvalidateBoundCmdBuffers();
1198 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001199}
Tobin Ehlis56a30942016-05-19 08:00:00 -06001200
John Zulauf6f3d2bd2018-10-29 17:08:42 -06001201// Update the drawing state for the affected descriptors.
1202// Set cb_node to this set and this set to cb_node.
1203// Add the bindings of the descriptor
1204// Set the layout based on the current descriptor layout (will mask subsequent layer mismatch errors)
1205// TODO: Modify the UpdateDrawState virtural functions to *only* set initial layout and not change layouts
Tobin Ehlisf9519102016-08-17 09:49:13 -06001206// Prereq: This should be called for a set that has been confirmed to be active for the given cb_node, meaning it's going
1207// to be used in a draw by the given cb_node
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001208void cvdescriptorset::DescriptorSet::UpdateDrawState(CoreChecks *device_data, CMD_BUFFER_STATE *cb_node,
John Zulauf6f3d2bd2018-10-29 17:08:42 -06001209 const std::map<uint32_t, descriptor_req> &binding_req_map) {
Tobin Ehlis9252c2b2016-07-21 14:40:22 -06001210 // bind cb to this descriptor set
1211 cb_bindings.insert(cb_node);
Tobin Ehlis7ca20be2016-10-12 15:09:16 -06001212 // Add bindings for descriptor set, the set's pool, and individual objects in the set
John Zulauf4fea6622019-04-01 11:38:18 -06001213 cb_node->object_bindings.emplace(set_, kVulkanObjectTypeDescriptorSet);
Tobin Ehlis7ca20be2016-10-12 15:09:16 -06001214 pool_state_->cb_bindings.insert(cb_node);
John Zulauf4fea6622019-04-01 11:38:18 -06001215 cb_node->object_bindings.emplace(pool_state_->pool, kVulkanObjectTypeDescriptorPool);
Tobin Ehlisf9519102016-08-17 09:49:13 -06001216 // For the active slots, use set# to look up descriptorSet from boundDescriptorSets, and bind all of that descriptor set's
1217 // resources
Tobin Ehlis022528b2016-12-29 12:22:32 -07001218 for (auto binding_req_pair : binding_req_map) {
1219 auto binding = binding_req_pair.first;
Tony-LunarG62c5dba2018-12-20 14:27:23 -07001220 // We aren't validating descriptors created with PARTIALLY_BOUND or UPDATE_AFTER_BIND, so don't record state
1221 if (p_layout_->GetDescriptorBindingFlagsFromBinding(binding) &
1222 (VK_DESCRIPTOR_BINDING_PARTIALLY_BOUND_BIT_EXT | VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT)) {
1223 continue;
1224 }
John Zulaufc483f442017-12-15 14:02:06 -07001225 auto range = p_layout_->GetGlobalIndexRangeFromBinding(binding);
1226 for (uint32_t i = range.start; i < range.end; ++i) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001227 descriptors_[i]->UpdateDrawState(device_data, cb_node);
Mark Lobodzinski2872f4a2018-09-03 17:00:53 -06001228 }
1229 }
1230}
1231
John Zulauf48a6a702017-12-22 17:14:54 -07001232void cvdescriptorset::DescriptorSet::FilterAndTrackOneBindingReq(const BindingReqMap::value_type &binding_req_pair,
1233 const BindingReqMap &in_req, BindingReqMap *out_req,
1234 TrackedBindings *bindings) {
1235 assert(out_req);
1236 assert(bindings);
1237 const auto binding = binding_req_pair.first;
1238 // Use insert and look at the boolean ("was inserted") in the returned pair to see if this is a new set member.
1239 // Saves one hash lookup vs. find ... compare w/ end ... insert.
1240 const auto it_bool_pair = bindings->insert(binding);
1241 if (it_bool_pair.second) {
1242 out_req->emplace(binding_req_pair);
1243 }
1244}
Mark Lobodzinski2872f4a2018-09-03 17:00:53 -06001245
John Zulauf48a6a702017-12-22 17:14:54 -07001246void cvdescriptorset::DescriptorSet::FilterAndTrackOneBindingReq(const BindingReqMap::value_type &binding_req_pair,
1247 const BindingReqMap &in_req, BindingReqMap *out_req,
1248 TrackedBindings *bindings, uint32_t limit) {
1249 if (bindings->size() < limit) FilterAndTrackOneBindingReq(binding_req_pair, in_req, out_req, bindings);
1250}
1251
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001252void cvdescriptorset::DescriptorSet::FilterAndTrackBindingReqs(CMD_BUFFER_STATE *cb_state, const BindingReqMap &in_req,
John Zulauf48a6a702017-12-22 17:14:54 -07001253 BindingReqMap *out_req) {
1254 TrackedBindings &bound = cached_validation_[cb_state].command_binding_and_usage;
1255 if (bound.size() == GetBindingCount()) {
1256 return; // All bindings are bound, out req is empty
1257 }
1258 for (const auto &binding_req_pair : in_req) {
1259 const auto binding = binding_req_pair.first;
1260 // If a binding doesn't exist, or has already been bound, skip it
1261 if (p_layout_->HasBinding(binding)) {
1262 FilterAndTrackOneBindingReq(binding_req_pair, in_req, out_req, &bound);
1263 }
1264 }
1265}
1266
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001267void cvdescriptorset::DescriptorSet::FilterAndTrackBindingReqs(CMD_BUFFER_STATE *cb_state, PIPELINE_STATE *pipeline,
John Zulauf48a6a702017-12-22 17:14:54 -07001268 const BindingReqMap &in_req, BindingReqMap *out_req) {
1269 auto &validated = cached_validation_[cb_state];
1270 auto &image_sample_val = validated.image_samplers[pipeline];
1271 auto *const dynamic_buffers = &validated.dynamic_buffers;
1272 auto *const non_dynamic_buffers = &validated.non_dynamic_buffers;
1273 const auto &stats = p_layout_->GetBindingTypeStats();
1274 for (const auto &binding_req_pair : in_req) {
1275 auto binding = binding_req_pair.first;
1276 VkDescriptorSetLayoutBinding const *layout_binding = p_layout_->GetDescriptorSetLayoutBindingPtrFromBinding(binding);
1277 if (!layout_binding) {
1278 continue;
1279 }
1280 // Caching criteria differs per type.
1281 // If image_layout have changed , the image descriptors need to be validated against them.
1282 if ((layout_binding->descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC) ||
1283 (layout_binding->descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC)) {
1284 FilterAndTrackOneBindingReq(binding_req_pair, in_req, out_req, dynamic_buffers, stats.dynamic_buffer_count);
1285 } else if ((layout_binding->descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER) ||
1286 (layout_binding->descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_BUFFER)) {
1287 FilterAndTrackOneBindingReq(binding_req_pair, in_req, out_req, non_dynamic_buffers, stats.non_dynamic_buffer_count);
1288 } else {
1289 // This is rather crude, as the changed layouts may not impact the bound descriptors,
1290 // but the simple "versioning" is a simple "dirt" test.
1291 auto &version = image_sample_val[binding]; // Take advantage of default construtor zero initialzing new entries
1292 if (version != cb_state->image_layout_change_count) {
1293 version = cb_state->image_layout_change_count;
1294 out_req->emplace(binding_req_pair);
1295 }
1296 }
1297 }
1298}
Tobin Ehlis9252c2b2016-07-21 14:40:22 -06001299
Tobin Ehlis300888c2016-05-18 13:43:26 -06001300cvdescriptorset::SamplerDescriptor::SamplerDescriptor(const VkSampler *immut) : sampler_(VK_NULL_HANDLE), immutable_(false) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001301 updated = false;
1302 descriptor_class = PlainSampler;
1303 if (immut) {
1304 sampler_ = *immut;
1305 immutable_ = true;
1306 updated = true;
1307 }
1308}
Tobin Ehlise2f80292016-06-02 10:08:53 -06001309// Validate given sampler. Currently this only checks to make sure it exists in the samplerMap
Mark Lobodzinski3840ca02019-03-08 18:36:11 -07001310bool cvdescriptorset::ValidateSampler(const VkSampler sampler, CoreChecks *dev_data) {
Mark Lobodzinskif8d1ef92019-03-06 11:53:27 -07001311 return (dev_data->GetSamplerState(sampler) != nullptr);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001312}
Tobin Ehlis56a30942016-05-19 08:00:00 -06001313
Tobin Ehlis554bf382016-05-24 11:14:43 -06001314bool cvdescriptorset::ValidateImageUpdate(VkImageView image_view, VkImageLayout image_layout, VkDescriptorType type,
Mark Lobodzinski3840ca02019-03-08 18:36:11 -07001315 CoreChecks *dev_data, const char *func_name, std::string *error_code,
John Zulaufb45fdc32018-10-12 15:14:17 -06001316 std::string *error_msg) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001317 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00326";
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07001318 auto iv_state = dev_data->GetImageViewState(image_view);
Tobin Ehlis8b26a382016-09-14 08:02:49 -06001319 if (!iv_state) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001320 std::stringstream error_str;
1321 error_str << "Invalid VkImageView: " << image_view;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001322 *error_msg = error_str.str();
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001323 return false;
Tobin Ehlis1809f912016-05-25 09:24:36 -06001324 }
Tobin Ehlis81280962016-07-20 14:04:20 -06001325 // 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 -06001326 // Validate that imageLayout is compatible with aspect_mask and image format
1327 // and validate that image usage bits are correct for given usage
Tobin Ehlis8b26a382016-09-14 08:02:49 -06001328 VkImageAspectFlags aspect_mask = iv_state->create_info.subresourceRange.aspectMask;
1329 VkImage image = iv_state->create_info.image;
Tobin Ehlis1809f912016-05-25 09:24:36 -06001330 VkFormat format = VK_FORMAT_MAX_ENUM;
1331 VkImageUsageFlags usage = 0;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001332 auto image_node = dev_data->GetImageState(image);
Tobin Ehlis1c9c55f2016-06-02 11:49:22 -06001333 if (image_node) {
1334 format = image_node->createInfo.format;
1335 usage = image_node->createInfo.usage;
Tobin Ehlis029d2fe2016-09-21 09:19:15 -06001336 // Validate that memory is bound to image
Tobin Ehlis2cb8eb22017-01-03 14:09:57 -07001337 // TODO: This should have its own valid usage id apart from 2524 which is from CreateImageView case. The only
1338 // the error here occurs is if memory bound to a created imageView has been freed.
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001339 if (dev_data->ValidateMemoryIsBoundToImage(image_node, func_name, "VUID-VkImageViewCreateInfo-image-01020")) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001340 *error_code = "VUID-VkImageViewCreateInfo-image-01020";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001341 *error_msg = "No memory bound to image.";
Tobin Ehlis029d2fe2016-09-21 09:19:15 -06001342 return false;
Tobin Ehlisfed999f2016-09-21 15:09:45 -06001343 }
Chris Forbes67757ff2017-07-21 13:59:01 -07001344
1345 // KHR_maintenance1 allows rendering into 2D or 2DArray views which slice a 3D image,
1346 // but not binding them to descriptor sets.
1347 if (image_node->createInfo.imageType == VK_IMAGE_TYPE_3D &&
1348 (iv_state->create_info.viewType == VK_IMAGE_VIEW_TYPE_2D ||
1349 iv_state->create_info.viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001350 *error_code = "VUID-VkDescriptorImageInfo-imageView-00343";
Chris Forbes67757ff2017-07-21 13:59:01 -07001351 *error_msg = "ImageView must not be a 2D or 2DArray view of a 3D image";
1352 return false;
1353 }
Tobin Ehlis1809f912016-05-25 09:24:36 -06001354 }
1355 // First validate that format and layout are compatible
1356 if (format == VK_FORMAT_MAX_ENUM) {
1357 std::stringstream error_str;
1358 error_str << "Invalid image (" << image << ") in imageView (" << image_view << ").";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001359 *error_msg = error_str.str();
Tobin Ehlis1809f912016-05-25 09:24:36 -06001360 return false;
1361 }
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001362 // TODO : The various image aspect and format checks here are based on general spec language in 11.5 Image Views section under
1363 // vkCreateImageView(). What's the best way to create unique id for these cases?
Dave Houlton1d2022c2017-03-29 11:43:58 -06001364 bool ds = FormatIsDepthOrStencil(format);
Tobin Ehlis1809f912016-05-25 09:24:36 -06001365 switch (image_layout) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001366 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
1367 // Only Color bit must be set
1368 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Tobin Ehlis1809f912016-05-25 09:24:36 -06001369 std::stringstream error_str;
Dave Houltona9df0ce2018-02-07 10:51:23 -07001370 error_str
1371 << "ImageView (" << image_view
1372 << ") 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 -06001373 *error_msg = error_str.str();
Tobin Ehlis1809f912016-05-25 09:24:36 -06001374 return false;
1375 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001376 // format must NOT be DS
1377 if (ds) {
1378 std::stringstream error_str;
1379 error_str << "ImageView (" << image_view
1380 << ") uses layout VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL but the image format is "
1381 << string_VkFormat(format) << " which is not a color format.";
1382 *error_msg = error_str.str();
1383 return false;
1384 }
1385 break;
1386 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
1387 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
1388 // Depth or stencil bit must be set, but both must NOT be set
Tobin Ehlisbbf3f912016-06-15 13:03:58 -06001389 if (aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) {
1390 if (aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) {
1391 // both must NOT be set
1392 std::stringstream error_str;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001393 error_str << "ImageView (" << image_view << ") has both STENCIL and DEPTH aspects set";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001394 *error_msg = error_str.str();
Tobin Ehlisbbf3f912016-06-15 13:03:58 -06001395 return false;
1396 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001397 } else if (!(aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
1398 // Neither were set
1399 std::stringstream error_str;
1400 error_str << "ImageView (" << image_view << ") has layout " << string_VkImageLayout(image_layout)
1401 << " but does not have STENCIL or DEPTH aspects set";
1402 *error_msg = error_str.str();
1403 return false;
Tobin Ehlisbbf3f912016-06-15 13:03:58 -06001404 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001405 // format must be DS
1406 if (!ds) {
1407 std::stringstream error_str;
1408 error_str << "ImageView (" << image_view << ") has layout " << string_VkImageLayout(image_layout)
1409 << " but the image format is " << string_VkFormat(format) << " which is not a depth/stencil format.";
1410 *error_msg = error_str.str();
1411 return false;
1412 }
1413 break;
1414 default:
1415 // For other layouts if the source is depth/stencil image, both aspect bits must not be set
1416 if (ds) {
1417 if (aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) {
1418 if (aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) {
1419 // both must NOT be set
1420 std::stringstream error_str;
1421 error_str << "ImageView (" << image_view << ") has layout " << string_VkImageLayout(image_layout)
1422 << " and is using depth/stencil image of format " << string_VkFormat(format)
1423 << " but it has both STENCIL and DEPTH aspects set, which is illegal. When using a depth/stencil "
1424 "image in a descriptor set, please only set either VK_IMAGE_ASPECT_DEPTH_BIT or "
1425 "VK_IMAGE_ASPECT_STENCIL_BIT depending on whether it will be used for depth reads or stencil "
1426 "reads respectively.";
1427 *error_msg = error_str.str();
1428 return false;
1429 }
1430 }
1431 }
1432 break;
Tobin Ehlis1809f912016-05-25 09:24:36 -06001433 }
1434 // Now validate that usage flags are correctly set for given type of update
Tobin Ehlisfb4cf712016-10-10 14:02:48 -06001435 // 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 -06001436 // TODO : The various image usage bit requirements are in general spec language for VkImageUsageFlags bit block in 11.3 Images
1437 // under vkCreateImage()
Dave Houltond8ed0212018-05-16 17:18:24 -06001438 // TODO : Need to also validate case "VUID-VkWriteDescriptorSet-descriptorType-00336" where STORAGE_IMAGE & INPUT_ATTACH types
1439 // must have been created with identify swizzle
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06001440 const char *error_usage_bit = nullptr;
Tobin Ehlis1809f912016-05-25 09:24:36 -06001441 switch (type) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001442 case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
1443 case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER: {
1444 if (!(usage & VK_IMAGE_USAGE_SAMPLED_BIT)) {
1445 error_usage_bit = "VK_IMAGE_USAGE_SAMPLED_BIT";
1446 }
1447 break;
Tobin Ehlis1809f912016-05-25 09:24:36 -06001448 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001449 case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE: {
1450 if (!(usage & VK_IMAGE_USAGE_STORAGE_BIT)) {
1451 error_usage_bit = "VK_IMAGE_USAGE_STORAGE_BIT";
1452 } else if (VK_IMAGE_LAYOUT_GENERAL != image_layout) {
1453 std::stringstream error_str;
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001454 // TODO : Need to create custom enum error codes for these cases
1455 if (image_node->shared_presentable) {
1456 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != image_layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001457 error_str << "ImageView (" << image_view
1458 << ") of VK_DESCRIPTOR_TYPE_STORAGE_IMAGE type with a front-buffered image is being updated with "
1459 "layout "
1460 << string_VkImageLayout(image_layout)
1461 << " but according to spec section 13.1 Descriptor Types, 'Front-buffered images that report "
1462 "support for VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT must be in the "
1463 "VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR layout.'";
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001464 *error_msg = error_str.str();
1465 return false;
1466 }
1467 } else if (VK_IMAGE_LAYOUT_GENERAL != image_layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001468 error_str << "ImageView (" << image_view
1469 << ") of VK_DESCRIPTOR_TYPE_STORAGE_IMAGE type is being updated with layout "
1470 << string_VkImageLayout(image_layout)
1471 << " but according to spec section 13.1 Descriptor Types, 'Load and store operations on storage "
1472 "images can only be done on images in VK_IMAGE_LAYOUT_GENERAL layout.'";
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001473 *error_msg = error_str.str();
1474 return false;
1475 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001476 }
1477 break;
Tobin Ehlis1809f912016-05-25 09:24:36 -06001478 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001479 case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT: {
1480 if (!(usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) {
1481 error_usage_bit = "VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT";
1482 }
1483 break;
Tobin Ehlis1809f912016-05-25 09:24:36 -06001484 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001485 default:
1486 break;
Tobin Ehlis1809f912016-05-25 09:24:36 -06001487 }
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06001488 if (error_usage_bit) {
Tobin Ehlis1809f912016-05-25 09:24:36 -06001489 std::stringstream error_str;
1490 error_str << "ImageView (" << image_view << ") with usage mask 0x" << usage
1491 << " being used for a descriptor update of type " << string_VkDescriptorType(type) << " does not have "
1492 << error_usage_bit << " set.";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001493 *error_msg = error_str.str();
Tobin Ehlis1809f912016-05-25 09:24:36 -06001494 return false;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001495 }
John Zulauff4c07882019-01-24 14:03:36 -07001496
1497 if ((type == VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE) || (type == VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER)) {
1498 // Test that the layout is compatible with the descriptorType for the two sampled image types
1499 const static std::array<VkImageLayout, 3> valid_layouts = {
Jeremy Hayesd0549f62019-06-05 10:15:36 -06001500 {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 -07001501
1502 struct ExtensionLayout {
1503 VkImageLayout layout;
1504 bool DeviceExtensions::*extension;
1505 };
1506
1507 const static std::array<ExtensionLayout, 3> extended_layouts{
1508 {// Note double brace req'd for aggregate initialization
1509 {VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR, &DeviceExtensions::vk_khr_shared_presentable_image},
1510 {VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, &DeviceExtensions::vk_khr_maintenance2},
1511 {VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, &DeviceExtensions::vk_khr_maintenance2}}};
1512 auto is_layout = [image_layout, dev_data](const ExtensionLayout &ext_layout) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001513 return dev_data->device_extensions.*(ext_layout.extension) && (ext_layout.layout == image_layout);
John Zulauff4c07882019-01-24 14:03:36 -07001514 };
1515
1516 bool valid_layout = (std::find(valid_layouts.cbegin(), valid_layouts.cend(), image_layout) != valid_layouts.cend()) ||
1517 std::any_of(extended_layouts.cbegin(), extended_layouts.cend(), is_layout);
1518
1519 if (!valid_layout) {
1520 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-01403";
1521 std::stringstream error_str;
1522 error_str << "Descriptor update with descriptorType " << string_VkDescriptorType(type)
1523 << " is being updated with invalid imageLayout " << string_VkImageLayout(image_layout)
1524 << ". Allowed layouts are: VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
1525 << "VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL, VK_IMAGE_LAYOUT_GENERAL";
1526 for (auto &ext_layout : extended_layouts) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001527 if (dev_data->device_extensions.*(ext_layout.extension)) {
John Zulauff4c07882019-01-24 14:03:36 -07001528 error_str << ", " << string_VkImageLayout(ext_layout.layout);
1529 }
1530 }
1531 *error_msg = error_str.str();
1532 return false;
1533 }
1534 }
1535
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001536 return true;
1537}
Tobin Ehlis56a30942016-05-19 08:00:00 -06001538
Tobin Ehlis300888c2016-05-18 13:43:26 -06001539void cvdescriptorset::SamplerDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
Chris Forbesfea2c542018-04-13 09:34:15 -07001540 if (!immutable_) {
1541 sampler_ = update->pImageInfo[index].sampler;
1542 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001543 updated = true;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001544}
1545
Tobin Ehlis300888c2016-05-18 13:43:26 -06001546void cvdescriptorset::SamplerDescriptor::CopyUpdate(const Descriptor *src) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001547 if (!immutable_) {
1548 auto update_sampler = static_cast<const SamplerDescriptor *>(src)->sampler_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001549 sampler_ = update_sampler;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001550 }
1551 updated = true;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001552}
Tobin Ehlis56a30942016-05-19 08:00:00 -06001553
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001554void cvdescriptorset::SamplerDescriptor::UpdateDrawState(CoreChecks *dev_data, CMD_BUFFER_STATE *cb_node) {
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001555 if (!immutable_) {
Mark Lobodzinskif8d1ef92019-03-06 11:53:27 -07001556 auto sampler_state = dev_data->GetSamplerState(sampler_);
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001557 if (sampler_state) dev_data->AddCommandBufferBindingSampler(cb_node, sampler_state);
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001558 }
1559}
1560
Tobin Ehlis300888c2016-05-18 13:43:26 -06001561cvdescriptorset::ImageSamplerDescriptor::ImageSamplerDescriptor(const VkSampler *immut)
Chris Forbes9f340852017-05-09 08:51:38 -07001562 : sampler_(VK_NULL_HANDLE), immutable_(false), image_view_(VK_NULL_HANDLE), image_layout_(VK_IMAGE_LAYOUT_UNDEFINED) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001563 updated = false;
1564 descriptor_class = ImageSampler;
1565 if (immut) {
1566 sampler_ = *immut;
1567 immutable_ = true;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001568 }
1569}
Tobin Ehlis56a30942016-05-19 08:00:00 -06001570
Tobin Ehlis300888c2016-05-18 13:43:26 -06001571void cvdescriptorset::ImageSamplerDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001572 updated = true;
Tobin Ehlis56a30942016-05-19 08:00:00 -06001573 const auto &image_info = update->pImageInfo[index];
Chris Forbesfea2c542018-04-13 09:34:15 -07001574 if (!immutable_) {
1575 sampler_ = image_info.sampler;
1576 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06001577 image_view_ = image_info.imageView;
1578 image_layout_ = image_info.imageLayout;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001579}
1580
Tobin Ehlis300888c2016-05-18 13:43:26 -06001581void cvdescriptorset::ImageSamplerDescriptor::CopyUpdate(const Descriptor *src) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001582 if (!immutable_) {
1583 auto update_sampler = static_cast<const ImageSamplerDescriptor *>(src)->sampler_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001584 sampler_ = update_sampler;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001585 }
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001586 auto image_view = static_cast<const ImageSamplerDescriptor *>(src)->image_view_;
1587 auto image_layout = static_cast<const ImageSamplerDescriptor *>(src)->image_layout_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001588 updated = true;
1589 image_view_ = image_view;
1590 image_layout_ = image_layout;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001591}
1592
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001593void cvdescriptorset::ImageSamplerDescriptor::UpdateDrawState(CoreChecks *dev_data, CMD_BUFFER_STATE *cb_node) {
Tobin Ehlis81e46372016-08-17 13:33:44 -06001594 // First add binding for any non-immutable sampler
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001595 if (!immutable_) {
Mark Lobodzinskif8d1ef92019-03-06 11:53:27 -07001596 auto sampler_state = dev_data->GetSamplerState(sampler_);
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001597 if (sampler_state) dev_data->AddCommandBufferBindingSampler(cb_node, sampler_state);
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001598 }
Tobin Ehlis81e46372016-08-17 13:33:44 -06001599 // Add binding for image
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07001600 auto iv_state = dev_data->GetImageViewState(image_view_);
Tobin Ehlis8b26a382016-09-14 08:02:49 -06001601 if (iv_state) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001602 dev_data->AddCommandBufferBindingImageView(cb_node, iv_state);
John Zulauff660ad62019-03-23 07:16:05 -06001603 dev_data->SetImageViewInitialLayout(cb_node, *iv_state, image_layout_);
Jeff Bolz148d94e2018-12-13 21:25:56 -06001604 }
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001605}
1606
Tobin Ehlis300888c2016-05-18 13:43:26 -06001607cvdescriptorset::ImageDescriptor::ImageDescriptor(const VkDescriptorType type)
1608 : storage_(false), image_view_(VK_NULL_HANDLE), image_layout_(VK_IMAGE_LAYOUT_UNDEFINED) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001609 updated = false;
1610 descriptor_class = Image;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001611 if (VK_DESCRIPTOR_TYPE_STORAGE_IMAGE == type) storage_ = true;
Petr Kraus13c98a62017-12-09 00:22:39 +01001612}
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001613
Tobin Ehlis300888c2016-05-18 13:43:26 -06001614void cvdescriptorset::ImageDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001615 updated = true;
Tobin Ehlis56a30942016-05-19 08:00:00 -06001616 const auto &image_info = update->pImageInfo[index];
Tobin Ehlis300888c2016-05-18 13:43:26 -06001617 image_view_ = image_info.imageView;
1618 image_layout_ = image_info.imageLayout;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001619}
1620
Tobin Ehlis300888c2016-05-18 13:43:26 -06001621void cvdescriptorset::ImageDescriptor::CopyUpdate(const Descriptor *src) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001622 auto image_view = static_cast<const ImageDescriptor *>(src)->image_view_;
1623 auto image_layout = static_cast<const ImageDescriptor *>(src)->image_layout_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001624 updated = true;
1625 image_view_ = image_view;
1626 image_layout_ = image_layout;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001627}
1628
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001629void cvdescriptorset::ImageDescriptor::UpdateDrawState(CoreChecks *dev_data, CMD_BUFFER_STATE *cb_node) {
Tobin Ehlis81e46372016-08-17 13:33:44 -06001630 // Add binding for image
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07001631 auto iv_state = dev_data->GetImageViewState(image_view_);
Tobin Ehlis8b26a382016-09-14 08:02:49 -06001632 if (iv_state) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001633 dev_data->AddCommandBufferBindingImageView(cb_node, iv_state);
John Zulauff660ad62019-03-23 07:16:05 -06001634 dev_data->SetImageViewInitialLayout(cb_node, *iv_state, image_layout_);
Jeff Bolz148d94e2018-12-13 21:25:56 -06001635 }
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001636}
1637
Tobin Ehlis300888c2016-05-18 13:43:26 -06001638cvdescriptorset::BufferDescriptor::BufferDescriptor(const VkDescriptorType type)
1639 : storage_(false), dynamic_(false), buffer_(VK_NULL_HANDLE), offset_(0), range_(0) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001640 updated = false;
1641 descriptor_class = GeneralBuffer;
1642 if (VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC == type) {
1643 dynamic_ = true;
1644 } else if (VK_DESCRIPTOR_TYPE_STORAGE_BUFFER == type) {
1645 storage_ = true;
1646 } else if (VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC == type) {
1647 dynamic_ = true;
1648 storage_ = true;
1649 }
1650}
Tobin Ehlis300888c2016-05-18 13:43:26 -06001651void cvdescriptorset::BufferDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001652 updated = true;
Tobin Ehlis56a30942016-05-19 08:00:00 -06001653 const auto &buffer_info = update->pBufferInfo[index];
Tobin Ehlis300888c2016-05-18 13:43:26 -06001654 buffer_ = buffer_info.buffer;
1655 offset_ = buffer_info.offset;
1656 range_ = buffer_info.range;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001657}
1658
Tobin Ehlis300888c2016-05-18 13:43:26 -06001659void cvdescriptorset::BufferDescriptor::CopyUpdate(const Descriptor *src) {
1660 auto buff_desc = static_cast<const BufferDescriptor *>(src);
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001661 updated = true;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001662 buffer_ = buff_desc->buffer_;
1663 offset_ = buff_desc->offset_;
1664 range_ = buff_desc->range_;
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001665}
1666
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001667void cvdescriptorset::BufferDescriptor::UpdateDrawState(CoreChecks *dev_data, CMD_BUFFER_STATE *cb_node) {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07001668 auto buffer_node = dev_data->GetBufferState(buffer_);
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001669 if (buffer_node) dev_data->AddCommandBufferBindingBuffer(cb_node, buffer_node);
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001670}
1671
Tobin Ehlis300888c2016-05-18 13:43:26 -06001672cvdescriptorset::TexelDescriptor::TexelDescriptor(const VkDescriptorType type) : buffer_view_(VK_NULL_HANDLE), storage_(false) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001673 updated = false;
1674 descriptor_class = TexelBuffer;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001675 if (VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER == type) storage_ = true;
Petr Kraus13c98a62017-12-09 00:22:39 +01001676}
Tobin Ehlis56a30942016-05-19 08:00:00 -06001677
Tobin Ehlis300888c2016-05-18 13:43:26 -06001678void cvdescriptorset::TexelDescriptor::WriteUpdate(const VkWriteDescriptorSet *update, const uint32_t index) {
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001679 updated = true;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001680 buffer_view_ = update->pTexelBufferView[index];
Tobin Ehlis0a43bde2016-05-03 08:31:08 -06001681}
1682
Tobin Ehlis300888c2016-05-18 13:43:26 -06001683void cvdescriptorset::TexelDescriptor::CopyUpdate(const Descriptor *src) {
1684 updated = true;
1685 buffer_view_ = static_cast<const TexelDescriptor *>(src)->buffer_view_;
1686}
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001687
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001688void cvdescriptorset::TexelDescriptor::UpdateDrawState(CoreChecks *dev_data, CMD_BUFFER_STATE *cb_node) {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07001689 auto bv_state = dev_data->GetBufferViewState(buffer_view_);
Tobin Ehlis8b872462016-09-14 08:12:08 -06001690 if (bv_state) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001691 dev_data->AddCommandBufferBindingBufferView(cb_node, bv_state);
Tobin Ehlis81e46372016-08-17 13:33:44 -06001692 }
Tobin Ehlis8020eea2016-08-17 11:10:41 -06001693}
1694
Tobin Ehlis300888c2016-05-18 13:43:26 -06001695// This is a helper function that iterates over a set of Write and Copy updates, pulls the DescriptorSet* for updated
1696// sets, and then calls their respective Validate[Write|Copy]Update functions.
1697// If the update hits an issue for which the callback returns "true", meaning that the call down the chain should
1698// be skipped, then true is returned.
1699// If there is no issue with the update, then false is returned.
Mark Lobodzinski3840ca02019-03-08 18:36:11 -07001700bool CoreChecks::ValidateUpdateDescriptorSets(uint32_t write_count, const VkWriteDescriptorSet *p_wds, uint32_t copy_count,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001701 const VkCopyDescriptorSet *p_cds, const char *func_name) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001702 bool skip = false;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001703 // Validate Write updates
Tobin Ehlis56a30942016-05-19 08:00:00 -06001704 for (uint32_t i = 0; i < write_count; i++) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001705 auto dest_set = p_wds[i].dstSet;
Mark Lobodzinskifc2f0d32019-03-06 11:25:39 -07001706 auto set_node = GetSetNode(dest_set);
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001707 if (!set_node) {
John Zulaufb45fdc32018-10-12 15:14:17 -06001708 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_EXT,
1709 HandleToUint64(dest_set), kVUID_Core_DrawState_InvalidDescriptorSet,
Lockeca0d9792019-03-03 23:48:13 -07001710 "Cannot call %s on descriptor set %s that has not been allocated.", func_name,
1711 report_data->FormatHandle(dest_set).c_str());
Tobin Ehlis300888c2016-05-18 13:43:26 -06001712 } else {
Dave Houltond8ed0212018-05-16 17:18:24 -06001713 std::string error_code;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001714 std::string error_str;
John Zulauf613fd982019-06-04 15:14:41 -06001715 if (!ValidateWriteUpdate(set_node, report_data, &p_wds[i], func_name, &error_code, &error_str)) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001716 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001717 HandleToUint64(dest_set), error_code,
Lockeca0d9792019-03-03 23:48:13 -07001718 "%s failed write update validation for Descriptor Set %s with error: %s.", func_name,
1719 report_data->FormatHandle(dest_set).c_str(), error_str.c_str());
Tobin Ehlis300888c2016-05-18 13:43:26 -06001720 }
1721 }
1722 }
1723 // Now validate copy updates
Tobin Ehlis56a30942016-05-19 08:00:00 -06001724 for (uint32_t i = 0; i < copy_count; ++i) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001725 auto dst_set = p_cds[i].dstSet;
1726 auto src_set = p_cds[i].srcSet;
Mark Lobodzinskifc2f0d32019-03-06 11:25:39 -07001727 auto src_node = GetSetNode(src_set);
1728 auto dst_node = GetSetNode(dst_set);
Tobin Ehlisa1712752017-01-04 09:41:47 -07001729 // Object_tracker verifies that src & dest descriptor set are valid
1730 assert(src_node);
1731 assert(dst_node);
Dave Houltond8ed0212018-05-16 17:18:24 -06001732 std::string error_code;
Tobin Ehlisa1712752017-01-04 09:41:47 -07001733 std::string error_str;
John Zulaufd9435c32019-06-05 15:55:36 -06001734 if (!ValidateCopyUpdate(report_data, &p_cds[i], dst_node, src_node, func_name, &error_code, &error_str)) {
Lockeca0d9792019-03-03 23:48:13 -07001735 skip |= log_msg(
1736 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_EXT, HandleToUint64(dst_set),
1737 error_code, "%s failed copy update from Descriptor Set %s to Descriptor Set %s with error: %s.", func_name,
1738 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 -06001739 }
1740 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001741 return skip;
Tobin Ehlis300888c2016-05-18 13:43:26 -06001742}
1743// This is a helper function that iterates over a set of Write and Copy updates, pulls the DescriptorSet* for updated
1744// sets, and then calls their respective Perform[Write|Copy]Update functions.
1745// Prerequisite : ValidateUpdateDescriptorSets() should be called and return "false" prior to calling PerformUpdateDescriptorSets()
1746// with the same set of updates.
1747// This is split from the validate code to allow validation prior to calling down the chain, and then update after
1748// calling down the chain.
Mark Lobodzinski3840ca02019-03-08 18:36:11 -07001749void cvdescriptorset::PerformUpdateDescriptorSets(CoreChecks *dev_data, uint32_t write_count, const VkWriteDescriptorSet *p_wds,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001750 uint32_t copy_count, const VkCopyDescriptorSet *p_cds) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06001751 // Write updates first
1752 uint32_t i = 0;
1753 for (i = 0; i < write_count; ++i) {
1754 auto dest_set = p_wds[i].dstSet;
Mark Lobodzinskifc2f0d32019-03-06 11:25:39 -07001755 auto set_node = dev_data->GetSetNode(dest_set);
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001756 if (set_node) {
1757 set_node->PerformWriteUpdate(&p_wds[i]);
Tobin Ehlis300888c2016-05-18 13:43:26 -06001758 }
1759 }
1760 // Now copy updates
1761 for (i = 0; i < copy_count; ++i) {
1762 auto dst_set = p_cds[i].dstSet;
1763 auto src_set = p_cds[i].srcSet;
Mark Lobodzinskifc2f0d32019-03-06 11:25:39 -07001764 auto src_node = dev_data->GetSetNode(src_set);
1765 auto dst_node = dev_data->GetSetNode(dst_set);
Tobin Ehlis6a72dc72016-06-01 16:41:17 -06001766 if (src_node && dst_node) {
1767 dst_node->PerformCopyUpdate(&p_cds[i], src_node);
Tobin Ehlis300888c2016-05-18 13:43:26 -06001768 }
1769 }
1770}
Mark Lobodzinski3d63a042017-03-09 16:24:13 -07001771
Mark Lobodzinski3840ca02019-03-08 18:36:11 -07001772cvdescriptorset::DecodedTemplateUpdate::DecodedTemplateUpdate(CoreChecks *device_data, VkDescriptorSet descriptorSet,
John Zulauf1d27e0a2018-11-05 10:12:48 -07001773 const TEMPLATE_STATE *template_state, const void *pData,
1774 VkDescriptorSetLayout push_layout) {
John Zulaufb845eb22018-10-12 11:41:06 -06001775 auto const &create_info = template_state->create_info;
1776 inline_infos.resize(create_info.descriptorUpdateEntryCount); // Make sure we have one if we need it
1777 desc_writes.reserve(create_info.descriptorUpdateEntryCount); // emplaced, so reserved without initialization
John Zulauf1d27e0a2018-11-05 10:12:48 -07001778 VkDescriptorSetLayout effective_dsl = create_info.templateType == VK_DESCRIPTOR_UPDATE_TEMPLATE_TYPE_DESCRIPTOR_SET
1779 ? create_info.descriptorSetLayout
1780 : push_layout;
1781 auto layout_obj = GetDescriptorSetLayout(device_data, effective_dsl);
Mark Lobodzinski3d63a042017-03-09 16:24:13 -07001782
1783 // Create a WriteDescriptorSet struct for each template update entry
1784 for (uint32_t i = 0; i < create_info.descriptorUpdateEntryCount; i++) {
1785 auto binding_count = layout_obj->GetDescriptorCountFromBinding(create_info.pDescriptorUpdateEntries[i].dstBinding);
1786 auto binding_being_updated = create_info.pDescriptorUpdateEntries[i].dstBinding;
1787 auto dst_array_element = create_info.pDescriptorUpdateEntries[i].dstArrayElement;
1788
John Zulaufb6d71202017-12-22 16:47:09 -07001789 desc_writes.reserve(desc_writes.size() + create_info.pDescriptorUpdateEntries[i].descriptorCount);
Mark Lobodzinski3d63a042017-03-09 16:24:13 -07001790 for (uint32_t j = 0; j < create_info.pDescriptorUpdateEntries[i].descriptorCount; j++) {
1791 desc_writes.emplace_back();
1792 auto &write_entry = desc_writes.back();
1793
1794 size_t offset = create_info.pDescriptorUpdateEntries[i].offset + j * create_info.pDescriptorUpdateEntries[i].stride;
1795 char *update_entry = (char *)(pData) + offset;
1796
1797 if (dst_array_element >= binding_count) {
1798 dst_array_element = 0;
Mark Lobodzinski4aa479d2017-03-10 09:14:00 -07001799 binding_being_updated = layout_obj->GetNextValidBinding(binding_being_updated);
Mark Lobodzinski3d63a042017-03-09 16:24:13 -07001800 }
1801
1802 write_entry.sType = VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET;
1803 write_entry.pNext = NULL;
1804 write_entry.dstSet = descriptorSet;
1805 write_entry.dstBinding = binding_being_updated;
1806 write_entry.dstArrayElement = dst_array_element;
1807 write_entry.descriptorCount = 1;
1808 write_entry.descriptorType = create_info.pDescriptorUpdateEntries[i].descriptorType;
1809
1810 switch (create_info.pDescriptorUpdateEntries[i].descriptorType) {
1811 case VK_DESCRIPTOR_TYPE_SAMPLER:
1812 case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER:
1813 case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
1814 case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE:
1815 case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT:
1816 write_entry.pImageInfo = reinterpret_cast<VkDescriptorImageInfo *>(update_entry);
1817 break;
1818
1819 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
1820 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
1821 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:
1822 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC:
1823 write_entry.pBufferInfo = reinterpret_cast<VkDescriptorBufferInfo *>(update_entry);
1824 break;
1825
1826 case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
1827 case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:
1828 write_entry.pTexelBufferView = reinterpret_cast<VkBufferView *>(update_entry);
1829 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -06001830 case VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT: {
1831 VkWriteDescriptorSetInlineUniformBlockEXT *inline_info = &inline_infos[i];
1832 inline_info->sType = VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET_INLINE_UNIFORM_BLOCK_EXT;
1833 inline_info->pNext = nullptr;
1834 inline_info->dataSize = create_info.pDescriptorUpdateEntries[i].descriptorCount;
1835 inline_info->pData = update_entry;
1836 write_entry.pNext = inline_info;
1837 // skip the rest of the array, they just represent bytes in the update
1838 j = create_info.pDescriptorUpdateEntries[i].descriptorCount;
1839 break;
1840 }
Mark Lobodzinski3d63a042017-03-09 16:24:13 -07001841 default:
1842 assert(0);
1843 break;
1844 }
1845 dst_array_element++;
1846 }
1847 }
John Zulaufb845eb22018-10-12 11:41:06 -06001848}
John Zulaufb45fdc32018-10-12 15:14:17 -06001849// These helper functions carry out the validate and record descriptor updates peformed via update templates. They decode
1850// the templatized data and leverage the non-template UpdateDescriptor helper functions.
Mark Lobodzinski3840ca02019-03-08 18:36:11 -07001851bool CoreChecks::ValidateUpdateDescriptorSetsWithTemplateKHR(VkDescriptorSet descriptorSet, const TEMPLATE_STATE *template_state,
1852 const void *pData) {
John Zulaufb45fdc32018-10-12 15:14:17 -06001853 // Translate the templated update into a normal update for validation...
Mark Lobodzinski3840ca02019-03-08 18:36:11 -07001854 cvdescriptorset::DecodedTemplateUpdate decoded_update(this, descriptorSet, template_state, pData);
1855 return ValidateUpdateDescriptorSets(static_cast<uint32_t>(decoded_update.desc_writes.size()), decoded_update.desc_writes.data(),
1856 0, NULL, "vkUpdateDescriptorSetWithTemplate()");
John Zulaufb45fdc32018-10-12 15:14:17 -06001857}
John Zulaufb845eb22018-10-12 11:41:06 -06001858
Mark Lobodzinski254c8512019-03-09 12:21:15 -07001859void CoreChecks::PerformUpdateDescriptorSetsWithTemplateKHR(VkDescriptorSet descriptorSet, const TEMPLATE_STATE *template_state,
1860 const void *pData) {
John Zulaufb45fdc32018-10-12 15:14:17 -06001861 // Translate the templated update into a normal update for validation...
Mark Lobodzinski254c8512019-03-09 12:21:15 -07001862 cvdescriptorset::DecodedTemplateUpdate decoded_update(this, descriptorSet, template_state, pData);
1863 cvdescriptorset::PerformUpdateDescriptorSets(this, static_cast<uint32_t>(decoded_update.desc_writes.size()),
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001864 decoded_update.desc_writes.data(), 0, NULL);
Mark Lobodzinski3d63a042017-03-09 16:24:13 -07001865}
John Zulauf4e7bcb52018-11-02 10:46:30 -06001866
1867std::string cvdescriptorset::DescriptorSet::StringifySetAndLayout() const {
1868 std::string out;
1869 uint64_t layout_handle = HandleToUint64(p_layout_->GetDescriptorSetLayout());
1870 if (IsPushDescriptor()) {
1871 string_sprintf(&out, "Push Descriptors defined with VkDescriptorSetLayout 0x%" PRIxLEAST64, layout_handle);
John Zulauf4e7bcb52018-11-02 10:46:30 -06001872 } else {
Bob Ellisonaf2f8532019-03-12 11:05:47 -06001873 string_sprintf(&out, "VkDescriptorSet 0x%" PRIxLEAST64 " allocated with VkDescriptorSetLayout 0x%" PRIxLEAST64,
John Zulauf4e7bcb52018-11-02 10:46:30 -06001874 HandleToUint64(set_), layout_handle);
1875 }
1876 return out;
1877};
1878
John Zulauf1d27e0a2018-11-05 10:12:48 -07001879// Loop through the write updates to validate for a push descriptor set, ignoring dstSet
John Zulaufd9435c32019-06-05 15:55:36 -06001880bool cvdescriptorset::ValidatePushDescriptorsUpdate(const DescriptorSet *push_set, const debug_report_data *report_data,
1881 uint32_t write_count, const VkWriteDescriptorSet *p_wds,
1882 const char *func_name) {
1883 assert(push_set->IsPushDescriptor());
John Zulauf1d27e0a2018-11-05 10:12:48 -07001884 bool skip = false;
1885 for (uint32_t i = 0; i < write_count; i++) {
1886 std::string error_code;
1887 std::string error_str;
John Zulaufd9435c32019-06-05 15:55:36 -06001888 if (!ValidateWriteUpdate(push_set, report_data, &p_wds[i], func_name, &error_code, &error_str)) {
John Zulauf1d27e0a2018-11-05 10:12:48 -07001889 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 -06001890 HandleToUint64(push_set->GetDescriptorSetLayout()), error_code, "%s failed update validation: %s.",
John Zulauf1d27e0a2018-11-05 10:12:48 -07001891 func_name, error_str.c_str());
1892 }
1893 }
1894 return skip;
1895}
1896
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001897// For the given buffer, verify that its creation parameters are appropriate for the given type
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001898// 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 -06001899bool cvdescriptorset::ValidateBufferUsage(BUFFER_STATE const *buffer_node, VkDescriptorType type, std::string *error_code,
1900 std::string *error_msg) {
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001901 // Verify that usage bits set correctly for given type
Tobin Ehlis94bc5d22016-06-02 07:46:52 -06001902 auto usage = buffer_node->createInfo.usage;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06001903 const char *error_usage_bit = nullptr;
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001904 switch (type) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001905 case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
1906 if (!(usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001907 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00334";
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001908 error_usage_bit = "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT";
1909 }
1910 break;
1911 case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:
1912 if (!(usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001913 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00335";
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001914 error_usage_bit = "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT";
1915 }
1916 break;
1917 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
1918 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:
1919 if (!(usage & VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001920 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00330";
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001921 error_usage_bit = "VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT";
1922 }
1923 break;
1924 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
1925 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC:
1926 if (!(usage & VK_BUFFER_USAGE_STORAGE_BUFFER_BIT)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001927 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00331";
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07001928 error_usage_bit = "VK_BUFFER_USAGE_STORAGE_BUFFER_BIT";
1929 }
1930 break;
1931 default:
1932 break;
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001933 }
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06001934 if (error_usage_bit) {
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001935 std::stringstream error_str;
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001936 error_str << "Buffer (" << buffer_node->buffer << ") with usage mask 0x" << usage
1937 << " being used for a descriptor update of type " << string_VkDescriptorType(type) << " does not have "
1938 << error_usage_bit << " set.";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001939 *error_msg = error_str.str();
Tobin Ehlis6bd2b982016-05-24 12:33:42 -06001940 return false;
1941 }
1942 return true;
1943}
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001944// For buffer descriptor updates, verify the buffer usage and VkDescriptorBufferInfo struct which includes:
1945// 1. buffer is valid
1946// 2. buffer was created with correct usage flags
1947// 3. offset is less than buffer size
1948// 4. range is either VK_WHOLE_SIZE or falls in (0, (buffer size - offset)]
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -07001949// 5. range and offset are within the device's limits
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001950// 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 -06001951bool cvdescriptorset::ValidateBufferUpdate(CoreChecks *device_data, VkDescriptorBufferInfo const *buffer_info,
1952 VkDescriptorType type, const char *func_name, std::string *error_code,
1953 std::string *error_msg) {
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001954 // First make sure that buffer is valid
John Zulaufd9435c32019-06-05 15:55:36 -06001955 auto buffer_node = device_data->GetBufferState(buffer_info->buffer);
Tobin Ehlisfa8b6182016-12-22 13:40:45 -07001956 // Any invalid buffer should already be caught by object_tracker
1957 assert(buffer_node);
John Zulaufd9435c32019-06-05 15:55:36 -06001958 if (device_data->ValidateMemoryIsBoundToBuffer(buffer_node, func_name, "VUID-VkWriteDescriptorSet-descriptorType-00329")) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001959 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00329";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001960 *error_msg = "No memory bound to buffer.";
Tobin Ehlis81280962016-07-20 14:04:20 -06001961 return false;
Tobin Ehlisfed999f2016-09-21 15:09:45 -06001962 }
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001963 // Verify usage bits
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001964 if (!ValidateBufferUsage(buffer_node, type, error_code, error_msg)) {
1965 // error_msg will have been updated by ValidateBufferUsage()
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001966 return false;
1967 }
1968 // offset must be less than buffer size
Jeremy Hayesd1a6a822017-03-09 14:39:45 -07001969 if (buffer_info->offset >= buffer_node->createInfo.size) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001970 *error_code = "VUID-VkDescriptorBufferInfo-offset-00340";
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001971 std::stringstream error_str;
Jeremy Hayesd1a6a822017-03-09 14:39:45 -07001972 error_str << "VkDescriptorBufferInfo offset of " << buffer_info->offset << " is greater than or equal to buffer "
1973 << buffer_node->buffer << " size of " << buffer_node->createInfo.size;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001974 *error_msg = error_str.str();
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001975 return false;
1976 }
1977 if (buffer_info->range != VK_WHOLE_SIZE) {
1978 // Range must be VK_WHOLE_SIZE or > 0
1979 if (!buffer_info->range) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001980 *error_code = "VUID-VkDescriptorBufferInfo-range-00341";
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001981 std::stringstream error_str;
1982 error_str << "VkDescriptorBufferInfo range is not VK_WHOLE_SIZE and is zero, which is not allowed.";
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001983 *error_msg = error_str.str();
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001984 return false;
1985 }
1986 // Range must be VK_WHOLE_SIZE or <= (buffer size - offset)
1987 if (buffer_info->range > (buffer_node->createInfo.size - buffer_info->offset)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06001988 *error_code = "VUID-VkDescriptorBufferInfo-range-00342";
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001989 std::stringstream error_str;
1990 error_str << "VkDescriptorBufferInfo range is " << buffer_info->range << " which is greater than buffer size ("
1991 << buffer_node->createInfo.size << ") minus requested offset of " << buffer_info->offset;
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06001992 *error_msg = error_str.str();
Tobin Ehlis3d38f082016-07-01 17:36:48 -06001993 return false;
1994 }
1995 }
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -07001996 // Check buffer update sizes against device limits
John Zulaufd9435c32019-06-05 15:55:36 -06001997 const auto &limits = device_data->phys_dev_props.limits;
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -07001998 if (VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER == type || VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC == type) {
John Zulaufd9435c32019-06-05 15:55:36 -06001999 auto max_ub_range = limits.maxUniformBufferRange;
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -07002000 if (buffer_info->range != VK_WHOLE_SIZE && buffer_info->range > max_ub_range) {
Dave Houlton00c154e2018-05-24 13:20:50 -06002001 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00332";
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -07002002 std::stringstream error_str;
2003 error_str << "VkDescriptorBufferInfo range is " << buffer_info->range
2004 << " which is greater than this device's maxUniformBufferRange (" << max_ub_range << ")";
2005 *error_msg = error_str.str();
2006 return false;
Peter Kohaut2794a292018-07-13 11:13:47 +02002007 } else if (buffer_info->range == VK_WHOLE_SIZE && (buffer_node->createInfo.size - buffer_info->offset) > max_ub_range) {
2008 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00332";
2009 std::stringstream error_str;
Peter Kohaut18f413d2018-07-16 13:15:42 +02002010 error_str << "VkDescriptorBufferInfo range is VK_WHOLE_SIZE but effective range "
2011 << "(" << (buffer_node->createInfo.size - buffer_info->offset) << ") is greater than this device's "
Peter Kohaut2794a292018-07-13 11:13:47 +02002012 << "maxUniformBufferRange (" << max_ub_range << ")";
2013 *error_msg = error_str.str();
2014 return false;
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -07002015 }
2016 } else if (VK_DESCRIPTOR_TYPE_STORAGE_BUFFER == type || VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC == type) {
John Zulaufd9435c32019-06-05 15:55:36 -06002017 auto max_sb_range = limits.maxStorageBufferRange;
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -07002018 if (buffer_info->range != VK_WHOLE_SIZE && buffer_info->range > max_sb_range) {
Dave Houlton00c154e2018-05-24 13:20:50 -06002019 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00333";
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -07002020 std::stringstream error_str;
2021 error_str << "VkDescriptorBufferInfo range is " << buffer_info->range
2022 << " which is greater than this device's maxStorageBufferRange (" << max_sb_range << ")";
2023 *error_msg = error_str.str();
2024 return false;
Peter Kohaut2794a292018-07-13 11:13:47 +02002025 } else if (buffer_info->range == VK_WHOLE_SIZE && (buffer_node->createInfo.size - buffer_info->offset) > max_sb_range) {
2026 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00333";
2027 std::stringstream error_str;
Peter Kohaut18f413d2018-07-16 13:15:42 +02002028 error_str << "VkDescriptorBufferInfo range is VK_WHOLE_SIZE but effective range "
2029 << "(" << (buffer_node->createInfo.size - buffer_info->offset) << ") is greater than this device's "
Peter Kohaut2794a292018-07-13 11:13:47 +02002030 << "maxStorageBufferRange (" << max_sb_range << ")";
2031 *error_msg = error_str.str();
2032 return false;
Tobin Ehlisc3b6c4c2017-02-02 17:26:40 -07002033 }
2034 }
Tobin Ehlis3d38f082016-07-01 17:36:48 -06002035 return true;
2036}
Tobin Ehlis300888c2016-05-18 13:43:26 -06002037// Verify that the contents of the update are ok, but don't perform actual update
John Zulaufd9435c32019-06-05 15:55:36 -06002038bool cvdescriptorset::VerifyCopyUpdateContents(CoreChecks *device_data, const VkCopyDescriptorSet *update,
2039 const DescriptorSet *src_set, VkDescriptorType type, uint32_t index,
2040 const char *func_name, std::string *error_code, std::string *error_msg) {
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06002041 // Note : Repurposing some Write update error codes here as specific details aren't called out for copy updates like they are
2042 // for write updates
John Zulaufd9435c32019-06-05 15:55:36 -06002043 switch (src_set->GetDescriptorFromGlobalIndex(index)->descriptor_class) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002044 case PlainSampler: {
2045 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
John Zulaufd9435c32019-06-05 15:55:36 -06002046 const auto src_desc = src_set->GetDescriptorFromGlobalIndex(index + di);
Józef Kucia5297e372017-10-13 22:31:34 +02002047 if (!src_desc->updated) continue;
2048 if (!src_desc->IsImmutableSampler()) {
John Zulaufd9435c32019-06-05 15:55:36 -06002049 auto update_sampler = static_cast<const SamplerDescriptor *>(src_desc)->GetSampler();
2050 if (!ValidateSampler(update_sampler, device_data)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06002051 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00325";
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002052 std::stringstream error_str;
2053 error_str << "Attempted copy update to sampler descriptor with invalid sampler: " << update_sampler << ".";
2054 *error_msg = error_str.str();
2055 return false;
2056 }
2057 } else {
2058 // TODO : Warn here
2059 }
2060 }
2061 break;
2062 }
2063 case ImageSampler: {
2064 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
John Zulaufd9435c32019-06-05 15:55:36 -06002065 const auto src_desc = src_set->GetDescriptorFromGlobalIndex(index + di);
Józef Kucia5297e372017-10-13 22:31:34 +02002066 if (!src_desc->updated) continue;
2067 auto img_samp_desc = static_cast<const ImageSamplerDescriptor *>(src_desc);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002068 // First validate sampler
2069 if (!img_samp_desc->IsImmutableSampler()) {
2070 auto update_sampler = img_samp_desc->GetSampler();
John Zulaufd9435c32019-06-05 15:55:36 -06002071 if (!ValidateSampler(update_sampler, device_data)) {
Dave Houlton00c154e2018-05-24 13:20:50 -06002072 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00325";
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002073 std::stringstream error_str;
2074 error_str << "Attempted copy update to sampler descriptor with invalid sampler: " << update_sampler << ".";
2075 *error_msg = error_str.str();
2076 return false;
2077 }
2078 } else {
2079 // TODO : Warn here
2080 }
2081 // Validate image
2082 auto image_view = img_samp_desc->GetImageView();
2083 auto image_layout = img_samp_desc->GetImageLayout();
John Zulaufd9435c32019-06-05 15:55:36 -06002084 if (!ValidateImageUpdate(image_view, image_layout, type, device_data, func_name, error_code, error_msg)) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06002085 std::stringstream error_str;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002086 error_str << "Attempted copy update to combined image sampler descriptor failed due to: " << error_msg->c_str();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06002087 *error_msg = error_str.str();
Tobin Ehlis300888c2016-05-18 13:43:26 -06002088 return false;
2089 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06002090 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002091 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06002092 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002093 case Image: {
2094 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
John Zulaufd9435c32019-06-05 15:55:36 -06002095 const auto src_desc = src_set->GetDescriptorFromGlobalIndex(index + di);
Józef Kucia5297e372017-10-13 22:31:34 +02002096 if (!src_desc->updated) continue;
2097 auto img_desc = static_cast<const ImageDescriptor *>(src_desc);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002098 auto image_view = img_desc->GetImageView();
2099 auto image_layout = img_desc->GetImageLayout();
John Zulaufd9435c32019-06-05 15:55:36 -06002100 if (!ValidateImageUpdate(image_view, image_layout, type, device_data, func_name, error_code, error_msg)) {
Tobin Ehlis300888c2016-05-18 13:43:26 -06002101 std::stringstream error_str;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002102 error_str << "Attempted copy update to image descriptor failed due to: " << error_msg->c_str();
Tobin Ehlis75f04ec2016-10-06 17:43:11 -06002103 *error_msg = error_str.str();
Tobin Ehlis300888c2016-05-18 13:43:26 -06002104 return false;
2105 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06002106 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002107 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06002108 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002109 case TexelBuffer: {
2110 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
John Zulaufd9435c32019-06-05 15:55:36 -06002111 const auto src_desc = src_set->GetDescriptorFromGlobalIndex(index + di);
Józef Kucia5297e372017-10-13 22:31:34 +02002112 if (!src_desc->updated) continue;
John Zulaufd9435c32019-06-05 15:55:36 -06002113 auto buffer_view = static_cast<const TexelDescriptor *>(src_desc)->GetBufferView();
2114 auto bv_state = device_data->GetBufferViewState(buffer_view);
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002115 if (!bv_state) {
Dave Houlton00c154e2018-05-24 13:20:50 -06002116 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00323";
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002117 std::stringstream error_str;
2118 error_str << "Attempted copy update to texel buffer descriptor with invalid buffer view: " << buffer_view;
2119 *error_msg = error_str.str();
2120 return false;
2121 }
2122 auto buffer = bv_state->create_info.buffer;
John Zulaufd9435c32019-06-05 15:55:36 -06002123 if (!ValidateBufferUsage(device_data->GetBufferState(buffer), type, error_code, error_msg)) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002124 std::stringstream error_str;
2125 error_str << "Attempted copy update to texel buffer descriptor failed due to: " << error_msg->c_str();
2126 *error_msg = error_str.str();
2127 return false;
2128 }
Tobin Ehlis300888c2016-05-18 13:43:26 -06002129 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002130 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06002131 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002132 case GeneralBuffer: {
2133 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
John Zulaufd9435c32019-06-05 15:55:36 -06002134 const auto src_desc = src_set->GetDescriptorFromGlobalIndex(index + di);
Józef Kucia5297e372017-10-13 22:31:34 +02002135 if (!src_desc->updated) continue;
John Zulaufd9435c32019-06-05 15:55:36 -06002136 auto buffer = static_cast<const BufferDescriptor *>(src_desc)->GetBuffer();
2137 if (!ValidateBufferUsage(device_data->GetBufferState(buffer), type, error_code, error_msg)) {
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002138 std::stringstream error_str;
2139 error_str << "Attempted copy update to buffer descriptor failed due to: " << error_msg->c_str();
2140 *error_msg = error_str.str();
2141 return false;
2142 }
Tobin Ehliscbcf2342016-05-24 13:07:12 -06002143 }
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002144 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06002145 }
Jeff Bolze54ae892018-09-08 12:16:29 -05002146 case InlineUniform:
Jeff Bolzfbe51582018-09-13 10:01:35 -05002147 case AccelerationStructure:
Jeff Bolze54ae892018-09-08 12:16:29 -05002148 break;
Mark Lobodzinski64318ba2017-01-26 13:34:13 -07002149 default:
2150 assert(0); // We've already verified update type so should never get here
2151 break;
Tobin Ehlis300888c2016-05-18 13:43:26 -06002152 }
2153 // All checks passed so update contents are good
2154 return true;
Chris Forbesb4e0bdb2016-05-31 16:34:40 +12002155}
Tobin Ehlisf320b192017-03-14 11:22:50 -06002156// Update the common AllocateDescriptorSetsData
Mark Lobodzinski3840ca02019-03-08 18:36:11 -07002157void CoreChecks::UpdateAllocateDescriptorSetsData(const VkDescriptorSetAllocateInfo *p_alloc_info,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002158 cvdescriptorset::AllocateDescriptorSetsData *ds_data) {
Tobin Ehlisf320b192017-03-14 11:22:50 -06002159 for (uint32_t i = 0; i < p_alloc_info->descriptorSetCount; i++) {
Mark Lobodzinski3840ca02019-03-08 18:36:11 -07002160 auto layout = GetDescriptorSetLayout(this, p_alloc_info->pSetLayouts[i]);
Tobin Ehlisf320b192017-03-14 11:22:50 -06002161 if (layout) {
2162 ds_data->layout_nodes[i] = layout;
2163 // Count total descriptors required per type
2164 for (uint32_t j = 0; j < layout->GetBindingCount(); ++j) {
2165 const auto &binding_layout = layout->GetDescriptorSetLayoutBindingPtrFromIndex(j);
2166 uint32_t typeIndex = static_cast<uint32_t>(binding_layout->descriptorType);
2167 ds_data->required_descriptors_by_type[typeIndex] += binding_layout->descriptorCount;
2168 }
2169 }
2170 // Any unknown layouts will be flagged as errors during ValidateAllocateDescriptorSets() call
2171 }
Petr Kraus13c98a62017-12-09 00:22:39 +01002172}
Tobin Ehlisee471462016-05-26 11:21:59 -06002173// Verify that the state at allocate time is correct, but don't actually allocate the sets yet
Mark Lobodzinski3840ca02019-03-08 18:36:11 -07002174bool CoreChecks::ValidateAllocateDescriptorSets(const VkDescriptorSetAllocateInfo *p_alloc_info,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002175 const cvdescriptorset::AllocateDescriptorSetsData *ds_data) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002176 bool skip = false;
Mark Lobodzinski7804bd42019-03-06 11:28:48 -07002177 auto pool_state = GetDescriptorPoolState(p_alloc_info->descriptorPool);
Tobin Ehlisee471462016-05-26 11:21:59 -06002178
2179 for (uint32_t i = 0; i < p_alloc_info->descriptorSetCount; i++) {
Mark Lobodzinski3840ca02019-03-08 18:36:11 -07002180 auto layout = GetDescriptorSetLayout(this, p_alloc_info->pSetLayouts[i]);
John Zulauf5562d062018-01-24 11:54:05 -07002181 if (layout) { // nullptr layout indicates no valid layout handle for this device, validated/logged in object_tracker
John Zulauf1d27e0a2018-11-05 10:12:48 -07002182 if (layout->IsPushDescriptor()) {
John Zulauf5562d062018-01-24 11:54:05 -07002183 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 -06002184 HandleToUint64(p_alloc_info->pSetLayouts[i]), "VUID-VkDescriptorSetAllocateInfo-pSetLayouts-00308",
Lockeca0d9792019-03-03 23:48:13 -07002185 "Layout %s specified at pSetLayouts[%" PRIu32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002186 "] in vkAllocateDescriptorSets() was created with invalid flag %s set.",
Lockeca0d9792019-03-03 23:48:13 -07002187 report_data->FormatHandle(p_alloc_info->pSetLayouts[i]).c_str(), i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002188 "VK_DESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT_KHR");
John Zulauf5562d062018-01-24 11:54:05 -07002189 }
Jeff Bolzfdf96072018-04-10 14:32:18 -05002190 if (layout->GetCreateFlags() & VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT &&
2191 !(pool_state->createInfo.flags & VK_DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT)) {
2192 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 -06002193 0, "VUID-VkDescriptorSetAllocateInfo-pSetLayouts-03044",
Jeff Bolzfdf96072018-04-10 14:32:18 -05002194 "Descriptor set layout create flags and pool create flags mismatch for index (%d)", i);
2195 }
Tobin Ehlisee471462016-05-26 11:21:59 -06002196 }
2197 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002198 if (!device_extensions.vk_khr_maintenance1) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002199 // Track number of descriptorSets allowable in this pool
2200 if (pool_state->availableSets < p_alloc_info->descriptorSetCount) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002201 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 -06002202 HandleToUint64(pool_state->pool), "VUID-VkDescriptorSetAllocateInfo-descriptorSetCount-00306",
Lockeca0d9792019-03-03 23:48:13 -07002203 "Unable to allocate %u descriptorSets from pool %s"
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002204 ". This pool only has %d descriptorSets remaining.",
Lockeca0d9792019-03-03 23:48:13 -07002205 p_alloc_info->descriptorSetCount, report_data->FormatHandle(pool_state->pool).c_str(),
2206 pool_state->availableSets);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002207 }
2208 // Determine whether descriptor counts are satisfiable
Jeff Bolze54ae892018-09-08 12:16:29 -05002209 for (auto it = ds_data->required_descriptors_by_type.begin(); it != ds_data->required_descriptors_by_type.end(); ++it) {
2210 if (ds_data->required_descriptors_by_type.at(it->first) > pool_state->availableDescriptorTypeCount[it->first]) {
Lockeca0d9792019-03-03 23:48:13 -07002211 skip |= log_msg(
2212 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_POOL_EXT,
2213 HandleToUint64(pool_state->pool), "VUID-VkDescriptorSetAllocateInfo-descriptorPool-00307",
2214 "Unable to allocate %u descriptors of type %s from pool %s"
2215 ". This pool only has %d descriptors of this type remaining.",
2216 ds_data->required_descriptors_by_type.at(it->first), string_VkDescriptorType(VkDescriptorType(it->first)),
2217 report_data->FormatHandle(pool_state->pool).c_str(), pool_state->availableDescriptorTypeCount[it->first]);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002218 }
Tobin Ehlisee471462016-05-26 11:21:59 -06002219 }
2220 }
Tobin Ehlis5d749ea2016-07-18 13:14:01 -06002221
Jeff Bolzfdf96072018-04-10 14:32:18 -05002222 const auto *count_allocate_info = lvl_find_in_chain<VkDescriptorSetVariableDescriptorCountAllocateInfoEXT>(p_alloc_info->pNext);
2223
2224 if (count_allocate_info) {
2225 if (count_allocate_info->descriptorSetCount != 0 &&
2226 count_allocate_info->descriptorSetCount != p_alloc_info->descriptorSetCount) {
2227 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 -06002228 "VUID-VkDescriptorSetVariableDescriptorCountAllocateInfoEXT-descriptorSetCount-03045",
Jeff Bolzfdf96072018-04-10 14:32:18 -05002229 "VkDescriptorSetAllocateInfo::descriptorSetCount (%d) != "
2230 "VkDescriptorSetVariableDescriptorCountAllocateInfoEXT::descriptorSetCount (%d)",
2231 p_alloc_info->descriptorSetCount, count_allocate_info->descriptorSetCount);
2232 }
2233 if (count_allocate_info->descriptorSetCount == p_alloc_info->descriptorSetCount) {
2234 for (uint32_t i = 0; i < p_alloc_info->descriptorSetCount; i++) {
Mark Lobodzinski3840ca02019-03-08 18:36:11 -07002235 auto layout = GetDescriptorSetLayout(this, p_alloc_info->pSetLayouts[i]);
Jeff Bolzfdf96072018-04-10 14:32:18 -05002236 if (count_allocate_info->pDescriptorCounts[i] > layout->GetDescriptorCountFromBinding(layout->GetMaxBinding())) {
2237 skip |= log_msg(
2238 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 -06002239 "VUID-VkDescriptorSetVariableDescriptorCountAllocateInfoEXT-pSetLayouts-03046",
2240 "pDescriptorCounts[%d] = (%d), binding's descriptorCount = (%d)", i,
Jeff Bolzfdf96072018-04-10 14:32:18 -05002241 count_allocate_info->pDescriptorCounts[i], layout->GetDescriptorCountFromBinding(layout->GetMaxBinding()));
2242 }
2243 }
2244 }
2245 }
2246
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06002247 return skip;
Tobin Ehlisee471462016-05-26 11:21:59 -06002248}
2249// Decrement allocated sets from the pool and insert new sets into set_map
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002250void CoreChecks::PerformAllocateDescriptorSets(const VkDescriptorSetAllocateInfo *p_alloc_info,
2251 const VkDescriptorSet *descriptor_sets,
Mark Lobodzinskia33af952019-04-25 14:59:05 -06002252 const cvdescriptorset::AllocateDescriptorSetsData *ds_data) {
2253 auto pool_state = descriptorPoolMap[p_alloc_info->descriptorPool].get();
Mark Lobodzinskic9430182017-06-13 13:00:05 -06002254 // Account for sets and individual descriptors allocated from pool
Tobin Ehlisee471462016-05-26 11:21:59 -06002255 pool_state->availableSets -= p_alloc_info->descriptorSetCount;
Jeff Bolze54ae892018-09-08 12:16:29 -05002256 for (auto it = ds_data->required_descriptors_by_type.begin(); it != ds_data->required_descriptors_by_type.end(); ++it) {
2257 pool_state->availableDescriptorTypeCount[it->first] -= ds_data->required_descriptors_by_type.at(it->first);
Tobin Ehlis68d0adf2016-06-01 11:33:50 -06002258 }
Jeff Bolzfdf96072018-04-10 14:32:18 -05002259
2260 const auto *variable_count_info = lvl_find_in_chain<VkDescriptorSetVariableDescriptorCountAllocateInfoEXT>(p_alloc_info->pNext);
2261 bool variable_count_valid = variable_count_info && variable_count_info->descriptorSetCount == p_alloc_info->descriptorSetCount;
2262
Mark Lobodzinskic9430182017-06-13 13:00:05 -06002263 // Create tracking object for each descriptor set; insert into global map and the pool's set.
Tobin Ehlisee471462016-05-26 11:21:59 -06002264 for (uint32_t i = 0; i < p_alloc_info->descriptorSetCount; i++) {
Jeff Bolzfdf96072018-04-10 14:32:18 -05002265 uint32_t variable_count = variable_count_valid ? variable_count_info->pDescriptorCounts[i] : 0;
2266
Mark Lobodzinski14112ab2019-04-25 15:29:34 -06002267 std::unique_ptr<cvdescriptorset::DescriptorSet> new_ds(new cvdescriptorset::DescriptorSet(
2268 descriptor_sets[i], p_alloc_info->descriptorPool, ds_data->layout_nodes[i], variable_count, this));
2269 pool_state->sets.insert(new_ds.get());
Tobin Ehlisee471462016-05-26 11:21:59 -06002270 new_ds->in_use.store(0);
Mark Lobodzinski14112ab2019-04-25 15:29:34 -06002271 setMap[descriptor_sets[i]] = std::move(new_ds);
Tobin Ehlisee471462016-05-26 11:21:59 -06002272 }
2273}
John Zulauf48a6a702017-12-22 17:14:54 -07002274
2275cvdescriptorset::PrefilterBindRequestMap::PrefilterBindRequestMap(cvdescriptorset::DescriptorSet &ds, const BindingReqMap &in_map,
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002276 CMD_BUFFER_STATE *cb_state)
John Zulauf48a6a702017-12-22 17:14:54 -07002277 : filtered_map_(), orig_map_(in_map) {
2278 if (ds.GetTotalDescriptorCount() > kManyDescriptors_) {
2279 filtered_map_.reset(new std::map<uint32_t, descriptor_req>());
2280 ds.FilterAndTrackBindingReqs(cb_state, orig_map_, filtered_map_.get());
2281 }
2282}
2283cvdescriptorset::PrefilterBindRequestMap::PrefilterBindRequestMap(cvdescriptorset::DescriptorSet &ds, const BindingReqMap &in_map,
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002284 CMD_BUFFER_STATE *cb_state, PIPELINE_STATE *pipeline)
John Zulauf48a6a702017-12-22 17:14:54 -07002285 : filtered_map_(), orig_map_(in_map) {
2286 if (ds.GetTotalDescriptorCount() > kManyDescriptors_) {
2287 filtered_map_.reset(new std::map<uint32_t, descriptor_req>());
2288 ds.FilterAndTrackBindingReqs(cb_state, pipeline, orig_map_, filtered_map_.get());
2289 }
Artem Kharytoniuk2456f992018-01-12 14:17:41 +01002290}
John Zulauf4a015c92019-06-04 09:50:05 -06002291
2292// Starting at offset descriptor of given binding, parse over update_count
2293// descriptor updates and verify that for any binding boundaries that are crossed, the next binding(s) are all consistent
2294// Consistency means that their type, stage flags, and whether or not they use immutable samplers matches
2295// If so, return true. If not, fill in error_msg and return false
2296bool cvdescriptorset::VerifyUpdateConsistency(DescriptorSetLayout::ConstBindingIterator current_binding, uint32_t offset,
2297 uint32_t update_count, const char *type, const VkDescriptorSet set,
2298 std::string *error_msg) {
2299 // Verify consecutive bindings match (if needed)
2300 auto orig_binding = current_binding;
2301 // Track count of descriptors in the current_bindings that are remaining to be updated
2302 auto binding_remaining = current_binding.GetDescriptorCount();
2303 // First, it's legal to offset beyond your own binding so handle that case
2304 // Really this is just searching for the binding in which the update begins and adjusting offset accordingly
2305 while (offset >= binding_remaining && !current_binding.AtEnd()) {
2306 // Advance to next binding, decrement offset by binding size
2307 offset -= binding_remaining;
2308 ++current_binding;
2309 binding_remaining = current_binding.GetDescriptorCount(); // Accessors are safe if AtEnd
2310 }
2311 assert(!current_binding.AtEnd()); // As written assumes range check has been made before calling
2312 binding_remaining -= offset;
2313 while (update_count > binding_remaining) { // While our updates overstep current binding
2314 // Verify next consecutive binding matches type, stage flags & immutable sampler use
2315 auto next_binding = current_binding.Next();
2316 if (!current_binding.IsConsistent(next_binding)) {
2317 std::stringstream error_str;
2318 error_str << "Attempting " << type;
2319 if (current_binding.Layout()->IsPushDescriptor()) {
2320 error_str << " push descriptors";
2321 } else {
2322 error_str << " descriptor set " << set;
2323 }
2324 error_str << " binding #" << orig_binding.Binding() << " with #" << update_count
2325 << " descriptors being updated but this update oversteps the bounds of this binding and the next binding is "
2326 "not consistent with current binding so this update is invalid.";
2327 *error_msg = error_str.str();
2328 return false;
2329 }
2330 current_binding = next_binding;
2331 // For sake of this check consider the bindings updated and grab count for next binding
2332 update_count -= binding_remaining;
2333 binding_remaining = current_binding.GetDescriptorCount();
2334 }
2335 return true;
2336}
John Zulauf4956fff2019-06-04 16:54:38 -06002337
2338// Validate the state for a given write update but don't actually perform the update
2339// If an error would occur for this update, return false and fill in details in error_msg string
2340bool cvdescriptorset::ValidateWriteUpdate(const DescriptorSet *dest_set, const debug_report_data *report_data,
2341 const VkWriteDescriptorSet *update, const char *func_name, std::string *error_code,
2342 std::string *error_msg) {
2343 const auto dest_layout = dest_set->GetLayout();
2344
2345 // Verify dst layout still valid
2346 if (dest_layout->IsDestroyed()) {
2347 *error_code = "VUID-VkWriteDescriptorSet-dstSet-00320";
2348 string_sprintf(error_msg, "Cannot call %s to perform write update on %s which has been destroyed", func_name,
2349 dest_set->StringifySetAndLayout().c_str());
2350 return false;
2351 }
2352 // Verify dst binding exists
2353 if (!dest_layout->HasBinding(update->dstBinding)) {
2354 *error_code = "VUID-VkWriteDescriptorSet-dstBinding-00315";
2355 std::stringstream error_str;
2356 error_str << dest_set->StringifySetAndLayout() << " does not have binding " << update->dstBinding;
2357 *error_msg = error_str.str();
2358 return false;
2359 }
2360
2361 DescriptorSetLayout::ConstBindingIterator dest(dest_layout.get(), update->dstBinding);
2362 // Make sure binding isn't empty
2363 if (0 == dest.GetDescriptorCount()) {
2364 *error_code = "VUID-VkWriteDescriptorSet-dstBinding-00316";
2365 std::stringstream error_str;
2366 error_str << dest_set->StringifySetAndLayout() << " cannot updated binding " << update->dstBinding
2367 << " that has 0 descriptors";
2368 *error_msg = error_str.str();
2369 return false;
2370 }
2371
2372 // Verify idle ds
2373 if (dest_set->in_use.load() && !(dest.GetDescriptorBindingFlags() & (VK_DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT_EXT |
2374 VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT))) {
2375 // TODO : Re-using Free Idle error code, need write update idle error code
2376 *error_code = "VUID-vkFreeDescriptorSets-pDescriptorSets-00309";
2377 std::stringstream error_str;
2378 error_str << "Cannot call " << func_name << " to perform write update on " << dest_set->StringifySetAndLayout()
2379 << " that is in use by a command buffer";
2380 *error_msg = error_str.str();
2381 return false;
2382 }
2383 // We know that binding is valid, verify update and do update on each descriptor
2384 auto start_idx = dest.GetGlobalIndexRange().start + update->dstArrayElement;
2385 auto type = dest.GetType();
2386 if (type != update->descriptorType) {
2387 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00319";
2388 std::stringstream error_str;
2389 error_str << "Attempting write update to " << dest_set->StringifySetAndLayout() << " binding #" << update->dstBinding
2390 << " with type " << string_VkDescriptorType(type) << " but update type is "
2391 << string_VkDescriptorType(update->descriptorType);
2392 *error_msg = error_str.str();
2393 return false;
2394 }
2395 auto total_descriptors = dest_layout->GetTotalDescriptorCount();
2396 if (update->descriptorCount > (total_descriptors - start_idx)) {
2397 *error_code = "VUID-VkWriteDescriptorSet-dstArrayElement-00321";
2398 std::stringstream error_str;
2399 error_str << "Attempting write update to " << dest_set->StringifySetAndLayout() << " binding #" << update->dstBinding
2400 << " with " << total_descriptors - start_idx
2401 << " descriptors in that binding and all successive bindings of the set, but update of "
2402 << update->descriptorCount << " descriptors combined with update array element offset of "
2403 << update->dstArrayElement << " oversteps the available number of consecutive descriptors";
2404 *error_msg = error_str.str();
2405 return false;
2406 }
2407 if (type == VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT) {
2408 if ((update->dstArrayElement % 4) != 0) {
2409 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-02219";
2410 std::stringstream error_str;
2411 error_str << "Attempting write update to " << dest_set->StringifySetAndLayout() << " binding #" << update->dstBinding
2412 << " with "
2413 << "dstArrayElement " << update->dstArrayElement << " not a multiple of 4";
2414 *error_msg = error_str.str();
2415 return false;
2416 }
2417 if ((update->descriptorCount % 4) != 0) {
2418 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-02220";
2419 std::stringstream error_str;
2420 error_str << "Attempting write update to " << dest_set->StringifySetAndLayout() << " binding #" << update->dstBinding
2421 << " with "
2422 << "descriptorCount " << update->descriptorCount << " not a multiple of 4";
2423 *error_msg = error_str.str();
2424 return false;
2425 }
2426 const auto *write_inline_info = lvl_find_in_chain<VkWriteDescriptorSetInlineUniformBlockEXT>(update->pNext);
2427 if (!write_inline_info || write_inline_info->dataSize != update->descriptorCount) {
2428 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-02221";
2429 std::stringstream error_str;
2430 if (!write_inline_info) {
2431 error_str << "Attempting write update to " << dest_set->StringifySetAndLayout() << " binding #"
2432 << update->dstBinding << " with "
2433 << "VkWriteDescriptorSetInlineUniformBlockEXT missing";
2434 } else {
2435 error_str << "Attempting write update to " << dest_set->StringifySetAndLayout() << " binding #"
2436 << update->dstBinding << " with "
2437 << "VkWriteDescriptorSetInlineUniformBlockEXT dataSize " << write_inline_info->dataSize
2438 << " not equal to "
2439 << "VkWriteDescriptorSet descriptorCount " << update->descriptorCount;
2440 }
2441 *error_msg = error_str.str();
2442 return false;
2443 }
2444 // This error is probably unreachable due to the previous two errors
2445 if (write_inline_info && (write_inline_info->dataSize % 4) != 0) {
2446 *error_code = "VUID-VkWriteDescriptorSetInlineUniformBlockEXT-dataSize-02222";
2447 std::stringstream error_str;
2448 error_str << "Attempting write update to " << dest_set->StringifySetAndLayout() << " binding #" << update->dstBinding
2449 << " with "
2450 << "VkWriteDescriptorSetInlineUniformBlockEXT dataSize " << write_inline_info->dataSize
2451 << " not a multiple of 4";
2452 *error_msg = error_str.str();
2453 return false;
2454 }
2455 }
2456 // Verify consecutive bindings match (if needed)
2457 if (!VerifyUpdateConsistency(DescriptorSetLayout::ConstBindingIterator(dest_layout.get(), update->dstBinding),
2458 update->dstArrayElement, update->descriptorCount, "write update to", dest_set->GetSet(),
2459 error_msg)) {
2460 // TODO : Should break out "consecutive binding updates" language into valid usage statements
2461 *error_code = "VUID-VkWriteDescriptorSet-dstArrayElement-00321";
2462 return false;
2463 }
2464 // Update is within bounds and consistent so last step is to validate update contents
John Zulauf459939f2019-06-04 16:49:35 -06002465 if (!VerifyWriteUpdateContents(dest_set, update, start_idx, func_name, error_code, error_msg)) {
John Zulauf4956fff2019-06-04 16:54:38 -06002466 std::stringstream error_str;
2467 error_str << "Write update to " << dest_set->StringifySetAndLayout() << " binding #" << update->dstBinding
2468 << " failed with error message: " << error_msg->c_str();
2469 *error_msg = error_str.str();
2470 return false;
2471 }
2472 // All checks passed, update is clean
2473 return true;
2474}
John Zulaufadb3f542019-06-04 17:01:00 -06002475
2476// Verify that the contents of the update are ok, but don't perform actual update
2477bool cvdescriptorset::VerifyWriteUpdateContents(const DescriptorSet *dest_set, const VkWriteDescriptorSet *update,
2478 const uint32_t index, const char *func_name, std::string *error_code,
2479 std::string *error_msg) {
2480 auto *device_data = dest_set->GetDeviceData();
2481 switch (update->descriptorType) {
2482 case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER: {
2483 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
2484 // Validate image
2485 auto image_view = update->pImageInfo[di].imageView;
2486 auto image_layout = update->pImageInfo[di].imageLayout;
2487 if (!ValidateImageUpdate(image_view, image_layout, update->descriptorType, device_data, func_name, error_code,
2488 error_msg)) {
2489 std::stringstream error_str;
2490 error_str << "Attempted write update to combined image sampler descriptor failed due to: "
2491 << error_msg->c_str();
2492 *error_msg = error_str.str();
2493 return false;
2494 }
2495 if (device_data->device_extensions.vk_khr_sampler_ycbcr_conversion) {
2496 ImageSamplerDescriptor *desc = (ImageSamplerDescriptor *)dest_set->GetDescriptorFromGlobalIndex(index + di);
2497 if (desc->IsImmutableSampler()) {
2498 auto sampler_state = device_data->GetSamplerState(desc->GetSampler());
2499 auto iv_state = device_data->GetImageViewState(image_view);
2500 if (iv_state && sampler_state) {
2501 if (iv_state->samplerConversion != sampler_state->samplerConversion) {
2502 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-01948";
2503 std::stringstream error_str;
2504 error_str << "Attempted write update to combined image sampler and image view and sampler ycbcr "
2505 "conversions are not identical, sampler: "
2506 << desc->GetSampler() << " image view: " << iv_state->image_view << ".";
2507 *error_msg = error_str.str();
2508 return false;
2509 }
2510 }
2511 } else {
2512 auto iv_state = device_data->GetImageViewState(image_view);
2513 if (iv_state && (iv_state->samplerConversion != VK_NULL_HANDLE)) {
2514 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-01947";
2515 std::stringstream error_str;
2516 error_str << "Because dstSet (" << update->dstSet << ") is bound to image view ("
2517 << iv_state->image_view
2518 << ") that includes a YCBCR conversion, it must have been allocated with a layout that "
2519 "includes an immutable sampler.";
2520 *error_msg = error_str.str();
2521 return false;
2522 }
2523 }
2524 }
2525 }
2526 }
2527 // fall through
2528 case VK_DESCRIPTOR_TYPE_SAMPLER: {
2529 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
2530 SamplerDescriptor *desc = (SamplerDescriptor *)dest_set->GetDescriptorFromGlobalIndex(index + di);
2531 if (!desc->IsImmutableSampler()) {
2532 if (!ValidateSampler(update->pImageInfo[di].sampler, device_data)) {
2533 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00325";
2534 std::stringstream error_str;
2535 error_str << "Attempted write update to sampler descriptor with invalid sampler: "
2536 << update->pImageInfo[di].sampler << ".";
2537 *error_msg = error_str.str();
2538 return false;
2539 }
2540 } else {
2541 // TODO : Warn here
2542 }
2543 }
2544 break;
2545 }
2546 case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
2547 case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT:
2548 case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE: {
2549 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
2550 auto image_view = update->pImageInfo[di].imageView;
2551 auto image_layout = update->pImageInfo[di].imageLayout;
2552 if (!ValidateImageUpdate(image_view, image_layout, update->descriptorType, device_data, func_name, error_code,
2553 error_msg)) {
2554 std::stringstream error_str;
2555 error_str << "Attempted write update to image descriptor failed due to: " << error_msg->c_str();
2556 *error_msg = error_str.str();
2557 return false;
2558 }
2559 }
2560 break;
2561 }
2562 case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
2563 case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER: {
2564 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
2565 auto buffer_view = update->pTexelBufferView[di];
2566 auto bv_state = device_data->GetBufferViewState(buffer_view);
2567 if (!bv_state) {
2568 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00323";
2569 std::stringstream error_str;
2570 error_str << "Attempted write update to texel buffer descriptor with invalid buffer view: " << buffer_view;
2571 *error_msg = error_str.str();
2572 return false;
2573 }
2574 auto buffer = bv_state->create_info.buffer;
2575 auto buffer_state = device_data->GetBufferState(buffer);
2576 // Verify that buffer underlying the view hasn't been destroyed prematurely
2577 if (!buffer_state) {
2578 *error_code = "VUID-VkWriteDescriptorSet-descriptorType-00323";
2579 std::stringstream error_str;
2580 error_str << "Attempted write update to texel buffer descriptor failed because underlying buffer (" << buffer
2581 << ") has been destroyed: " << error_msg->c_str();
2582 *error_msg = error_str.str();
2583 return false;
John Zulaufd9435c32019-06-05 15:55:36 -06002584 } else if (!ValidateBufferUsage(buffer_state, update->descriptorType, error_code, error_msg)) {
John Zulaufadb3f542019-06-04 17:01:00 -06002585 std::stringstream error_str;
2586 error_str << "Attempted write update to texel 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_UNIFORM_BUFFER:
2594 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:
2595 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
2596 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC: {
2597 for (uint32_t di = 0; di < update->descriptorCount; ++di) {
John Zulaufd9435c32019-06-05 15:55:36 -06002598 if (!ValidateBufferUpdate(device_data, update->pBufferInfo + di, update->descriptorType, func_name, error_code,
2599 error_msg)) {
John Zulaufadb3f542019-06-04 17:01:00 -06002600 std::stringstream error_str;
2601 error_str << "Attempted write update to buffer descriptor failed due to: " << error_msg->c_str();
2602 *error_msg = error_str.str();
2603 return false;
2604 }
2605 }
2606 break;
2607 }
2608 case VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT:
2609 break;
2610 case VK_DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_NV:
2611 // XXX TODO
2612 break;
2613 default:
2614 assert(0); // We've already verified update type so should never get here
2615 break;
2616 }
2617 // All checks passed so update contents are good
2618 return true;
2619}